Home
Runtimes
Descriptions of Link runtime services.
Map Command Server
To use the Map Command Server to execute a map, you will prepare the maps for execution.
Execution commands
This documentation includes information about the various ways to use execution commands and their options when executing maps. Execution commands are used to specify how to execute a map.
List of execution commands
This documentation contains information about the execution commands and associated options, including the syntax of each command and its particular usage.
MapTrace (-T)
The MapTrace execution command (-T) creates a trace file that you can use to diagnose invalid data or incorrect type definitions.
Examples using MapTrace (-T)
The following are the examples of the MapTrace (-T) command.

Runtimes
Descriptions of Link runtime services.
- REST API
  The REST Runtme provides a REST API used to run maps and flows that have been deployed.
- Flow Command Server
  Deploy a flow from the HCL Link to the local filesystem using Execution flow server definition.
- Map Command Server
  To use the Map Command Server to execute a map, you will prepare the maps for execution.
  - Overview
    Map Command Server is used to develop, test, and execute maps in development environments. It can also be used to execute commands in production environments.
  - Executing a map
    After a map has been built for a specific execution platform and transferred, the map can be executed using a Map Command Server.
  - Troubleshooting tools
  - External interfaces for applications, EXIT and RUN
    Maps can interface with other maps, functions in libraries, or programs using the EXIT function, the RUN function or an adapter as a data source or target.
  - Windows platforms
    There are several activities you can do with the Map Command Server that you have installed on your Windows environment.
  - Execution commands
    This documentation includes information about the various ways to use execution commands and their options when executing maps. Execution commands are used to specify how to execute a map.
    - Command Server overview
      Use execution commands to override the map settings or card settings in a compiled map when a map is run using one of the following methods:
    - Using Command Server commands
      When you run a map, you can:
    - List of execution commands
      This documentation contains information about the execution commands and associated options, including the syntax of each command and its particular usage.
      - Command availability
        Some commands are limited because they can only be used with a Command Server and cannot be used from within a RUN() function or using the Platform API. Also, there are some commands that are not available on all platforms. The Map Designer, and the Command Server have a user interface for these commands where they apply.
      - MapAudit (-A)
        Use the MapAudit execution command (-A) to control the creation of audit log information.
      - Close Window (-B)
        When executing a map using a Command Server for Windows™ or AS/400® OS/400®, use the Close Window execution command (-B) to exit the Command Server application after the map has completed.
      - Century (-D)
        Use the Century execution command (-D) to specify the start of a 100-year range used to supply a missing century portion for a Date & Time.
      - Fail on Warnings (-F)
        Use the Fail on Warnings (-F) execution command to specify that the map should fail when any of the selected warning codes are returned.
      - Ignore Validation Options (-G)
        Use the Ignore Validation Options execution command (-G) to specify the item properties, if any that should be ignored during validation.
      - Input Source Override - Application (-IA)
        Use the Input Source Override - Application execution command (-IA) to override specifications in the compiled map file for a specific input card for a single execution of a map.
      - Input Source Override - Database (-ID)
        Use the Input Source Override - Database execution command (-ID) to override specifications in the compiled map file for a specific input card for a single execution of a map.
      - Input Source Override - Echo (-IE)
        Use the Input Source Override - Echo execution command (-IE) to override specifications in the compiled map file for a specific input card for a single execution of a map.
      - Input Source Override - File (-IF)
        Use the Input Source Override - File execution command (-IF) to override specifications in the compiled map file for a specific input card for a single execution of a map.
      - Input Source Override - Message (-IM)
        Use the Input Source Override - Message execution command (-IM) to override specifications in the compiled map file for a specific input card for a single execution of a map.
      - Input Source Override - Pointer (-IP)
        The Input Source Override - Pointer execution command (-IP) is for platform API users only, and allows data to be passed in via a pointer rather than a buffer.
      - List (-L)
        When using a Command Server on a platform other than Windows™, use the List execution command (-L) to display a list of the data sources and targets that are compiled into a map file.
      - Output Target Override - Application (-OA)
        Use the Output Target Override - Application execution command (-OA) to override specifications in the compiled map file for a specific output card for a single execution of a map.
      - Output Target Override - Database (-OD)
        Use the Output Target Override - Database execution command (-OD) to override specifications in the compiled map file for a specific output card for a single execution of a map.
      - Output Target Override - Echo (-OE)
        Use the Output Target Override - Echo execution command (-OE) to override specifications in the compiled map file for a specific output card for a single execution of a map.
      - Output Target Override - File (-OF)
        Use the Output Target Override - File execution command (-OF) to override data destination specifications for a specific output card in a compiled map file for a single execution of a map.
      - Output Target Override - Message (-OM)
        Use the Output Target Override - Message execution command (-OM) to override data destination specifications for a specific output card in a compiled map file for a single execution of a map.
      - Output Target Override - Pointer (-OP)
        The Output Target Override - Pointer execution command (-OP) is for platform API users only, and allows data to be returned via a pointer rather than a buffer.
      - WorkSpace PageSize (-P)
        When a file-based WorkSpace is used, the amount of memory accessed at a given time depends on the number of pages and the size of pages you configure for a map to run. Use the WorkSpace PageSize execution command (-P) to specify the size of and number of pages to be used.
      - Refresh Status (-R)
        The Refresh Status execution command (-R) is used to specify the frequency of map status update when displayed in the Command Server window when using the Windows™ operating system or in the console when using all other operating systems.
      - MapTrace (-T)
        The MapTrace execution command (-T) creates a trace file that you can use to diagnose invalid data or incorrect type definitions.
        Examples using MapTrace (-T)
        The following are the examples of the MapTrace (-T) command.
      - Stop Validation (-V)
        The Stop Validation execution command (-V) specifies to stop validation at the card where the first error is detected.
      - Time Zone (-TZ)
        The following 39 time zones are identified here, for use with the -TZ command.
      - WorkSpace (-W)
        When you run a map, the Command Server uses its own paging scheme to access information about the data as efficiently as possible. Portions of both workspace data and actual data are paged as needed. The workspace can be either a combination of files and memory or memory-based. When file-based workspace is used, the amount of memory accessed at a given time depends on the number of pages and the count of pages configured for map execution.
      - Retry (-Y)
        The Retry execution command (-Y) is used to specify the retry rate for non-data files accessed during map execution.
      - Ignore Warnings (-Z)
        The execution Ignore Warnings execution command (-Z) specifies for a map that selected warning codes should be ignored and a 0 return code should be issued.
    - Examples
      This documentation presents a variety of examples involving the execution of maps using various execution commands in a RUN() function and from the command line in UNIX™ and Windows™ environments.
    - Config.yaml commands for debugging maps
      This documentation presents the config.yaml file settings that you can use for the debugging of adapter connections for maps run using non event-driven execution methods.
  - Utility commands
    You can use the utility commands to do various functions.
