Home
LNK APIs
The LNK programming interface includes language-specific methods and objects that provide common functionality across multiple environments.
Link programming interface overview
The Link programming interface is an object-oriented approach that enables applications to invoke HCL Link maps, thus removing reliance on command lines.
Link programming interface object overview
The Link programming interface is based on map, card, adapter, connection, and stream objects.
Link programming interface map object
The Link programming interface creates a map object instance from the byte array representing a compiled map file. The hierarchies of map, card and adapter objects are created by this method.
Map object properties
Properties can be set and their values can be obtained by executing the methods defined by the map object.
Map trace properties
The trace properties for map objects allow you to set the trace settings for map execution.
MPIP_MAP_TRACE_FORMAT
This property creates the map trace file in text format (the default) or binary format.

LNK APIs
The LNK programming interface includes language-specific methods and objects that provide common functionality across multiple environments.
- Link programming interface overview
  The Link programming interface is an object-oriented approach that enables applications to invoke HCL Link maps, thus removing reliance on command lines.
  - Link programming interface methods
    The Link programming interface map, card, and adapter object properties define the properties that can be set for each object. Use these methods to GET or SET the object properties.
  - Link programming interface object overview
    The Link programming interface is based on map, card, adapter, connection, and stream objects.
    - Link programming interface object hierarchy
      The Link programming interface objects have a relationship to each other defined by a specific hierarchy.
    - Link programming interface properties
      The Link programming interface methods provide a means to query or modify properties of objects.
    - Link programming interface map object
      The Link programming interface creates a map object instance from the byte array representing a compiled map file. The hierarchies of map, card and adapter objects are created by this method.
      - Map object properties
        Properties can be set and their values can be obtained by executing the methods defined by the map object.
        General map properties
        The general properties for map objects provide high-level information about the map object.
        Map trace properties
        The trace properties for map objects allow you to set the trace settings for map execution.
        MPIP_MAP_TRACE_DIRECTORY
        The directory for the trace file is either map or custom.
        MPIP_MAP_TRACE_DIRECTORY_CUSTOM_VALUE
        This is the directory for the trace file if MPIP_MAP_TRACE_DIRECTORY is set to MPI_DIRECTORY_CUSTOM.
        MPIP_MAP_TRACE_FILENAME
        The trace file name can be the default name (mapname.mtr), a custom name, or a unique, system-generated name (prefix_mapname_processIDtime_number_hostname.mtr), where prefix is Mer for executable maps or Run for run maps.
        MPIP_MAP_TRACE_FILENAME_CUSTOM_VALUE
        This is the filename for the trace file if MPIP_MAP_TRACE_FILENAME is set to MPI_FILENAME_CUSTOM.
        MPIP_MAP_TRACE_FORMAT
        This property creates the map trace file in text format (the default) or binary format.
        MPIP_MAP_TRACE_INPUT_CARD_END
        This is the number of the last card to trace if MPIP_MAP_TRACE_INPUT_CONTENT is MPI_TRACE_RANGE.
        MPIP_MAP_TRACE_INPUT_CARD_NUMBER
        This is the number of the card to trace if MPIP_MAP_TRACE_INPUT_CONTENT is MPI_TRACE_CARD.
        MPIP_MAP_TRACE_INPUT_CARD_START
        This is the number of the first card to trace if MPIP_MAP_TRACE_INPUT_CONTENT is MPI_TRACE_RANGE.
        MPIP_MAP_TRACE_INPUT_CONTENT
        This determines the scope of the input tracing.
        MPIP_MAP_TRACE_LOCATION
        Create the trace information in a file or memory.
        MPIP_MAP_TRACE_RULES_CARD_NUMBER
        This specifies the card number if MPIP_MAP_TRACE_RULES_CONTENT is set to MPI_TRACE_CARD.
        MPIP_MAP_TRACE_RULES_CONTENT
        This turns the trace rules content on or off.
        MPIP_MAP_TRACE_SUMMARY_CONTENT
        Controls whether the trace file contains a summary of the validation status of each input and the build status of each output.
        MPIP_MAP_TRACE_SWITCH
        This is the master switch for map trace.
        Map workspace properties
        The workspace properties for map objects allow you to define the workspace settings for map execution.
        Map sliding century properties
        Use the sliding century properties for map objects to define the sliding century settings for map execution.
        Map custom validation properties
        Use the custom validation properties for map objects to define custom validation settings for map execution.
        Map audit properties
        The audit properties for map objects allow you to set the audit settings for map execution.
        Map retry properties
        The map retry properties for map objects allow you to define the map retry settings for map execution.
      - Map object methods
        The map object methods are defined by the map object.
    - Card object overview
      The card object is an abstraction of a card in a map.
    - Adapter object overview
      An adapter object is created for each card when a map instance object is created.
  - Link programming interface function overview
    Use the Link programming interface to load, run and control maps.
- C API
  The C API enables applications to invoke maps and to develop adapters to use with HCL Link.
- Python API
  Use the Python API to create, edit, and run maps and schemas from a Python program. For details, see the documentation installed in install_dir/python/api/hip/docs/html/index.html. Examples of the Python API are installed in install_dir/python/api/examples. Documentation for the Python API examples is available in install_dir/python/api/docs/html/examples.html.
- Java API
  The Java API interfaces enable you to create, edit, and run maps and schemas from a Java™ program.
- Java Tools
  The Java™ Tools provide objects and JNI utilities that you can use to get information about your map instances.

MPIP_MAP_TRACE_FORMAT

This property creates the map trace file in text format (the default) or binary format.


Type	Values
Integer	MPIP_MAP_TRACE_FORMAT_TEXT MPIP_MAP_TRACE_FORMAT_BINARY