Unique Id
The Unique Id (or unique identifier) is a property that exists on most resources in JPAC e.g. People, Requirements, Org Units, Roles, etc.
The Unique Id is used to:
- Differentiate each resource from the other resources in the same class. For example, two People cannot have the same Unique Id, while a Role and an Org Unit could share the same Unique Id (though this should be avoided).
- Find and retrieve a resource. The Unique Id is the most efficient way to search for a single resource.
Properties
A Unique Id:
- is set by the user who creates the resource and cannot be changed once the resource has been saved for the first time.
- must be at least 2 characters long.
- must be a maximum of 100 characters long.
- can be made up of upper or lower case letters, numbers and special characters. Spaces are allowed, but are considered bad practice and should be avoided.
If you have an existing system that already assigns Ids to your resources, e.g. a HR system, then use the Ids from that system as the Unique Id in JPAC. This will ensure the data can be integrated correctly.
Related Errors
JPAC will return an error relating to a Unique Id when attempting any of the following:
- Creating a resource with a Unique Id that is less than 2 characters long or greater than 100 characters long.
- Creating a new resource with a Unique Id that has already been used for the same type of resource.