Vlocity Facts #55 || Generate Unique Numbers in OmniStudio Using Omni Global Auto Number

Omni Global Auto Number

Omni Global Auto Number enables you to generate unique, consistent numbers for records such as sales orders, cases, loan applications, and other business entities. The numbering system can be customized using attributes such as increment value, padding, minimum length, prefix, and separator.

Once configured, global auto numbers can be referenced in Data Mappers and Integration Procedures using the GLOBALAUTONUMBER function.

Enable Omni Global Auto Number

To use Omni Global Auto Number, you must enable the feature in OmniStudio Settings.

Prerequisites

  • Your org uses the standard data model.
  • The custom object GlobalAutoNumberSetting__c does not exist.
  • The Omni Interaction Configurations RollbackIPChanges and RollbackDRChanges are disabled.
  • Create, edit, and delete permissions for the Omni Global Auto Number standard object are granted to OmniStudio Admin and User profiles.

----------------------------------------------------------------------------------------------
Example:

In scenarios where Salesforce sends outbound callouts to external systems and expects a callback response, having a reliable unique identifier is critical to correlate requests and responses.

For example, when Salesforce sends a Client Inception request to an external system, once the inception is completed, the external system needs to send an update back to Salesforce. To correctly map this callback to the original request, we must include a unique reference ID in the initial callout.

Earlier approach:

  • Used a combination of Record Id + Timestamp

  • Worked, but was harder to read, manage, and standardize across integrations

Improved approach with Omni Global Auto Number:

  • Use Omni Global Auto Number to generate a clean, sequential, and reusable identifier

  • Optionally combine it with key record fields for better traceability

  • Ensures consistency across Data Mappers and Integration Procedures

  • Makes callback correlation simpler and more reliable

This approach is especially useful for:

  •  Asynchronous callouts expecting callbacks

  •  Long-running external processes (like client onboarding or inception)

  •  Multi-system integration tracking and reconciliation

----------------------------------------------------------------------------------------------

Step-by-Step Process implementation:

Important
After enabling Omni Global Auto Number, the setting cannot be disabled without contacting Salesforce Customer Support. Toggling this setting is not recommended, as it may result in data inconsistencies.

Steps

  • In Setup, enter OmniStudio Settings in the Quick Find box.
  • Enable Omni Global Auto Number.


Set Up Omni Global Auto Numbers

Use Omni Global Auto Number to define a custom numbering system for specific business use cases.

Steps

  1. From the App Launcher, select Omni Global Auto Number.
  2. Click New.
  3. Enter the required details (all fields are mandatory unless noted):
    • Name – Unique identifier used by the GLOBALAUTONUMBER function.
    • Increment – Value by which the number increases.
    • Last Generated Number – Starting number for the sequence (default is 0).
    • Left Pad – Character used to pad the number.
    • Minimum Length – Minimum length of the generated number.
    • Prefix – Text added before the number.
    • Separator  – Character between the prefix and number.
    4.Click Save.

Example

Configuration

  • Name: CaseCallOutAutoNumber
  • Increment: 1
  • Last Generated Number: 0
  • Left Pad: 0
  • Minimum Length: 6
  • Prefix: Case
  • Separator: -

Use Global Auto Numbers

Use the GLOBALAUTONUMBER function in Data Mappers and Integration Procedures to generate numbers dynamically during runtime.

Configure Global Auto Number in a Data Mapper

Use a Data Mapper to generate and map an auto number using the GLOBALAUTONUMBER function.
Steps

  1. Open OmniStudio Data Mapper.

  2. Open an existing Data Mapper or click New to create one.

  3. Navigate to the Formula tab.

  4. Click Add Formula and configure the formula:
    We need to use     GLOBALAUTONUMBER() function

    • Formula GLOBALAUTONUMBER(CaseCallOutAutoNumber)

    • Path Name: CaseCallOutAutoNumberF

    • Formula Expression: Use the GLOBALAUTONUMBER function with the configured global auto number name.

  5. Save the formula.

  6. Navigate to the Mapping tab.

  7. Map the Formula Path Name (CaseCallOutAutoNumberF) to the preferred Output JSON field name.

  8. Click Preview to generate and verify the auto number.



The generated value appears in the output JSON based on the configured global auto number settings.
Generated Number

  • The next generated number is Case-000001.


Comments

Post a Comment

Popular posts from this blog

Vlocity Facts #01 | OmniStudio DataRaptors

DataRaptor is a mapping tool that  you can use to read, transform, and write Salesforce data. For Example. In each interaction with a digital customer  or business process, the system needs to extract the data in order to display it. If the user modifies this data or enters new data, they also need to be saved. This is where we use OmniStudio DataRaptors.  Where to use DataRaptors? Retrieving Data:   OmniScript calls  DataRaptor Extract (via the integration procedure) to read the data from Salesforce. For example, OmniScript editing an account should display data such as account name, phone number, website, and so on. Manipulating data: OmniScript captures modified and new data based on user input. For example, an agent changes the  phone number of an account. Save Data:   OmniScript calls DataRaptor Load (via the integration procedure) to write the data back to Salesforce. For example, the updated account phone number is saved back to the Account rec...
Read more

Vlocity Facts #44 || Communication between Omniscript and Flexcard [Pub/Sub]

Image
Flexcards have the ability to trigger and listen to two kinds of events: Custom and Pubsub events . Custom Events: Facilitate the transmission of information between a child and its parent. This can occur between a child Flexcard and its parent Flexcard, or between an element and the Flexcard to which it belongs. Pubsub Events: Allows communication between two separate components. This could occur between two separate Flexcards on the same Lightning page, known as sibling Flexcards, or between a Flexcard and an Omniscript.  In this post I will discuss about Pub/Sub event. Consider we have omniscript and flexcard individually on home page when an update happens we need to show those details in flexcard. To achieve this we can use pub/sub event. Step 1: Create a omniscript according to your requirement. I'm trying to create Contact record by using Step element and data raptor post action. Now to trigger the flexcard we need to configure the messaging frame work when an update happen...
Read more

Vlocity Facts #39 || DataMapper - Functions and Formulas

Image
In Data Mapper we can use functions and formulas to manipulate our data or we can change the out come of the values according to our requirement. In this post we will go through some of the formulas which we used in daily requirements. 1. Consider the following example: we have a list of products and need to filter them depending on their color or name. By using FILTER() function we can separate the list which has Green products. FILTER(LIST(Products),'Color == "Green"') Result: 2. We are getting list of contacts or cases and we need to display those records by sorting with DSC or ASC. By using   SORTBY() we can sort the list by using this formula.   SORTBY ( LIST ( Nephews ),  ' Name ',' [ : DSC ] ' ) Result:  Note: we can use [:DSC] only in Data Mapper Transform. 3. We can use SUM(), AVG(), MIN(), MAX() functions to return the Sum/Avg/Min/Max of the list or individual values. Result:  4. We can executes a SOQL query to produce a JSON list of values. ...
Read more