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.
Backup card properties
Use the backup properties for card objects to define the backup settings of the card for map execution.

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.
        Backup card properties
        Use the backup properties for card objects to define the backup settings of the card for map execution.
        MPIP_CARD_BACKUP
        This is the master switch for turning backup on or off.
        MPIP_CARD_BACKUP_ACTION
        Determines whether to append to an existing file or to create a new file.
        MPIP_CARD_BACKUP_DIRECTORY
        The directory in which the backup file is located.
        MPIP_CARD_BACKUP_DIRECTORY_CUSTOM_VALUE
        The filename for the trace file if MPIP_CARD_BACKUP_DIRECTORY is set to MPI_DIRECTORY_CUSTOM.
        MPIP_CARD_BACKUP_FILENAME
        The name of the backup file.
        MPIP_CARD_BACKUP_FILENAME_CUSTOM_VALUE
        The filename for the trace file if MPIP_CARD_BACKUP_FILENAME is set to MPI_FILENAME_CUSTOM.
        MPIP_CARD_BACKUP_FILEPATH
        The path of the backup file.
        MPIP_CARD_BACKUP_WHEN
        Determines under what circumstances to create a backup file.
        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.

Backup card properties

Use the backup properties for card objects to define the backup settings of the card for map execution.