Excel - Merge Rows

Overview

The 'Excel - Merge Rows' flow action merges the rows contained witthin up to 1,000 Microsoft Excel files (and related formats) into single Microsoft Excel worksheet.

To maintain separate worksheets in a merged file, please see our Merge Excel Files action.  

Input File Types

The following file types are supported for files to be merged:

  • XLSX
  • XLSB
  • XLST
  • XLSM
  • XLS
  • CSV
  • tabdelimited
  • ODS
  • spreadsheetml
  • TSV

Output File Types

The merged output can be saved in any of the following file formats:

  • PDF
  • CSV
  • TIFF
  • XLSX
  • XLS
  • XLSB
  • XLSM

Credit Count

This action consumes 1 credit per operation.

Note, different Encodian actions can consume different number credits. Please always check the action specific documentation and read What is an Encodian Action for a full description of how credits are consumed.

Default Parameters

The default 'Excel - Merge Rows' flow action parameters are detailed below:

  • Filename: The filename of the output excel file
  • Output Format: The format of the output excel file
  • Documents: The array of files to be processed

As a manually entered array:

  • Filename: The filename of the source file (including the file extension)
  • File Content: The file content of the source file
  • Sort Position: Set the sort position for the document within the array, lowest number first.
  • Worksheets to Merge: Specify which worksheets from the source file should be included within the output (default is all worksheets)
  • Include First Row: Set whether to include the first row of the worksheet, 'false' by default

As an array object:

Documents - JSON Schema 

The JSON provided within the documents parameter should conform to the following schema:

{
"fileName": "<Filename including extension>",
"fileContent": "<File contents (Base 64 string)>",
"sortPosition": <Optional - Sort position number>,
"worksheetsToMerge": [<Optional - int array>],
"includeFirstRow" : true|false
}

Advanced Parameters

The default 'Excel - Merge Rows' flow action parameters are detailed below:

  • Preserve First Row: Ensures that the first row of the first workbook and sheet is always preserved. This overrides the 'Include First Row' setting for the first workbook in the array.

Return Parameters

The 'Excel - Merge Rows' flow action returns the following data. 

Action Specific Return Values

  • File Content - The processed file (Base64)

Standard Return Values

  • OperationId - The unique ID assigned to this operation.
  • HttpStatusCode - The HTTP Status code for the response.
  • HttpStatusMessage - The HTTP Status message for the response.
  • Errors - An array of error messages should an error occur.
  • Operation Status - Indicates whether the operation has completed, has been queued or has failed.
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk