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.
Card object overview
The card object is an abstraction of a card in a map.
Card object properties
Properties can be set and their values can be obtained by executing the methods defined by the card object.
General card properties
The general properties for card objects provide high-level information about the card object.
MPIP_CARD_METADATA_LOCATION
This is the location of the metadata (XML schema or DTD).

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.
      - Card object overview
        The card object is an abstraction of a card in a map.
        Card object properties
        Properties can be set and their values can be obtained by executing the methods defined by the card object.
        General card properties
        The general properties for card objects provide high-level information about the card object.
        MPIP_CARD_DIRECTION
        Indicates whether the card is an input or output card.
        MPIP_CARD_DOCUMENT_VERIFICATION
        Determines under what circumstances to call the external document verification program when an instance of an object with an XML type property is found.
        MPIP_CARD_METADATA_LOCATION
        This is the location of the metadata (XML schema or DTD).
        MPIP_CARD_MODE
        MPIP_CARD_MODE is the mode of the card (input card only).
        MPIP_CARD_NAME
        The name of the card.
        MPIP_CARD_NUMBER
        The number of the card.
        MPIP_CARD_OBJECT_COUNT
        The number of objects found in validation (if an input card) or found in build (if an output card).
        MPIP_CARD_REUSE_WORK_AREA
        Determines whether the work area for the card is reused (input card only).
        MPIP_OBJECT_ERROR_CODE
        The error code from the last operation on the map object.
        MPIP_OBJECT_ERROR_MSG
        The error message from the last operation on the map object.
        Backup card properties
        Use the backup properties for card objects to define the backup settings of the card for map execution.
        Card object methods
        The card object methods are defined by the card object.
      - 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_CARD_METADATA_LOCATION

This is the location of the metadata (XML schema or DTD).

Use this card object property to override the metadata location specified on the map card settings at run time.


Type	Values
Text	`user-defined`