Description:

The clsGenerateID workflow step generates an ID according to the configured ID type and optional ID start value. The resulting next value is stored in the specified Variable or Global variable for use by subsequent workflow activities.

The step supports:

• Selecting an ID generation type.
• Providing an optional ID start value.
• Generating an ID value for workflow processing.
• Storing the generated next value in a Variable or Global variable.
• Reusing the generated value in subsequent workflow steps.
• Generating identifiers as part of workflow automation.
• Returning a True or False result for subsequent workflow processing.

Usage:

The clsGenerateID step is typically placed at a point in a workflow where a new identifier is required.

The workflow supplies an ID type, optionally provides an ID start value, and specifies the Variable or Global that should receive the generated next value.

A typical workflow pattern is:

Prepare Data → Generate ID → Use Generated ID

The resulting value can then be used by later workflow steps to:

• Assign an identifier to a workflow transaction.
• Populate a Variable.
• Build a business reference.
• Associate an identifier with generated output.
• Pass the generated value to another workflow activity.
• Use the value in downstream processing.
• Include the identifier in notifications or messages.
• Use the identifier as part of an integration payload.

Typical Workflow Suggestions:

Generate an ID for a New Request

Use Generate ID when a workflow needs to assign an identifier to a newly created request.

Example:

Start
  ↓
Generate ID
  ↓
Store Request ID
  ↓
Process Request

Generate an ID for a Business Transaction

A workflow can generate an identifier before processing a business transaction.

Example:

Receive Transaction
       ↓
Generate ID
       ↓
Store Transaction ID
       ↓
Process Transaction

Generate an ID Before Creating a Record

Generate ID can be placed before a subsequent record-creation operation when the workflow requires an identifier to be available first.

Example:

Collect Data
     ↓
Generate ID
     ↓
Create Record

Use an Optional Starting Value

When the workflow needs to establish a starting point for ID generation, configure the ID start value property.

Example:

ID type
   ↓
ID start value
   ↓
Generate ID
   ↓
Store Next Value

The exact behavior of the starting value should be validated for the selected ID type.

Generate IDs for Workflow Documents

A document-processing workflow can generate an identifier before creating or processing a document.

Example:

Document Request
      ↓
Generate ID
      ↓
Prepare Document
      ↓
Store/Process Document

Generate IDs for Notifications

A workflow can generate an identifier and then include that value in a notification or message.

Example:

Process Request
      ↓
Generate ID
      ↓
Prepare Notification
      ↓
Send Notification

Generate an ID for Integration Data

You can use the generated ID before an external integration when the integration payload requires a workflow-generated identifier.

Example:

Prepare Integration Data
        ↓
Generate ID
        ↓
Build Payload
        ↓
External Integration

Reuse the Generated Value

The generated value is explicitly stored in a Variable or Global variable.

This allows multiple subsequent activities to reference the same generated value.

Example:

Generate ID
    ↓
variable.NextID
   ↙       ↘
Step A    Step B

Generate an ID for a Process Summary

A workflow can generate an identifier at the beginning of processing and use it throughout a process summary.

Example:

Generate ID
    ↓
Process Request
    ↓
Collect Results
    ↓
Generate Summary

Generate IDs Conditionally

Generate ID can be placed on a particular workflow branch when an identifier is required only under specific conditions.

Example:

                  ┌─ Generate ID → Continue
Decision ─────────┤
                  └─ Other Processing

Generate an ID Before a Subworkflow

A parent workflow can generate an identifier before invoking another workflow activity.

Example:

Generate ID
    ↓
Start Subworkflow
    ↓
Continue Processing

Generate IDs for Repeated Processing

Generate ID can be incorporated into workflows that process multiple business items when each item requires an identifier.

Example:

Process Item
     ↓
Generate ID
     ↓
Store ID
     ↓
Process Item Output

Use a Consistent ID Variable

Use a meaningful Variable or Global name for the generated value.

For example:

