Main data model entities for Document intelligence
The main data model entities associated with Document intelligence are as follows: Document request, Document pipeline, Document pipeline step, Document definition, Pipeline step definition, and Step field definition.
Solution-aware entities
A solution-aware entity has each record as a component in a solution. The entity is imported and exported as part of the solution. In a managed solution, you cannot delete the records but only deactivate them. The fields can be defined localized. This means that their values can be translated, and the values can exist in multiple languages within the same environment. In an upgrade scenario, the records that are modified will not be overridden.
In Document intelligence, the definition records can be shipped as part of the customization solution that contains both the definitions and their related flows. The fields whose values are displayed in the user interface can be defined as localizable, and can support a multilanguage environment (the steps and fields' display names, the step states' descriptions, and the pipeline recommendations).
The following are solution-aware tables: Document definition, Pipeline step definition, and Step field definition.
Document request
The main entity for managing and processing documents.
| Name | Description | Comments |
|---|---|---|
| Context | Polymorphic lookup to the context entity of the document request. | |
| Regarding | Polymorphic lookup to the entity, which is associated with the document. | |
| Description | A brief description of the document request. | |
| Document | A lookup to the actual document record. | |
| Document definition | A lookup to the document definition table, which provides relevant metadata regarding the document type. | |
| Is auto updated | A Boolean value to indicate whether the document was updated automatically or not. | |
| Latest pipeline | A lookup to the last pipeline, which was executed for the current document. | |
| State | The status of the document: In review, Missing, Rejected, or Approved | Missing file (104800000) Pending review (104800001) Approved (104800002) Rejected (104800003) |
| State updated on | The date on which the document status was updated. | |
| Uploaded on | The date on which the document was uploaded. |
Document pipeline
Shows the results of an executed pipeline.
| Name | Description | Comments |
|---|---|---|
| Document request | A lookup to the document request. | |
| Pipeline document state | The status of the document determined by the pipeline workflow. | |
| Pipeline state | The run status of the pipeline workflow: Running, Failed, or Succeeded | Running (104800000) Success (104800001) Failure (104800002) |
| Trigger custom pipeline on | A date field that triggers the custom pipeline when changed. | Unclear (104800000) Rejected (104800001) Approved (104800002) |
Document pipeline step
Shows the results of an executed pipeline step of a document.
| Name | Description | Comments |
|---|---|---|
| Document pipeline | A lookup to the pipeline workflow that the pipeline step is related to. | |
| Output | The formatted output of the pipeline step. | |
| Pipeline step definition | A lookup to the Pipeline step definition table, which provides the metadata of the pipeline step. | |
| Pipeline step state | The run status of the pipeline step: Running, Failed, or Succeeded. | Running (104800000) Success (104800001) Failure (104800002) |
| Pipeline step document state | The status of the document determined by the current pipeline step. | Unclear (104800000) Rejected (104800001) Approved (104800002) |
| Raw output | The actual output of the pipeline step logic (AI Model, Third Party, API, and so on.) |
Document definition
The definition of a document type for processing. Each definition can have a different workflow.
| Name | Description | Comments |
|---|---|---|
| Document definition | A unique identifier for entity instances used in the flow for identifying the document definition. | |
| Name | The name of the document definition. | |
| Description | The description of the additional or specially requested document for the application. | |
| Is Automatic Flow | A flag that indicates whether the document type has an automatic document intelligence flow or not. | |
| Relevant scenarios | Relevant scenarios for the document type. Each document type can be linked to multiple scenarios. | |
| Type | The type of the document. |
Pipeline step definition
The definition of the steps that are a part of a document's workflow.
| Name | Description | Comments |
|---|---|---|
| Name | The name of the step. | |
| Pipeline step definition | A unique identifier for entity instances used in the flow for identifying the document definition. | |
| Type | The type of the operation this step performs. | Extraction (104800000) Enrichment (104800001) Other (104800002) |
| Document definition | The document definition this step is used for. | |
| Info link | The URL that leads to an informative page regarding the step module. | |
| Order | Defines the order between the step definitions of the related document definition. | |
| AI builder model | AI builder model to use for this step. | |
| Success threshold | The number that describes the minimum value required for success. | |
| Failure threshold | The number that indicates the threshold value for failure. |
Step field definition
The definition of each field exposed by the step definition.
| Name | Description | Comments |
|---|---|---|
| Display name | The display name of the field. | |
| Read only | A flag that determines whether the field's value can be edited from the user interface. | |
| External name | The name of the field as defined in the model or the external system. | |
| Order | Defines the order between the fields of the related step definition. | |
| Required for approval | ||
| Step definition | The step definition to which the field definition relates. |
Annotation
Holds the document payload.
Entity reference for Document intelligence
The following entity relationship diagram shows the main data model entities for Document intelligence:
