Legacy Migration Tool

About Legacy Migration Tool

The APM Entity and Relationship families in Rounds Pro are significantly different from Legacy Rounds. Using the Legacy Rounds Migration tool you can migrate data from Legacy Rounds to Rounds Pro.

Following are the highlights of the Migration tool:
  • You can run the tool multiple times for the same route. For instance, if you find any issues with the data during the migration process, you can correct the data and re-run the migration utility for the same route. When you re-run the utility for the same route, it updates all the related migrated data in Rounds Pro and may create new records if they were not created in the previous run.
  • You can use the tool to migrate all data or subset of data. For example, you can use a query to filter and migrate a single Route for testing purposes or migrate multiple Routes belonging to a specific site.
  • Migration tool will not delete any data in Legacy Rounds.

Terminology

The following table provides the terminology in Legacy Rounds versus Rounds Pro:
Table 1. Legacy Rounds Vs Rounds Pro
Legacy Rounds Rounds Pro Notes
Allowable Values Picklists None
Measurement Location Measurement Step None
Route Route Master/Route Instance When a Route Master is due a separate Route Instance is created.
Measurement Location Template Step Template None
Condition Conditional Step Conditional Steps are part of the Measurement Step.
ReadingStep ReadingNone
Operator Rounds Recommendation Operator Rounds Recommendation Same family is used in both Legacy Rounds and Rounds Pro.

Key Considerations

In the current release, following data from Legacy Rounds is migrated to Rounds Pro:
  • Routes
  • Measurement Locations
  • Category/Allowable values
  • Checkpoint Conditions
  • Health Indicators: New Health Indicators are created and then associated with the Measurement Steps. The original Health Indicators associated with Measurement Locations are not updated and will continue to stay.
  • Users and Teams assigned to Routes.

Limitations

In the current version, following limitations exist:
  • Data: The Migration tool will migrate the data structure, but not the data generated from Legacy Rounds. The following items will not be migrated to Rounds Pro:
    • Readings
    • Route History records
    • Operator Rounds Recommendations
    • Reference Documents
    • GIS Data
  • Functionality: The following functionality will not be migrated to Rounds Pro:
    • Step Scheduling: If your Measurement Locations have schedules defined, those schedules will not be migrated to Rounds Pro.
    • Lubrication Requirements and Lubrication Templates: Lubrication Requirements are currently not available in Rounds Pro and hence lubrication requirements will not be migrated. If your route has a lubrication requirement, routes will be migrated without lubrication requirements.
    • Templates Groups: Template Groups are currently not available in Rounds Pro and will not be migrated.
    • Localization Data: Only English language is supported in Rounds Pro
  • Other Modules: Data related to the following modules will not be migrated:
    • Policies: Policies created based on the Measurement Location node will not be upgraded to Measurement Steps.
    • Health Indicators: New Health Indicators will be created in Rounds Pro. The original Health Indicators associated with Measurement Locations will not be updated.
    • Strategy: Measurement Locations with links to Asset Strategy will be migrated as Measurement Steps in Rounds Pro but the measurement steps will not be linked to Asset Strategy.
  • Customization:
    • Fields: Any custom fields, custom rules that are created on the Legacy Rounds families will not be migrated to Rounds Pro Families
    • Catalog Items (Queries/Reports/Graphs): Any custom catalog items using Legacy Rounds Families will not be migrated to Rounds Pro.
  • Others:
    • Checkpoint Images: If there are checkpoint images associated with the Measurement location, they will not be migrated.
    • Measurement Location not linked to Assets: Measurement Steps in Rounds Pro needs an Asset to be linked, which is not required in Legacy Rounds. If there are any Measurement Locations that are not linked to an Asset or unknown assets, they will not be created in Rounds Pro. However, you can create dummy Functional Locations before running the Migration tool, then these will steps be linked with the newly created Functional Locations. Functional Locations should follow the exact naming convention as below:
      • Catch-All for unknown Asset: Measurement Locations that are linked to an Unknown asset will be migrated as Measurement Steps and are linked to this Functional Location.
      • Catch-All for no Asset: Measurement Locations that are not linked to an asset will be migrated as Measurement Steps and are linked to this Functional Location.
    • Actions: Actions in the Measurement Location are not migrated.
    • Route Schedule: Route Schedule is not migrated.

Route Migration

When Migration Type is selected as Routes, the complete Route is migrated from Legacy Rounds to Rounds Pro and a new Route Master is created in Rounds Pro. During this process, several other records that are part of the Route will be created like the Picklists/Picklist item, Measurement Steps, and Conditional steps.

