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.
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.

Parent topic: Excel Adapter