

Note: You must have valid Relativity Community credentials in order to download any Community file linked to the documentation site. You'll need to enter those credentials on the Community login screen if you're not already logged in. If you're already logged in to the Community at the time you click a link, the file is automatically downloaded in the bottom left corner of your screen. If you get an error message stating "URL No Longer Exists" after clicking a Community link, it may be due to a single sign-on error related to the SAML Assertion Validator, and you should contact your IT department.
The Document unitization solution can be used to split an imaged document into multiple child documents. This solution is one component of the Document Utilities application along with the move to folder path mass operation.
Using the Document unitization solution, you can split a document into multiple child documents. You can specify the page range of each child document and split the parent document into as many child documents as necessary.
This solution is supported in Relativity 9.2.337.3 and above.
Solution version | Supported Relativity version |
---|---|
24000.0.3 | Server 2024 |
This solution consists of the following components:
Users must have the following permissions in order to use this solution:
Note: The Document unitization solution doesn't work when document item-level security is enabled. Set the Document’s associated folder permissions accordingly.
Before you deploy and run the solution, it's important to keep the following in mind:
To deploy and configure the solution, you must first add it to the Application Library as a Relativity application. You can then install and configure the solution in a workspace.
To deploy the solution, you first add it to the Application Library as a Relativity application. You can then install it from the Application Library to one or more workspaces.
Note: This script runs from the Admin level, you must install this application into a workspace for it to appear in the Script Library (at the instance level).
To add the solution to the Application Library:
To add the solution to a workspace:
After you add the solution application to the Application Library, you're ready to install and configure it in a workspace by performing these basic tasks:
To perform document unitization, you must first create at least one manager agent and one worker agent. You can create multiple instances of these agents if you want to distribute the workload.
To create manager and worker agents, perform the following steps:
Note: When you create manager and worker agents, you must create them on each instance of the agent server that shares the same resource pools as the workspaces you plan on using the Document unitization solution in. The solution will not process any data in a workspace if the associated resource pool does not have its own manager and worker agents. Any Document unitization jobs will simply sit inactive in queue.
When you unitize a document, a new document identifier is assigned to the child document(s).
You can configure the padding, or the number of zeroes that appear before the final number. To configure the padding, perform the following steps:
Note: When you install the Document Utilities application in a workspace, the Default Padding value is automatically set to 5.
If you change this value from the default of 5, only new job requests use the new padding. Previous unitization jobs are not be updated.
The maximum Default Padding value is 20 characters.
To unitize a document, perform the following steps:
The page range you entered moves from the Page Range field to the Page Range History field in the Document Unitization History section. To view the newly split document(s), return to the Document unitization view on the Document list.
After you've specified the page range(s) for the new document(s) using the Document unitization layout and clicked Save, you can view the newly created child document(s) in the Related Items pane.
Click the Unitization icon to view all the child documents for the parent document you just split. The most recently created child document appears at the bottom of the list. Click the control number to view the document.
Note: When you're viewing a parent document, the Unitization Page Range field on the Document unitization layout is blank, and when you're viewing a child document, the Unitization Split Counter and Page Range History fields are blank.
You can also see the newly created child document(s) on the Document list.
From the Views drop-down menu, select Document Unitization to display document unitization details.
The newly created child document(s) appear on this Document unitization view. You can locate the child document(s) on this view using the Unitization Identifier and Unitization Page Range.
The Document unitization view provides the following details for each document:
While using the Document unitization solution, you may encounter the following issues or error messages:
Note: When Document unitization agents are added to Relativity, they are added to specific resource pools, which are associated with workspaces. If you attempt to unitize documents in a workspace and nothing happens, it may be because there isn’t at least one dedicated manager or worker agent added to that specific resource pool.
At least one requested document currently exists. Please update the Unitization Split Counter field to match the number of unitized documents.
This message appears when the value in the Unitization Split Counter field is less than the number of children already created. To resolve, update the value in the Unitization Split Counter field to equal the number of children that have been created.
This document cannot be unitized because this is a child document of a previously unitized parent document. Please try unitizing the parent document [Parent Control Number: ].
This message appears when you try to unitize a document which has a Unitization Type = Child. To resolve, locate the parent document and unitize that document.
Unitization Padding is not set up.
This message appears when the Default Padding setting does not have a value. To resolve, perform the steps in Configuring padding settings for child documents.
Missing images for pages: 10-200
This message appears when you attempt to unitize pages (images) that do not exist for the current document.
Child document identifier value will be greater than document identifier field length. Please try again by lowering your padding value or by increasing document identifier field length.
This message appears when you attempt to unitize a document and the length of the resulting child document identifier exceeds the value set for the document identifier field. You can resolve this issue by decreasing the padding value (using the steps in Configuring padding settings for child documents) or by increasing the length of the document identifier field in your workspace.
Consider the following when uninstalling the Document Utilities application:
Document Unitization completes approximately 500 unitization jobs an hour.
Note: The number of images included in a unitization job and the number of times that images are split may decrease performance.
Why was this not helpful?
Check one that applies.
Thank you for your feedback.
Want to tell us more?
Great!