Legacy Rounds records are migrated in the following way to Rounds Pro records:

  • Measurement Locations are migrated as Measurement Steps
  • Routes are migrated as Route Masters
  • Allowable Values are migrated as Picklists

Measurement Location to Measurement Step

During the migration process, the Legacy Rounds Migration tool performs the following tasks in the background.
  • If there is no Measurement Step (Same Name and Asset relationship) in Rounds Pro, a new Measurement Step is created.
  • If there is an existing Measurement Step in Rounds Pro with same Name and Asset relationship, a new Measurement Step is created and the Step Name is appended with the last four digits of the Entity Key. For example, Step Name [1234].
  • Since the information related to Conditions is part of the Measurement Step in Rounds Pro, the Conditions under the parent Measurement Location are now part of the Measurement Step in Rounds Pro.
  • In Rounds Pro, it is required for all the Measurement Steps in the Route Master should belong to the same site. Hence, in Legacy Rounds if a Route has Measurement Locations from different sites, these routes and the associated Measurement Locations will not be migrated.
  • In Rounds Pro, it is required that all Measurement Steps should belong to an Asset. Hence in Legacy Rounds if there are any routes which have Measurement Locations not related to any Asset, then these Measurement Locations will not be migrated to Rounds Pro, unless dummy Functional Locations are created as mentioned in the previous section.
To improve transparency and facilitate a better understanding of the data migration process, the Setup section in the runtime log provide the actual transformation that happens during the migration process. If, however, there is a discrepancy between the mappings described in this document and the mappings in the runtime log, the runtime log must be considered final.
Table 2. Mapping Between Step Fields and Checkpoint Fields
Step FieldsCheckpoint FieldsNotes
Step IDDescriptionThe value is copied as-is; however:
  • If there are multiple Measurement Locations with the name same description within the Asset, the Step Name is appended with four digits of the Entity Key (for example, <Step Name> [3456]).
  • If the description is longer than 50 characters, it is truncated.
