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.
Adapter object overview
An adapter object is created for each card when a map instance object is created.
Adapter object properties
Properties are defined for all adapter objects, though each adapter can also GET and SET its own adapter-specific properties (for example, QueueManagerName for MQSeries®).
Adapter aggregation properties
Use the aggregation properties for adapter objects to define the settings that determine the number of messages that are returned from an input adapter for map execution.

Runtimes
Descriptions of Link runtime services.
- REST API
  The REST Runtime 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.
      - Adapter object overview
        An adapter object is created for each card when a map instance object is created.
        Adapter object properties
        Properties are defined for all adapter objects, though each adapter can also GET and SET its own adapter-specific properties (for example, QueueManagerName for MQSeries®).
        General adapter properties
        These properties provide high-level information about the adapter object.
        Adapter retry properties
        Use the adapter retry properties for adapter objects to define the settings for the retry settings for map execution.
        Adapter on failure properties
        Use the MPIP_ADAPTER_ON_FAILURE property for adapter objects to define the settings for the OnFailure transactional settings for map execution.
        Adapter on success properties
        Use the MPIP_ADAPTER_ON_SUCCESS property for adapter objects to define the settings for the OnSuccess transactional settings for map execution.
        Adapter scope properties
        Use the MPIP_ADAPTER_SCOPE property for adapter objects to define the settings for the scope of the transaction for map execution.
        Adapter warning properties
        Use the MPIP_ADAPTER_WARNINGS property for adapter objects to define the settings for action on adapter warnings for map execution.
        Adapter aggregation properties
        Use the aggregation properties for adapter objects to define the settings that determine the number of messages that are returned from an input adapter for map execution.
        MPIP_ADAPTER_FETCH_UNIT
        The fetch unit for a single burst.
        MPIP_ADAPTER_LISTEN_TIME
        The listen timeout (in seconds).
        MPIP_ADAPTER_QUANTITY
        The quantity of messages to return for the map.
        Adapter object methods
        The adapter object methods are defined by the adapter object.
    - 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.

Adapter aggregation properties

Use the aggregation properties for adapter objects to define the settings that determine the number of messages that are returned from an input adapter for map execution.

These properties apply to source adapter objects only.