Home
Resource adapters
This documenation provides a description of how to use the HCL Link Resource adapers.
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.
IBM® MQ adapter commands
Correlation ID (-CID)

Resource adapters
This documenation provides a description of how to use the HCL Link Resource adapers.
- 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 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
  With the Amazon S3 or Amazon Simple Storage Service adapter, a user can access S3 buckets to fetch stored data and send new data to S3 buckets for storing.
- 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.
- CICS Adapter
  The Customer Information Control System (CICS) adapter allows you to retrieve CICS screen data without the difficulties associated with 3270 "screen scraping."
- 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.
  - IBM® MQ message content
  - Transmission queues
  - IBM® MQ client or server adapter
  - System requirements
  - Command aliases
  - IBM® MQ adapter commands
    - Channel definition (-CD)
    - Cluster queue manager name (-CQMN)
    - Coded character set identifier (-CCSID)
      Use the Coded Character Set ID (-CCSID) adapter command to identify or transform the character set encoding of message data.
    - Complete message (-CMSG)
    - Convert (-CVT)
    - Correlation ID (-CID)
    - Default header (-DH)
    - Error queue manager name (-EQMN)
    - Error queue name (-EQN)
    - Message expiration (-EXPIRY)
      The -EXPIRY command specifies the amount of time that a message can spend on a queue before it becomes eligible for the queue manager to discard it.
    - Global transaction management (-GTX)
    - Group message (-GRP)
    - Group message 2 (-GRP2)
    - Header (-HDR)
    - Hex correlation ID (-HCID)
    - Hex group message ID (-HGRP)
    - Hex message ID (-HMID)
    - Ignore group message (-XGRP)
    - Listen (-LSN)
    - Message buffer size (-MBS)
    - Message format (-FORMAT)
    - Message ID (-MID)
    - MQOPEN options (-MQOO)
    - Packet (-PKT)
    - Password (-P)
      The -PASSWORD command specifies the password that the IBM® MQ adapter uses to authenticate its connection to the IBM MQ queue manager.
    - Quantity (-QTY)
    - Queue manager name (-QMN)
    - Queue name (-QN)
    - Refresh message cursor (-REFRESH)
    - Require all messages (-ALLMSG)
    - Require all segments (-ALLSEG)
    - Trace (-T)
    - Transmission Error queue name (-XEQN)
    - Transmission queue name (-XQN)
    - User (-U)
      The -USER command specifies the user ID that the IBM® MQ adapter uses to authenticate its connection to the IBM MQ queue manager.
    - Version 2 (-V2)
    - Wait Interval (-WI)
  - Syntax summary
  - Using the messaging adapter
  - Group message support
  - Example files
  - Troubleshooting
  - Return codes and error messages
- 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.
- Microsoft SQL Server Adapter
  This documentation discusses the Microsoft SQL Server Adapter. You can use the adapter with the Command Server, or with a map in a map rule.
- 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.
- 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.
- SNMP Adapter
  The SNMP Adapter is used to create and send custom-defined traps to an SNMP manager.
- 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.

Correlation ID (-CID)

Use the Correlation ID adapter command (-CID) to specify a particular correlation identifier (CID) for a source or target. Use this adapter command for a data source to retrieve messages from a queue with a specific correlation ID. You can also use it for a data target to assign a correlation ID to a message when placing it on a queue. A correlation identifier can be up to 24 bytes long and is expected to contain printable characters.

-CID [correlation_ID]

Spaces can also be specified in values. However, if the value contains a space, it must be enclosed with double quotation marks as shown in the example below:

-CID "my ID"

The double quotation mark character can also be used as part of a value. To do this, the double quotation mark value must be represented by a pair of double quotation marks. For example, if you wanted to specify a correlation ID of My "New" ID, you would need to enter the following:

-CID "My ""New"" ID"

When a correlation identifier is specified for a source, the adapter retrieves the first message on the queue with that correlation ID. If no argument is supplied, the correlation ID of the first message retrieved is used.

If the Correlation ID adapter command (-CID) is specified and is used with the Message ID adapter command (-MID), the retrieved messages begin with the first message on the queue that has the specified message ID and the correlation ID. Additional messages are retrieved that have the same message ID and correlation ID. If no correlation ID is specified, the message is identified only by the message ID.

When a correlation identifier is specified for a data target, the adapter places the message on the queue with the assigned correlation identifier.