cicsmap - generate BMS map files
The cicsmap command processes a source file that contains Basic Mapping Support (BMS) macros, and generates either a symbolic map or maps, or a physical map or maps, or both as specified by the map input. You use command-line options to control the generation of symbolic or physical maps.
Syntax
cicsmap [-a -r ] [ -s | -p] [-e] [-f code_page] {file | file.bms} [-x]
Description
The output physical map file, which is in the current working directory, is x.map where x is determined by the SUFFIX and TERM BMS macros. CICS® overwrites any previous physical map file for the same map source file with the newly generated map.
CICS places the symbolic map file in mapset.e for COBOL, mapset.h for C or C++. CICS produces the symbolic map file in the current working directory. CICS overwrites any previous symbolic map file for the same map set in the current working directory with the newly generated map.
CICS does not generate maps if errors are detected in the map source file. The contents of the map source file determine the operation of the cicsmap command. The LANG option that is associated with the map set macro (DFHMSD) determines the output of cicsmap.
cicsmap produces the symbolic and physical maps by default, or you can use the -p or -s flags to restrict cicsmap to producing a single map type.
cicsmap ignores TYPE=DSECT, TYPE=MAP, and TYPE=&SYSPARM options. If you include any other value for TYPE, cicsmap produces an error message. For more information, see Migrating maps from your CICS system to other family members.
Errors are written to stderr.
Help information is available when an invalid flag or -? is specified.
Options
- -a
- cicsmap generates an alternative map, which would be similar to CICS-TS (supported only for COBOL). However, you need not use this option when generating maps used with CICS TX on Cloud.
- -e
- Affects the interpretation of the hexadecimal data that is presented in the XINIT option. When specified, cicsmap converts the hexadecimal data in the XINIT option from the code set that is specified by -f to the current code set.
- -f code_set
- Code page from which cicsmap is to translate XINIT strings. If you do not specify this, CICS assumes the user's locale.
- file
- Name of the input map source file. You can include an optional path name with this name. The source file must either have the extension bms, or have no extension, in which case cicsmap appends the suffix bms.
- -m mapname
- Name of the map to be generated. The mapname should be a maximum of 7 characters; anything beyond 7 characters will be truncated. If you do not specify this option, the mapname from the input map source file is used.
- -p
- Generates only a physical map.
- -r
- Generates return codes.
- -s
- Generates only a symbolic (logical) map.
- -x
- Prevents PIC G type COBOL code or GRAPHIC type code from being generated.
If PS=8 is specified in a named DFHMDF BMS macro of a BMS COBOL the cicsmap command generates the PIC G type COBOL code . For example, if LENGTH=12 is specified in the field BMS macro, PIC G(6) is generated instead of PIC X(12) in a COBOL map. However, the PIC G type is possibly unsupported on your version of COBOL compiler, or you might want not to have PIC G or GRAPHIC types generated. If this is the case, use the -x flag to prevent the PIC G or GRAPHIC type code from being generated. (Refer to the documentation for your COBOL compiler to determine whether the PIC G type is supported.)
Restrictions
Standard operating system access permissions for files and directories apply.
Returned Values
cicsmap has the following exit values:
- 0
- cicsmap successfully processed the source map set.
- 1
- cicsmap (default) encountered at least one error, which it has written to stderr.
- 4
- cicsmap (-r set) encountered at least one error of moderate severity, which it has written to stderr.
- 8
- cicsmap (-r set) encountered at least one error of high severity, which it has written to stderr.
Examples
- To run the command from the current directory to obtain a symbolic
map:
cicsmap -s temp.bms - The -e option is required where you have converted maps
from EBCDIC; for example, from a CICS/MVS system,
and the maps contain the XINIT option. So that cicsmap produces
the correct physical map, you need to specify the -e flag.
cicsmap -p -e temp2.bms