› System data › Data models

Data models

A data model is a user-defined data structure that represents a collection of data.

Data models simplify integration with REST APIs and reduce database storage space. A data model is used to group data. The data held within the structure can be used in processes and forms using the data object variable. TotalAgility provides the following out-of-the-box data models for document processing and knowledge base search capabilities.

You can define global and local data models.

A global model is available to all processes and forms, but a local model is available only to the form or process it is defined for. A local data model is useful for one-off integrations when you do not have to reuse the data model.

You can also create a global or local data model using a sample JSON. On adding a JSON file, the JSON format is parsed, and a tree structure is created. The field names in the data model match that of the JSON, and the field types are implied from the JSON sample. Any ambiguous field types are set to string You can edit the data model by changing field types or deleting the fields that you do not want. You can create a data model for simple JSON strings, strings having multiple nested objects, and with an array of data.

See Examples of Data models using JSON sample.

You can generate the global data models using the Generative AI functionality.

You must have the required permissions to create and view data models. See Access control list for more information.

Out-of-the-box data models

The following are the system objects you can use without any custom configuration.

  • Document Barcodes: Used for extracting, storing, and returning barcode data detected during document processing. Helps classify documents or populate fields based on barcode values.

  • KBDynamicSearch: Supports dynamic Knowledge Base search so that the search criteria is defined in the datamodel.

  • KBSearchOnly: Performs search queries only, without returning extended metadata or search results.

  • KBSearchResult: Holds the knowledge base search only results.

  • Key Words: Stores and manages keyword lists used for keyword‑based classification, indexing, or validation. It supports search logic within Capture and document based systems by enabling rule‑based identification and categorization of content.

How to: