Description:

The GetCPUMemoryUtilization workflow step retrieves CPU and memory resource utilization information from the server and stores the values in the specified Variables or Global variables.

The step supports:

• Retrieving server CPU utilization.
• Retrieving server memory utilization.
• Storing CPU utilization in a Variable or Global variable.
• Storing memory utilization in a Variable or Global variable.
• Using the retrieved resource information in subsequent workflow activities.
• Returning a True or False result for subsequent workflow processing.

Usage:

Place the GetCPUMemoryUtilization step when a workflow needs to obtain the current server CPU and memory utilization before subsequent processing.

A typical workflow pattern is:

Get Server Resources → Evaluate Resources → Continue Workflow

The retrieved values can then be used by later workflow steps to:

• Monitor server resource utilization.
• Record CPU utilization.
• Record memory utilization.
• Evaluate resource values before performing processing.
• Control workflow routing.
• Trigger resource-related notifications.
• Provide resource information to downstream workflow activities.
• Support operational monitoring workflows.
• Store resource measurements for later processing.

Typical Workflow Suggestions:

Monitor Server Resource Utilization

Use the step when a workflow needs to retrieve server CPU and memory utilization.

Example:

Start → Server Resources → Evaluate Resources

The CPU and memory values are stored in the configured Variables or Global variables.

Check Resources Before Resource-Intensive Processing

Use GetCPUMemoryUtilization before an activity that may perform substantial processing.

Example:

Server Resources → Evaluate CPU/Memory → Processing Activity

The workflow can retrieve current resource values and then use subsequent logic to decide how to proceed.

Route the Workflow Based on CPU Utilization

Store the CPU utilization in a Variable and use it in a subsequent decision or evaluation activity.

Example:

Server Resources → Evaluate CPU Use → Route Workflow

The workflow can use the retrieved CPU value as an input to its subsequent processing logic.

Route the Workflow Based on Memory Utilization

You can similarly store and evaluate the memory utilization value before continuing the workflow.

Example:

Server Resources → Evaluate Memory Use → Continue/Alternative Path

This can be useful when workflow processing needs to account for server resource conditions.

Monitor Both CPU and Memory

Use the step when both CPU and memory information are required by the same workflow.

Example:

Start → Server Resources → Evaluate CPU and Memory → Continue Process

The step provides separate Variables or Global variables for CPU use and memory use.

Record Resource Utilization

Use the step as part of an operational or monitoring workflow that records resource measurements.

Example:

Server Resources → Store Resource Values → Monitoring/Reporting Activity

The retrieved CPU and memory values can be passed to subsequent activities for recording or reporting.

Generate a Resource Monitoring Notification

Use the retrieved resource values as inputs to a notification workflow.

Example:

Server Resources → Evaluate Resources → Send Notification

For example, the workflow can retrieve CPU and memory information, then use subsequent workflow logic to determine whether to generate a notification.

Prepare Resource Information for Another Workflow Activity

Use GetCPUMemoryUtilization as an intermediate step when a downstream activity requires server resource information.

Example:

Server Resources → Prepare Resource Data → Downstream Activity

The CPU and memory values are stored in Variables or Global variables and become available to subsequent workflow processing.

Periodic Server Resource Monitoring

You can incorporate this step into a workflow that runs periodically to collect server resource information.

Example:

Scheduled Workflow → Server Resources → Store Measurements → Monitoring Process

Each workflow execution can retrieve CPU and memory values and pass them to subsequent processing.

Use the True and False Paths

Use the two return paths to separate successful resource retrieval from alternative processing.

Example:

                         ┌── True → Evaluate Resources
Start → Server Resources
                         └── False → Handle Failure

Example:

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

• Create a new process definition named “getCPUMemoryUtilizationDef” and open it in the designer.
• Drag a "getCPUMemoryUtilizationDef" step to the canvas. 
• Connect the dots between the “Start” and “getCPUMemoryUtilizationDef” 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 variables or globals to store the CPU and Memory values.
• Click the “getCPUMemoryUtilizationDef” step to configure its “Required” properties. Provide a name for the step. Click the button to configure the business object’s parameters, then click Save. Note: Click the "AI Predict" button for the Copilot to add new process steps that match your process description. 

• The “Logging” configuration is necessary for documentation and to measure workflow progress and percent complete. Configure the step state and percent fields individually, as shown in the images 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 Server Resources step to view its properties. When the workflow reaches the GetCPUMemoryUtilization step, FlowWright retrieves the server CPU and memory resource utilization. The retrieved CPU value is stored in the Variable or Global variable configured in Variable or Global to CPU use. The retrieved memory value is stored in the Variable or Global variable configured in Variable or Global to Memory use. The workflow can then continue through the True path or use the False path for alternative or error-handling processing.

Tips:

• Configure both required output Variables or Global variables before executing the step.
• Use meaningful Variable names such as varCPUUse and varMemoryUse.
• Verify that the Variables or Global variables configured for CPU and memory are available to downstream activities.
• Test the workflow in the target server environment.
• Verify the stored CPU value after the step executes.
• Verify the stored memory value after the step executes.
• Use separate Variables when CPU and memory values need to be evaluated independently.
• Use a subsequent decision or evaluation activity when workflow routing depends on the retrieved resource values.
• Connect the True path to the normal workflow processing path.
• Connect the False path to appropriate alternative or error-handling logic.
• Consider recording resource measurements when the workflow is being used for operational monitoring.
• Avoid assuming the exact unit, scale, precision, or representation of the CPU and memory values unless confirmed by the FlowWright implementation.
• Do not hard-code assumptions about threshold values into the documentation; define thresholds according to the requirements of the specific workflow and environment.
• Test resource-based workflow conditions using representative server conditions.
• Verify the workflow after changing the Variables used to store CPU or memory information.
• Avoid excessive logging if the workflow executes frequently.
• When building monitoring workflows, consider how often to collect resource measurements.
• Treat the retrieved resource values as measurements for the execution environment in which the workflow is running.
• Do not assume that the step retrieves historical, averaged, or predictive resource utilization; the supplied XML only identifies the step as retrieving server CPU and Memory resources.

Definition Sample:

You may download the sample definition(s) from the link provided and later import them into your FlowWright Process Definition (XML file) or Form Definition (HTML file) page, following the same approach described in the supplied SearchAndReplaceString documentation.

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

• Variable or Global variable for CPU utilization.
• Variable or Global variable for memory utilization.
• Workflow Variable references.
• Environment-specific server configuration.
• Any subsequent resource-evaluation logic.
• Downstream True and False workflow paths.
• Monitoring, logging, notification, or reporting activities.

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

Click here to download the sample file.