Learn about different basic components of the user interface (UI)
The Parashift user interface is designed to be user-friendly and easy to navigate. It features a clean, intuitive layout that allows users to quickly access and use the platform's features and functions. In this introduction, we will explore some of the key aspects of the Parashift user interface and how it can help users be more productive and efficient.
Basic Layout:
When the user logs in and lands up on a certain tenant, the interface shows a document overview page (see also this article on the basic layout). The whole layout has the following 4 major components.
1. Name and Logo
The top-left corner of the interface is where the user places their logo and customizes it.
2. Menu
Upon opening the app, the user can find the main menu located on the left sidebar. This menu contains four main sections:
-
- Documents
- Configuration
- Development
- Reports
3. User & Tenant
In this part of the UI, the user can view and access information about the current tenant they are associated with. This may include the tenant's name, ID, and other relevant information. Additionally, if the user is a part of multiple tenants, they can use this section of the UI to quickly and easily switch between different tenants. This allows them to view and access information and features specific to each tenant, without having to navigate through the rest of the app. The UI for this section includes a drop-down menu or a list of tenant names that the user can select from, as well as a button or link to initiate the tenant-switching process.
a) Active tenant, click to switch tenants
Learn more: Switch tenants
b) User Settings
Learn more: User Settings
3. Main content
The left sidebar contains a menu of options that allows users to easily access the different features and functions of the web app. Depending on the option chosen, the main content area of the interface will display the relevant information or tools. For example, if the user selects the "Overview" option, the main content area will show a list of their current documents in the tenant and allow them to manage and track their state and progress. The left sidebar also provides quick access to settings and other tools, allowing users to customize their experience and work more efficiently.
Documents
Upon clicking on the "Document" section of the left sidebar, the user is presented with five sub-sections. The first sub-section, labeled "Overview," opens a list of all the documents present in the tenant in the main content area of the app. This list provides an overview of the documents, including the document name, date created, and status etc.
The other four sub-sections, labeled "Separation," "Classification," "Extraction," and "QC Operations," show only the documents that are currently in the corresponding document processing workflow stage. For example, the "Classification" sub-section will show only the documents that have been separated and are currently being classified.
Sidebar - Documents
These sub-sections allow the user to easily view and manage the documents that are in each stage of the document processing workflow, without having to search or filter through the entire list of documents in the tenant. The user can use these sub-sections to view the details of individual documents, as well as to perform actions associated with those stages.
The UI for this section may include a list or table of the documents in each sub-section, with options to sort, filter, and search through the list. The user can also use this section to view detailed information about individual documents and to perform actions such as editing document metadata or annotating the document content.
The top bar of the main content has some preset filters based on the status, e.g.Pending, Separation, Classification, Extraction, QC, Done, Exported, Failed, etc. One can create a customized filter and save that filter.
Different sorting criteria are available, as shown below.
There are two different views available, namely Standard View and Expert View. The latter show some more e.g. document id, workflow step explicitly written, owner tenant id (shown below).
Standard View
Expert View
The additional columns here are the document id, the name of the workflow step and status, and the id of the owner's tenant. Upon selecting some documents the user can perform some bulk actions.
Bulk Action
The bulk action feature on the platform and with which, upon filtering and selecting some docs you can perform bulk classification, deletion, reset, copying of ids, etc.
It is important to mention here that the bulk actions will fail if any of the documents are locked. One can go to the details view of the locked document and unlock it before proceeding with the bulk action. More on this is here in the release notes.
Configurations
Upon clicking on the "Configuration" section of the left sidebar, the user is presented with four sub-sections. The user can edit and delete existing configurations of documents, fields, fieldsets, or workflows, as well as create new ones. The interface is intuitive and easy to navigate, allowing the user to quickly and efficiently manage their configuration settings.
Sidebar – Configurations
In the "Document Types" sub-section, the user can view a list of all the available document types, along with their associated metadata and settings. The user can edit the settings for each document type, including setting default values for fields and defining the structure of the document.
The "Fields" sub-section allows the user to view a list of all the available fields, along with their data types and other settings. The user can edit the settings for each field, including defining the field's name, description, extractor, data type, verifiers, transformers and other attributes.
The "Fieldsets" sub-section allows the user to view a list of all the available fieldsets, along with their associated fields and other settings. The user can edit the settings for each fieldset, including defining the fields that are included in the fieldset and the order in which they are displayed, name, description, extractor, data type, verifiers, transformers, and other attributes.
The "Upload" sub-section allows the user to view and manage their upload configuration settings. The user can create new upload profiles, specifying the workflow and separation settings for each profile. The user can also edit and delete existing upload profiles as needed. Additionally, the user can edit and delete existing configuration settings, as well as create new ones. The interface is intuitive and easy to navigate, allowing the user to quickly and efficiently manage their configuration settings.
Development
Additionally, the user can edit and delete existing API keys and webhooks, as well as create new ones. The interface is intuitive and easy to navigate, allowing the user to quickly and efficiently manage their development settings.
Sidebar – Development
In the "API Keys" sub-section, the user can view a list of all the available API keys, along with their associated metadata and settings. The user can edit the settings for each API key, including defining the key's name, description, and access levels.
The "Webhooks" sub-section allows the user to view a list of all the available webhooks, along with their associated metadata and settings. The user can edit the settings for each webhook, including defining the webhook's URL, event triggers, and payload data.
Overall, the Development section of the app provides the user with powerful tools for integrating their app with external systems and automating their workflow. These features are essential for developers looking to build robust, scalable applications.
Reports
Upon clicking on the "Reports" section of the left sidebar, the user is presented with Five sub-sections.
Sidebar – Reports
Clicking on the "Dashboard" sub-section, the user can view various graphs and charts summarizing the usage of the documents, the average processing time, the throughput time, and any corrections that were made. The user can filter the data by selecting a time period, document type, and user.
Clicking on "Process Time" sub-section, the user can view a detailed breakdown of the processing time for each document. The user can filter the data by selecting a time period, document type, and user.
Clicking on the "Activity" sub-section, the user can view a summary of different activities performed on the documents, such as the average processing time, the number of documents that met the service level agreement, the total number of documents processed, and counts of various tasks such as separation, classification, extraction, and export. The user can filter the data by document type, validation profile, and time period.
Clicking on the "Document errors" sub-section, the user can view a summary of errors that occurred during the processing of the documents. The user can filter the data by document ID, document type, workflow task, and time period.
Clicking on the "Field errors" sub-section, the user can view a detailed breakdown of errors that occurred at the field level, including the values, page numbers, and coordinates of the errors. The user can filter the data by document ID, document type, error location, workflow task, and time period.