- SDK
  The LNK programming interface includes language-specific methods and objects that provide common functionality across multiple environments.

Examples of the MapTrace (-T) command

The following are the examples of the MapTrace (-T) command.

The commands in the following table show combinations of the -T command options:


-T [I [Cinput_card_num | [from[:to]]] [O [Coutput_card_num]] [S] [B] [U] [=filepath]

The table is not an exhaustive list of all possible option combinations.

The command options are not positional, with these exceptions:

If specified, the filepath option must be the last option on the command.
The Cinput_card_num and from:to variables must follow the I option. The Coutput_card_num must follow the O option.

For example, in the -TIC3OC4B command, 3 is the number of the input card and 4 is the number of the output card. However, -TBOC4IC3 is an identical command.

Table 1. Example MapTrace commands
MapTrace command	Trace target	Trace file format	Trace file name	Trace file location
-T	Do not trace	text	`mapname`.mtr	map directory
-TI	Trace all inputs	text	`mapname`.mtr	map directory
-TI2:10	Trace input objects 2 through 10	text	`mapname`.mtr	map directory
-TIC7	Trace input card 7	text	`mapname`.mtr	map directory
-TIB	Trace all input objects	binary	`mapname`.mtr	map directory
-TIBU	Trace all inputs	binary	unique	map directory
-TIBU=C:\TXTRACES	Trace all inputs	binary	unique	C:\TXTRACES directory
-TI2:10BU=C:\TXTRACES	Trace input objects 2 through 10	binary	unique	C:\TXTRACES directory
-TO	Trace all output cards	text	`mapname`.mtr	map directory
-TOC3BU=C:\TXTRACES\Card3Trc.mtr	Trace output card 3	binary	Card3Trace.mtr	C:\TXTRACES directory
-TIC3OC4	Trace input object 3 and output card 4	text	`mapname`.mtr	map directory
-TI2:22OC1	Trace input objects two through 22 and output card 1	text	`mapname`.mtr	map directory
-TS	Trace all input and output cards and provide a message for each card	text	`mapname`.mtr	map directory