Skip to end of metadata
Go to start of metadata

Perform the procedures on this page ONLY if you are working with the latest Enterprise Studio release and have a tool configuration containing customizations made outside the Metamodeler, or if you are working with a version older than 4 (30 October 2019). Otherwise, following the instructions from Updating to a new Enterprise Studio release

On this page:


Upgrading your custom configuration to a new tool configuration

On-premise solution

Working with a custom configuration in Enterprise Studio requires you to upgrade your configuration to a new tool configuration when updating Enterprise Studio to a newer version. Please check the following conditions before upgrading your custom configuration to a new tool configuration:

  • Your customizations are located in additional MPS and MPD files, not in the original configuration files. If your customizations are located in original configuration files, please contact BiZZdesign Support. Do not perform the upgrade procedure.
  • Your customizations are located in the CustomData folder(s) in your configuration. If they are not, please contact BiZZdesign Support. Do not perform the upgrade procedure.

Steps:

  1. Create a copy of the configuration folder of the newly installed Enterprise Studio version. It is located in the tool's installation folder.

  2. If you have one or more customData and (possibly) customViewpoints folders in your metamodels, copy each folder from your old custom configuration to the associated metamodel folder in your copy of the new configuration. Example:



    If you do not have these folders, do the following:

    1. Open the model package with the customizations.

    2. On the File tab, go to Manage Package > Manage Configuration, and click on the metamodel containing the customizations.



      A new instance of Enterprise Studio opens with a metamodel package with a representation of the selected metamodel and a view with your customizations.

    3. On the Metamodel tab, click Export, select the configuration folder in your copy of the new configuration, and click OK.



    4. Repeat this for all metamodels containing customizations.

    Now you have a new tool configuration including your customizations.

  3. Start the new Enterprise Studio, and in the Enterprise Studio Options, on the Configuration tab, change the configuration location to the location of the new tool configuration (File > Options).

    Also select the Reload configuration at startup check box.



  4. Save the changes, close the window, and restart Enterprise Studio.

  5. Test the new configuration. Check if all customizations work as they should be.


If the customizations are ok, Manually upgrading the tool configuration and migrating model packages to the new configuration#migrate your Team Server model packages to the new custom configuration.

Hosted solution

Follow this procedure to upgrade your custom configuration to the new tool configuration of Enterprise Studio Online, and to make your Team Server model packages compatible with the new configuration in the latest version of Enterprise Studio Online. 

Steps:

  1. Contact BiZZdesign Support to request the latest default tool configuration. Save the received file somewhere on your local device.

  2. Start an Enterprise Studio Online session, and in the remote session toolbar, click .

  3. In the My Files window, click the Temporary Files folder.

  4. Upload the configuration zip file by dragging it from your local device onto the My Files window, or click Upload Files in this window and select the file from your local device. The added file is shown in the window.

    Take note that the file will only be saved for the current session. It will be automatically removed from the Temporary Files folder once the session ends.



  5. In the remote session toolbar, go to , and open the  File explorer.

  6. Move the configuration zip file from the Temporary Files folder to the shared network location, and unzip the file.

  7. If you have one or more customData and (possibly) customViewpoints folders in your metamodels, copy each folder from your old custom configuration to the associated metamodel folder in your copy of the new configuration. Example:


     
    If you do not have these folders, do the following:

    1. Open the model package with the customizations.

    2. On the File tab, go to Manage Package > Manage Configuration, and click on the metamodel containing the customizations.



      A new instance of Enterprise Studio opens with a metamodel package with a representation of the selected metamodel and a view with your customizations.

    3. On the Metamodel tab, click Export, select the configuration folder in your copy of the new configuration, and click OK.



    4. Repeat this for all metamodels containing customizations.

    Now you have a new tool configuration including your customizations.

  8. In the Enterprise Studio Online Options, on the Configuration tab, set the configuration location to the location of the new tool configuration (File > Options).

    Also select the Reload configuration at startup check box.



  9. Save the changes, close the window, and restart Enterprise Studio Online.

  10. Test the new configuration. Check if all customizations work as they should be.


If the customizations are OK, Manually upgrading the tool configuration and migrating model packages to the new configuration#migrate your Team Server model packages to the new custom configuration.

Migrating Team Server model packages to a new tool configuration

If a new tool configuration becomes available (because of a new release or new customizations), model packages stored on the Team Server need to be migrated to become compatible with the new configuration. A model package only needs to be migrated once. After migrating and committing, the changes will be available to the other users working on the model package. Please be aware of the migration limitations before you start a migration.

  1. In Enterprise Studio, open the model package from the Team Server.

  2. On the File tab, click Options, and then click the Configuration tab.



  3. Click Start migration, and then click OK to proceed.

    If a message appears indicating that the model package is already up-to-date, you do not need to migrate the model package. Click OK to exit the migration procedure.

  4. The migration starts. If migration is successful, a confirming message appears. Click OK to complete the procedure.



    If the model package cannot be migrated, a message will appear indicating the reason. Click OK to exit the migration procedure, and resolve the problem. For more information about possible solutions, see Model package migration troubleshooting.

  5. You are redirected to the Commit page. Click Commit to commit the configuration changes (indicated by the icon).

    Enter a version number of the configuration you have migrated to in the Comments box. That way you can see in the model package's timeline which configuration version you are working with.


Migration of the model package is now complete. The configuration changes will become available to other users participating on the model package. They need to update their copy of the model package to include the configuration changes.

If the migrated model package has projects based on it, these projects need to be updated with contributions from the master model package to include the configuration changes.

Users contributing to these projects can include the configuration changes in their copies of the project by updating their project with contributions from other users.