After upgrading Cameo Collaborator for Magic Collaboration Studio from version 19.0-19.0 SP4 to version 2021x Refresh1 or later, you need to migrate all the published Cameo Collaborator documents to a new version. This chapter explains how to perform an automated Cameo Collaborator document migration from the command-line interface using a JAR file. The workflow described below will update all the documents in the Magic Collaboration Studio server using the whole model as a scope.
Prerequisites
- Make sure that the virtual machine used to migrate documents has a modeling tool with the Cameo Collaborator Publisher plugin installed.
- Download the collaborator-migrator.jar file.
To migrate Cameo Collaborator documents
- Go to <modeling_tool_installation_directory>\plugins\com.nomagic.collaborator.publisher, open the template.properties file specify the server related properties.
Generate properties files for all Cameo Collaborator documents stored on the server by executing the following command:
java -Dstep=properties -DtwcRestURL=http(s)://<server_address>:<port> -DuserName=<user_name> -DuserPassword=<password> -DtemplateFile=<path_to_template.properties> -DdestinationDirectory=<path_to_destination_directory> -jar collaborator-migrator.jar
Check the generated properties files and make sure that the template is specified.
- Document scope should be specified as element IDs. If a document has more than one view, the scope is not specified automatically.
- If any commented properties have a space after the hashtag symbol (#), the space needs to be removed. Otherwise, the properties will not work.
- If there are documents that need to be published from a historic project version, do the following (otherwise proceed to step 4):
- Place the properties files generated for the documents that need to be published from a historic project version in a separate folder.
Create branches from the related historic project versions by executing the following command (the property files will be updated with new project branch information):
java -Dstep=branch -DtwcRestURL=http(s)://<server_address>:<port> -DuserName=<user_name> -DuserPassword=<password> -DtemplateFolder=<path_to_selected_property_files> -jar collaborator-migrator.jar
- Publish Cameo Collaborator documents using the command-line interface.