RequestID
TransactionID
DocumentID
ReferenceID
GeneratedID

Example:

Let’s build and execute the “generateIdDef” example.          

• Create a new process definition named “generateIdDef” and open it in Designer mode. 
• Drag a few “generateID, and synchronize” steps to the canvas. 
• Connect the dots between the “Start” and other steps, as shown above.
• Select the line between the steps to configure the “Connection Properties”. The default property values are “None, True, False, Error, and Evaluate”. Depending on the step’s purpose, you can configure additional values.
• Define a variable, preferably a global variable, to store the generated ID value.
• Select the first “generateID” step to configure its “Required” properties. Provide a step name. Set the ID type as shown below. In this case, the ID value “CHECK” is suffixed with a unique ID generated by this step. The generated ID values are stored in the “deGenerateID” SQL table. Provide a variable or a global reference to store the generated ID value. Click the Save button. Note: Click the "AI Predict" button to have Copilot add new process steps that match your process description. 

• Select the first “generateID” step to configure its “Optional” properties. Enter the ID start value in any format. Repeat the configuration for the second GenerateID process step. Note: The ID start value must match.   

• The “Logging” configuration is necessary for documentation and to measure workflow progress and percent complete. This is done by configuring the step state and percent fields individually, as shown below. Configure the “Logging” using the following properties.

• Save the process definition, create a new instance, and execute it. Render the process instance and click the Generate ID step to view its properties. When the workflow reaches the Generate ID step, FlowWright uses the configured ID type and optional ID start value to generate the ID. The resulting next value is stored in the specified Variable or Global variable. The generated value can then be referenced by subsequent workflow activities.

•  The generated ID values are stored in the “deGenerateID” SQL table.  

Tips:

• Configure the Enter ID type property before executing the step.
• The ID type property is required. 
• Verify the available ID-generation types in the FlowWright designer before selecting one.
• Use ID start value when the workflow requires a specific starting value.
• Remember that the ID start value is optional. 
• Use a meaningful Variable or Global name for the generated value, such as GeneratedID, RequestID, or TransactionID.
• The destination Variable/Global is required. 
• Test the selected ID type with representative workflow executions before deploying the workflow.
• Verify the generated value after execution.
• Confirm that downstream activities reference the correct Variable or Global.
• Decide where in the workflow an ID should be generated before adding the step.
• Generate the identifier before an activity that requires that value.
• Reuse the stored generated value when multiple downstream activities require the same identifier.
• Avoid generating multiple IDs unnecessarily when one workflow reference is sufficient.
• If a starting value is used, verify the resulting behavior with multiple workflow executions.
• Consider connecting the False return path to appropriate error handling.
• Connect the True path to the normal workflow continuation.
• Test the workflow with different input and configuration scenarios.
• Document the purpose of the generated identifier when maintaining complex workflows.
• If the identifier is used in an external integration, verify that its format and behavior meet the receiving system's requirements.
• Do not assume specific ID formats, sequencing behavior, uniqueness guarantees, reset behavior, or concurrency behavior unless confirmed for the selected ID type and FlowWright implementation.
• Keep identifiers out of log messages when exposing them could reveal sensitive business information.

Definition Sample:

You may download the sample definition(s) from the provided link and later import them (drag-and-drop) into your FlowWright Process Definition (XML file) or Form Definition (HTML file) page.

Before executing a workflow containing the clsGenerateID step, verify:

1. The Generate ID step has been added to the Process Definition.
2. An ID type has been selected.
3. An ID start value has been configured if required.
4. A Variable or Global has been defined to store the generated next value.
5. The upstream workflow activity is connected to the Generate ID step.
6. The True path is connected to the normal continuation path.
7. The False path is connected to appropriate alternate or error handling where required.
8. Logging has been configured if workflow progress needs to be documented.
9. The generated value has been tested with representative workflow executions.
10. The output Variable or Global contains the expected generated value.
11. Downstream activities reference the correct Variable or Global.

Click here to download the sample file.