

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 Auto Increment Field on Object solution calculates and adds an incremental value to a field automatically each time a user creates a new record for an object. This solution is not supported for the document object.
The Auto Increment Field on Object solution calculates and adds an incremental value to a fixed-length text or long text field automatically each time a user creates a new record for an object. The value uses the format <prefix><padded number>, where prefix is a set of characters that you can optionally specify for the first part of the value. Padded number is the number of digits that you want to pad the second, numeric part of the value with. When you configure the solution, you can also specify the starting value and increment to use when calculating values. To see examples of how the solution calculates values based on various configuration settings, see Creating a configuration record.
This solution is supported in the following Relativity Server versions and RelativityOne.
Solution version | Supported Relativity version |
---|---|
2.5.2.1 | 10.3.287.3 - Server 2024, RelativityOne |
This solution consists of the following components:
To add the solution to the Application Library:
If you currently have a previous version of this solution, any previous configurations are updated when you upgrade to a new version.
To add the solution to a workspace:
After you add the solution to the Application Library, you're ready to prepare a workspace to use the solution. Preparing a workspace consists of these basic tasks:
After you install the solution in the workspace, the next step is to create a configuration record with settings that define how you want to increment and format values and which field you want to add those values to. The key settings are:
Note: You can't change this value after the configuration record is created.
The following table provides examples that demonstrate the logic that the solution uses to define the correct incremental value based on various scenarios and sample settings.
Scenario | Highest existing value | Starting value | Increment by | Padding | Incremented value |
---|---|---|---|---|---|
The field doesn't contain any existing values for existing records. The solution settings specify a standard prefix ("MyID"), starting value, and padding value. | None | MyID000001 | 1 | 6 | MyID000001 |
The field doesn't contain any existing values for existing records. The solution settings don't specify a standard prefix or starting value but do specify a padding value. | None | Not set | 1 | 6 | 000001 |
To create a configuration record:
For example, you could set the start value to ABC01, the increment value to 2, and the padding to 5. The first RDO field would then be set to ABC00001, the second to ABC00003, and so on.
Note: You can only set the Start value when you create the configuration. After setting this value and saving the configuration, you can't modify it or the Current value field.
The final step in preparing the workspace is to associate the event handler, which is included in the solution, with the object type that contains the field you want to add incremental values to.
To associate the event handler with the object type:
Select the KCD_1042103.AutoIncrement.EventHandlers.PostSave .dll file.
After you complete all the steps for deploying and configuring the solution in a workspace, the solution automatically starts using the settings that you specified to calculate and add incremental values to the field. This occurs each time a user creates a new record by clicking the Save, Save and Next, or Save and New button in an appropriate layout. You don't need to take any additional steps to run the solution.
To view the results of running the solution, navigate to any view, layout, or other area containing the field that the solution calculates and adds values to automatically.
Why was this not helpful?
Check one that applies.
Thank you for your feedback.
Want to tell us more?
Great!