Configuring the Review Center UI

You can configure the Review Center UI by using the Use Case Management APIs.

To create a new use case type configuration, use POST /api/v1/rpa/exception/usecasetypes.

The request payload of the API includes JSON objects that can be manipulated to modify the UI as per the business use case requirement. The specific objects in the JSON correspond to a component on the Review Center UI. For example:

Category in the Object appear as tabs on the UI. Categories are used to group different review scenarios based on the business requirement.
Subcategories appear within a category and display the data extracted from documents. Thee subcategories are displayed as standard fields for review or correction.

The Review Center also supports IDM document type mapping:

The UI uses the configured document type and attribute, instead of hardcoded values, to query and display document previews
When a document is sent to the Review Center, the idm_document_id in the payload must match the attribute value of the mapped document type
The RPA flow that uploads documents to IDM must use the document type and attribute configured in the Review Center use case type, instead of the previously hardcoded RPAReviewCenter type

The request body is explained below:


Property	Description
Name	The display name or label of an element, such as a document, section, or category within the Review Center interface.
ERP	The source ERP system associated with the review configuration, document, or data being presented in the Review Center.
Categories	The classification groups in which documents, tasks, or review items are organized. Key: The unique internal identifier for each category. Value: The display label or user-friendly name of the category. List Labels: The labels that must be displayed in the list-based views within the Review Center Key: The specific label type or identifier within the list Value: The actual text that must be displayed in the list-based components of the UI.
Subcategories	The nested or child categories under a main category. Key : A unique internal identifier for each subcategory within a category Value: The label of the subcategory that is displayed on the UI Type: The type of value the subcategory represents. Possible values: Standard fields Table Associations: The relationship between the sub-category and other fields such as the categories, or document elements.
Filters	The conditions that determine which documents, fields, or category items must be displayed, processed, or included in the Review Center Key: The name of the data field or attribute on which the filter condition is applied Type: The data type of the value that the filter must evaluate. Possible values: Standard Document Display_name: The user-friendly label that must be displayed in the Review Center UI for the filter Data_type: The format or structure of the data that the filter must evaluate.
Exception_type	The category or classification of an exception that the Review Center must detect, highlight, or require user attention during document review
Default_Category	The category that must be automatically pre-selected or assigned to a document or data field when uploaded in the Review Center UI
idm_document_id	The IDM document type associated with this use case.
idm_doc_attribute	The attribute of the IDM document type that stores the idm_document_id of the document
List labels	The set of labels displayed when a field, category, or filter uses a drop down list or options in the Review Center UI. Key: The internal identifier or system value for an item in a list Value: The user-friendly label displayed in the Review Center UI for each item in a list.
Document_entities	The set of document fields, metadata, and extracted data elements that the Review Center UI must display, validate, or allow users to review during document processing in the RPA application Value: The actual data extracted from the document or the pre-populated field value that the Review Center UI must display for a specific document entity (field) Key: The unique identifier or field name used to represent a specific document entity in the request body. Required: Indicates whether a particular entity field must be provided when making a request Disabled: Indicates whether a particular entity field is editable or interactive in the UI. Field_type: Specifies the type of data that the entity must hold and how it must be displayed or validated in the UI Min_length: Specifies the minimum number of characters or digits required for the value of a field. The default minimum length is considered when a value in this field is not specified. Max_length: Specifies the maximum number of characters or digits required for the value of a field. The default maximum length is considered when a value in this field is not specified. Category_associations: The categories to which the document belongs. These associations determine how the document is grouped, filtered, and displayed within the Review Center. Key: unique identifier for the document within the system. Disabled: Controls whether the document must be Active or Inactive within the Review Center. Possible Boolean values: True False Required: Indicates whether the document is mandatory for the review process. Possible values: True False
Control_Dropdown	Specifies the predefined list of options that a field can present to the user as a drop down selection.
Default_dropdown	Specifies the pre-selected value that is displayed in a drop down field when the UI is loaded
Dropdown_controls	The details of drop down-type fields in the UI. Key: The unique identifier for each option in the drop down list. Value: The label is displayed to the user in the drop down list. Control_fields: Specifies additional related fields or metadata associated with each drop down option Required: Specifies whether selecting a value from the drop down is mandatory for the request to be considered valid Disabled: Indicates whether the drop down field is editable or read-only in the UI Label_key: The localization or display reference key for the drop down label.
Lookup_enabled	Indicates whether a lookup or search functionality is enabled for a field, typically for drop downs or reference fields
Lookup_metadata	Additional configuration or details for lookup-enabled fields: Attributes: Specifies additional fields or properties from the lookup source that must be retrieved or displayed along with the main lookup value. Example: Vendor Name, contact Message: A custom user-facing notification, hint, or error message related to the lookup operation
Table_definitions	Specifies the structure, columns, and behavior of table-type document entities displayed in the UI
Name	Specifies the unique identifier or label within the request and UI
Column_definitions	Defines the structure, behavior, and attributes of columns within a table-type document-entity Key: The unique identifier for a column that is used internally by the system to reference that column. Display: Specifies whether the column must be visible to the user in the UI Type: Specifies the data type or input type of the column, which determines how the column behaves in the UI and how data is validated. Min_length: Specifies the minimum number of characters or digits required for a column. The default minimum length is considered when a value in this field is not specified. Max_length: Specifies the maximum number of characters or digits required for a column. The default maximum length is considered when a value in this field is not specified Category_associations: Specifies the link between a column and one or more categories or classification types that determine how the data is processed, validated, or displayed Disabled: Specifies whether a column is editable or read-only in the UI. Possible values: True False Required: Specifies whether the column must have a value entered by the user before submission