Split Documents activity

This activity splits root documents or extracts sub-documents in root documents. Various criteria are used to split sub-documents of a single root document into different root documents, or to extract sub-documents from a root document and make them into separate root documents.

Tip: Splitting can be "undone" by using the Merge Document activity.

Note: This activity must be assigned to an Activities Service in order to run.

If for some reason you need to add this activity to the Process Designer, the file to add is xboundActDocSplitter.dll.

The following settings are available when configuring a process step of this activity type.

Note: When two or more splitting criteria are specified, they must all be met in order for the document to be split.

Filter tab
Split level	The sub-document level to apply the extraction or splitting criteria to: 1 – the first sub-level (direct sub-documents of the root documents). 2 – the second sub-level (sub-sub documents, or "grandchildren", of the root documents). Etc.
Split mode	This activity can work in two modes: Extract – sub-documents that meet the specified criteria are extracted from the root document and processed in subsequent process steps as root documents of their own. Split – sub-documents are divided into multiple root documents. Some root documents contain only sub-documents that meet the criteria, while others contain only sub-documents that do not. (More information about the Split settings.) Max. number of documents – How many sub-documents a newly created root document can contain before a new root document is created. Copy media to new root document – Includes the media of the original root document in the new one. Copy steps to new root document – Includes the processing history of the original root document in the new one. Use original root document name – By default, the names of new root documents are a combination of the name of the original root document plus an underscore and a sequential number. Select this option to use the original root document name, instead.
Split by document types	Select to use the document type of the sub-documents as a criterion. Then choose the document types.
Advanced tab*
Split by valid status	Select to use the status object of the sub-documents as a criterion. Then choose the statuses.
Split by process fields	Select to use the status fields of the sub-documents as a criterion. Then specify the process step, status field name, and status field value.
Check canceled documents	Select to use the cancellation status of the sub-documents as a criterion. Select Work on canceled documents to apply that criterion. Related topic: Canceling a document
Split by field values	Select to use the field content of the sub-documents as a criterion. Type the field name and regular expressions that fields with this name are to be checked against. As soon as one of the listed field values is found, a new root document is created.

* Note: The options on the Advanced tab are connected by OR operation. Only one of the specified criterion needs to apply in order to split the document.

These settings are also available:

Import button	Imports settings from an XML file that was previously created using Export.
Export button	Exports the settings to an XML file. Specify the file name and location. You can then import the XML file to get the same settings. See Exporting and importing process step settings.
Check regular expression link	Opens a test form, where you can (when applicable) check a regular expression.

XBOUND activities: Overview

Process Designer plug-in