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.
Pagination support in REST adapter
Pagination turns big archives of data into smaller, more digestible pieces.
First Offset
The First Offset property specifies the offset value to provide in the first call.

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.
- Amazon SQS Adapter
  With the Amazon SQS or Amazon Simple Queue Service adapter, a user can access Amazon Simple Queue Services. The adapter connects to the fully managed Amazon Simple Queue Service system, using AWS keys. The SQS adapter can send and fetch messages to and from the queues to which a user has access.
- 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. In Design Studio, use the Excel importer (File > Import > Excel) to create a type tree based on a specified worksheet in the 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.
  - SSL/TLS support in REST adapter
    The SSL/TLS provides stricter security for HTTPS connections involving very selected parties.
  - Pagination support in REST adapter
    Pagination turns big archives of data into smaller, more digestible pieces.
    - Pagination Type
      There are four patterns that are commonly used for implementing pagination in REST APIs and they can be specified using the Pagination Type property.
    - Records per Call
      The Records per Call property specifies the number of records to fetch per call.
    - Limit
      The Limit property specifies the total number of records to return across all calls.
    - First Offset
      The First Offset property specifies the offset value to provide in the first call.
    - Number of Records Location
      The Number of Records Location property specifies the location in response as where to find the total number of records.
    - Number of Records Path
      The Number of Records Path property specifies the header name or the path where the total number of records are found.
    - First Page
      The First Page property specifies the page value to provide in the first call.
    - Number of Pages Location
      The Number of Pages Location property specifies the response location where the total number of pages are found.
    - Number of Pages Path
      The Number of Pages Path property specifies the header name or the path where the total number of pages are found.
    - Next Page Link Location
      The Next Page Link Location property specifies the name of the header or the path in the body for the field containing an URL for the next page. The URL may be absolute or relative.
    - Next Page Link Path
      The Next Page Link Path property specifies the header name or path where the URL for the next page is found.
    - Base URL
      The Base URL property specifies the URL to which all relative links for next pagination call would be appended.
    - Next Page Token Location
      The Next Page Token Location property specifies the name of the header or the path in the body for the field containing the token for the next page.
    - Next Page Token Path
      The Next Page Token Path property specifies the header name or path where the token for the next page is found.
    - Pagination Token Location
      The Pagination Token Location property specifies the location where the pagination token for subsequent calls would be configured.
    - Pagination Token Name
      The Pagination Token Name property specifies the name of the pagination token to be passed in the next subsequent calls.
    - Header and Parameter Special Values
  - Examples
  - OAuth 2.0 authentication examples
- RabbitMQ Adapter
  This documentation describes the RabbitMQ Adapter.
- 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.
- SAP R/3 ALE Adapter
  This documentation describes the SAP R/3 ALE Adapter.
- 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
  This documentation describes the SOAP Adapter.
- SOAP (Legacy) 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.

First Offset

The First Offset property specifies the offset value to provide in the first call.

This property is applicable only when the Pagination Type is set to Offset.

The corresponding command for this property is -FO [num] (or -FIRSTOFFSET [num]).