Overview
The 'PDF - Split by Text' flow action splits a PDF document into multiple separate PDF documents according to the search text provided.
Example Flows
Please refer to the following article showcasing the 'PDF - Split by Text' action
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 'PDF - Split by Text' flow action parameters are detailed below:
- Filename: The filename of the source PDF document (including the file extension)
- File Content: A Base64 encoded representation of the source PDF document
- Split Value: Specify either a text value or a regular expression
- Is Expression: Set whether to evaluate the 'Split Value' as a string or regular expression.
- Prefix Filename: Set whether the expression value should be used within the output filename.
- Split Configuration: Select whether to split on the first instant, last instant or all instances pertaining to the results provided from the 'Split Value'.
-
Split Action: Select a split action, whether to split on, before, after or remove the page containing the split value.
A single 5 page PDF document containing the text value on page 3 will return the following file and page combination:
- Remove: 1-2, 4-5
- SplitOn: 1-2, 3-5
- SplitAfter: 1-3, 4-5
- SplitBefore: 1, 2-5
Return Parameters
The 'PDF - Split by Text' flow action returns the following data.
Action Specific Return Values
- Documents - The collection of PDF Documents created from the PDF 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.
0 Comments