Skip to main content

Reject/Repair

Description

Use the step to create a Document Reviews task in the Pending Tasks tab on the AutomationEdge portal (AE UI). The approver can then review and edit the extracted data from the document.

Prerequisite

  • A Task Template must be defined in the AE UI. For more details, see Work with Tasks in the AutomationEdge User's Guide.
  • To use a predefined document structure, you must define Document Metadata in AE UI. See Document metadata Type in the configuration table.

Note: The selected template must be of type Document Review. For more information, see the Work with Tasks section in the AutomationEdge User’s Guide.

Important: Ensure that the Auto Delete Input Files option in the Workflow Configuration is unchecked after publishing and before running the workflow from the agent, if the Document file input parameter name option is used. For more details, see Work with Task section in the AutomationEdge User’s Guide.

Configurations

No.Field NameDescription
1Step nameSpecify the unique name for the workflow.
Multiple documents can be attached to a document review task. The workflow designer decides how to process these documents:
• Option 1: Process all documents first and then create a single review task that attaches all documents together.
• Option 2: Process documents one by one and attach each document to the same review task incrementally.
This flexibility lets the designer align the workflow with the required review and approval strategy.
For Option 2, the user selectes the Task already exists? checkbox and enters the ID of the existing task in the Task ID field.
No.Field NameDescription
2Task already exists?Check Task already exists? Checkbox to use an existing task and then enter the Task ID. In this case, you do not need to configure other fields such as the template, approvers, or deadline.
Unchecked If the task does not exist, specify the template details in the General tab.
Note: A document review task can include multiple attached documents. To process them one by one and attach them incrementally to the same review task, check the Task already exists? checkbox, and enter the ID of the existing task in the Task ID field.
3Task idIf the task already exists, specify or select the task id.
Note: The field is available if you select the Task already exists? checkbox.
The field is mandatory.
General tab:Note: If Task already exists? Checkbox is checked; the following fields are disabled.
1Task template nameSpecify 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.
2Task titleSpecify the title for the task.
The field accepts variable or static values.
Note: If specified, AE UI creates the task with specified title; otherwise, it uses the default title defined in the template.
3Action deadline (Duration)Specify the duration for the task in minutes (m), hours (h), or days (d).
For example:
• 30m or 1h or 1d
OR
• 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.
4ApproversSpecify a valid AE user’s group, valid AE users, or both to send the request.
Specify approvers as: A single user, A single user group, Multiple users, Multiple user groups, or 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.1Approver (Groups)Specify one or more valid AE user groups to assign the task. Separate multiple groups with commas.
4.2Approver (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.
5Output fieldThe step returns the task ID of the newly created document review task. You can use this ID to perform further actions.
Default Value: task_id
Documents tab:Click add (+) to add documents. A dialog box appears for entering details. You can add multiple documents, edit the details of a particular document, or delete a specific document as needed.
1Document metadata typeSelect the document metadata type from the list.
Available types are:
1. Use Document metadata defined on the server: Select to use data fields defined in the document metadata. For more information, see section Work with Tasks in AutomationEdge User’s guide.
2. Use server-compatible Document metadata generated at runtime: Select to define Meta JSON at runtime. You can pass either the field name or a variable that contains the JSON.
3. Use Document metadata generate at runtime (raw Json): Select If you have already generated metadata JSON.
Note: Metadata must still be provided in JSON format; however, the JSON can follow any structure. In this case, AE does not render a UI—the JSON is displayed as-is.
2Document codeSpecify the Document code same as defined in AE UI.
Note: If you select Use server-compatible Document metadata generated at runtime or Use Document metadata generate at runtime (raw Json) as the metadata type and the server has no metadata defined, provide a unique name to identify the document.
The field is mandatory.
Since this step creates document review tasks, the processed document file and extracted data can be sent to the server for task creation using one of the following:
• Specify file path from which the data being extracted to AE UI.
• Specify input file parameter name if the file is uploaded directly through the input parameter. You do not need to upload it again, as the server already has a copy of the input file.
No.Field NameDescription
3Document source file pathSpecify path of the document to be uploaded on the server while creating the document review task.
Note: Make sure to specify the full document path including filename.
The field accepts variable or static values
3.1Document file input parameter nameSpecify input parameter name that refers to the document file.
Note: Use if the file is already uploaded to the server as an input.
Specify the following field details, if you set the Document metadata type as Use Document metadata defined on the server. The user needs to define runtime values for the metadata that has been defined on the server.
No.Field NameDescription
1Document meta keySpecify unique key associated with a specific attribute defined in the metadata on the server.
2Extracted valueThe actual value extracted from the document for the specified attribute.
3Coordinate detailsSpecify the coordinates for the extracted values.
AE UI can use this information to highlight the extracted value in the document.
4Table json formatSelect the table format of the extracted value.
Available Formats:
• None- Select this option if the value is obtained from a step other than DocEdge:Get Table or DocEdge:GenAI
• DocEdge:Get Table - Select this option if the value is obtained from the DocEdge:Get Table step.
• DocEdge: GenAI - Select this option if the value is obtained from the DocEdge: GenAI step.
Notes:
• If the attribute type is defined as a table on the server, you can select the appropriate format from the dropdown.
• If a format other than None is selected, a compatible JSON must be provided in the Extracted Value field.
5Confidence levelSpecify the confidence level as High, Medium or Low for the extracted value.
The confidence level appears on AE UI as follows:
• Low: appears next to the extracted data.
• Medium: appears next to the extracted data.
• High: appears next to the extracted data.
Note: Confidence level is case sensitive, for example, use Low and not low.
6Meta JSON (Field/Variable)Specify a JSON field or variable based on the selected metadata type.
Note: Enabled if you set metadata type as Use Document metadata generated at runtime (raw JSON) or Use server-compatible metadata generated at runtime. Disabled for Use Document metadata defined on the server.