Configuration options when Action is Split documents #
If the selected action is SplitDocument, the following configuration sections are available:
Document split options #
State Actions > State Action [1] > Action: SplitDocument > Configuration > Document split options
Defines how the document should be split.
Within this section, the following fields are available by default: Split mode, Pages per split type, Pages per split.
Split mode #
State Actions > State Action [1] > Action: SplitDocument > Configuration > Document split options > Split mode
Determines how the source document should be split up.
- Interval (default): Splits the document at regular page intervals (default: split on every page).
- FixedPoints: Splits the document at specific page numbers (e.g. split on page 5).
Pages per split type #
State Actions > State Action [1] > Action: SplitDocument > Configuration > Document split options > Split mode: Interval > Pages per split type
Displayed only when Split mode is set to Interval.
Specifies how the number of pages between splits is defined:
- Static (default): Fixed value defined in the configuration.
- Dynamic: Dynamic value retrieved from a property on the source object.
Pages per split #
State Actions > State Action [1] > Action: SplitDocument > Configuration > Document split options > Split mode: Interval > Pages per split
Displayed only when Split mode is set to Interval.
Defines the number of pages after which the document will be split. The default value is 1.
Page split points #
State Actions > State Action [1] > Action: SplitDocument > Configuration > Document split options > Split mode: FixedPoints > Page split points
Displayed only when Split mode is set to FixedPoints.
Specifies the exact pages at which the document should be split.
- Expand Page split points.
- Click on Add Page split point.
- Expand Page split point [1].
By default, the Page split point value type and Page options are available.
Page split point value type #
State Actions > State Action [1] > Action: SplitDocument > Configuration > Document split options > Split mode: FixedPoints > Page split points > Page split point value type
Displayed only when Split mode is set to FixedPoints.
Specifies how the split page number is defined:
- Static (default): Enter the page number directly in the Page field.
- Dynamic: The page number is taken from a property on the source object. You must specify the property containing the split page number.
Save options #
State Actions > State Action [1] > Action: SplitDocument > Configuration > Save options
Options for how the split documents should be saved.
Within this section, the following fields are available by default: Save mode, Save as Object options, File name parameters, and File name templates.
Save mode #
State Actions > State Action [1] > Action: SplitDocument > Configuration > Save options > Save mode
Specifies where the resulting documents are saved.
- SaveAsObjects (default): Creates new objects for each split document.
- SaveToSource: Adds the split documents as files to the source object.
Save As Object options #
State Actions > State Action [1] > Action: SplitDocument > Configuration > Save options > Save mode: SaveAsObjects
Displayed only when Save mode is SaveAsObjects.
Configuration options for creating new objects from split documents. If not explicitly set:
- Object Type and Class are inherited from the source object.
- Name or Title is generated based on the file name.
Within this section, you can configure Object type, Class, Properties (via Property setter), and whether to reference the new object to the source (and vice versa).
File name parameters #
File name parameters to be used for the resulting document naming. Name should be used in FileNameTemplate as is, and will be replaced with the resolved parameter value. If no parameters are set, the default FileName will be SourceFileName-Iterator (e.g. OriginalDocumentName-1).
File name template #
File name template used for naming the resulting documents. Should reference parameters from FileNameParameters.
If FileNameParameters are not set, the default FileName will be template-Iterator (e.g. if FileNameTemplate is ‘SplitDocument’, the result would be SplitDocument-1).
