Running map coverage from the command line

Edit online

You can run map coverage using the dtxcoverage command-line utility for Windows and Linux. The utility uses dtxcoverage.bat for Windows and dtxcoverage.sh for Linux and other supported non-Windows platforms.

The command-line utility processes the coverage settings file, executes each coverage run, generates the interim report, and then produces the final report. You can use this utility when you run coverage as part of an automated pipeline or on platforms where Design Studio is not available.

Note: Windows and Linux environments support all reporting levels because they can access .mms and .mdg files. The AIX, zLinux, and z/OS USS platforms support only Outline reports. To generate Details or Verbose reports from these restricted platforms, you must port the interim report file (.mcr~.json) to a Windows or Linux system and run the dtxcoverage utility with the -REPORTONLY option. The map coverage feature is not supported on the DataPower, z/OS BATCH, or CICS platforms.

To run the utility, use the following syntax:

dtxcoverage -MAP <map_name> [-SOURCEMAP <source_map>] [-REPORTONLY] [-REPORTLEVEL {OUTLINE | DETAILS | VERBOSE}] [-LOGLEVEL {OFF | INFO | WARNING | SEVERE | VERBOSE}] [-ONRUNERROR {CONTINUE | STOP}] [-CONSOLELOG] [-HELP]

The -MAP parameter is required. Other parameters act as overrides to the existing .mcs.json file, or take effect if no .mcs.json file exists.

Command-line options

-MAP map_name ( -M ): Specifies the compiled map file name for which the system will run coverage. This value is required.
-SOURCEMAP source_map ( -S ): Specifies the path to a map source file. You can specify this option multiple times to include multiple source map locations. The system uses this option to resolve map rules when you generate Details or Verbose reports. This value is optional.
-REPORTONLY ( -R ): Generates the final report from an existing interim report file without re-executing the map. This value is optional.
-REPORTLEVEL ( -RL ): Sets the report detail level to OUTLINE, DETAILS, or VERBOSE. This setting overrides the ReportLevel value in the coverage settings file. The default setting is OUTLINE. In Design Studio, the default setting is DETAILS. This value is optional.
-LOGLEVEL ( -LL ): Sets the diagnostic logging level to OFF, INFO, WARNING, SEVERE, or VERBOSE. This setting overrides the LogLevel value in the coverage settings file. The default setting is OFF. This value is optional.
-ONRUNERROR ( -ORE ): Sets the run error handling behavior to CONTINUE or STOP. This setting overrides the OnRunError value in the coverage settings file. The default setting is STOP. This value is optional.
-CONSOLELOG ( -CL ): Writes the log output to the console. This value is optional.
-HELP ( -H ): Displays usage information and exits. This value is optional.

Examples

Run coverage for a map using default settings:

dtxcoverage -MAP C:\maps\invoice_process.mmc

Run coverage with a verbose report and a specified source map:

dtxcoverage -MAP invoice_process.mmc -SOURCEMAP C:\src\invoice_process.mms -REPORTLEVEL VERBOSE

Generate a final report only from an existing interim report (after porting from a restricted platform):

dtxcoverage -MAP invoice_process.mmc -REPORTONLY -REPORTLEVEL DETAILS