You can edit many of the properties for tasks and task steps. This topic contains a list of the available properties for each of these elements, and a short description of each.
To display a task or task step's properties, select it from the Task Inputs/Outputs or the Task Steps pane. All elements, except folders, have properties associated with them. To edit a property, in the Properties pane, type or select a new value.
![]() |
While recognition rules are properties, they are edited using the Recognition Rule Editor. See the Related Topic, Modifying Screen Recognition Rules, for more information. |
Property | Description |
---|---|
Name | The name assigned to the task when it was created.
You can change the name to something more meaningful by typing a new name under Value; however, be sure to not use any of the reserved words.
Names cannot contain spaces; they must begin with alpha (a-z, A-Z) characters, and may contain alpha characters (a-z, A-Z), numbers (0-9), the underscore (_), and the dollar sign ($). |
Login Task | Indicates whether or not this task is a login task. Values are true or false. After a login task is published to MCS, it is made available as a login task for session pools in MCS. |
Parent Tasks | Displays the parent tasks for the current task. If there are no parent tasks, the value is None. Click under Value to display the Edit Task Parents dialog box, in which you can add or remove parents for the current task. |
Property | Description |
---|---|
Input Name | By default, the input name consists of a prefix, (in or out), and the field name appended to the step number; for example, In_Step2_HostField24 . You can change the name to something more meaningful; however, be sure to not use any of the reserved words.
Names cannot contain spaces; they must begin with alpha (a-z, A-Z) characters, and may contain alpha characters (a-z, A-Z), numbers (0-9), the underscore (_), and the dollar sign ($). |
Default Value | By default, displays the value that was supplied for the field during recording. You can edit this value to supply a new default value for the task input. |
Data Type | The type of data expected for this field. Value is a String. This value cannot be edited. |
Input Required | Indicates whether or not input is required to be supplied by the user of the task. Values are true and false.
If set to true, an input value must be supplied by the user of the task, otherwise it will not be executed by the run-time. If set to false, an input is not required, but if one is supplied, it will be used. If one is not supplied, the runtime behavior is defined by the Input Not Supplied property. To not send a value for a particular task input in the run-time environment, do one of the following:
|
Input Not Supplied | Indicates what value to add to a field when one is not required nor supplied. By default, the Default Value is used. If set to Use existing host value, then the field will be left unchanged and whatever value currently exists in the host field will be used. |
Property | Description |
---|---|
Output Name | By default, the output name consists of a prefix, (in or out), and the field name appended to the step number; for example, Out_Step2_HostField24 . The output name and the Step Output variable name must be the same in order to be available to the generated task interface objects. You can change the name to something more meaningful; however, be sure to not use any of the reserved words.
Names cannot contain spaces; they must begin with alpha (a-z, A-Z) characters, and may contain alpha characters (a-z, A-Z), numbers (0-9), the underscore (_), and the dollar sign ($). |
Data Type | The type of data expected for this field. Value is a String. This value cannot be edited. |
Step properties include all the properties associated with global steps and step destinations. A subset of these step properties are also included in the Custom Step Properties .
Every flow of execution through a task must have a marked task endpoint.
Task endpoint action properties provide you with the ability to anticipate abnormal task flows and then handle them appropriately when they occur.
When task endpoint actions are specified, a special event, called a User Exception, is logged to MCS. The User Exception, which contains both the User Return Code Number and the User Message, is logged to MCS as an error. Task endpoint action error codes and messages are expressions and can render complex data from the task.
![]() |
In previous versions of Task Builder for Screens, task endpoint actions were not expressions but integer or text strings. Any task endpoint action properties that were set in previous versions will be converted automatically to expressions. Since quotation marks are not valid in expressions, they are converted to spaces. |
You can turn off logging by disabling the option in MCS.
User Return Code Number | Positive or negative integer expression, not more than 7 digits long, that uniquely identifies this action. The variables in the expression must refer to screen data only. Screen data consists of the data contained in host or user fields. The User Return Code Number, together with the User Message, is sent as the User Exception text. Defaults to 0. If the User Return Code expression fails during runtime, it returns a 0. | ||||||||
User Message | String expression that is sent with the event when it is executed (when the step is reached). The variables in the expression must refer to screen data only. Screen data consists of the data contained in host or user fields. The User Message is sent, along with the User Return Code Number, as the User Exception text. If the User Message expression fails during runtime, an empty string is returned. | ||||||||
Task Endpoint Action | Defaults to None. There are two task endpoint actions available to you.
|
Property | Description |
---|---|
Step Adapter Class | The fully qualified name of the user-created class that is instantiated and run when the custom step is executed. You can edit this value by selecting another class from the drop-down list of available adapter class implementations.
Available adapter classes are those classes that you have saved in the <Install Location>\Attachmate\EAI\recordings\<project name>\scripts\java\classes directory. |
Additional custom step properties | Other step properties available from the Custom Step Properties page:
These are step properties that are available when following the standard workflow. To log events to MCS from within a custom step use the INavSystem interface. Errors ( |
Property | Description | ||
---|---|---|---|
Name | The name of the step output variable. To make this step output value available as a task output, the name must exactly match a task output name, and the adapter class implementation must supply a value to the task variable map using this name as the key. | ||
Table Data | Default value is false, indicating that the output will contain a single value of type String. If set to true, then the step output will contain tabular data like that found in the output for a Table Step and the Column Names property is enabled.
|
||
Column Names (comma delimited) |
This property is disabled when the Table Data property is set to false (the default value). When the Table Data property is set to true, the property is enabled and can be used to specify the column names for the tabular data output. Column names are used to generate the proper methods and schema for generated task interface objects.
The column names must be comma delimited and any leading or trailing spaces are trimmed from each column name. Column names cannot contain spaces; and can only contain alpha characters (a-z, A-Z), numbers (0-9), or the underscore (_). |
Property | Description | ||
---|---|---|---|
Step Name | The name of the destination step. You can edit this value by selecting a different step destination from the drop-down list of available destination steps.
|
Property | Description |
---|---|
Input Host Field Name | The name of the field receiving the value. |
Expression | The data sent to the host field. The variables in the expression must refer to task data, therefore they do not have access to the functions provided in Task Builder. Task data consists of task inputs or outputs, and step inputs or outputs. |
Property | Description |
---|---|
Output Host Field Name | The name of the field where the value comes from. |
Variable Name | Name of the variable the value is assigned to. Step outputs must be mapped to task outputs to be available from the generated task interface objects. |
Using user-defined step outputs, you can define a variable that is not tied to one particular host field. For example, you may want to combine values from two or more fields, or simply define a string not available on the screen.
Property | Description |
---|---|
Expression | Defaults to the string "null". This string should be changed to a meaningful string or expression. By default the variables in the expression can refer to both host fields and user fields (screen data). To refer to task data, (task inputs or outputs, and step inputs or outputs), prepend the variable name with the string, |
Variable Name | Name of the variable the value is assigned to. Step outputs must be mapped to task outputs to be available from the generated task interface objects. |
![]() |
|
![]() |
Creating Tasks, Overview |
![]() |
Modifying Screen Recognition Rules |
![]() |
Host and User Field Property Descriptions |
![]() |
Table Property, Constant, and Variable Descriptions |
![]() |
Reserved Words |
![]() |
AID Keys |
![]() |