ROUTE - IBM Mainframe

The command will route a BMS logical message to one or more terminals and the function is only supported under full function BMS. The syntax of the ROUTE command is given below: Take a screenshot The various options of the ROUTE command are explained:

  • AFTER - This option is used in defining the elapse time prior to execution. There exists two methods of entering the time for this option.
    1. Enter a combination of at least two of the following: HOURS (0-99), MINUTES (0-59), and SECONDS (0-59)
    2. Enter only one of the following: HOURS (0-99), MINUTES (0-5999), or SECONDS (0-359 999)
  • AT - Enter the exact time that the ROUTE command is to be executed. The following contains the valid values: HOURS (0-24), MINUTES (0-59), and SECONDS (0-59)
  • ERRTERM (name) - Defines the terminal to be notified in the event the message cannot be delivered and is deleted. The message number, title identification, and destination are used. When this option is omitted or no value is supplied, the originating terminal is assumed. This option is only valid when the PRGDLAY has been specified in the CICS SIT. (System Initialization Table)
  • HOURS (hh) - Fullword binary (PIC S9(8) COMP) value (0-99 range). This is a sub-option to the AFTER and AT options.
  • INTERVAL (hhmmss) - Specify the time interval to wait before transmitting of data to be specified terminal(s) identified in the command. The default is INTERVAL(O). This command option is unsupported in the C/370 programming language.
  • LDC (name) - Command option is valid for logical units only. Contains a mnemonic (2-byte character field), which is used in determining the logical device code (LDC) used in transmitting in the FMH to a logical unit. The mnemonic represents the RDO option LDCLIST or an LDC entry specified in the terminal control table TYPE=LDC. When the LDC is used, the format of the message is determined by the BMS using the device type, the page size, and the page status associated with the LDC mnemonic. The mnemonics are retrieved from the extended local LDC table for the LU if one exists. When the LU has only a local (unextended) LDC table, the values are taken from the system LDC table. The LDC numeric value is retrieved from the local LDC table unless its an extended table and the value is not specified, then the value is retrieved from the system table. If this option is omitted, the LDC mnemonic defined in DFHMSD is used. If the option is also omitted from DFHMSD, then the action depends on what of logical unit is being used:
    1. 3601 LU - If one exists then the first entry in the'local or extended local LDC table is used. If a default value is not found then a null LDC numeric value (X'001) is used. The page size used is what is defined in the TCT TYPE=TERM1NAL or (1,40) tf\he value is missing.
    2. LUTYPE4 LU, batch LU, or batch data interchange LU - The message is sent to a LU console (the local LDC table is not used in finding the default LDC). A LU console could be any medium on which the LU elects to receive such messages. For a batch data interchange LU, this does not imply sending an £D£ in an FMH. The page size is obtained in the manner described for the 3601 LU. For message routing, this option on the command will take precedence over the LDC option of the ROUTE command. When the option is omitted and a route list is used (LIST option), the LDC mnemonic in the route list is used. When the route list has no LDC mnemonic, or no route list is used, a default LDC is chosen as described above.
  • LIST (data_area) - A data area containing the list of terminals and operators of which the message will be routed. If the option is omitted then all BMS supported terminals will receive the message. (Unless the OPCLASS option is in effect)
  • MINUTES (mins) - Fullword binary (PIC S9(8) COMP) value (0-5999 range). This is a suboption to the AFTER and AT options.
  • NLEOM - This option is valid only for a 3270 printer or a 3275 display with the printer adapter feature. The data stream should be constructed with blanks and new-line (NL) characters, and that an end-of-message (EM) character should be placed at the end of the data. While printing the NL character causes printing to continue on the next line, and the EM character terminates printing. When using this option, CICS includes the ERASE option on every write to the terminal, which prevents any buffer updating, or attribute modification of fields previously written into the*buffer. The NL character occupies a buffer position. A number of buffer positions, equivalent to the value of the RDO options PAGES1ZE or ALTPAGE or the PGESIZE or ALTPGE in the terminal control table for that terminal, are unavailable for data. This may cause data to wrap around in the buffer; if this occurs, the PGESIZE value must be reduced.
  • OPCLASS (data_area) - This option points to a data area containing the list of operator classes where the messages will be routed. The format is a 3-byte field with a range of 1 to 24 where each bit corresponds to one of the codes. The layout is in reverse order as follows for each of the codes:
    1. byte-1 24 through 17
    2. byte-2 16 through 09
    3. byte-3 08 through 01
  • SECONDS (sees) - Fullword binary (PIC S9(8) COMP) value (0-359,999 range). This is a sub-option to the AFTER and AT options.
  • REQID (name) - Character field (2 bytes) containing the prefix that is used as part of a temporary storage identifier used in CICS message recovery. Only one prefix is allowed for each logical message. The default is '**'. BMS message recovery works for logical messages when the PAGING option is used in the BMS SEND commands and a syncpoint has been reached.
  • TIME (hhmmss) - Specify the time of day to issue the transmit of data to the specified terminal(s) identified in the command. This command option is unsupported in the C/370 programming language.
  • TITLE (dataarea) - The option points to the data area containing the title for the routing of local messages. This title appears as part of the response to a page query command.
  • Handle Conditions:

  • INVERRTERM - Condition is set when the terminal identifier specified in the ERRTERM option is invalid or is assigned to an unsupported terminal by BMS. The default action is the abnormal termination of the task.
  • INVLDC - Condition is set when the specified LDC mnemonic is not included in the LDC list for the logical unit. The default action is the abnormal termination of the task.
  • INVREQ - Condition can occur for any of the following reason where a request for BMS services is not valid:
    1. Blanks are not found for bytes 10-15 of a route list entry
    2. Out of range value for the Hours option
    3. Out of range value for the Minutes option
    4. Out of range value for the Seconds option
    5. BMS commands are invalid for distributed program link
  • The default action is the abnormal termination of the task.
  • RTEFAIL - Condition can occur for any of the following reasons:
    1. The command will only send the message to the terminal issuing the command.
    2. The command is used against a remote shippable terminal that has not yet been installed in the application-owning region.
  • The control is returned to the next statement in the user application program issuing the command when this condition occurs. RTESOME - Condition is set when any of the terminals did not receive the message from the ROUTE command. The control is returned to the next statement in the user application program issuing the command when the condition occurs.

All rights reserved © 2018 Wisdom IT Services India Pvt. Ltd DMCA.com Protection Status

IBM Mainframe Topics