Field Properties

Each layout can be set up in a multi-column table with each cell of the table able to hold a field. The Field properties allow you to specify the details about how the field is displayed and handled on the screen. To add a field to the layout, you use the drag and drop operation to move a field from the from the Fields tab to the layout.

The Properties tab allows you to define standard and advanced properties. When you select the field in the layout, the Properties tab will display the applicable properties for that category.

The field properties available to you are dependent on the field you select. Not all system field properties will display for all fields.

Depending on the category (field) you may see any of the following:

Field	Description
Display Type	Select the display type of the field: Input or Display or Sensitive Data. Available options depend on the type of data being displayed in the field. For example, the Issue Seq field displays the following: DisplayOnly, DisplayOnlyCheckbox, Input, InputCheckbox, Input DropDown, InputTextArea and SensitiveData.
Display	Select the level that should be displayed in the field: Code, Description 1, Description 2, or Description 3.
Browse Order	Select the browse order for the field. Choose from: Ascending or Descending.
Display Description	Select True to display the code description. Select False to hide the code description.
Access Key	Access Keys are also known as hot keys or shortcut keys and allow you to quickly and easily perform a task that the Access Key is assigned. Enter one alphanumeric character to use in conjunction with the Alt key as a shortcut to access this field on the screen. Pressing [Alt+<Access Key>] moves your cursor to this field on the screen. You can set up one Access Key for each letter and each number on your keyboard. However, best practice would be to set up only the most useful Access Keys – for example, the top five shortcuts. A user is unlikely to remember 35 Access Keys for each screen in the system. In addition, an Access Key can only be used once per screen, but the same Access Keys can be assigned to different fields on several different screens. In Windows Internet Explorer 7, Alt+D selects text in the Address bar, making D unavailable as an Access Key.
ColumnOptionNoValueLabel	Enter the text that you want to appear when no option is selected in the field. Used with the Issue Sequence, Letter Sequence, Action Sequence, and Address ID fields.
ColumnSize	Select the width of the column. Choose from 1 to 12. Default width is 6. The category definition's Character Length value overrides the default.
MaxLength	Enter the maximum number of characters that can be entered into a field. This can also be set in category maintenance.
RowSize	Select the default row height when the field is HTML text area (ColumnType property is InputTextArea). Choose from 1 to 12. This setting specifies the HTML "rows" attribute.
Style	Enter the Cascading Style Sheet (CSS) style for a specific field. CSS provides rules on how HTML content is formatted when displayed.
Rowspan	Specify the number of spanned rows for two or more columns. For example, a Rowspan of "2" sets the height to twice the size of the default. You also need to set the Column Type to "Block" in Advanced Properties. This setting specifies the HTML "rowspan" attribute.

Advanced Properties

Click the Advanced Properties link to display additional properties that you can set for the field.

