Home
Resource Adapters
About the HCL Link Resource Adapters, and how to use them.
REST Adapter
REST adapter is a solution where Link can readily call any Web/REST API and provide easy mapping to and from the APIs.
REST Adapter properties and commands
This documentation provides a detailed description of the adapter properties for defining connections, actions, and cards.
Configuration mode
Configuration package

Resource Adapters
About the HCL Link Resource Adapters, and how to use them.
- Resource Adapters overview
  Resource adapters are used to retrieve and route data. They provide access to databases, files, messaging systems, enterprise applications and other data sources and targets.
- Apache HDFS Adapter
  The Apache HDFS Adapter allows the HCL Link to access the HDFS file system in Apache Hadoop environments.
- Apache ActiveMQ Adapter
  With the ActiveMQ Adapter, users can access any of the queues of the Active MQ Adapter to send and receive messages. Users can also create a new queue altogether for sending and receiving messages.
- Azure Service Bus Adapter
  The Azure Service Bus adapter supports accessing queue and topics on the Microsoft Azure Service Bus, a fully managed message broker service on the Microsoft Azure cloud.
- Azure SQL Adapter
  Microsoft Azure SQL Database is a general-purpose relational database, provided as a managed service. With it, you can create a highly available and high-performance data storage layer for the applications and solutions in Azure.
- Azure Blob Storage Adapter
  The Azure Blob Storage adapter provides support to perform read and write operations on the blobs in the block storage managed by the Azure Blob Storage cloud service
- Apache Kafka Adapter
  With the Apache Kafka adapter, maps can connect to a Kafka cluster to consume and produce messages.
- Amazon S3 Adapter
  This documentation discusses the Amazon S3 Adapter.
- Amazon SNS Adapter
  With the Amazon SNS adapter, a user can access the Amazon Simple Notification Services. This adapter connects to the Simple Notification Services (SNS) topics, using AWS keys. The adapter can fetch and send notifications from and to those AWS SNS topics, to which the user has subscribed.
- Batch File and Shell Script Adapters
  The Batch File adapter processes a (Windows™) batch file as the data source of an input map card or the data target of an output map card. The Shell Script adapter processes a (UNIX™) shell script as the data source of an input map card or the data target of an output map card.
- Cipher Adapter
  The Cipher adapter encrypts and decrypts data by using the Advanced Encryption Standard (AES) established by the U.S. National Institute of Standards and Technology (NIST). A single cryptographic key enciphers (encrypts) and deciphers data. The cryptographic key is stored in a master key file (MKF) in an AES-based encrypted format. As long as the MKF is not compromised or lost, the enciphered data is cryptographically secure.
- Email Adapters
  An email adapter automatically receives email messages as sources of a map or sends email messages as targets of a map.
- FTP Adapter
  Use the File Transfer Protocol (FTP) Adapter to transport data. When source data arrives at its target, it often must be transformed into a different format for a receiving application to use it successfully.
- Excel Adapter
  The Excel Adapter reads data from and maps data to a sheet in a Microsoft Excel workbook.
- Google Cloud Storage Adapter
  The Google Cloud Storage Adapter provides access to Google Cloud Storage buckets and objects in the Google Cloud Platform.
- Google Pub / Sub Adapter
  The Google Cloud Pub/Sub adapter provides access to Google Cloud Pub/Sub topics and subscriptions in the Google Cloud Platform.
- GZIP/ZLIB Adapter
  Use the GZIP/ZLIB Adapter to retrieve data in file or memory formats and export data for GZIP, ZLIB and Plain file formats.
- HTTP Adapter
  The Hypertext Transfer Protocol (HTTP) Adapter provides support for Proxy servers and Secure Socket Layer (SSL) protocol, which is required to process HTTPS (secure) URLs.
- IBM MQ Adapter
  The IBM® MQ adapter works with IBM MQ to accomplish the task of maintaining data compatibility, handling all kinds of data transformations from the simplest to the most complex.
- Java Class Adapter
  Use the Java Class Adapter to instantiate a Java™ object and to invoke a sequence of methods on the object.
- HL7 MLLP Adapter
  The HL7 MLLP adapter uses the MLLP protocol over TCP/IP to pass data to and from HCL Link. The adapter has a listener interface that can detect the arrival of data on a socket and trigger a map to run. With the HL7 MLLP adapter, remote applications can pass data to HCL Link without using additional middleware software.
- JAXB Adapter
  The JAXB adapter converts Java™ objects to XML and converts XML to Java objects. With the JAXB adapter, you can build Java objects that can be represented with XML, parse the objects, and use them in maps. The JAXB adapter supports all JAXB properties for marshalling and unmarshalling an XML document.
- JDBC Adapter
  Use the Java Database Connectivity (JDBC) adapter to query or update a database through the appropriate JDBC driver for the database.
- JMS Adapter
  Use the Java™ Message Service (JMS) Adapter as a client to any JMS-compliant messaging system provider.
- JNDI Adapter
  Use the Java™ Naming and Directory Interface (JNDI) Adapter to enable maps to look up, add, modify and delete entries in external directories, and retrieve the results that these operations return so that they can be reused in a map.
