General Information

Control-O AutoEdit variables embedded in the DO KSL statement are automatically resolved (replaced) at time of rule activation. For more information on the AutoEdit facility, see Chapter 4, "AutoEdit Facility."

Wait Completion Mode

Execution of the DO statements following a DO KSL statement can be delayed until the KeyStroke OpenAccess (KOA) script has finished executing, thereby enabling checking of the completion code. This delay is achieved by specifying Y (Yes) for the WAITMODE subparameter, which places the rule in Wait (Completion) mode. The TIMEOUT subparameter can be used to specify how long (in seconds) to wait for completion of the script.

When rule execution is resumed, AutoEdit System variable %%KSLRC will contain either the completion code of the script, or the value 522, which means that the TIMEOUT limit was reached before completion of the script.

Wait mode can also be specified for a KSL script execution by specifying a DO SET=%%WAITKSL = Y statement before the DO KSL statement. Using this method, a TIMEOUT period can be specified through a DO SET %%TIMEOUT = value statement. This method is supported for historical reasons.

Using a Preset Environment

DO KSL statements are executed by Control-O servers. Servers are started tasks that are managed automatically by Control-O. You can define Immediate, Special, and General servers. These server types are discussed in detail in Chapter 5, "Control-O Servers." However, when defining a DO KSL statement, bear in mind the following information:

• Immediate servers

  Immediate servers are useful for either

  • KOA scripts that need to be executed immediately, for example, those that need to bypass the wait queue of the server
  • KOA scripts that should not be executed by a Special or General server, for example, long running scripts that delay the running of other scripts waiting to be executed

  To request an Immediate server, type Y (Yes) in the IMMEDIATE subparameter.

• Special servers

  Special servers are useful when the same environment is used frequently for KOA scripts. This generally occurs when different KOA scripts (in the same or different rules) use the same VTAM application. Use of the same VTAM session by all these scripts improves performance considerably.

  To request a Special server, do the following:

  1. Type N (No) in the IMMEDIATE subparameter, or leave it blank.
  2. Enter the name of the KOA script that handles the preset environment in the INITPROC subparameter.
  3. Ensure that a Special server with the name specified in the INITPROC subparameter has been defined to Control-O.

• General servers

  General servers are useful when scripts infrequently use a specific environment and/or do not use a preset environment.

  To request a General server, do the following:

  1. Type N (No) in the IMMEDIATE subparameter, or leave it blank.
  2. Ensure that the necessary environment is established by either the script specified in the DO KSL statement or by the script specified in the INITPROC subparameter.
  3. Ensure that there is no Special server defined to Control-O with the same name as the script specified in the INITPROC subparameter (if one was specified).

  Whenever INITPROC is specified, Control-O ensures that the indicated script is automatically invoked to maintain the preset environment, for example, to perform logon, reset and logoff actions.

  Ensure that the script specified in the DO KSL statement does not perform any of the functions performed by the KOA script specified in INITPROC.

  Examples of how to use DO KSL and INITPROC scripts are provided in the Keystroke Language (KSL) User Guide.

  For information on how to define servers, see the INCONTROL for z/OS Installation Guide.