Task and Task Step Property Descriptions

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.

Note While recognition rules are properties, they are edited using the Recognition Rule Editor. See the Related Topic, Modifying Screen Recognition Rules, for more information.

Properties

Task Properties

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.

Task Input Properties

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:

  • Beans (ITask interface)— enter a Null property value.

  • Task files (XML files using the IConnectorAccess interface)— omit the XML tag from the input document. An empty XML tag, for example, <a></a>, is interpreted as an empty string.

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.

Task Output Properties

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

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 .

Property Description
Screen Name Displays the name of the host screen associated with this step. You can change the name to something more meaningful. If you do, the screen name for all other steps associated with the same screen will also be updated. You cannot use the same name for different screens within the same task.

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 ($).

Step Description Provides a description of the step. Adding information to this property is optional.
Task Endpoint Indicates whether or not this step has been marked as the task endpoint. Values are true and false. When the task endpoint is set to true, the step can have one or more actions associated with it. The task endpoint action properties are displayed within the same Step properties pane. When the task endpoint is set to false, the task endpoint action properties are unavailable.

At least one step in a task must be marked as a task endpoint, and regardless of the task flow, every flow of execution through a task must have a task endpoint. Global screen handlers are always task endpoints. When you mark a task endpoint, a red dot is added to the appropriate icon.

Recognition Rule The unique expression that identifies the screen associated with this step.
Cursor Row The row location of the cursor. On an unformatted screen, defaults to the cursor's last row position on the screen.

Values must be valid integers and cannot be less than one or greater than the height of the screen.

If there are no values set:

  • On a formatted screen - the cursor will be placed at the last position set by the host.

  • On an unformatted screen - the cursor will be placed at the end of the last text input.

Note Because cursor placement on unformatted screens is handled automatically, use caution when setting a cursor row position.

When navigating, the cursor displays at the location specified before the transition action is sent, unless the values are blank.

If there are no values set for both the cursor row or cursor column properties and you enter a value for either a row or a column, the corresponding value defaults to 1. Alternatively, if you clear either the cursor row or cursor column values, the corresponding value will also be cleared.

Cursor Column The column location of the cursor. Defaults to the cursor's last column position on the screen.

Values must be valid integers and cannot be less than one or greater than the width of the screen.

If there are no values set:

  • On a formatted screen - the cursor will be placed at the last position set by the host.

  • On an unformatted screen - the cursor will be placed at the end of the last text input.

Note Because cursor placement on unformatted screens is handled automatically, use caution when setting a cursor column position.

When navigating, the cursor displays at the location specified before the transition action is sent, unless the values are blank.

If there are no values set for both the cursor column or cursor row properties and you enter a value for either a row or a column, the corresponding value defaults to 1. Alternatively, if you clear either the cursor column or cursor row values, the corresponding value will also be cleared.

Log User Event Defaults to None. Prior to logging events, using the MCS for Screens management console, you must enable Log User Events and specify the type of event you want to be logged. After logging is enabled, you can select one of three types of log event; Error, Warning, or Info. Events of the type you specify here are logged to MCS using the User Event Message Expression property. An event will be logged, after the step outputs have been retrieved from the host screen, each time the task step is encountered.
Note If you are creating custom steps, you can log events to MCS by using the INavSystem interface. Errors (system.logErrorEvent(String)), warnings (system.logWarningEvent(String)), and info (system.logInfoEvent(String)) can be logged to MCS from within your custom step. By extending the BaseCustomNavStep, which must be done when implementing a custom step, you can access the system class member.
User Event Message Expression This is the message which is logged to MCS in the User Event. The expression accesses task data variables by appending the string "Task" to the variable name.

For example, you have a task that takes an account number (with a task input called AccountNumber) and returns account information. When a bad account number is entered, the host shows a screen that displays an error message in HostField2 and your task is recorded to handle the situation. You can log an Error event to MCS on the step that contains the host error screen using the following User Event Message Expression:

'Host Error Screen Encountered--Account Number Entered: ' + Task.AccountNumber + ' Host Error Message: ' + HostField2
Transition Action The keys that navigate from the current step to the destination step. If your task contains a single step, then the value is None.

Click the Transition Action Value field for a drop down list of all possible transition actions, including IBM AID keys and other special actions. Unisys and VT AID keys are not included in the drop down list.

Note Use caution when changing your transition action to a special action, such as <NONE>, <DISCONNECT>, and <WAIT FOR SCREEN (Transient)>. Possible complications can occur, which may involve unrecognized screen errors, task execution errors, and timeout issues.

If you enter an AID key manually, Task Builder contains a translator that formats all AID key designations. It is important that you enter the AID key in the correct format, for example {F8}. If you enter an 8 in the transition action value, the translator will correctly read {F8}. However, if you enter F8, the translator reads F{F8}, which is an invalid command. By correctly entering the AID key, you will avoid navigation errors.

VT-specific expressions for transition actions

The expressions are bracketed { }, and multiple expressions can be included using commas as separators.

  • Alpha characters are single quoted. For example, {'a', 'b', 'c', 'd'}

  • Numeric characters are sub-expressions, bracketed with the Keypad label. For example, {{Keypad 1}, {Keypad 2}, {Keypad 3}, {Keypad 4}}

  • Control + Key sequences are also sub-expressions, bracketed with the Control label. For example, {{Control R}, {Keypad 1}}

  • Function keys are supported. For example, {{F5}, 'a', 'b'}

Task Endpoint Action 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.

Note 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.
This setting
Does this
Fail Task and Send User Exception An error is logged to MCS, consisting of the following text, A task endpoint was reached in error. The task has failed. Return Code Number: { } Message: { }, and a User Exception is sent from the Runtime Service to the client application when the step is reached.

The task will fail, however, since the Runtime Service can reset the session, the session will not be lost.

Close Connection and Fail Task An error is logged to MCS, consisting of the following text: A task endpoint was reached in error. The task has failed. Return Code Number: { } Message: { }.

When the step is reached, the host connection will be severed, the task will fail, and the session will be lost.

Note In previous versions of Task Builder, warnings were sent to MCS using the Log Warning to MCS setting under the Task Endpoint Action property. You can now use the Log User Event property to log warning, errors, and information to MCS on any task step. Any warnings that you set up using the previous method will automatically be modified to use the new Log User Event property.

Custom Step Properties

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:
  1. Step Description
  2. Task Endpoint
  3. User Return Code Expression
  4. User Message Expression
  5. Task Endpoint Action

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 (system.logErrorEvent(String)), warnings (system.logWarningEvent(String)), and info (system.logInfoEvent(String)) can be logged to MCS. By extending the BaseCustomNavStep, which must be done when implementing a custom step, you can access the system class member.

Custom Step Output Properties

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.
Note Changing this value from true to false clears the Column Names property.
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 (_).

Step Destination Properties

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.
Caution The list of available step destinations contains all the possible, but not necessarily valid, step destinations. Use caution when selecting a step destination, choosing an invalid step destination may render a task invalid and cause it not to execute properly.

Step Input Properties

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.

Step Output Properties

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.

Step Output Properties - User-Defined

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, Task.  For example, Task.MyTaskInput.

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.
Related Topics
Bullet Creating Tasks, Overview
Bullet Modifying Screen Recognition Rules
Bullet Host and User Field Property Descriptions
Bullet Table Property, Constant, and Variable Descriptions
Bullet Reserved Words
Bullet AID Keys
  Attachmate