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 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.
Properties can be set and their values can be obtained by executing the methods defined by the map object.
The general properties for map objects provide high-level information about the map object.
This is a unique instance number for the map object.
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.
If the value is set to TRUE, the objects related to the map instance will be destroyed after the map is executed.
This is the fully qualified name of the map for the map object.
The error code from the last operation on the map object.
The error message from the last operation on the map object.
The trace properties for map objects allow you to set the trace settings for map execution.
The workspace properties for map objects allow you to define the workspace settings for map execution.
Use the sliding century properties for map objects to define the sliding century settings for map execution.
Use the custom validation properties for map objects to define custom validation settings for map execution.
The audit properties for map objects allow you to set the audit settings for map execution.
The map retry properties for map objects allow you to define the map retry settings for map execution.
The map object methods are defined by the map object.
The card object is an abstraction of a card in a map.
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.