Word - Split

** AVAILABLE AUGUST 2024 **

Overview

The 'Word - Split' flow action splits the word document provided into multiple word documents aligned to the configuration specified.

The following file types are supported:

  • Docx
  • Dotx
  • Doc
  • Dot
  • Docm
  • Dotm
  • Rtf

Parameters

The default 'Word - Split' flow action parameters are detailed below:

  • Filename: The filename of the source Microsoft Word file, the file extension is mandatory: 'file.docx' and not 'file'
  • File Content: The file content of the source Microsoft Word file
  • Split Type: Select how to split the file
  • Split Configuration: Provide a split configuration

Split Type Options

The 'Split PDF' flow action provides three different options for splitting the PDF document:

  • All Pages: Each page within the Word document supplied would be split into a new Word document
  • Array: Splits the Word document utilising the array configuration provided
  • NumberOfPages: Splits the Word document by the number of pages specified.
  • Section:  Splits the Word document by the contined sections

All Pages - Example:

Each page within the Word document supplied would be split into a new Word document.

Array - Example:

The following configuration will split the Word document into three separate documents with the first document containing pages 1 to 3, the second document pages 7 to 18 and the last document pages 19 to 20. 

Number of Pages - Example:

The following configuration would split a Word document into collections of 5 pages, i.e. a 20-page document would create 4 separate documents.

Section - Example:

The following configuration would split a Word document by the contained sections creating a Word document for each section found.

Please refer to the Obtaining the 'File Contents' Parameter article for guidance on how to obtain the 'File Content' parameter ready to provide to an Encodian flow action. 

Advanced Parameters

The advanced 'Word - Split' flow action parameters are detailed below:

  • Culture Name: This setting is used to set the culture for the document prior to conversion. Please refer to the Culture Names article for a list of supported cultures

Return Parameters

The 'Word - Split' flow action returns the following data:

Action Specific Return Values

  • Documents - The collection of Word documents created from the Word document supplied
    Each document within the documents collection contains the following values:
    • Documents Filename - The filename of the file
    • Documents File Content - The file content of the file

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