Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

Changing the case ID format

Updated on March 29, 2022

Change the case ID format to help case workers distinguish between instances of different case types. Custom case IDs can help users save time and simplify the organization of work by improving readability. For example, case IDs of the type Loan Request start with the prefix LORE-, and case IDs of the type New Account start with the prefix NACC-.

For each case, your application generates a unique case ID in the following format: prefix-integer. By default, a case ID contains the following elements:

A single character that your application derives from the name of the case type that you provide when you create or import a case type, and a hyphen. Prefixes are required, but they do not need to be unique.
More than one case type can share a prefix.
A number that increases by one each time that you create a case. You cannot count the number of cases in your application based on the integer of a case ID because the system reserves case IDs before successfully creating a case.

The following examples of case IDs illustrate the different formats that you can use:

  • C-100
  • JobApp-420
  • MORT-763
  1. In the navigation pane of App Studio, click Case types, and then click the case type that you want to open.
  2. On the Settings tab, click General.
  3. In the Case ID prefix field, enter a prefix for your case ID, for example, JobApp-.
    When you enter the prefix, consider the following guidelines:
    • A case ID prefix can consist of a maximum of 32 characters, including a hyphen at the end. If you do not enter a hyphen at the end of the prefix, the system adds it automatically after you save the settings.
    • Do not use the ampersand (&) and double quotation marks (") in the case ID.
  4. Click Save.
Result: The following figure shows a new case with an ID that starts with the prefix that you configure for the case type:
Setting a case ID prefix
Case ID prefix setting at design time, and a new case at run time with an ID that uses the prefix.
  • Case ID format

    Your application generates a unique ID for each case to help case workers distinguish between instances of different case types.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us