Contents

Data Migration Maps

Mohammed Jamal Updated by Mohammed Jamal

A Data Migration Map provides the mapping between the Business Object as it exists in the database and the data in the import file.

Default mappings are shipped with each release of the system, but in the event they need to be edited or additional maps put in place for a migration process, you can do this via Data Migration Maps as follows:

  1. Navigate to Settings > Configuration > Data Management. The 'Data Management' page is displayed:
  2. Expand the Data Import section, and select Data Migration Maps. The 'Data Migration Maps' page is displayed.
  3. Select the Create new record button on the toolbar.
  4. Complete the fields on the page, mandatory fields are marked with a red asterisk *.

The following table describes the fields in the Data Migration Map record:

Field

Description

Field Logic Type

Target Record Type*

Business Object that is being imported.

Reference to Business Object system metadata object

Name*

Name of the Migration Map

Text

Max 500 characters

Expected File Name

Name of the expected data load file. For example, "Person.csv"

Text

Max 300 characters

Inactive

Indicates whether the Data Migration Map is inactive or not.

Yes/No radio button

Set to 'No' by default

Valid for Lookup Map

Indicates whether data is loaded into the lookup map as well as the Business Object map.

Defines if during import system should compare Source Title field with existing data and load lookup map.

Yes/No radio button

Set to 'No' by default.

Is Legacy DataMap?*

Indicates whether the Legacy ID values are generated during the import process.

This setting is used if migrating data from an external source and the import files contain Legacy ID values.

Yes/No radio button

Set to 'No' by default

Read-only after initial save

Include Required Field Only

Yes/No radio button

Set to 'No' by default

Use Label For Source Field

The source field within the system has two elements, the display that we see as users, or the back end field name. When set to Yes, this will look against the display label.

Yes/No radio button

Set to 'No' by default

Import Handler

Custom import handler for this data map.

Reference to Plugin Type system metadata object.

Post Import Handler

Custom import handler for this data map.

Reference to Plugin Type system metadata object.

Valid For Export

Indicates whether the Data Migration Map is included in a data migration processes.

Set to 'No' by default.

Always Execute

Indicates whether to repeatedly execute the Data Migration Map.

Set to 'No' by default.

Change Log

Provide details of any changes (such as release number or date).

Changes to the Data Migration Map which have been implemented by OneAdvanced are also shown in this field. This can be viewed when accessing a record.

Free text

  1. Select the Save button on the toolbar.

Additional tabs have appeared:

  • Fields
  • Related Packages
  • Rules

Fields Tab

Data Migration Field Maps provide the mappings for specific fields in Care Cloud.

Default mappings should already be in place, but in the event they need to be edited or additional maps put in place for a migration process, you can do this via Data Migration Maps as follows:

  1. Open the Data Migration Map record in the way described above.
  2. Select the Fields tab. An example is shown below:

  1. Select a row in the view to open the associated Data Migration Field Map record. An example is shown below:

The following table describes the fields in the Data Migration Field Map record:

Field

Description

Field Logic Type

Source Field*

Important: You should ensure the name of the Source Field = the Name of the field in the data import file.

Max 128 characters

Target Field*

Field in Care Cloud to which values in the Data Import file are migrated.

Reference values are filtered to only display fields that are relevant to the specified Data Migration Map.

Reference to Business Object Field

Data Migration Map*

Data Migration Map to which the Data Migration Field Map belongs.

Reference to Data Migration Map setup data object

Parent record is specified by default

Read-only after initial save

Field Transformation*

Specifies how the Target Field is populated by the Source Field. The following options are available:

  • None: No transformation takes place. The field value is moved from the Data Import file to the Target Field as it appears in the file.
  • Legacy Id: The field in the import file is a Legacy id to be matched with the Legacy id for the related Business Object in the database. The value saved to the Target Field is the associated GUID
  • Text Comparison: The field in the import file is a text description to be matched with the Title field of the related Business Object. The value saved to the Target Field is the associated GUID
  • Lookup Map & Legacy Id: The field in the import file is a Legacy Id. This is matched to the Legacy Id for the associated Business Object in the Lookup Data Map (LookupDataMap table). The value saved to the Target Field is the associated GUID, taken from the Lookup Map (stored as LookupDataMapId)
  • Resolve By Reference Field: The Legacy Id is unknown and the value that is saved is that which matches a specified field (see Resolve By Field below)

Drop-down selection

Source Field Order*

Column number of the field in the Data Import file (first column = 1). This will successfully increase the more fields there are.

Numeric value

Display Reference List (in Excel)

Yes/No radio button

Set to 'No' by default

Resolve By Field*

Field by which the target field is resolved.

Only visible when Field Transformation = Resolve By Reference Field.

Selection

Inactive

Indicates whether the Data Migration Field Map is inactive.

Yes/No radio button

Set to 'No' by default

Valid For Export

Indicates whether the Data Migration Field Map is included in a data migration processes.

Yes/No radio button

Set to 'No' by default

  1. Select the Save and Close button.

Download Data Migration Maps

  1. Select the relevant record(s) on the 'Data Migration Maps' page.
  2. Select the Download Maps button on the toolbar.

Your browser will download the ZIP file:

  1. Open the ZIP file.

The CSV file(s) will contain the necessary headers and columns required for you to complete.

Get to know the destination of your data within the system to make sure the CSV files import correctly.

The Word document will contain details about the field types and change log.

Was this article useful?

Data Import Procedure Overview

Data Migration Packages

Contact