Related Asset KeyAsset KeyThe value is copied as-is; however, catch-all Functional Locations are configured and used.
Table 3. Mapping Between Step Fields and Checkpoint Entity Fields
Step FieldsCheckpoint Entity FieldsNotes
StepTypeMI_CHECK_PT_TYPE_CIf both the Category and Allowable fields contain values, this field is populated with the value Picklist: Single Select; otherwise, this field is populated with the value Text Entry: Character or Text Entry: Numeric, depending on the Measurement Location type.
ReadingPickListMI_MEAS_LOC_ALLOW_VAL_C, MI_MEAS_LOC_CATEG_C, MI_MEAS_LOC_MEAS_LOC_TYPE_C
UOMMI_MEAS_LOC_UOM_CThe value is copied as-is.
ScanIdMI_CHECK_PT_BARCD_ID_CThe value is copied as-is
Table 4. Mapping Between Step Fields and Checkpoint Fields
Step FieldsCheckpoint FieldsNotes
LockedMI_CHECK_PT_LOCKED_LThe value is copied as-is.
Lower1ValueMI_MEAS_LOC_LO_LVL1_ALRT_N, MI_MEAS_LOC_LO_LVL1_ALRT_COne of the values is used.
Lower1MessageMI_MEAS_LOC_LO_LVL1_MSG_CThe value is copied as-is.
Lower2ValueMI_MEAS_LOC_LO_LVL2_ALRT_N, MI_MEAS_LOC_LO_LVL2_ALRT_COne of the values is used.
Lower2MessageMI_MEAS_LOC_LO_LVL2_MSG_CThe value is copied as-is.
Lower3ValueMI_MEAS_LOC_LO_LVL3_ALRT_N, MI_MEAS_LOC_LO_LVL3_ALRT_COne of the values is used.
Lower3MessageMI_MEAS_LOC_LO_LVL3_MSG_CThe value is copied as-is.
Upper1ValueMI_MEAS_LOC_UP_LVL1_ALRT_N, MI_MEAS_LOC_UP_LVL1_ALRT_COne of the values is used.
Upper1MessageMI_MEAS_LOC_UP_LVL1_MSG_CThe value is copied as-is.
Upper2ValueMI_MEAS_LOC_UP_LVL2_ALRT_N, MI_MEAS_LOC_UP_LVL2_ALRT_COne of the values is used.
Upper2MessageMI_MEAS_LOC_UP_LVL2_MSG_CThe value is copied as-is.
Upper3ValueMI_MEAS_LOC_UP_LVL3_ALRT_N, MI_MEAS_LOC_UP_LVL3_ALRT_COne of the values is used.
Upper3MessageMI_MEAS_LOC_UP_LVL3_MSG_CThe value is copied as-is.
Table 5. Mapping Between Step Entity Fields and Measurement Location Entity Fields
Step FieldsCheckpoint FieldsNotes
MI_MEAS_STP_DWNLD_STORD_DOC_FMI_MEAS_LOC_DWLD_STRD_DOC_LThe value is copied as-is.
MI_MEAS_STP_EHW_WGHT_NMI_MEAS_LOC_EHW_WGHT_NThe value is copied as-is.
MI_MEAS_STP_LO_LVL1_ACT_CMI_MEAS_LOC_LO_LVL1_ACT_CThe value is copied as-is.
MI_MEAS_STP_LO_LVL2_ACT_CMI_MEAS_LOC_LO_LVL2_ACT_CThe value is copied as-is.
MI_MEAS_STP_LO_LVL3_ACT_CMI_MEAS_LOC_LO_LVL3_ACT_CThe value is copied as-is.
MI_MEAS_STP_MAX_TRGVAL_NMI_MEAS_LOC_MAX_TRGVAL_NThe value is copied as-is.
MI_MEAS_STP_MAX_VLDVAL_NMI_MEAS_LOC_MAX_VLDVAL_NThe value is copied as-is.
MI_MEAS_STP_PRODUCT_CMI_MEAS_LOC_PRODUCT_CThe value is copied as-is.
MI_MEAS_STP_MIN_VLDVAL_NMI_MEAS_LOC_MIN_VLDVAL_NThe value is copied as-is.
MI_MEAS_STP_MIN_TRGVAL_NMI_MEAS_LOC_MIN_TRGVAL_NThe value is copied as-is.
MI_MEAS_STP_MORE_INFO_CMI_MEAS_LOC_MORE_INFO_CThe value is copied as-is.
MI_MEAS_STP_UP_LVL1_ACT_CMI_MEAS_LOC_UP_LVL1_ACT_CThe value is copied as-is.
MI_MEAS_STP_UP_LVL2_ACT_CMI_MEAS_LOC_UP_LVL2_ACT_CThe value is copied as-is.
MI_MEAS_STP_UP_LVL3_ACT_CMI_MEAS_LOC_UP_LVL3_ACT_CThe value is copied as-is.
MI_STP_EQUIP_TECH_NUM_CSC_CHECK_PT_EQUIP_TECH_NBR_CThe value is copied as-is.
MI_STP_REL_RDOC_IMG_KEY_NMI_CHECK_PT_REFDOC_KEY_NThe value is copied as-is.
MI_STP_STATUS_CMI_MEAS_LOC_STAT_CThe value is copied as-is.
MI_STP_REQ_EQUIP_SHUT_LMI_CHECK_PT_REQU_EQUI_SHUT_FLGThe value is copied as-is.

Routes to Route Masters

During the migration process, the Legacy Rounds Migration tool performs the following tasks in the background.
  • Route is migrated as a Route Master in Rounds Pro. If the Route belongs to an asset, then the new route master created in Rounds Pro is linked to the same asset.
  • The new route master in Rounds Pro is assigned the same site that the route belonged to in legacy.
  • All allowable values and measurement locations that are part of the Legacy Rounds are migrated to Rounds Pro. The measurement locations in legacy are migrated in the same sequence as they exist in Legacy Rounds.
  • Any conditions and conditional measurement locations that exist in the route are migrated to Rounds Pro as conditions and conditional steps in the new route master.
  • All new measurement locations in Rounds Pro after migration belong to the same site as in Legacy Rounds.
Table 6. Mappings Between Route Master Fields and Legacy Route Fields
Route Master FieldsLegacy Route FieldsNotes
RouteMasterIDIDThe value is copied as-is.
DescriptionRouteDescriptionThe value is copied as-is.
RouteScheduleMI_ROUTE000_SCHED_CThe value is copied as-is.
IsScheduleActiveMI_ROUTE000_SCHED_C, MI_ROUTE000_STAT_CIf the Status is Active and the Schedule is configured, this field contains the value Active; otherwise, Inactive.
MI_RTE_MST_LAST_DONE_DTMI_ROUTE000_LAST_DATE_DThe value is copied as-is.
MI_RTE_MST_NEXT_DUE_DTMI_ROUTE000_NEXT_DATE_DThe value is copied as-is.
MI_RTE_MST_SCAN_ID_CMI_ROUTE000_BARCD_ID_CThe value is copied as-is.

