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: @@
-<blockquote style="font-size:16pt>
+<blockquote>{{#lst:Glossary|Field Mapping}}</blockquote>
-'''Field Mapping''' allows users to create logical connections from metadata content in Grooper to an external storage platform.
-</blockquote>
-For example, field mappings can be created between data elements in a data model in Grooper and corresponding metadata fields in an external content management system.  A Data Field capturing an invoice document's invoice number could be mapped to a field in the content management system named "Invoice Number".  After those data fields are extracted from a document set, when the documents are exported their information will populate the mapped fields in the content management system.
+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.
-Field mappings can be used for both import and export operations.  Document metadata from an external storage platform can be imported via field mappings as well as exported.
+=== 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.
+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.
+:*<li class="fyi-bullet"> 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).
+:*<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 '''''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]]
+<!---
+EDITORS NOTE:  I've commented out the rest of this article because it is out of date, old, and unhelpful.
 == Version 2.72 ==
+Grooper Version 2.72 introduces simplified field mappings.  Fields can now be mapped as they are defined at the root of the Data Model.
-Grooper Version 2.72 introduces simplified field mappings for **Mapped Export**.  Fields can now be mapped as they are defined at the root of the Data Model.
+{|cellspacing="20" style="margin:auto"
+|-valign="top"
+|If your Data Model looks like the one below with fields in several different sections...
-If your Data Model looks like the one below with fields in several different sections...
+[[file:1559246479073-630-fieldmap.png|center]]
+|...when you go to map them to (or from) a CMIS repository, the dropdown list will be structured like your Data Model, from top to bottom with each heading listed before the field. This makes it much easier to find which field you're looking for.
-[[file:1559246479073-630|center]]
+[[file:1559246887350-568-fieldmap.png|center]]
+|}
-...when you go to map them to (or from) a CMIS repository, the dropdown list will be structured like your Data Model, from top to bottom with each heading listed before the field. This makes it much easier to find which field you're looking for.
-[[file:1559246887350-568|center]]
+== Version 2.80 ==
+Beginning in 2.80, administrators now have the ability to add expressions to mapped fields on import and export.
-== Version 2.80 ==
+When setting up a Database Export activity, new options are exposed on the "column mappings" property.
-Beginning in 2.80, administrators now have the ability to add expressions to mapped fields on export. When setting up a Database Export activity, new options are exposed on the "column mappings" property.
-{|
+{|style="margin:auto" cellspacing="10"
-|[[file:image-20190925162347-1.png]]||[[file:image-20190925162359-2.png]]||[[file:image-20190925162430-3.png]]
+|[[file:image-20190925162347-1.png|center|900px]]
+|-
+|[[file:image-20190925162359-2.png|center|550px]]
+|-
+|[[file:image-20190925162430-3.png|center|900px]]
 |}
@@ Line 51: / Line 87: @@
 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.
+<!---EDITOR'S NOTE
+This article needs overhaul.  It should either:
+# Focus tightly on what Field Mappings are and can do with specific examples, detailing Expression mapping, navigating Data Model hierarchy and use cases in more depth.
+# OR, be deleted entirely and leave explanations of Field Mappings to the Export (Activity), CMIS Export, Data Export articles and wherever else field mappings are touched on.