- MongoDB Adapter
  Use the MongoDB adapter to create, read, update, and delete single or multiple JavaScript Object Notation (JSON) documents in a MongoDB database.
- OData Adapter
  The OData (Open Data Protocol) adapter provides support for performing read and write operations on data sources that expose OData interface. OData adapter is an ISO/IEC approved, OASIS standard that defines a set of best practices for building and consuming RESTful APIs.
- OpenPGP Adapter
  Use the OpenPGP Adapter to exchange information with the GnuPG application.
- PDF Adapter
  The PDF Adapter works with Acrobat forms and templates to generate a PDF document or extract data from all or part of an input PDF document.
- REST Adapter
  REST adapter is a solution where Link can readily call any Web/REST API and provide easy mapping to and from the APIs.
  - Authenticating connections
  - REST Adapter properties and commands
    This documentation provides a detailed description of the adapter properties for defining connections, actions, and cards.
    - Configuration mode
      - Generic Mode
        When you set Configuration Mode property to Generic; URL, Method and Headers properties are required to connect to the REST API.
      - Configuration Script
        When you set Configuration Mode property to Configuration Script, a JSON file (configuration file) defines the endpoints for an API.
      - Configuration package
    - URL
      This property specifies the REST URL. It is available, when you set Configuration Mode to Generic.
    - Method
      This property is available, when you set Configuration Mode to Generic. It specifies a method.
    - Headers
      This property specifies the header. This is an optional property. The value of Headers is -H header1=value1.
    - Script Path
      This property provides script path. It is available, when you set Configuration Mode to Configuration Script. This is a mandatory property.
    - Endpoint
      This property specifies actions available in Link. It is available, when you set Configuration Mode to Configuration Script or Configuration Packages.
    - Package Id
      This property fetches deployed Package Id’s. It is available, when you set Configuration Mode to Configuration Packages. This is an optional property.
    - Authentication
      This property provides the options to authenticate the connection. This is an optional property.
    - Access Token
      This property specifies an access token to access the REST APIs using OAuth 2.0 Authentication. It can be generated outside LNK using REST API tools, such as Postman. This is a mandatory property
    - Access Token Expiry Action
      Action to be taken by REST Adapter if the access token provided is either expired or invalid. This is a mandatory property.
    - Access Token URL
      The Access Token URL property provides the URL of the access token. This is a mandatory property
    - Consumer Key
      The Consumer Key property is used to make an OAuth authentication request when the token expiry action is selected as Refresh Token or Request New Token. This is a mandatory property.
    - Consumer Secret
      The Customer Secret property is required to request a new token when the access token expires. This is a mandatory property.
    - Refresh Token
      When Access Token Expiry Action set to Refresh Token, user requires to provide a refresh token. Refresh token must be captured outside of Link to enable the adapter to refresh the access token later without your interaction. This is a mandatory property.
    - Security Token
      The Security Token property represents the security token that is provided to you when you register. This is an optional property.
    - Token Storage File
      If the access token is renewed, it is stored in a file for later reference. The storage file path is specified by this property. This is a mandatory property.
    - Encryption Key
      The Encryption Key is used for keeping the access token stored in the file secure, adapter uses AES-256 bits encryption. This property is used to provide key that is used for encrypting the access token. This is a mandatory property.
    - Logging
      The Logging property specifies the level of logging to use for the log (trace) file produced by the adapter.
    - Append Log
      The Append Log consists of a flag that indicates what to do if the specified log file already exists. The default value is true.
    - Log File Path
      Name of the log file to which to write log messages. If not specified, the default log file name m4rest.mtr is used, and the file is stored to the directory in which the executed compiled map resides.
  - Examples
  - OAuth 2.0 authentication examples
- SAP BAPI Adapter
  The SAP BAPI contains the BAPIs which internally invokes Remote Function Calls (RFCs) which is necessary to pass inbound and outbound data to and from SAP R/3.
- Salesforce Adapter
  Salesforce Adapter provides support to access Salesforce REST API resource. It is useful for abstracting a piece of information or an action.
- ServiceNow Adapter
  The ServiceNow adapter provides support for accessing ServiceNow REST API resources.
- SFTP Adapter
  With the Secure File Transfer Protocol (SFTP) adapter, you can send and fetch files securely to and from an SFTP server.
- SOAP Adapter
  SOAP defines the XML-based message format that applications use to communicate and inter-operate with each other over the Web.
- Socket Adapter
  The Socket Adapter provides a means of passing data to and from HCL Link through standard TCP/IP sockets.
- Archive (Tar) Adapter
  This documentation introduces the Archive (Tar) adapter. You can use the adapter with a Command Server, Software Development Kit, or map in a map rule.
- Archive (Zip) Adapter
  Use the Archive (Zip) Adapter with a Command Server, Software Development Kit, or map in a map rule.

Configuration package

This is a Configuration Mode property option. A deployed Configuration Package consists of:

A JSON configuration file that defines the endpoints for an API.
A Java plugin class. If an API requires complex authentication code, or other extensions, this can be implemented in Java.
JSON templates to define request and reply data.
Configuration Package has all the capabilities and provides benefits supported in Configuration Script mode.

Example: Amazon S3: To implement reading and writing to S3:

Plugin is required because of AWS request signing.
Note use of $bucket and $key properties.