Human in Loop
Description
Use the step to create Approval tasks on AutomationEdge Portal (AEUI).
Prerequisite: You must define a Task Template in the AutomationEdge portal (AEUI). For more Information, see Work with Tasks in the AutomationEdge User's Guide.
Note: Select Pause Workflow in the task template to pause workflow execution until the approver takes action. The request state changes to Awaiting Input, and the agent thread stays blocked until:
- The approver takes action on the task.
- An admin cancels the request due to no action from the developer.
Important: Tasks do not auto-cancel. One of the actions mentioned earlier is required. This behavior affects agent availability when you use related task templates.
Configurations
| No. | Field Name | Description |
|---|---|---|
| 1 | Step name | Specify the unique step name for the workflow. |
| General Tab | ||
| 1 | Task template name | Specify the task template name created in AE UI. The field accepts variable or static values and is mandatory. Notes: • The task template name is case-sensitive. Specify it exactly as defined in AE UI. • While creating the task, the AE UI refers to the specified template and displays the action buttons on the approval page. • Based on the selected template, the AE UI also determines whether workflow execution pauses until the task request is approved. |
| 2 | Task title | Specify the title for the task. The field accepts variable or static values. Note: If specified, AE UI creates the task with the specified title; otherwise, it uses the default title defined in the template. |
| 3 | Action deadline (Duration) | Specify the duration for the task in minutes (m), hours (h), or days (d). Examples: • 30m or 1h or 1d • 2d 20h 10m The duration sets the deadline for approvers to take action on the assigned task. The field accepts variable or static values and is mandatory. Notes: • Approvers can view the remaining time in Pending Tasks in the AE UI. • If no action is taken within the specified duration, the approver sees an Overdue tag on the Pending Tasks page. • For more information, see Work with Tasks in the AutomationEdge User's Guide. |
| 4 | Approvers | Specify a valid AE user’s group, valid AE user’s, or both to send the request. Specify approvers as: - A single user - A single user group - Multiple users - Multiple user groups - A combination of users and groups (separated by commas). One of these fields is required. The field accepts variable or static values and is mandatory. Notes: • In the current plugin version, manually enter the exact username (used to log in to the AE UI) or the group name (for groups). • The task is completed when any nominated user or any member of a nominated group takes an action. After that, the task is marked as Completed and appears in History under the Tasks tab. The task is resolved on a first-come basis. • All valid AE users in the selected group or AE users receive the task in their Pending Tasks list. • For more information, see Pending Tasks in the AutomationEdge User’s Guide. |
| 4.1 | Approver (Groups) | Specify one or more valid AE user groups to assign the task. Separate multiple groups with commas. |
| 4.2 | Approver (Users) | Specify one or more valid AE usernames (used to log in to the AE UI) to assign the task. Separate multiple usernames with commas. |
| Approval Data Mapping Tab | ||
| 1 | Template metadata type | Select the template metadata type from the list: 1. Use template metadata defined at server: Use data fields defined in the Task Template. 2. Use Server Compatible Metadata generated at Runtime: Define Meta JSON at runtime. You can pass either the field name or a variable that contains the JSON. This field is mandatory. |
| 1.1 | Key-Value tabular field table | Specify the key and value to be displayed on the pending task. Note: The tabular field is available only if the Template Metadata Type is set to Use template metadata defined on the server. - Key: Specify the unique key associated with an attribute defined in the template metadata on the server. - Value: Specify the value associated with the key. |
| 1.2 | Meta JSON (Field/Variable) | Specify a JSON field or variable that contains the JSON data used to generate server-compatible metadata at runtime. Note: Enabled only if the Template Metadata Type is set to Use server-compatible metadata generated at runtime. Disabled otherwise. The field accepts variable or static values. |
| Output Tab | ||
| 1 | Task ID | If Pause Workflow is not selected in the template on the AE UI, this step returns the task ID of the created task. You can use the task ID to perform further actions. This ID is available in the field defined under Task ID. |
| 2 | Task response | If Pause Workflow is checked in the selected template, this step returns the task response of the created task and waits until an action is taken. |