Attributes
- name
- Required. The name of the macro. Macro names are case-sensitive!
- description
- Optional. Descriptive text about this macro. You should include here any information that you want to remember about this macro.
- timeout
- Optional integer. The number of milliseconds allowed for screen recognition. If this timeout value is specified and it is exceeded, then the macro runtime terminates the macro and displays a message (see Timeout Between Screens (Macro tab)). By default the Macro Editor sets this value to 60000 milliseconds (60 seconds).
- pausetime
- Optional integer. The delay for the "pause between actions" (see Pause Between Actions (Macro tab)). By default the Macro Editor sets this value to 300 milliseconds.
- promptall
- Required boolean. If this attribute is set to true then the macro runtime, before performing any action in the first macro screen, collects user input for all the <prompt> elements inside the entire macro, combining the individual prompts into one large prompt. The promptall attribute of the <actions> element performs a similar function for all the <prompt> elements in one <actions> element (see <actions> element).
- author
- Optional. The author or authors of this macro.
- creationdate
- Optional. Information about the dates and versions of this macro.
- suppressclearevents
- Optional boolean (default false). Advanced feature that determines whether the system should ignore screen events when a host application sends a clear screen command immediately followed by an end of record indicator in the data stream. You might want to set this value to true if you have screens in your application flow that have all blanks in them. If there is a valid blank screen in the macro and clear commands are not ignored, it is possible that a screen event with all blanks will be generated by clear commands coming from an ill-behaved host application. This will cause a screen recognition event to be processed and the valid blank screen will match when it shouldn't have matched.
- usevars
- Required boolean (default false). If this attribute is set to true then the macro uses the advanced macro format (see Choosing a macro format).
- ignorepauseforenhancedtn
- Optional. 3270 Display sessions only. If this attribute is set to true then the macro runtime skips all <pause> elements if the session is a TN3270E session running in contention-resolution mode (see Attributes that deal with screen completion). To re-enable a particular <pause> element see the ignorepauseoverride attribute of the <pause> element.
- delayifnotenhancedtn
- Optional. 3270 Display Sessions only. This attribute specifies a value in milliseconds and has an effect only when the session is not a TN3270E session running in contention-resolution mode. In that situation, this attribute causes the macro runtime to add a pause of the specified duration each time the macro runtime receives a notification that the OIA indicator has changed (see Attributes that deal with screen completion).
- blockTerminalInput
- Optional. When the value of this attribute is true, keyboard inputs and mouse clicks are ignored while the macro is playing. The events are discarded. There is no indication to the user that input is blocked unless you create a Message action to indicate this.
- ignorepausetimeforenhancedtn
- The ability to ignore the macro pausetime attribute when running
in a contention-resolution environment is now available. A new attribute, “ignorepausetimeforenhancedtn”,
has been added to the <HAScript> macro element. This attribute
allows you to ignore both the pausetime attribute in <HAScript>
and the pause attribute in <screen>. Possible values for this attribute
include:
True: Both the pausetime attribute in <HAScript> and the pause attribute in <screen> are ignored. No pause occurs after input/prompt actions or between screens. This is the default value.
False: The pausetime attribute in <HAScript> and the pause attribute in <screen> are not ignored.
Note that ignorepausetimeforenhancedtn has no effect when running in a non-contention-resolution environment. That is, even if ignorepausetimeforenhancedtn is true, the pausetime attribute in <HAScript> and the pause attribute in <screen> will not be ignored if running in a non-contention-resolution environment.
See the "Macro Programming Guide" for information on ignorepauseforenhancedtn and delayifnotenhancedtn, two other attributes that affect the way that macros are executed in a contention-resolution environment. To view or modify the value for ignorepausetimeforenhancedtn, use the Code Editor of the Macro Editor.