Field Mapping (Concept): Difference between revisions

From Grooper Wiki
No edit summary
No edit summary
 
(3 intermediate revisions by one other user not shown)
Line 3: Line 3:
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 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
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.
:*<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 more information on '''''Export Mappings''''', please visit the following articles:
* [[Export Behavior]]
* [[Data Export]]
* [[CMIS Export]]


For more information on '''''Import Mappings''''', please visit the following article:
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.
* [[Import Behavior]]
:*<li class="fyi-bullet"> Mappings may also be defined by values generated from [[Code Expressions]].


== Glossary ==
<u><big>'''Behavior'''</big></u>: {{#lst:Glossary|Behavior}}


<u><big>'''CMIS Export'''</big></u>: {{#lst:Glossary|CMIS Export}}
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]].


<u><big>'''CMIS'''</big></u>: {{#lst:Glossary|CMIS}}


<u><big>'''Data Element'''</big></u>: {{#lst:Glossary|Data Element}}
For more information on '''''Write Mappings''''' and '''''Read Mappings''''' on export, refer to the following articles:
* [[CMIS Export]]


<u><big>'''Data Export'''</big></u>: {{#lst:Glossary|Data Export}}
For more information on '''''Write Mappings''''' and '''''Read Mappings''''' in import, please visit the following article:
* [[Import Behavior]]


<u><big>'''Data Field'''</big></u>: {{#lst:Glossary|Data Field}}
=== Mapping to a database ===


<u><big>'''Data Model'''</big></u>: {{#lst:Glossary|Data Model}}
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.


<u><big>'''Export Behavior'''</big></u>: {{#lst:Glossary|Export Behavior}}
For more information on '''''Table Mappings''''' refer to the following article:
* [[Data Export]]


<u><big>'''Export'''</big></u>: {{#lst:Glossary|Export}}


<u><big>'''Field Mapping'''</big></u>: {{#lst:Glossary|Field Mapping}}


<!---
<!---
Line 92: 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.
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
<!---EDITOR'S NOTE

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.


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: