Field Mapping (Concept)

From Grooper Wiki
Revision as of 10:03, 18 September 2024 by Dgreenwood (talk | contribs)

Field Mapping refers to how logical connections are made between metadata content in Grooper and an external storage platform.

Field mappings are created between Grooper Data Elements in a Data Model and corresponding metadata fields in an external content storage platform. For example, a Data Field capturing an invoice document's invoice number could be mapped to a field in a content management system named "Invoice Number". After Grooper extracts those Data Fields from a document set, the extracted data is mapped to fields in the content management system on export.

Mapping to and from properties in a content management system

Field mappings can be used for both import and export operations, using either Write Mappings or Read Mappings

  • While exporting data from Grooper to an external platform via field mappings is more common, document metadata from an external storage platform can be imported into Grooper via field mappings as well.


For import, mappings are defined using an Import Behavior. Read Mappings define what metadata are read from the import source and mapped to which Data Fields in Grooper. Write Mappings define what (if any) metadata are written back to the import source after the import completes.


For export, mappings are defined using an Export Behavior. Write Mappings define what Grooper Data Field values are written to which metadata properties in the content management system. Read Mappings define what data is read back from the content management system to a Grooper Data Field (This is uncommon).


For more information on Write Mappings and Read Mappings on export, refer to the following articles:

For more information on Write Mappings and Read Mappings in import, please visit the following article:

Mapping to a database

Field mapping may also refer to how Grooper extracted data are mapped to a database on export. The Data Export definition's Table Mappings define what Data Elements values are mapped to which columns in a database table.

For more information on Table Mappings refer to the following article:

Glossary

Behavior: A "Behavior" is one of several features applied to a Content Type (such as a description Document Type). Behaviors affect how certain Activities and Commands are executed, based how a document (folder Batch Folder) is classified. They behave differently, according to their Document Type. This includes how they are exported (how Export behaves), if and how they are added to a document search index (how the various indexing commands behave), and if and how Label Sets are used (how Classify and Extract behave in the presence of Label Sets).

  • Each Behavior is enabled by adding it to a Content Type. They are configured in the Behaviors editor.
  • Behaviors extend to descendent Content Types, if the descendent Content Types has no Behavior configuration of its own.
    • For example, all Document Types will inherit their parent Content Model's Behaviors.
    • However, if a Document Type has its own Behavior configuration, it will be used instead.

CMIS Export: CMIS Export is an Export Definition available when configuring an Export Behavior. It exports content over a cloud CMIS Connection, allowing users to export documents and their metadata to various on-premise and cloud-based storage platforms.

CMIS: CMIS (Content Management Interoperability Services) is open standard allowing different content management systems to "interoperate", sharing files, folders and their metadata as well as programmatic control of the platform over the internet.

Data Element: Data Elements are a class of node types used to collect data from a document. These include: data_table Data Models, insert_page_break Data Sections, variables Data Fields, table Data Tables, and view_column Data Columns.

Data Export: Data Export is an Export Definition available when configuring an Export Behavior. It exports extracted document data over a database Data Connection, allowing users to export data to a Microsoft SQL Server or ODBC compliant database.

Data Field: variables Data Fields represent a single value targeted for data extraction on a document. Data Fields are created as child nodes of a data_table Data Model and/or insert_page_break Data Sections.

  • Data Fields are frequently referred to simply as "fields".

Data Model: data_table Data Models are leveraged during the Extract activity to collect data from documents (folder Batch Folders). Data Models are the root of a Data Element hierarchy. The Data Model and its child Data Elements define a schema for data present on a document. The Data Model's configuration (and its child Data Elements' configuration) define data extraction logic and settings for how data is reviewed in a Data Viewer.

Export Behavior: An Export Behavior defines the parameters for exporting classified folder Batch Folder content from Grooper to other systems. This includes where they are exported to (what content management system, file system, database etc), what content is exported (attached files, images, and/or data), how it is formatted (PDF, CSV, XML etc), folder pathing, file naming and data mappings (for Data Export and CMIS Export).

Export: output Export is an Activity that transfers documents and extracted information to external file systems and content management systems, completing the data processing workflow.

Field Mapping: Field Mapping refers to how logical connections are made between metadata content in Grooper and an external storage platform.