Skip to end of metadata
Go to start of metadata

If you already have existing data created in CEDW 18.3 or TWCloud 18.4, you need to migrate the data to 18.5 compatible format before starting to use Teamwork Cloud (TWCloud) 18.5 using the migration tool. After successfully migrating the data, you will need to update the projects to enable project editingUpgrading your CEDW 18.3 or TWCloud 18.4 to TWCloud 18.5 is also possible without migrating your database. If you do not need to keep your existing data, you can simply skip the migration steps and delete your database folder.

The following instructions explain how to migrate data from CEDW 18.3 or TWCloud 18.4 and 18.4 SP1 to TWCloud 18.5, upgrade your server to TWCloud 18.5, and update the projects. 

Warning: Check the schema version before upgrading TWCloud

Before upgrading your TWCloud, check if the schema of your current TWCloud is the same as that of TWCloud you are going to upgrade to. If both schema versions match, you can upgrade your TWCloud without the need to migrate your data. Otherwise, you need to migrate your data.

TWCloud versionSchema version
18.4 SP18
18.5 SP112
18.5 SP212
18.5 SP312
19.0 beta15

Migrating data

This section provides the steps to migrate your data from a previous version of TWCloud to 18.5. Follow the backup procedure here if you need to back up your data. The migration tool is a zip file that should be on the same download page as the TWCloud installer file. If your database has already been migrated, you should see a message informing you that the database is up to date.


  • You have to back up your data before migrating them to TWCloud 18.5.
  • If you start TWCloud 18.5 with Cassandra database created using CEDW 18.3 or TWCloud 18.4 without migrating your data first, TWCloud will fail to start and an error message similar to the following will appear in server.log:

ERROR 2017-01-20 10:57:26.630 Connection to Cassandra failed: [com.nomagic.esi.server.core.impl.CoreManagerComponent, Component Resolve Thread]

java.lang.RuntimeException: Schema version is version 8, expected 12. Please do the migration.

To migrate data from CEDW 18.3 or TWCloud 18.4 (or 18.4 SP1) to TWCloud 18.5

  1. Stop TWCloud if it is running.
  2. Confirm that Cassandra is up and running.
  3. Run the command, nodetool drain, to flush all memtables from the node to SSTables on disk.

    C:\> cd "Program Files\DataStax Community\apache-cassandra\bin"
    C:\> nodetool drain

    For more information about the command, click this link:

  4. Stop Cassandra.
  5. Back up the Cassandra database on your machine. You can backup the database by copying the database stored folder. The following are default folders that you need to back up for each OS.

    Windows: C:\Program Files\DataStax Community\data
    Linux: /var/lib/cassandra

    Please note that the database folder can be changed by configuring cassandra.yaml. So, please make sure that you back up the correct folder.

    Alternatively, you can use the backup and restore script explained in Backup and restore data procedures. In this case, you will need to start Cassandra since the script makes use of nodetool utility which will connect to running Cassandra.

  6. If you want to upgrade your Cassandra version to 2.2.8, uninstall the old version and install Cassandra 2.2.8 in this step.


    TWCloud 18.5 supports Cassandra 2.2.8 and is NOT compatible with Cassandra 3.x.x.

  7. Start Cassandra and confirm that it is up and running.
  8. Download the migration tool zip and extract the zip file.
  9. Start the migration tool (migrator for Linux or migrator.exe for Windows).
  10. Issue the command, twcloud migrate, from the osgi console to start migration to TWCloud 18.5, as in the following example.

    osgi> twcloud migrate


  11. Wait for the migration process to complete.

    Successful data migration from CEDW 18.3 or 18.4 to TWCloud 18.5.
  12. Upgrade your TWCloud using the following instructions.

Upgrading to TWCloud 18.5

You need to migrate your data prior to upgrading to TWCloud 18.5.

To upgrade to TWCloud 18.5

  1. Uninstall CEDW 18.3 or TWCloud 18.4 from your machine. Do not uninstall Cassandra.
  2. If you do not need your data, delete the Cassandra database folder from your machine.


    By default, the Cassandra database folder is located in:

    • Linux: /var/lib/cassandra
    • Windows: C:\Program Files\DataStax Community\data
  3. Install TWCloud 18.5 on Linux or on Windows.
  4. Start TWCloud.

Updating projects 

Once you have successfully migrated data to TWCloud 18.5, you must update the projects in the database to the latest version. A project that is not updated will open in read-only mode. When you open the project in a modeling tool, the following notification appears. Project editing is disabled, because it uses system or standard profiles that are incompatible with the current installation.


Editing a project is not allowed until you update the project to the latest version.

You can see the same notification in the Notification Window. Therefore, you must update the project before you can edit it.

Editing a project that has not been upgraded to the latest version is not allowed.


You need an Administer Project permission to upgrade a project by migrating it. You can use the automatic server project migration feature to migrate all server projects at one time or migrate each server project manually. While the project is being migrated, other users are prevented from any modifications in that project. We highly recommend that the same person migrates all projects.

To migrate all server projects automatically

  1. Start the modeling tool and login on the TWCloud server.
  2. From the Collaborate menu, select Migrate All Project to Version X. The question message appears.
  3. Do one of the following:
    • Click Yes to migrate all server projects.

    • Click No to cancel this action.

After the project migration is completed, you will either get a message about successful project migration or a list of projects that were not migrated. You must migrate those projects manually.

To migrate server projects manually (for a user role with the Administer Projects permission)

  1. Start the modeling tool and login on the TWCloud server.
  2. On the main menu, click Collaborate > Projects. The Manage Projects dialog opens.
  3. Select a project and click . A dialog prompting you to update the System/Standard Profiles in the project to allow project editing opens.

  4. Click . The modeling tool updates your project opens a notification after it has successfully updated it.

  5. You can also open the Notification Window to see the same message about successfully updating the project.

  • No labels