Field	Description
Attribute	Displays the selected field name according to the Master Field List XML.
Attribute2	Displays the name of second attribute of the selected field. It is only used for the "SideLabelPair2" field type (it is specified with the “Name” property).
Description	Displays a description of the attribute. It is used with a few standard insert definitions, but it does not affect XSL generation.
Element	Displays the selected field element name according to the Master Field List XML.
Element2	Displays the name of the second Element of the selected field. It is used only for the "SideLabelPair2" field type (it is specified with the “Name” property).
Field Column Size	Select the width of the Field Column. Choose from 1 to 12. Default width is 6.
Label Column Size	Select the width of the Label Column. Choose from 1 to 12. Default width is 6.
LCID	Displays the LCID (language resource ID) number. The property is not read-only but should only be changed with an automated process.
AllowedDragItemList	Displays the property of the selected field that specifies that dragging from the super Category Browser window is allowed for the field.
BrowseType	Allows you to override the default browse behavior. If the Column Type is "InputDropDown," the codes are browsable by default. The supported browse types include: "" – No browse "Code" – Category codes browser "Calendar" – the Calendar browser for date type fields "File" "FileFolder" "FileMulti" "FileNew" "FileNewPrompt" – the file system browser "Email" – "SelectRecipients" dialog "Phone" – "SelectPhone" window "CaseID" – it is used by the “CaseEdit” window for browsing the Case according to case ID value in the field "OrderID" – it is used by the “OrderEdit” window for browsing the Case according to order ID value in the field "SendTo" – it is used by the "ConfigPCCase" layout, yet it is not supported by Emplifi Agent.
BrowseType2	Similar to the BrowseType property, this property specifies the browse type of the second attribute of the selected field. It is only used for the "SideLabelPair2" field type (it is specified with the “Name” property).
BrowseXPath	Specifies the XPath [Used to specify the data source for the defined object (usually lists and drop downs).] to the attribute which specifies the category codes for browsing. It is used only with the "Code" browse type.
ABrowseXPath2	Similar to the “BrowseXPath” property, this property specifies the “BrowseXPath” of the second attribute of the selected field. It is used only for the "SideLabelPair2" attribute type (it is specified with the “Name” property).
ButtonCaption	Specifies the button caption for the button type elements of layouts.
ButtonID	This property has no effect on the XSL generation.
ButtonTitle	Specifies the title of the “Button” element.
CategoryIDColumn	Specifies the column name for the category ID field. It is used only for "InputCategoryNameID" layout’s element type (Name property). The "InputCategoryNameID" element creates the category name field and in additional it creates the field for a category ID. This attribute is used with the “CategoryNameColumn” property. They contain two fields: Category Name and Category ID. The Category ID is the input field, but it is always read-only.
CategoryNameColumn	Specifies the column name for the category name input field of the "InputCategoryNameID" layout’s element type.
CheckboxValueOff	Specifies the value for the check box type field when the element is not checked. It is used when the ColumnType property is "InputCheckbox" or “DisplayOnlyCheckbox”.
CheckboxValueOn	Specifies the value for the check box type field when the element is checked. It is used when the ColumnType property is "InputCheckbox" or “DisplayOnlyCheckbox”.
CheckedExpr	Specifies the condition for the check box type field when the element should be checked. It is used when the ColumnType property is "InputCheckbox" or “DisplayOnlyCheckbox”.
Choice Data Source	Enter DropDown name/value pairs with a pipe '\|' delimiter and each pair separated by a semicolon. For example: 1\|one;2\|two;3\|three...
Colspan	Specifies the value of the “colspan” property for the “TD” HTML element.
Column	Typically left blank, this property is specified only if the attribute name in the data island is different than the attribute data (for example, label and codes) used for a field. For example, the Case Status of a case search view has the 'case_status' Column property and the 'CaseStatusOption' Attribute. This option allows you to save a selected code to 'case_status' attribute in data island, but the label and drop-down data are used from 'CaseStatusOption'.
Column2	Specifies the second column name for a case with using the "SideLabelPair2" element type (it is specified with the “Name” property).
Column2OptionNoValueLabel	Specifies the label for the “0” value of the drop-down field of the second column for a case when using the "SideLabelPair2" element type (it is specified with the “Name” property). It is specific to sequence values input (issue sequence and letter sequence drop downs - "InputIssueSeq" and "InputLetterSeq" column types).
Column2Size	Specifies the second input field size for a case when using the "SideLabelPair2" element type (it is specified with the “Name” property).
Column2Type	Specifies the second field type for a case when using the "SideLabelPair2" element type.
Column2XPath	Specifies the X-Path to the second attribute for a case when using the "SideLabelPair2" element type.
ColumnOptionNoValueLabel	Specifies the label for the “0” value of the drop-down field. It is a specific attribute for sequence values input (issue sequence and letter sequence drop downs - "InputIssueSeq" and "InputLetterSeq" column types).
ColumnSize	Specifies the size for the field input element or width of the column when the element is text.
ColumnType	Specifies the field type. Usually used with “Input,” “InputCheckbox,” “InputDropDown,” and “DisplayOnly.”
ColumnXPath	Specifies the X-Path [Used to specify the data source for the defined object (usually lists and drop downs).] to the attribute of the script data island. The Layout Editor can generate this value automatically when a user adds a category which is not in the current layout X-Path context.
DataType	Specifies the CSS class for the element. It can be “code,” “numeric,” or “date.a” According to the default.css file these classes specify the “text-align” property of HTML element.
DateFormat	Specifies the format of a date entered in the field. This value is not used with elements, because Emplifi Agent automatically provides the date format according to the date format settings. Dates use the following formats: "dd/mm/yyyy," "mm/dd/yyyy," and "regional."
DisableExpr	Specifies the condition when the element should be disabled.
Display Filter	Filters the data shown in HTML view. Select the Help button to view useful descriptions for each option. Click Selectnext to the option you want for the field.
DragItem	Specifies that the property could have only the "ColumnReSequence" value for the report’s column re-sequence functionality.
DropDownValues	Specifies the value list for the “drop-down” element type. The property uses the following format: value1-text1;value2-text2;value3-text3…
DynamicName	This attribute is only used for “List” type layouts generation and should always have the “{METADynamicName}” value.
FormatType	This is assigned based on category type and uses the following values: “s” – system date format “d” – date format according to system configuration “dt” – date-time format according to system configuration “t” – time format according to system configuration
Hide if	This property hides elements from view when you add an expression to this field. You can use the following list of operators in the expression. The description for the operator is also given. Operators include: && means AND \|\| means OR != means NOT EQUAL == means EQUAL When writing an expression, you must add "_$" before the field code. For example, c05_code is written _$c05_code. If you want to include items in the expression that belong to the same section, you can use their element name. The name is found in the Element field under the Advanced Properties. If you want to know the field name for a particular field, you can find it in the Attribute field under Advanced Properties. Below are some examples of expressions: To hide b05(Origin) if the Case Status is "Closed" and the Initial Rep is not "jimsmith", enter the following expression: Case._$case_status=="C"&&Case._$initial_rep != "jimsmith" To hide an Issue Status(issue_status) if Reason(c05_code) is empty (null), enter: Issue._$c05_code==null\|\| Issue._$c05_code=="" To hide a layout field if Reason, Product, or Origin equals 800, but Brand does not equal A: (Issue._$c01_code == null \|\| Issue._$c01_code == "") && (Issue._$c05_code == null \|\| Issue._$c05_code == "") && (Case._$b05_code == "800") && (Case._$b06_code != "A") To hide the Origin field in the Case section if the Reason field in the Issue section is empty (null), enter: Case.IssueList.Issue[0]._$c05_code==null Since a case might have multiple issues, you will need to choose an issue for the expression. In the example above, [0] indicates it is for issue 1. (Issue data on a case is stored as an array and starts with index 0.)
Hide if not	This property hides elements from view. Leaving this field blank shows all of the fields. This is the default. Select from these options: Is Mandatory - hides fields that are not labeled as mandatory. Is Important - hides fields that are not labeled as important. Either - hides fields that are not labeled as mandatory or important.
IfColumn	Specifies the name of an attribute. Only if the attribute exists and is not empty, then the element is displayed for the “SideLabelPairIfColumn” element.
IfValue	Specifies a value which is used with the “SideLabelPairIfNotValue” element. The element will be displayed when the attribute was specified with IfColumn property is absent or the value of this attribute is not equal the value which specified with IfValue property.
ImageSrc	Specifies the image URL for the “DisplayOnlyImage” element type of the “List” type layouts.
ImageSrc2	Specifies the second image URL for the “DisplayOnlyImage” element type of the “List” type layouts. Currently, this property can not be used because it is not supported with any standard insert definition.
Label	Specifies the label of the element. We recommend you not specify the label directly, because Emplifi Agent used the translation store to specify the label according to the user’s language.
Label2	Specifies the label of the second element for the "SideLabelPair2" element.
Label2Type	Specifies the type label for the second element for the "SideLabelPair2" element. Not currently used.
LabelSuffix	Specifies the label after element.
LabelType	Specifies the label type of element. You can use one of the following label types: “Blank” – the blank label (contains one   instead of label text) “ID” – the ID of label HTML element could be also specified with “ID” property “Sequence” – the sequence-specified label text (The label format is “label-text sequence-value”) “CodeDescriptions” – the “@APCW{METAColumn}_label” attribute is used as the label text
LabelXPath	Specifies the X-Path with attribute to display as the column heading for the element of the “List” type layout.
MaxLength	Specifies the maximal allowable length of the input element value.
NewpaperColumnSize	Select the width of the Newspaper Column. Choose from 1 to 12. The default is 6.
Onclick	Specifies the java script that will be started by onclick event on the button type element. The button type elements are following: "CancelButton," "CloseButton," and "SaveButton."
PermitLockedExpr	Specifies an XSL expression. If the expression returns true, then the Emplifi Agent script engine locks the field. The field is locked only for the report related layouts.
PhoneSeq	The property is only used with "DisplayPhone1" element type. It specifies the phone sequence.
RowSize	Specifies the “rows” attribute when the element is the HTML text area.
ShowBlank	If specified as “true()” to show blank element, if the column must not be displayed according to IfColumn/IfValue for "SideLabelPairIfColumn" or "SideLabelPairIfNotValue" element type.
SortID	Specifies the ID of the parent table of the element.
SortSpec	The attribute is used only for “List” type layouts generation. This specific attribute always has a value of “{METASortSpec}” or it is empty.
Style	Enter the Cascading Style Sheet (CSS) style for a specific field. CSS provides rules on how HTML content is formatted when displayed.
TDWidth	Specifies the “width” attribute for the parent “TD” tag of the element.
TimeFormat	Specifies the format of time entered in the field. This value is not used with elements, because Emplifi Agent automatically provides the time format settings. Time uses the following formats: "hh:mm," "hh:mm:ss," "h:mmAM," "hh:mmAM," "regional," and " regionalseconds ."
Title	Specifies the label before the element. It is used only with "DisplayOnlyWrap," "DisplayOnly" and "DisplayOnlyTextKS" element types of "List" type layouts.
TitleText	Specifies the section title text for the "SectionTitleText" and "SectionTitleTextXPath" elements.
XPath	Displays the XPath attribute with the attribute name for the "DisplayOnlyBase," "DisplayOnlyPreformatted" and "InputChoiceTranslation" element types of "List" type layouts. Also specifies the XPath to attribute for the "SideLabelPairXPath" element type.
XPathTitle	Displays the XPath to nodes for creating drop-down lists for the "InputIssueSeq" and "InputDropDownXPathTitle" column types.
XPathTitleInternalValue	Displays the attribute name for creating drop-down lists for the "InputIssueSeq" and "InputDropDownXPathTitle" column types while specifying the XPathTitle attribute.
colspan	Specifies the “colspan” attribute for “TD” HTML element (the number of columns to span).
rowspan	Specifies the "rowspan" attribute for "TD" HTML element (the number of spanned rows).
Address Lookup	Specifies if the Single Address Line Lookup feature is enabled on the selected field. Choose "True" to enable address lookup or "False" to disable address lookup.
Name	Displays the name of the standard insert definition which will be used as a base to generate XSLT code of element.
Type	Displays the property value "STDInsert," which means that the standard insert definition is used with the data of the attribute and the element which are specified according to the Master Field List.