Allowable Values to Picklists

During the migration process, the Legacy Rounds Migration tool performs the following tasks in the background.
  • If there is no Picklist with the same name as the Category in Rounds Pro a new Picklist is created.
  • If the Picklist does not have the Picklist Item, a new Picklist item is added to the Picklist.
  • If both the Picklist and Picklist Items are available, the existing ones are used.
Table 7. Allowable Values to Picklists
Allowable ValuesPicklistsComments
Category NamePicklist NameNone
TypePicklist TypeNone
ValuesValueNone

Access the Legacy Rounds Migration Page

Before You Begin

  • You must be a Super User.
  • You must have active Legacy Rounds and Rounds Pro licenses.
  • If you are have data in Rounds Pro, you must review the existing Rounds Pro data before starting the migration process to avoid any unnecessary updates to your existing Rounds Pro data.

Procedure

  1. Access the Rounds Designer administration page.
  2. Select the Legacy Rounds Migration tab.
    The Legacy Rounds Migration workspace appears.

Migrate Legacy Rounds Data

Procedure

  1. Access the Legacy Rounds Migration Page
  2. Select Migration Type.
  3. Under Migration Scope, select one of the following options:
    • Migrate from query: Using this option, you can migrate a subset or subsets of data. You can use the query located at Public/Meridium/Modules/Rounds Pro/Queries/Legacy Migration/Routes to migrate a single Route for testing purposes or multiple Routes belonging to a specific site. You can customize this query as needed.
    • Migrate All: Using this option you can migrate all of the data.
  4. Select Initiate Migration.
    The Review migration window appears.
  5. Select Migrate Data to initiate migration.
    Your migration job is started.
    Note: If more than 10 Routes are selected for migration, then separate migration jobs are created for each batch of 10 routes.

Access Migration Results

About This Task

After each migration run, one or more log entries gets created, providing detailed information about the action taken on each record. These logs enable you to take necessary actions.

Procedure

  1. Access the Legacy Rounds Migration Page
  2. Select the Job ID, for which you want to view the logs details.
    A Master-Details record opens in the Record Manager displaying the following fields.
    Table 8. Legacy Rounds Migration Job
    FieldData TypeDescriptionBehavior and Usage
    Job IDCharacterEach migration is a unique job, and each job has an ID.This is automatically created when you start a migration task.
    Note: If more than 10 Routes are selected for migration, then separate migration jobs are created for each batch of 10 routes.
    Job StatusCharacterThe status of the migration job.

    The following status are available:

    • Completed – Migration job completed successfully.
    • CompletedWithError - Migrated job is completed with errors.
    • In Progress – Migration job is still running.
    Migration Component TypeCharacterDefines the component types that will be migrated, such as Routes, Measurement Location.Only Routes is supported.
    Processed Item CountNumericNumber of items processed in the current migration.None
    Total Item CountNumericTotal items selected for the migration.None
    Migration LogTextHigh level Summary log.Summary log entry for each Route, with status set as either of the following:
    • Success
    • Completed with Warning
    • Failed with Error
    Migration Starts OnDateMigration start date and time.None
    Migration Ends OnDateMigration end date and time.None
  3. Select Legacy Rounds Migrated Item family in the Record Manager.
    The following available fields appear:
    Table 9. Legacy Rounds Migrated Item
    FieldData TypeDescriptionBehavior and Usage
    Migrated Item Family KeyCharacterFamily ID of the migrated itemThis fields can contain Measure Step or Rounds Pro families.
    Migrated Item Entity KeyNumericEntity Key of the migrated itemNone
    StatusCharacterIt could be either Insert or UpdateNone
    Source Item Family KeyCharacterFamily Key of the migrated itemThis field can contain Measurement Location or Legacy Route families.
    Source Item Entity KeyCharacterEntity Key of the migrated itemNone
  4. Select Legacy Rounds Migration Log family in the Record Manager.
    The following available fields appear:
    Table 10. Legacy Rounds Migration Log
    FieldData TypeDescriptionBehavior and Usage
    Job IdCharacterIdUnique Job ID
    Source Item Family KeyNumericFamily keyFamily key of the item processed
    Source Item Entity KeyCharacterEntity keyEntity key of the item processed
    Source IDCharacterSource IDNone
    Error MessageCharacterError or warning message None
    StatusCharacterSuccess, Warning, ErrorNone
    LogTextDetailed Migration LogNone