Label-value pair formats


Your email must use specific syntax for label/value pairs so that the parser can extract the required information. Each of the following formats can be used in plain text, HTML, or XML documents.

Basic format

The basic format is the simplest. You can associate a label with a constant value or a variable value. The labels and associated constant values are written as follows:

Label:[$$Value$$]

The opening and closing $$ enable the parser to extract the value from the email, including situations where the value incorporates multiple lines. If the value does not incorporate multiple lines, the label/value pair can be written as follows:

Label:Value

Tip

You should use the [$$ ... $$] variable syntax when the Email Engineneeds to parse multi-line values. Strictly speaking, you do not need to use this multi-line syntax for all label/value pairs but adopt this method if you think the values in a variable might exceed a single line.

The label and value do not have to be left justified, and can be prefaced by text on the same line. You do not have to surround the label with any special characters.

You can associate a label with a variable also. A variable is written as follows:

#$$variable_name$$#

When used in a label/value format:

Label:[$$#$$variable_name_Value$$#$$]

XML format

The XML format is as follows:

<Label>Value</Label>

AR Systemfields are treated differently. The format is as follows:

<Field ID="!Field_ID!">Field Value</Field>

or:

<Field Name="!Field_Name!">Field Value</Field>

Variables are referenced as #$$variable_name$$# in the Basic format. To view a template using XML, see Creating-result-templates-for-outgoing-email.

HTML format

The four major HTML field types are:

  • Text fields
  • Radio buttons
  • Checkbox buttons
  • Menu field

These types have a fixed format in HTML. In HTML, however, an editor automatically generates the correct format when filling in any missing field values. You can still use the Basic format within the HTML document. The corresponding fields can be used in situations where input is required from the user. The email client must allow or support the ability to edit HTML fields directly; such an example would be Microsoft Outlook when it is configured to edit emails with Microsoft Word. To create a template by using HTML field types, see Sending outgoing email in HTML.

The name tag represents the label, and the value tag represents the value.

Text field

In HTML, a text field typically looks like this:

<input type="text" name="Label" size="20" value ="Value">

This represents a text field into which data can be typed so it easily represents a label/value pair. The name tag contains a label, such as Action, and the value tag will contain a corresponding value, such as Query.

Radio buttons

Radio buttons allow you to design a document where the user can select from a given range of possibilities. Unlike a text field where only one set of tags between the <> markers represent a label/value pair, radio buttons can contain several sets of tags that comprise one instruction label and several values. An example follows:

<input type="radio" value ="Submit" checked name="Action" >
<input type="radio" value ="Query" name="Action">

This represents two radio buttons grouped together under the name Action. The values for the radio buttons would be Submit and Query. The selected value would be determined by the word "checked." The resulting label/value pair would be Action:Submit.

Checkbox buttons

Checkbox buttons allow you to design a document where there are several possibilities, but those possibilities are not grouped together. An example follows:

<input type="checkbox" name="Label" value ="Value">

or

<input type="checkbox" name="Label" value ="Value" checked>

In the first example, the label and value is not used because the word "checked" is not included in the definition. But in the second example, the label and value is used because the box was checked.

This field can give the user the ability to select the parameters that are valid and those that are not.

Menu field

The menu field acts as a selection box where you will be able to create a label from which any specific value can be selected from a range. In the following example, the Action label has possible values of Modify, Submit, and Query.

<select size="1" name="Action">
  <option value="Modify">Modify the entry</option>
  <option selected value="Submit">Submit the entry</option>
  <option value="Query">Query the entry</option>
</select>

The type is a select HTML field; the label is Action; and the values are Modify, Submit, and Query. The tag containing the word "selected" determines the label/value paid to be used.

The menu field also allows the user to specify different visible text in the field with the correct field values defined underneath.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*