Skip to main content

Set Workflow Result

Description

Set Workflow Result defines the final outcome of a workflow execution on AutomationEdge for a specific request. Use this process entry to report whether the workflow succeeded or failed, set a completion status, and attach a custom message visible in the AutomationEdge UI. It also supports recording operation counts and custom output parameters that downstream integrations or service desk tickets can consume.

Configurations

Field NameDescription
Process Entry NameSpecify a unique name for the process entry on the workspace area. A process entry can be placed on the canvas several times; and each instance of the entry must have a unique name.
SuccessBoolean value (true or false) can be set 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.
MessageSuccess or error message to be set for the request. Message is governed by the Success set above.
Failure ReasonFailure reason can be set if success is false and status is failure. Choose from the fourteen failure reasons:

1. License invalid

2. Invalid request input

3. Invalid credentials

4. Invalid workflow

5. Agent stopped or restarted

6. Failed to connect to external system

7. Workflow failed to internal reason

8. Error while uploading/downloading file with server

9. Script exited with errors

10. Workflow failure set in OUTPUT.txt

11. Workflow instantiation failure

12. Exceeded maximum execution time

13. Too many pending requests

14. Unknown reason

Total OperationsTotal number of operations performed
SuccessfulNumber of successful operations performed
Attribute 1Additional Attribute 1
Attribute 2Additional Attribute 2
Attribute 3Additional Attribute 3
Attribute 4Additional Attribute 4
Attribute 5Additional Attribute 5
Attribute 6Additional Attribute 6
Output Parameters:
VariableName of the variable to set.
Display NameDisplay name of the variable as seen on AutomationEdge UI.
TypeData type of the variable. You can select either, String or Hyperlink or 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 User 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.