ID Generation
  • 08 Feb 2022
  • 2 Minutes to read
  • Dark
    Light
  This documentation version is deprecated, please click here for the latest version.

ID Generation

  • Dark
    Light

Article summary

Overview

ID Generation steps are used to generate unique IDs for records. For instance, unique IDs are used for Process Folder Records.

Additional Notes/Resources

Creating New ID Generation Key

To begin creating a new ID Generation Key: 

  1. From a Designer Project, click the CREATE FLOW button on the Global Action Bar; select Flow, provide a Name, and click CREATE.
  2. From the Flow Designer, navigate to and expand Toolbox > INTEGRATION > INTERNAL SERVICES > IDGENERATION category.
  3. Attach and configure any of the various Get[Parameter] steps to the Start and End steps. 
  4. Save the Flow, then close via X.

Get Next ID

Glossary Entry 

Step NameDescriptionLocationInputs/Outputs
Get Next IDGenerates an ID by combining the user input prefix with a numerical value. INTEGRATION > INTERNAL SERVICES > IDGENERATIONInputs: prefix [String]

Outputs: Output [String] 

Use Case: Can be used to generate Unique ID values for Accounts. 


Example

About Debug Results 
Upon run, the step Outputs the ID in the form of the prefix + numerical value. 



Get Next ID Fill With Pad Char

Glossary Entry

Step NameDescriptionLocationInputs/Outputs 
Get Next IDFill With Pad CharGenerates a Key based on three INPUTS, length, pad Char, and prefix.INTEGRATION > INTERNAL SERVICES > IDGENERATION

Use Case: Can be used to generate a unique User ID containing numerical values, a padding character, and a specified prefix. 


Example 

  1. From the Properties tab, define the length, pad Char, and prefix.
    About Inputs 
    • The length Input is used to determine the number of characters in the Key. 
    • The pad Char is the character that appears between the prefix and the final character. 

  2. Debug the Flow. 

    About Debug Results 
    The Flow will output a Key starting the prefix, with as many characters as is defined by the length Input.

    The remaining characters in the Key consist of the pad Char and a number. 



Get Next Number 

Alternatively to the Get Next ID step, users may utilize the Get Next Number step. This step operates by generating a sequence for the user-defined prefix in SQL Server.

The step interacts with SQL Server by increasing the prefix sequence's value each time the step is ran. The step's interaction with SQL Server helps prevent the possibility of duplicate IDs from being generated. 


Glossary Entry 

Step Name DescriptionLocationInputs/Outputs 
Get Next Number Generates an increase numerical value (Int32) for the user input prefix. Interacts with SQL Server to prevent duplicate Output. INTEGRATION > INTERNAL SERVICES > IDGENERATIONInputs: prefix [String]

Outputs: Output [Int32] 


Use Case: Used to generate numerical ID variables. Can be useful for assigning a Unique ID to a user within an environment. 


Example 

To use and configure the Get Next Number step:

  1. From the Flow Designer, navigate to Toolbox > INTEGRATION > INTERNAL SERVICES > IDGENERATION
  2. Attach a Get Next Number step to the Start and End steps.
  3. From the Properties of the Get Next Number step, provide a String value under the prefix Input.
  4. Save the Flow, then click Debug on the Top Action Bar
  5. From the Debugger, select Get Next Number > View Input/Output Data; verify that the step has Output an Int32 value. 

Was this article helpful?