SEND MAP - IBM Mainframe

This is the command to transfer the mapped data output to a terminal. The three supported forms of the command are separated by keywords into minimum, standard, and full-function BMS. The syntax of the SEND MAP command is given below:

Minimum BMS

Minimum BMS

Minimum BMS

Standard BMS

Standard BMS

Full BMS

Full BMS

An example of the SEND MAP command is given below:

SEND MAP command

The various options of the SEND MAP command are given below:

  • ACCUM - This option notifies CICS link* 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 (datavalue) - Halfword binary (PIC S9(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.
  • DATAONLY - Identifies that only application program data is to be written. The 3270 attribute characters must be specified for each field in the data being supplied. When the field attribute byte in the data being written is set to X'00', the field attribute byte will remain unchanged. Any default data or attributes from the map are ignored.
  • 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 pseudo-conversational transactions, which when used will ensure that the correct screen size is selected, as defined in the RDO (Resource Definition On-line) 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.
  • ERASEAUP - Option will erase all unprotected character locations for the partition or the entire screen is to be erased. This option is only valid for 3270 and 8775 devices.
  • FMHPARM (name) - Character field (1-8 bytes) containing the name of the outboard map to be used. This option is only valid for 3650 logical units with outboard formatting abilities.
  • FORMFEED - Indicates a new page is required. The FORMFEED control character for display devices and 3270 printers is 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.
  • 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 (data_area) - Identifies the storage location that contains the data to be processed. When ATTACHID is used, this option may be omitted. If this option is omitted, the map name defaults to the mapset name suffixed within O. This includes the 12-byte prefix generated by the TIOAPXF=YES option on the DFHMDI and DFHMSD BMS map definitions. When using this option the MAPONLY option becomes invalid if used.
  • FRSET - The modified data tags (MDTs) of all the fields in the current 3270 buffer or partition buffer are reset to the unmodified condition (field reset).' When no other ATTRIBUTE information is written in the symbolic map, this option gives the ATTRB operand of DFHMDF for the next requested map, control over the final status of fields written or rewritten in response to a BMS command,
  • 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=TERMINAL, and the same as the printer platen width; otherwise data formatting problems may occur.
  • 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 only applies 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 an 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 on the logical unit type as follows: -3601 logical unit. The first entry in the local or extended local LDC table is used if one exists. If one isn't found then the default is a null LDC numeric value (X'00'). The page size value used comes from the terminal control table TYPE=TERM1NAL or (1,40) if a value doesn't exist. -LUTYPE4 logical unit, batch logical unit, or batch data interchange logical unit. The LDC default is not from the local LDC table, instead, the message is sent to the logical unit console providing the logical unit allows the receipt of such messages. For a batch data interchange logical unit, this does not imply sending an LDC in an FMH.
  • LENGTH (datavalue) - Halfword binary (PIC 9(4) COMP) indicating the number of bytes of storage required. This option should be used when the data area sending the map is longer than the data to be mapped. This should include the length of the 12 byte prefix generated by the TIOAPXF=YES option on the DFHMDI and DFHMSD BMS map definitions.
  • 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 set-up 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 set-up 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 set-up in the RDO or TCT TYPE=TERMINAL definition.
  • MAP (name) - Character field (1-7 bytes) containing the name of the map to be used.
  • MAPONLY - Identifies that only the default data from the map is written. If this option is used, then the FROM option must not be specified.
  • MAPSET (name) - Character field (1-7 bytes) containing the unsuffixed name of the mapset to be used. The mapset must reside in the CICS program library, and be defined in the RDO. When this option is omitted, the name specified in the MAP option is used.
  • 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 when 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 Nk character uses one buffer position. The number of buffer positions unavailable is equivalent to the value of the RDO options PAGESIZE or ALTPACE, or PGES1ZE 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.
  • NOFLUSH - Option indicates that CICS will not clear pages on completion of the command, but instead, return control to the program' (having set the OVERFLOW condition in EIBRESP).
  • 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.
  4. 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.
  • 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 (e.g. 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.

There are several conditions that can occur, CICS checks these conditions and if more than one is set, it will only return the first error back to the application program.

  • IGREQCD - 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 MAP 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.
  • INVMPSZ - Condition is set when either the map is too wide or too long for the terminal or the HANDLE CONDITION OVERFLOW command is active and the map being used is to long for the target terminal. 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 BMS services when any of the following is invalid:
  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. When neither partitions nor LDCs are in use, then the text data is output to the same logical message as mapped data.
  2. A separate SEND MAP command with the ACCUM option is4 issued to the terminal that originated the transaction while a routed logical message is being built.
  3. The SEND MAP command was used on a map without field specifications by specifying the FROM option without the DATAONLY option. While overflow processing is occurring, data is sent to a different LDC from the LDC that caused page overflow.
  4. Partitions are currently being used and the OUTPARTN option has not been coded on the SEND MAP command, but the PARTN operand has been coded in the map set definition. This error is an indication that different versions of the mapset have different PARTN values, and the suffix deduced for the partition is not the same as the suffix of the loaded map set.
  5. Command is invalid for a distributed program link server program.

The default action is the abnormal termination of the task.

  • OVERFLOW - Condition is set when the mapped data does not fit on the current page. This condition is only set when the HANDLE CONDITION OVERFLOW command is active. The default action is the abnormal termination of the task.
  • RETPACE - When using the SET option and a completed page is ready to be returned to the application program, then this condition is triggered. Control is returned to the next statement following the BMS SEND command in 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 CICS. 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