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.
C API
The C API enables applications to invoke maps and to develop adapters to use with HCL Link.
Custom adapters
The custom adapters interface makes it possible for users to develop adapters with as much functionality as those provided with the product.
Additional adapter methods
There are a number of additional methods that are part of the HCL Link Programming Interface library that are of particular relevance to adapter developers.
Wildcard methods
These methods are used to perform wildcard matching and determine the value for which a wildcard stands.
mpiExtractWildcard
The mpiExtractWildcard method compares a string (passed in pActual) with a wildcard pattern (pPattern) to see whether it matches. If it does, the string that substitutes for the wildcard value is returned in the buffer provided by the caller in pBuf.

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.
  - C API
    The C API enables applications to invoke maps and to develop adapters to use with HCL Link.
    - C API interface methods overview
      The map, card, and adapter object properties define the properties that can be set for each object. Use the C API interface methods to GET or SET the adapter object properties.
    - Object methods
    - Loading, running, and controlling maps
      There are various methods you can use to load, run, and control maps when you use APIs with HCL Link.
    - Custom adapters
      The custom adapters interface makes it possible for users to develop adapters with as much functionality as those provided with the product.
      - Developing custom adapters
        The custom adapters interface makes it possible for users to develop adapters with as much functionality as those provided with the product.
      - Adapter registration and the library virtual table
        The first step required to develop an adapter is to add the adapter to the adapters.xml registration file.
      - Initializing the adapter
        InitializeLibrary provides an entry point by which any global structures, critical sections, or lists that are required by the adapter can be initialized.
      - Point to adapter methods
        After your adapter is loaded, you call the virtual table (vtable) structure to obtain pointers to the methods.
      - Adapter registration file
        The adapters.xml registration file contains a single tag for each adapter, including a number of attributes to provide information about the adapter.
      - Vtable adapter library
      - Methods provided by adapter
      - Additional adapter methods
        There are a number of additional methods that are part of the HCL Link Programming Interface library that are of particular relevance to adapter developers.
        Wildcard methods
        These methods are used to perform wildcard matching and determine the value for which a wildcard stands.
        mpicomparewildcard
        The mpiCompareWildcard method compares a string (passed in pActual) with a wildcard pattern (pPattern) to determine whether it matches.
        mpiExtractWildcard
        The mpiExtractWildcard method compares a string (passed in pActual) with a wildcard pattern (pPattern) to see whether it matches. If it does, the string that substitutes for the wildcard value is returned in the buffer provided by the caller in pBuf.
        Status methods
        The mpiMapReportStatus method allows an adapter to display a short message in the map status window, and to determine whether the map has been cancelled by a user action.
      - Passing data to and from maps
        Data is passed between adapters and the engine through stream objects. From the adapter perspective, there is no need to create these stream objects; they are already created when either the Get or Put method is called.
      - Threads, connections, and transactions overview
        It is important to understand how threads, connections, and transactions interact.
  - 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.

mpiExtractWildcard method overview

The mpiExtractWildcard method compares a string (passed in pActual) with a wildcard pattern (pPattern) to see whether it matches. If it does, the string that substitutes for the wildcard value is returned in the buffer provided by the caller in pBuf.

For example, if pPattern is A*123 and pActual is ABCD123, the value returned in pBuf will be BCD.

MPIRC mpiExtractWildcard (const char  
*pPattern,int  nPatternLen,const char  
*pActual,int  nActualLen,char  *pBuf,int  
*pLen)

Inputs

pPattern: Wildcard pattern
nPatternLen: Length of the pPattern string
pActual: Actual data which might match the wildcard
nActualLen: Length of the actual data

Outputs

pBuf: A buffer to receive the wildcard value if one exists
pLen: Size of the buffer on input and the length of the wildcard value on output

Returns

MPI_CMP_EQUAL: Wildcard matches
MPI_CMP_LESS: Wildcard does not match