Field Mapping (Concept): Difference between revisions

Latest revision as of 14:33, 21 November 2024

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.

Mappings may also be defined by values generated from Code Expressions.

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).

Mappings may also be defined by values generated from Code Expressions.

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

CMIS Export

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

Import Behavior

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:

Data Export

@@ Line 1: / Line 1: @@
-<section begin="glossary" />
+<blockquote>{{#lst:Glossary|Field Mapping}}</blockquote>
-<blockquote>
-"Field mappings" allow users to create logical connections between metadata content in Grooper and an external storage platform.
-</blockquote>
-<section end="glossary" />
 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'''''
+:*<li class="fyi-bullet"> 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.
-Field mappings can be used for both ''import'' and ''export'' operations.
+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.
-* 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.
+:*<li class="fyi-bullet"> Mappings may also be defined by values generated from [[Code Expressions]].
-For more information on '''''Export Mappings''''', please visit the following articles:
-* [[Export Behavior]]
+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).
-* [[Data Export]]
+:*<li class="fyi-bullet"> Mappings may also be defined by values generated from [[Code Expressions]].
+For more information on '''''Write Mappings''''' and '''''Read Mappings''''' on export, refer to the following articles:
 * [[CMIS Export]]
-For more information on '''''Import Mappings''''', please visit the following article:
+For more information on '''''Write Mappings''''' and '''''Read Mappings''''' in import, please visit the following article:
 * [[Import Behavior]]
+=== 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:
+* [[Data Export]]
 <!---
@@ Line 74: / Line 88: @@
 When data about the Grooper process itself needs to be exported (user, batch name, statistics, machine name, etc.), these can be mapped to their corresponding database columns using expression-based mapping.
-[[Category:Articles]]
-[[Category:Version 2.72]]
-[[Category:Version 2.80]]
 <!---EDITOR'S NOTE