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.

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.
    - 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.

Link programming interface object overview

The Link programming interface is based on map, card, adapter, connection, and stream objects.

Objects are used for source and target overrides for map execution.

If no card overrides are required, only the map object is referenced. All other objects are created internally.
If card overrides are required, the card and adapter objects are referenced.

Overrides are accomplished using the defined property interface.

Adapter objects interface with the adapter API. The Link programming interface is based on HCL Link objects.


Object	Datatype	Object description
Map	HMPIMAP	An object that represents an instance of a map in the program memory. Methods allow the map properties to be modified and for the map to be executed and its execution controlled.
Card	HMPICARD	An object that represents an input or output card of a map in program memory. Defined methods allow the card properties to be modified.
Adapter	HMPIADAPT	An object that represents a resource adapter. Defined methods allow the adapter properties to be modified.
Connection	HMPICONNECT	An object that represents a connection to a resource. When a map executes, a Connection object is associated with one or more Adapter objects.
Stream	HMPISTREAM	An object that provides a means to pass data to, or get data from, a map. Stream objects eliminate the need for large, contiguous, memory buffers for passing data directly to a map object.