Description:

This step retrieves the unique identifier of the currently executing Process Definition.

The Get Process Definition ID workflow step retrieves the unique Process Definition ID for the currently executing workflow and stores it in a FlowWright Variable or Global Variable.

The retrieved Process Definition ID can be used by downstream workflow steps for reporting, auditing, REST API calls, process management, integrations, logging, and other scenarios that require a unique reference to the current Process Definition.

This step provides an efficient way to access workflow metadata without requiring custom code or database queries.

The step supports:

• Retrieving the current Process Definition ID
• Storing the ID in a Variable or Global Variable
• Integration with workflow metadata
• Process identification
• Support for reporting and auditing
• Integration with FlowWright workflow automation

This step can be used for:

• Process auditing
• Workflow reporting
• REST API integrations
• Process tracking
• Logging
• Workflow administration
• Business process automation

Usage:

The Get Process Definition ID step is typically placed near the beginning of a workflow when subsequent activities require the unique identifier of the currently executing Process Definition.

The workflow retrieves the Process Definition ID, stores it in the configured Variable or Global Variable, and makes it available for later workflow activities.

A typical workflow might look like this:

Once the Process Definition ID has been retrieved, later workflow steps can:

• Call FlowWright REST APIs
• Create audit records
• Generate reports
• Update workflow variables
• Log execution details
• Associate external records with the current Process Definition
• Continue workflow execution

The workflow must be executing within a valid FlowWright Process Definition before this step is executed.

Example:

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

• Create a new process definition named “clsProcessDefIDDef” and open it in designer mode. 
• Drag a “clsProcessDefID” step onto the canvas. 
• Connect the dots between the “Start” step and the “clsProcessDefID” step, as shown above. 
• Define a variable or a global to store the result.
• Click the "clsProcessDefID" step to configure its "Required" properties. Provide a name for the step. Provide the variable or global reference to store the process definition GUID. Click the Save button. Note: Click the "AI Predict" button to have the Copilot add new process steps that match your process description.

• The “Logging” configuration is necessary for documentation and also measures workflow progress and percent complete. This is achieved 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 Process Instance and execute it. When the workflow reaches the Get Process Definition ID step, FlowWright retrieves the unique identifier of the currently executing Process Definition and stores it in the configured Variable or Global Variable. If the operation completes successfully, the workflow follows the True return path. If the Process Definition ID cannot be retrieved because the workflow is not executing within a valid process context or an internal processing error occurs, the workflow follows the False return path. Click the process step to view its properties. The step should successfully populate the configured Variable or Global Variable with the Process Definition ID and return True upon completion.

• You must navigate to the Process Definition page and search for the definition by name. Use the column selector to display the DefinitionID column in the table. You notice that “definitionID” matches the variable or global that holds the GUID value from the process instance.   

Tips:

• Store the Process Definition ID in a Global Variable if multiple workflow steps require access to it.
• Use the retrieved Process Definition ID when calling FlowWright REST APIs that operate on process definitions.
• Include the Process Definition ID in audit logs to simplify troubleshooting and reporting.
• Combine this step with process metadata, reporting, or monitoring workflows.
• Use workflow variables to pass the Process Definition ID to external applications or integration services.
• Capture the Process Definition ID early in long-running workflows for consistent tracking.
• Use the True and False return paths to implement appropriate success and exception handling.
• Combine this step with Get Process Instance ID, REST Call, Get Open and Overdue Task Summary, Get Open and Overdue Task List, Update Variables, or Send Email workflow steps to automate process monitoring and administration.

Notes:

• This step retrieves the ID of the currently executing Process Definition only.
• The retrieved identifier is unique within the FlowWright environment.
• The Process Definition ID is stored in the configured Variable or Global Variable.
• The workflow must be executed within a valid Process Definition context.
• Internal workflow execution errors or invalid execution contexts may cause the step to return False.
• This step retrieves workflow metadata only and does not modify the Process Definition.
• The workflow should include appropriate handling for both True and False return paths.
• The Process Definition ID is particularly useful for integrations, reporting, auditing, process management, and API-based workflow automation.

Definition Sample:

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

Note: Verify and complete any missing configuration after importing the sample, including:

• Variable or Global Variable mapping
• Workflow variable definitions
• REST API integration settings
• Logging configuration
• Environment-specific settings

After verifying the configuration, save the Process Definition before execution.

Click here to download the sample file.