Descriptions of Link runtime services.
The LNK programming interface includes language-specific methods and objects that provide common functionality across multiple environments.
The Link programming interface is an object-oriented approach that enables applications to invoke HCL Link maps, thus removing reliance on command lines.
The Link programming interface is based on map, card, adapter, connection, and stream objects.
The card object is an abstraction of a card in a map.
Properties can be set and their values can be obtained by executing the methods defined by the card object.
The general properties for card objects provide high-level information about the card object.
The name of the card.
The REST Runtme provides a REST API used to run maps and flows that have been deployed.
Deploy a flow from the HCL Link to the local filesystem using Execution flow server definition.
To use the Map Command Server to execute a map, you will prepare the maps for execution.
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.
The Link programming interface objects have a relationship to each other defined by a specific hierarchy.
The Link programming interface methods provide a means to query or modify properties of objects.
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.
Indicates whether the card is an input or output card.
Determines under what circumstances to call the external document verification program when an instance of an object with an XML type property is found.
This is the location of the metadata (XML schema or DTD).
MPIP_CARD_MODE is the mode of the card (input card only).
The number of the card.
The number of objects found in validation (if an input card) or found in build (if an output card).
Determines whether the work area for the card is reused (input card only).
The error code from the last operation on the map object.
The error message from the last operation on the map object.
Use the backup properties for card objects to define the backup settings of the card for map execution.
The card object methods are defined by the card object.
An adapter object is created for each card when a map instance object is created.
Use the Link programming interface to load, run and control maps.
The C API enables applications to invoke maps and to develop adapters to use with HCL Link.
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.
The Java API interfaces enable you to create, edit, and run maps and schemas from a Java™ program.
The Java™ Tools provide objects and JNI utilities that you can use to get information about your map instances.