MMS3 to MMS4 migration [Draft]

 

Step

Description

Step

Description

Ensure you have “writer” permissions for MMS3 and MMS4 project

 

Ensure MMS3 and TWC are in sync

 

**Note: Make sure you are using CSM/MDK version 4.5.3 or earlier for all of the steps in the "Prep for Migration" phase.

 

***Note: Updating project usages before completing these steps may reduce validation errors.

  1. Lock the model for edit: right click the root "Model" package and select Lock -> Lock Elements for Edit Recursively.

  2. On the main toolbar, click Collaborate -> Update Project.

  3. Right click the root "Model" package and select MMS -> Validate Models.

  4. If there are any errors thrown, resolve them (slot errors or errors related to project usages may be ignored).

  5. Right click each View Editor document in the model and select MMS -> Validate Models. The "Element Validation" window will appear and display the errors (if there are any errors found).

  6. If there are any errors thrown, resolve them.

  7. Commit changes to TWC: click Collaborate -> Commit Changes to Server. In the "Comment" field, include a note that describes any updates you made.

Export View Editor HTML or PDF documents on MMS3

  1. Login to MMS3 View Editor: https://opencae.jpl.nasa.gov/alfresco/mmsapp/mms.html#/login

  2. For each View Editor document in your model, do steps 3-5.

  3. Click the icon that looks like a paper (view full document) and scroll down to check that all of the contents of the document are there.

  4. Right click the document itself (in the whitespace) and select Save As -> under "Format" select "Webpage, HTML Only" in the dropdown.

  5. Save the file locally.

 

Delete “__MMSSync__” Folder

  1. Lock the model for edit in TWC

  2. Delete "MMSSync" package in the containment tree

 

Remove MMS Stereotype from root “Model” Package

  1. Right click the root "Model" package and select Specification.

  2. In the "Applied Stereotype" field, delete the <<ModelManagementSystem>> stereotype.

  3. Log out of MMS.

 

Commit Changes to TWC

Expected outcome: notification window doesn't print element validation summary

Close TWC project

 

run ID migration scripts as jython macros one by one

_OpenMBEE-Documentation/migration/crush2donbot/TWC at master · Open-MBEE/_OpenMBEE-Documentation

when uploading/moving a project from local or from another TWC server, CSM changes the IDs which are not compatible with VE crossreferences.
The scripts revert those IDs

Open CSM with MDK with MMS Enabled

**Note: Make sure you are using MDK version 5.1.0 or later for all of the steps in the "Execute Migration" phase.

 

  1. Open CSM

  2. Login to TWC

  3. Open your project in TWC

Configure MMS in project options

Set URLs for MMS4 and VE4

 

Login to MMS

Select "MMS" tab from top ribbon -> Login -> Enter username and password -> Ok

Right Click Root Element → MMS → Validate Models

Right click the root "Model" package and select MMS -> Validate Models
**Note: Validation may take awhile if it is a bigger model.

Wait for Validation Window to Print Errors/Warnings

**Note: Validation may take awhile if it is a bigger model.

Right Click Error in Validation Window → Commit Project and Model

Note: Error will remain visible until validation window is closed

Choose MMS Org

Wait for "Choose MMS Org" dialog to pop up -> Select desired Org -> Ok

Again, Right Click Root Element → MMS → Validate Models

Right click the root "Model" package and select MMS -> Validate Models
**Note: Validation may take awhile if it is a bigger model.

Wait for Validation Window to see “Holding bin missing in client”

Can skip if Holding bin exists, otherwise choose “update from MMS”

Confirm that “__MMSSync__” folder has been created

 

Save Project locally by “File->Save Project”

 

Commit Changes to TWC

 

Again, Right Click Root Element → MMS → Validate Models

 

Run Presentation Element migration script

follow the readme here GitHub - Open-MBEE/mms3-to-mms4-json: Helper script for MMS3 to MMS4 JSON migration

Log into VE and check that org and project exist

 

Run Validation on CSM side

should see zero differences

Check View Editor for Errors

  1. Go to the View Editor page for the project

  2. Do a quick check of all of the views and documents to make sure there aren't any errors or data lost

 

Generate Model views

  1. Right click all the Documents in the model and select "MMS->Generate Views Recursively"

  2. Check these Documents on View Editor again and verify they look consistent

  3. Generate cover page view

 

Confirm VE Content (Except Artifacts)

 

Run Artifact Migration Script

for ve added images, follow this script mms3-to-mms4-json/images at master · Open-MBEE/mms3-to-mms4-json

Again, Right Click Root Element → MMS → Validate Models

 

Confirm VE Shows All Content

 

Check that project cover page migrated correctly

 

Run Csync by Committing to TWC

 

Generate Model views

  1. Right click all the Documents in the model and select "MMS->Generate Views Recursively"

  2. Check these Documents on View Editor again and verify they look consistent

  3. Generate cover page view

Confirm VE Shows All Content

 

Export VE HTML/PDF documents on MMS4

 

Diff HTML/PDF Documents MMS3 vs MMS4

 

Configure permissions for MMS4 project