How to Create and Insert Field Codes

Using Field Codes includes:

• Creating Field Codes
• Inserting Field Codes into a Standard Response

Creating Field Codes

From the Knowledge Manager browser window:

1. Select the language and Field Codes from the drop-down menus.
2. Click New.

• To configure your new Field Code, enter the properties you need in the Field Code configuration pane and then click Save.

The new Field Code appears in the Category Tree pane. You can edit a Field Code anytime by double-clicking it in the Category Tree.

1. Enter a name and (optionally) a description for the field code.
2. Select System and/or Custom variables from the drop-down lists.
3. Click Insert to populate the text box with the selected variables.

The New custom variable dialog box opens, as shown in "New Custom Variable".

New Custom Variable

• Enter a name (required) and description (optional). Observe the restrictions (see See The names of custom variables must begin with an alphabetic character or underscore, and the remainder of the name must consist only of alphanumeric characters or underscores. This differs from the requirements for the names of other Knowledge Manager objects, which may also contain hyphen and space. For example, 5-usercode is not an acceptable name for a custom variable, but it is acceptable as the name of a screening rule or category.) on custom variable names.
  
• Select a type (String or Integer).
  
• Enter a default value (required). This value is rendered when you click Check Field Codes in the Standard Response Editor (see Step 4 in Creating and Editing Standard Responses).
  
• Click Add.
  

You can also use this dialog box to edit and delete existing custom variables. Click OK to return to the New Field Code dialog box.

Select system and custom variables from the drop-down lists, then click Insert to insert them into the Text field.

Enter any other desired text in the Text field. This text must conform to the rules described in Field Code Overview: Field Code Syntax.

Click Check to verify that the field code is well-formed (that is, that it has no typographical errors, missing parentheses, and so on).

Next Steps

• Use field codes in a standard response.
  

Inserting Field Codes into a Standard Response

1. On the Categories tab, do one of the following:
1. Double-click a standard response. The Edit Standard Response dialog box opens.
2. Right-click and select New. The New Standard Response dialog box opens.
   

These two dialog boxes are identical apart from their titles. The figure "New Standard Response" shows New Standard Response.

New Standard Response

Click Insert Field Code to display a list of all the field codes that you have created. The list appears in the dialog box shown in "List of Field Codes."

List of Field Codes

Select a field code and click OK to insert it, together with its required delimiters <$ $>, into a standard response. This returns you to the Edit Standard Response (or New Standard Response) dialog box.

Click Check Field Codes to see the standard response with the field codes rendered. The values rendered come from a collection of generic properties that exists for this purpose.

Important

Standard Responses that are intended for use in FAQ objects should not contain field codes.

Next Steps

• Examine the use of field codes in Field Code Examples.