Type Tab

The Type tab includes the following options that allow you to customize field properties.

Field Type

The field type is used to indicate the type of data the field will use to collect and display. There are currently 12 field types are supported by Genesys Agent Scripting. Use the drop-down list box to select one of the following fields:

String

A string field should be used to display alphanumeric data.

Multi-Line Text

A multi-line text field will be displayed with scroll bars and will allow you to input many lines of text. See the Size tab for formatting information.

Numeric

A numeric field is used to store numbers. When the script is run, Genesys Agent Scripting will automatically validate that the you only input numeric information into the field. See the Size tab for formatting information.

Date and Time

A date and time field is used to store date and time values. Genesys Agent Scripting will display the date or time in the selected formatting. See the Size tab for formatting information.

Function

A function field is a display only field. The field’s value will be generated when a script is run based on the settings in the function tab.

Note: Function fields are being deprecated in Genesys Agent Scripting. In version 7.0.2 you may still define and use a Function field. In subsequent versions, you must use the Date and Time field in place of the Function field.

Calendar

A calendar field puts a calendar in the script.

You can select a single date on the calendar by scrolling through the months and years and clicking a date.

A calendar field value includes a date and time. If you set another field equal to the calendar field without clicking on the calendar to activate the calendar control, the date and time will be passed to the new field unchanged. However, if you click on any date, even the date to which the calendar field is currently set, the time will be set to 00:00:00. The intent of the calendar control is to pass the date information and automatically set any time information to 00:00:00. Failure to activate the calendar control could lead to misleading results if you subsequently use the time information.

Check Box

A check box field displays as a check box and can be used to capture and display true or false values.

A check box that is checked is the equivalent of a Boolean value of True, Yes, or 1. An unchecked check box is the equivalent of a Boolean value of False, No, or 0. If you set a string variable equal to a check box, the string will be set to 0 if the box is not checked, and to 1 if the box is checked. Conversely, if you set a check box equal to a string field, the check box will be set to selected if the string field is an integer 1, and unselected if the string field is not an integer.

Radio Buttons

Radio button fields are displayed as a group of options from which you may choose. For static values, the radio button shows the value names, but any logical comparisons are done based on the database value that is stored in the system. So, if you set a string field equal to the radio button, the string value will be whatever the database value is for the selected radio button. In the case of process flows, streams, and pages, the database value is the same as the name. If you set a radio button equal to another field that is not set to one of the database values of the radio button, none of the radio button values will be selected.

Radio buttons always have the first item in the list selected. To clear all items, or to pre-select a different item, use an action statement (for example Set FieldRadioButton = "").

See the Values tab for information regarding how to set the options you will be allowed to choose from.

Drop-Down List

Drop-down list fields are displayed as a drop-down list box that allows you to choose from a pre-selected list.

Drop-down lists always have the first item in the list selected. To clear all items, or to pre-select a different item, use an action statement (for example Set FieldDropdown = "").

See the Values tab for information regarding how to set the options you will be allowed to choose from.

Table

A table field is a collection of other fields. A table field will be displayed on the window as a table with columns made up of other fields. A table field can contain other table fields to support an unlimited level of parent child relationships. See the Table tab for information regarding how to associate fields with a table.

Custom Field Type

A custom field type field is a user defined field. Custom Field Types allow you to customize field types that are specific to their needs.

Listener

A listener field is a field type whose value can be updated asynchronously. Listener fields are display only.

Required

Required indicates that the script user must provide a value for this field. Genesys Agent Scripting will prevent you from leaving the script page if they have not provided a value.

Display Only

A Display Only field is a field that cannot be modified by the user. It will appear in a script as text.

Parameter

A Parameter Field is a field that will be passed to Genesys Agent Scripting at the start of the script via the URL. The values for parameter fields will generally be provided by applications, such as a CTI (Computer Telephony Integration) application.

Parameter and Configuration File Field options are mutually exclusive.

Do Not Transfer

Select this option for any field whose value should not be transferred on a Save Session or Load Session action. This option is useful for data elements that should not be carried forward when a session is transferred.

Password

Select this option to have the field’s value masked as a password field.

Configuration File Field

When this box is checked, the field is read in from the configuration file when the Genesys Agent Scripting application is started.

Parameter and Configuration File Field options are mutually exclusive. See configuration files for more information.

Reporting

The Reporting dropdown list is enabled for all field types except Table. Three options are available:

Show this Field If

Fields can be shown or hidden based on the value of a specific field.

You may select a field from the Field drop-down list and Genesys Agent Scripting will automatically determine the valid operators and range of values based on the type of field selected. For example, if you select a check box type field then only the equal and not equal operators will be selectable, and only true and false for values will be selectable. Similarly, if you selects a radio button type field then only the equal and not equal operators will be available, however, the values drop-down list will list all possible values for the radio button. You can then select either a field or static value in the Value Type drop-down list to compare it against.