SEND TEXT - IBM Mainframe

Command will send text data without any mapping. This command supports only standard and full-function BMS and the keywords are separated into those two functions. The text being sent is separated into lines that match the width of the terminal such that the words are not broken across line boundaries. If the text exceeds a page, it is split into pages that fit in the terminal with application-defined headers and trailers. The syntax of the SEND TEXT command is given below:

Standard BMS

Standard BMS

Standard BMS

Full BMS

Full BMS

The different options of the SEND TEXT command are explained below:

  • ACCUM - This option notifies CICS that this command is part of several commands used in building a logical message. The. message is completed by issuing the SEND PAGE command, or deleted by issuing the PURGE MESSAGE command.
  • ACTPARTN (name) - Character field (1-2 bytes) containing the name of the partition to be activated. Partition activation moves the cursor into the specified partition, and unlocks the keyboard for the specified partition. If the terminal does not support the partition feature then the option is ignored.
  • ALARM - Option when used will activate the 3270 audible alarm feature. This option instructs BMS to set the alarm flag in the FMH for logical units that support FMH's (except interactive and batch logical units).
  • CURSOR (data_value) - Halfword binary (PIC 9(4)COMP) containing the cursor position location relative to zero for a 3270 or 3604 device type. The value range depends on the size of the screen. The data value for the cursor location must be a positive value, a negative value will lead to unpredictable results. When omitted or no data value is supplied- then symbolic cursor positioning is assumed. When this option is used it overrides any IC option of the ATTRB operand of DFHMDF. ACCUM is used with this option, the most recent value of CURSOR specified is used to position the cursor.
  • ERASE - This option will position the cursor in the upper left corner of the screen after erasing the screen printer buffer or partition. This option is only valid for 3270 or 8775 devices and the 3604 Keyboard Display. This is normally specified on the first output operation in any transaction, or in a series of pseudoconversational transactions, which when used will ensure that the correct screen size is selected, as defined in the RDO (Resource Definition Online) file. When switching from one screen size to another on a transaction basis, if the ERASE option is not executed on the first output command of the transaction then the screen size remains unchanged from the previous transaction setting, or the default screen size if the CLEAR key was pressed.
  • FORMFEED - Indicates a new page is required. The FORMFEED control character for display devices and 3270 printers are placed at the beginning of the buffer. After placing the control character in the buffer, care must be taken by the application program not to over write the control character by a map or text data. If the terminal definition does not specify this option then it is ignored. This option can be used on any SEND TEXT ACCUM command. It only needs to be specified once within a physical page as it always forces a FORMFEED at the start of a physical page. To force a FORMFEED at the start of a particular SEND TEXT ACCUM command, use the JUSFIRST option instead.
  • FREEKB - Option will unlock the 3270 keyboard. If omitted, the keyboard remains locked. The keyboard lock status is maintained independently for each partition on a terminal that supports partitions.
  • FROM (dataarea) - Identifies the storage location that contains the data to be sent.
  • HEADER (data_area) - Identifies the text data that is to be placed at the beginning of each page of data. The header format is:
    1. 2 bytes Binary length of the data (n)
    2. 2 bytes Binary zero n bytesData.
  • HONEOM - This option when used indicates the default printer line length is to be used. The default length should be equal to the value specified in RDO options PAGES1ZE or ALTPAGE, or PGESIZE or ALTPGE of the entry TYPE-T€RMINAL, and the same as the printer platen width; otherwise data formatting problems may occur.
  • JUSFIRST - Option indicates that the text data is placed at the top of the page. Any partially formatted pages from prior requests are considered to be complete. If the HEADER option is also used, then the header precedes all the text data.
  • JUSLAST - Identifies that the text data is to be positioned at the bottom of the page. After the request has been processed, the page is considered to be complete. When the TRAILER option is also used, then the trailer data follows all the text data.
  • JUSTIFY (datavalue) - Halfword binary (PIC 9(4) COMP) values containing the page line where the text data is to be positioned. The value range is 1 through 240. The special values -1 and -2 may not be used as constants, but the values can be supplied dynamically to signify JUSFIRST or JUSLAST, respectively.
  • LAST- Indicates that for the transaction, this is the last output operation for a transaction and as a result the end of a bracket. This applies only to logical units.
  • LDC (name) - Character field (2 bytes) identifying the mnemonic used in determining the suitable logical device code (LDC) numeric value which is transmitted in the FMH to the logical unit. The mnemonic represents a LDC entry in the terminal control table TYPE=LDC. When using this option, BMS will use the device type, page size, and page status associated with the LDC mnemonic when formatting the message. The value used for the LU are used from the local extended LDC table when present, otherwise the values are used from the system LDC table when only a local (unextended) LDC is present. When the LDC option is omitted, the mnemonic specified in the DFHMSD macro is used. When the LDC option is omitted and its also missing from the DFHMSD macro, then the action depends oh the logical unit type as follows:
  • LENGTH (data_value) - Halfword binary (PIC 9(4) COMP) indicating the number of bytes of storage required.
  • L40 - Defines a 3270 printer line length. The characters for a carrier return and line feed are added after 40 characters have been printed. Results may be unacceptable if this option differs from the page width definition setup in the RDO or TCT TYPE=TERMINAL definition.
  • L64 - Defines a 3270 printer line length. The characters for a carrier return and line feed are added after 40 characters have been printed. Results may be unacceptable if this option differs from the page width definition setup in the RDO or TCT TYPE=TERMINAL definition.
  • L80 - Defines a 3270 printer line length. The characters for a carrier return and line feed are added after 40 characters have been printed. Results may be unacceptable if this option differs from the page width definition setup in the RDO or TCT TYPE=TERMINAL definition.
  • MSR (datavalue) - Character field (4 bytes) containing the value that controls the 10/63 magnetic stripe reader attached to an 8775 or 3643 terminal. DFHMSRCA provides a set of constants in assisting the setting of this 4-byte area. The option is ignored when either the RDO option MSRCNTRL was omitted, or the TCT does not specify FEATURE=MSRCNTRL.
  • NLEOM - Identifies the data stream for a 3270 printer or a 3275 display with the printer adapter feature will be built with blanks and new-line (NL) characters, and the end-of-message (EM) character should be added onto the end of the data stream. The NL character will cause the printing to continue on the next line as the data is printing and the EM character terminates printing. When building a logical message this option must be used on the first SEND MAP command. This option is ignored, written the receiving device is not one of those mentioned above. When using this option, buffer updating and attribute modification of previously written fields in the buffer are not allowed. For every write to a terminal CICS includes the ERASE option. The NL character uses one buffer position. The number of buffer positions unavailable is equivalent to the value of the RDO options PAGESIZE or ALTPAGE, or PGESIZE or ALTPGE in the TCT TYPE=TERMINAL for that terminal. Thus adding the NL or EM character may cause data to wrap around in the buffer; should this occur, the PGESIZE value must be reduced. This option also overrides the ALARM option if the ALARM option is used.
  • OUTPARTN (name) - Character field (1-2 bytes) containing the partition name where the data will be sent. The option is ignored for either of the following reasons:
    1. The terminal does not support partitions
    2. No application partition set associated with the terminal
  • When the OUTPARTN option is omitted, and there is an application partition set, then the data is sent to the partition named by the PARTN option of the DFHMSD (map definition macros). The output is sent to the first partition in the set when either maps are not used or if there is no PARTN operand
  • PACING - Indicates that instead of sending the output immediately to the terminal, the data is placed in temporary storage and displayed in response to a paging command entered by the terminal operator. When PAGING is used with the REQID option (defined as recoverable in the Temporary Storage Table), CICS then provides local messages with message recovery when the task reaches a syncpoint.
  • PRINT - Indicates that the print operation is started for any of the following:
    1. 3270 printer
    2. 3275 with the printer adapter feature
    3. LUTYPE2 (3274/76 or 3790) data will be printed on an allocated controller printer.
  • When omitted, the data is sent to the printer buffer but is not printed.
  • REQID (name) - Character field (2 bytes) containing the prefix (default is '**') to be used as part of the temporary storage identifier for CICS message recovery. For each local message, only one prefix can be used. BMS message recovery is only valid for a local message when the PAGING option is used on a BMS SEND command and a syncpoint has been reached.
  • SET (ptr-ref) - Set the pointer reference value to the address of the output data. The option indicates the application program will receive the completed pages and the pointer reference address is set to the list of completed pages. The application program regains control either immediately following the SEND MAP command (if the current page is not yet completed), or at the label specified in a HANDLE CONDITION RETPAGE command, if the page has been completed. When TIOAPFX=YES is used in the map definition, the pointer will return the address of the storage accounting area (SAA). The user data starts at offset X'OC from the start of the SAA.
  • TERMINAL - Option when used indicates that the output will be sent to the terminal, which originated the transaction.
  • TRAILER (data_area) - Identifies the text data that is to be placed at the bottom of each page of data. The trailer format is:
    1. 2 bytes Binary length of the data fuj^*'
    2. 2 bytes Binary zero
    3. n bytesData.
  • WAIT - The currently executed command must be completely finished before any further subsequent processing can be started. Without this option being specified, control is returned to the application program once the copy function of this command is started. Therefore any subsequent terminal processing (eg. I/O request, terminal control, BMS, batch data interchange) connected with the task will cause the application program to wait until the previous request has been completed. Handle Conditions:
  • ICREQCD - A LUTYPE4 logical unit receives a SIGNAL data_flow control command with a request change direction (RCD) code and then the application program attempts to execute a SEND TEXT command. The default action is the abnormal termination of the task.
  • ICREQID - Condition is set when the prefix used in the REQID option is different from one previously established with the REQID option or by default ('**') for this logical message. The default action is the abnormal termination of the task.
  • INVLDC - Condition is set when the LDC mnemonic being used is missing in the LDC list for the logical unit. The default action is the abnormal termination of the task.
  • INVPARTN - Condition is set when the specified partition is not defined in the partition set associated with the application program. The default action is the abnormal termination of the task.
  • INVREQ - Condition is set for any of the following reasons:
    1. While a BMS logical message is active, the application program tries to send text data as output to the same partition or LDC as mapped data. If neither partitions nor LDCs are in use text data is output to the same logical message as mapped data.
    2. While overflow processing is occurring, data is sent to a different LD from the LDC that caused page overflow.
    3. The header length is negative.
    4. The trailer length is negative.
    5. Command is invalid for a distributed program link server program.

    The default action is the abnormal termination of the task.

  • LENGERR - Condition is set when LENGTH or FLENGTH values are invalid. The valid range of value is 0 through 327,767. The default action is the abnormal termination of the task.
  • RETPAGE - When using the SET option and a completed page is ready to be returned to the application program, then this condition is triggered. The control is returned to the next statement following the BMS SEND command to the application program when this condition occurs.
  • TSIOERR - Condition is set when there is an irrecoverable temporary storage input/output error. The default action is the abnormal termination of the task.
  • WRBRK - Condition is set when the command is interrupted by the terminal operator pressing the ATTN key. This option is only valid on a 2741Communication Terminal with the write break supported for C1CS. The default action is the abnormal termination of the task.

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

IBM Mainframe Topics