How do I set up public unique IDs (PUIDs)?

Setup Options for Public Unique IDs (PUIDs)

There are three levels of setup options for PUIDs:

Use the default setup, where no implementation steps are required.
Use the basic setup, which is configurable to a certain degree. If you use this setup, the default setup isn't used.
Use an advanced setup which is more complex and configurable. The default and basic setups apply to all objects. Advanced setup is on a per-object basis.

In this topic, we talk about "advanced setup" for PUIDs. This means you set up the unique sequence generation of PUIDs that's a specific prefix and radix configuration. You set these for each business object. In addition, keep in mind that PUID specifications mandate that users can search for all supported business objects by PUID and Party Number.

Here's a list of setup options and where to find more information about the setup.

Setup Option	Description
Default Setup	In this setup, no implementation steps are required. The application automatically generates a unique 15-digit numeric ID for each record. The document sequencing begins with a 1.
Basic Setup	In this setup, you set two profile options where you configure the radix (or base numbers and characters) and prefix to use. The application generates an alphanumeric public unique ID instead of the default numeric public unique ID for each record.
Advanced Setup	In this setup, you define a radix and prefix for each object. It isn't required for the radix and prefix to be different for each object.

Public Unique ID Basic Setup

In the basic setup, you define a single prefix that's shared across all business objects in the implementation. In addition, you have several different radix values that can be used. Together these values form the PUIDs.

To perform the basic setup, you set these profile options:

CRM Public Unique ID String Encoding profile option: Controls the characters used in the encoding of the public unique ID based on a radix, or base number.
CRM Public Unique ID Prefix profile option (ZCA_PUID_PREFIX): Defines the optional prefix value for the public unique ID. If you use this profile option, define the prefix for the public unique ID at the site level. After you set this profile option to the prefix you want, the application inserts the prefix before the public unique ID base encoded document sequence value. For example, you might want the records for the pharmaceutical divisions of your company to be denoted with public unique IDs and the prefix Pharma or Pharma1, Pharma2, and so on. By default, the prefix has no value.
CRM Public Unique ID String Encoding profile option (ZCA_PUID_RADIX): This profile option determines the set of numbers and letters used in creating the public unique ID. The default value is null. After you set the radix, the application converts the public unique ID into user-friendly IDs, using alphanumeric characters instead of numeric digits.

These base values are available when constructing the PUIDs:

Numbers 0-9, letters A-F
Letters A-Z, upper case
Numbers 2-9, letters BCDFGHJKLMNPQRSTVWXYZ
Numbers 0-9, letters ABCDEFGHJKLMNPQRTUWXY
Numbers 0-9, letters A-Z, upper case
Numbers 0-9, letters A-Z, letters a-z
No alphanumeric conversion

The values for the radix are stored in the lookup type, ZCA_PUID_ENCODING. This lookup type is accessible using the Manage Standard Lookups task in Setup and Maintenance.

Keep these points in mind:

If you enter a prefix value, then you must set a radix value. The length of a prefix value is 5. You can't use the prefix setting by itself.
If you require a delimiter, then include it as part of the prefix.
The concatenated public unique ID and prefix must not exceed the defined field length, which is usually 30 characters.

Here's how to set the profile options.

Sign in as a setup user and in Setup and Maintenance, go to: Sales offering > SalesFoundation functional area > Manage Public Unique Identifier Profile Options.
On the Manage Public Unique Identifier Profile Options page, click the ZCA_PUID_RADIX option.
In the ZCA_PUID_RADIX: Profile Values section of the page, click the Profile Option Values list of values and select the base numbering value.
Click Save and Close.
Optionally, click the ZCA_PUID_PREFIX option.
In the ZCA_PUID_PREFIX: Profile Values section of the page, in the Profile Value box, enter the prefix and the delimiter you want, if any. For example, enter CDRM_.
Click Save and Close.

Public Unique ID Advanced Setup

In the advanced setup, you can define a different prefix and numbering radix for each business object, for example, Accounts, Contacts, and Opportunities. Oracle recommends that you do this to avoid PUID clashes when populating object records via import while also creating records in the UI or via REST.

Keep these points in mind:

If you enter a prefix value, you must set a radix value. You can't use the prefix setting by itself. The length of a prefix value is 5.
If you require a delimiter, then include it as part of the prefix.
The concatenated public unique ID and prefix must not exceed the defined field length, which is usually 30 characters.

Use these steps to configure the radix and optionally, the prefix in the advanced setup.

Sign in as a setup user and in Setup and Maintenance, go to: Sales offering > SalesFoundation functional area > Manage Public Unique Identifier Sequence Generation.
On the Manage Public Unique Identifier Sequence Generation page, if you're configuring these values for the first time, add a row to the table.
In the Object list of values, select the object you're configuring the public unique ID for.
In the Radix list of values, select the base numbering to use. This list of possible radix values is the same list of values that are provided in the ZCA_PUID_RADIX profile option.
In the Prefix box, enter the prefix you want to use for the object and unique ID.
- Enter a maximum of five characters.
- The allowed characters are: 0-9, A-Z, a-z, and these special characters: period, hyphen, comma, and underscore.
Repeat for other objects.
Click Save and Close.

This table lists options for RADIX in the Manage Public Unique Identifier Sequence Generation task. For example, the sequence looks as follows if a Lead Number is in the format of "LeadNumber":

"CDRM_2452" if the advanced setup for the Lead object isn't set up.
If the advanced setup for the Lead object is set up, then the LeadNumber is created in the form of "LeadNumber" = "LEAD_106065".
PREFIX is LEAD_ and RADIX is "106065", which is in the format of "No Alphanumeric Conversion".
RADIX is in the format of "Letters A-Z, Upper Case". "LeadNumber": "LEAD_GAXM".

Prefix	Radix
NULL	NULL
NULL	Numbers 0-9, letters A-F
NULL	Numbers 0-9, letters A-F
A-	Numbers 0-9, letters A-F
A-	Numbers 0-9, letters A-F
Null	No alphanumeric conversion
A-	Numbers 0-9, letters A-Z, letters a-z
A-	Numbers 0-9, letters A-Z upper case
A-	Numbers 0-9, letters ABCDEFGHJKLMNPQRTUWXY
A-	Numbers 2-9, letters BCDFGHJKLMNPQRSTVWXYZ
A-	Letters A-Z, Upper Case
A-	Numbers 0-9, letters A-F