Skip to main content

Set Workflow Result

Description:

Set Workflow Result defines the final outcome of a workflow execution on the AutomationEdge Server for a specific request. Use this step to report whether the workflow succeeded or failed, set a completion status (Complete, Failure, or Diverted), and attach a custom message that appears in the AutomationEdge UI. It also lets you record operation counts, populate up to six custom display attributes visible on the Requests page, and define output parameters that downstream integrations or service desk tickets can consume. This step is typically placed at the end of a workflow to communicate results back to operators and connected systems.

Configurations

Field NameDescription
Step nameSpecify the unique step name for a single workflow.
SuccessSpecify True or False to define the request status (Success or Failure)
StatusStatus can be set from one of the following: Complete, Failure or Diverted.
Status can be set irrespective of value set in Success above.
MessageWrite the success or error message to be set for the request in this field.
Since Success field can have two values and Status field has three values, the following combinations are possible.
Success field - Status Field
True - Complete
True - Diverted
True - Failure
False - Complete
False - Diverted
False - Failure
The message format is governed by the Success field set above.
If Success is True message is prefixed with Message.
And if success is False, message is prefixed with Error:
The exceptions are the combinations of True-Failure and False-Complete. For these combinations no message is displayed.
Total OperationsTotal number of operations performed such as no. of lines processed in a file.
The value in this field can be viewed in the
Status-wise Workflow Operations Report
Successful OperationsNumber of successful operations performed.
The value in this field can be viewed in the Status-wise Workflow Operations Report.
Attribute 1Additional Attribute 1.
This attribute can be chosen for display as columns in Requests in AutomationEdge UI.
Attribute 2Additional Attribute 2.
This attribute can be chosen for display as columns in Requests in AutomationEdge UI.
Attribute 3Additional Attribute 3.
This attribute can be chosen for display as columns in Requests in AutomationEdge UI.
Attribute 4Additional Attribute 4.
This attribute can be chosen for display as columns in Requests in AutomationEdge UI.
Attribute 5Additional Attribute 5.
This attribute can be chosen for display as columns in Requests in AutomationEdge UI.
Attribute 6Additional Attribute 6.
This attribute can be chosen for display as columns in Requests in AutomationEdge UI.
Output file name patterns (separated by comma)This field has been added for integration support. This field accepts a comma separated filename regex. These files would be available with the Service Request/Ticket on the Service Desk upon successful updation by an AE workflow.
Output Parameters:Note:
The step allows a maximum of 128 characters for the output parameter value when generating parameters. If the message exceeds this limit, the system automatically trims it to 128 characters when it passes through Set Workflow Result.
This trimming applies only to values sent as parameters. Messages defined within the step display the full content.[SG2]
NameSpecify the internal name of the variable.
Display NameSpecify display name of the variable as seen on AutomationEdge UI
TypeSelect data type of the variable.
Available values:
- String
- Hyperlink
- AE-AppLink.
Note:
- If you select Hyperlink, then you can provide links to external sites. You can access the link through the Requests page in AE UI.
- If you select AE-AppLink, then you can provide the app ID, display text, and page details of the AE app in the Set Value (AE-AppLink) dialog, which the user can access through the AE UI.
For details about the apps, see AE Apps in the User Guide.
For more details about accessing the external sites or AE apps, see Requests in the AutomationEdge User’s Guide.
ValueProvide the value of the variable. Value could be static, field or a variable.
Note: If the Type is:
- Hyperlink, then the Set Value (Hyperlink) dialog appears. In the dialog, enter the URL and the text you want to display for the URL in the Link and Display text fields, respectively.
- AE-AppLink, then the Set Value (AE-AppLink) dialog appears. In the dialog, enter the app ID, display text, and page details of the AE connected app in the App id, Display text, and Page and Page parameters fields.
Plain TextUse the Plain text setting to control how the step sends data to the AE Server. The secret status of upstream fields or protected variables automatically travels to the step.

· Select N (the default setting) to securely encrypt the data. The AE Server receives and stores only the encrypted ciphertext.

· Select Y to send the actual, unmasked value. The AE Server receives and stores the plain text data.

Note: Non-secret fields always send as plain text.

Runtime behaviour:

· At runtime, the value is treated as Secret if the incoming field is marked as Secret or if it is a ${var} reference that resolves to a Secret PS variable, Secret parameter, Credential, or credential attribute.

· If the value is Secret and Plain text is No (default), it is encrypted before being sent to the AE Server, and only the encrypted value is stored. If Plain text is Yes, the actual value is sent and stored as plain text.

· If the value is not Secret, it is sent as plain text, which matches the legacy behavior.

Important:

· Select Y only when explicitly required. Whenever possible, keep this set to N to ensure the AE Server database does not store sensitive credentials as plain text.

· The system saves the Y selection directly within the workflow file. This ensures security reviewers can easily audit the workflow and identify any field configured to expose plain text data.

· Renaming a secret column using the Rename Fields step removes the secret status and exposes the data as plain text. Avoid using this step for sensitive data.

· Modifying data upstream, for example, using a Calculator step to build "Token: " + secretField, treats the result as a new field and removes the secret status.