Update Execution Secondary Status

Update the secondary status of the current MFlow execution with custom text. This function allows you to set a custom status message for tracking execution progress or state. The execution ID is automatically retrieved from the current execution context.

Technical Name: UpdateExecutionSecondaryStatusFunc

Properties

Execution Mode: SYNC
Type: NATIVE
Category: System Functions
Function ID: 8e5f2c1d-4b9a-4f8e-a1c6-7d3e9f2a8b4c

Input Schema

Optional Parameters

Parameter	Type	Description
`secondaryStatus`	string	Custom secondary status text to set (any string value, or null/empty to clear)

[Image placeholder: UpdateExecutionSecondaryStatus function configuration panel]

Input Example

Set Secondary Status

{
  "secondaryStatus": "Processing payment batch"
}

Clear Secondary Status

{
  "secondaryStatus": ""
}

Or:

{
  "secondaryStatus": null
}

Output Schema

Field	Type	Description
`executionId`	string (UUID)	The current execution ID that was updated
`secondaryStatus`	string	The secondary status that was set (or null if cleared)
`message`	string	Success message

Output Example

Success Response

{
  "executionId": "a7b9c4d2-3e5f-4a1b-9c8d-7e6f5a4b3c2d",
  "secondaryStatus": "Processing payment batch",
  "message": "Secondary status updated successfully"
}

Clear Status Response

{
  "executionId": "a7b9c4d2-3e5f-4a1b-9c8d-7e6f5a4b3c2d",
  "secondaryStatus": null,
  "message": "Secondary status updated successfully"
}

Use Cases

Track Execution Progress

Update status during long-running workflows:

{
  "secondaryStatus": "Step 3 of 10: Validating customer data"
}

Update Status Based on Conditions

Use in conditional branches to track workflow state:

{
  "secondaryStatus": "{{#if error}}Error occurred: {{errorMessage}}{{else}}Processing completed{{/if}}"
}

Clear Status on Completion

Reset status when workflow completes:

{
  "secondaryStatus": ""
}

Notes

Execution Context: The function automatically uses the current execution ID from the MFlow execution context
Status Format: Secondary status accepts any string value - use it for custom tracking, progress indicators, or state messages
Clearing Status: Pass null, empty string, or whitespace-only string to clear the secondary status
Trimming: Status text is automatically trimmed of leading/trailing whitespace
Error Handling: Throws an error if no execution ID is available in the current context

Run Sub-Workflow - Execute sub-workflows within a workflow

Update Execution Secondary Status

On this page