Home
Runtimes
Descriptions of Link runtime services.
SDK
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 audit properties
The audit properties for map objects allow you to set the audit settings for map execution.
MPIP_MAP_AUDIT_SUMMARY_EXECUTION
Turn execution summary audit on or off for the map object.

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.
- SDK
  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.
        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.
        MPIP_MAP_AUDIT_BURST_DATA
        Turn data audit on or off.
        MPIP_MAP_AUDIT_BURST_DATA_SIZE_VALIDATION
        Specifies whether to use two separate audit log status codes or a single code to indicate a size error or warning for data items that fail the minimum/maximum criteria when the Validation > SizeError map setting is set to Ignore.
        MPIP_MAP_AUDIT_BURST_EXECUTION
        Turn execution audit on or off.
        MPIP_MAP_AUDIT_DIRECTORY
        The directory for the audit file is either map or custom.
        MPIP_MAP_AUDIT_DIRECTORY_CUSTOM_VALUE
        This is the directory for the audit file if MPIP_MAP_AUDIT_DIRECTORY is set to MPI_DIRECTORY_CUSTOM.
        MPIP_MAP_AUDIT_FILENAME
        The filename for the audit file is either the default or a custom name.
        MPIP_MAP_AUDIT_FILENAME_ACTION
        The audit file can either be appended to or created anew.
        MPIP_MAP_AUDIT_FILENAME_CUSTOM_VALUE
        This is the filename for the audit file if MPIP_MAP_AUDIT_FILENAME is set to MPI_FILENAME_CUSTOM.
        MPIP_MAP_AUDIT_LOCATION
        Create the audit information in a file or in memory.
        MPIP_MAP_AUDIT_MEMORY_SIZED
        If MPIP_MAP_AUDIT_LOCATION is set to MPI_LOCATION_MEMORY, this determines whether the memory should be sized.
        MPIP_MAP_AUDIT_SETTINGS_DATA
        Turn data settings audit on or off.
        MPIP_MAP_AUDIT_SETTINGS_MAP
        Turn map settings audit on or off.
        MPIP_MAP_AUDIT_SUMMARY_EXECUTION
        Turn execution summary audit on or off for the map object.
        MPIP_MAP_AUDIT_SWITCH
        This is the master switch for map audit.
        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_AUDIT_SUMMARY_EXECUTION

Turn execution summary audit on or off for the map object.


Type	Values
Integer	MPI_SWITCH_ON MPI_SWITCH_OFF MPI_SWITCH_ONERROR MPI_SWITCH_OWARNING_ERROR