Home
Resource Adapters
About the HCL Link Resource Adapters, and how to use them.
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.
Excel Adapter commands
This documentation describes the functions and use of the Excel Adapter commands.
Read Mode (-READMODE) command
The -READMODE command specifies the type of read operation to be performed. Use this command for data sources.

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. In Design Studio, use the Excel importer (File > Import > Excel) to create a type tree based on a specified worksheet in the Excel workbook.
  - System requirements
    See the release notes for the Excel Adapter requirements.
  - Excel Adapter commands
    This documentation describes the functions and use of the Excel Adapter commands.
    - Transaction scope and document persistence in memory
      When a document is added using the -ADOC command, the Excel Adapter stores the document in memory. Documents stored in memory are identified by a document identifier that is either provided by the user, or generated by the Excel Adapter. The document persists in memory as specified by the transaction scope in the card settings.
    - data_from_map option
      Some of the Excel Adapter commands that are described in this documentation include the data_from_map option. The data_from_map option represents the data that is passed as the third parameter of a GET function. It is not a parameter on the command line.
    - Add document (-ADOC) command
      The -ADOC command adds a file on the local file system, or a remote file accessible through HTTP protocol, as a document in memory, and returns the document ID to the map. Alternatively, the -ADOC command can add dynamic data from a map as a document in memory and return the document ID to the map.
    - Remove document (-RDOC) command
      The -RDOC command removes a document from memory. By default, documents are removed from memory when map, or card processing completes. Transaction scope card setting determines the document persistence in memory. Use this command if too many intermediate documents accumulate in memory during map processing.
    - Replace document (-UDOC) command
      The -UDOC command replaces an existing document in memory with a new one and returns the new document ID.
    - Get document data (-GDOC) command
      The -GDOC command returns data from a document in memory for the given document identifier. Specify the identifier of the document being fetched from memory.
    - Excel workbook (-FILE) command
      The Excel workbook name. Use this command for data sources or data targets.
    - Worksheet (-WRKSHEET) command
      The Excel sheet name in the workbook. This command is required. Use this command for data sources or data targets.
    - Read Mode (-READMODE) command
      The -READMODE command specifies the type of read operation to be performed. Use this command for data sources.
    - Worksheet Identifier (-IDENTIFIER) command
      The -IDENTIFIER command specifies how to identify a worksheet. Use this command for data sources.
    - Worksheet Index (-WRKSHEETINDEX) command
      The -WRKSHEETINDEX command specifies the index of the worksheet. Use this command for data sources.
    - Template (-TEMPLATE) command
      The Excel template workbook name. This command is optional. Use this command for data targets.
    - Excel transformation (-XLS) command
      The -XLS command allows the map to transform map data in delimited format to Excel formatted data using the GET map rule. PUT receives map data in delimited format and transforms it to Excel formatted data. This command allows the same with GET, so that it can return Excel formatted data back to the map by performing in-memory transformation. The delimited format data has to conform to the Excel importer generated type tree for the corresponding 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.
- 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.

Read Mode (-READMODE) command

The -READMODE command specifies the type of read operation to be performed. Use this command for data sources.

-RM { wsl | wsd }

-READMODE { wsl | wsd }

The -READMODE command is optional. Valid values for this command are: wsl (worksheet list) and wsd (worksheet data). Default is wsd.

Worksheet list specification for -READMODE command returns the delimited list of worksheet names defined in the Excel workbook. The delimiter between worksheet names is Line feed (<LF>) character. Ignores -WORKSHEET command if specified in the command line.