Skip to end of metadata
Go to start of metadata

Below you can find the actions that need to be performed when updating your Enterprise Studio software to a specific release. The latest release is listed first.


On this page:


Update to Enterprise Studio 4

ReleaseDetails
7 September 2020No specific actions required.
6 August 2020

No specific actions required.

12 July 2020

Change for Dashboards may require renaming Kibana Index Patterns

As part of the upgrade to this release, there is a mandatory action to drop and recreate all Elasticsearch indices. Because of this change, Kibana index patterns that your Kibana visualizations are based on may break, causing visualizations in dashboards to no longer display data. 

If you are affected by this action, then you must rename your Kibana index pattern(s) to restore the visualizations. Unfortunately this is not possible using Kibana's user interface, but there is a solution:

  1. Open the Kibana user interface (by editing a dashboard, or creating a new one) and navigate to Management > Saved Objects.

  2. In the Saved Objects pane, click the "Type" drop down menu and select "index-pattern".

  3. Click the check box for the affected index pattern.

    If you have multiple affected index patterns, process the remainder steps for each index patterns separately.

  4. A file named "export.json" should download or prompt to be saved to a location. You can optionally rename it to something less generic.

  5. Open the file with a text editor, and near the top of the file locate the "title" key in the json block. The title value includes the name of the model package, looking something like this:

    [
      {
        "_id": "020b3921-619-37e5-bc93-52d74295b81a",
        "_type": "index-pattern",
        "_source": {
          "title": "dashboard-1-1-name_of_model_package",
    ...

    Change the title value to the new corresponding index pattern (e.g. dashboard-1-1) by removing the model package name, and save the file. Be sure not to change any other values, especially the id value.

    It should be apparent what the new index pattern name should be (because your original index pattern will likely contain the dashboard* prefix) but if you want to double check the index pattern, you can see all existing index patterns in the Kibana interface at Management > Index Patterns to derive the correct name.

  6. Return to the Kibana user interface and click Management > Index Patterns.

  7. Delete the old index pattern (e.g. dashboard-1-1-name_of_model_package).

  8. Go back to Management > Saved Objects, and click on the import link on the top right of the page. In the Import saved objects window, click the Import link, select the json file that you modified in Step 6 and click Import.

  9. Navigate back to Management > Index Patterns and confirm that the new (renamed) index pattern is present. You can reset the default index if applicable.


It may take a few minutes for the dashboards to begin displaying properly.

If you are unable to work through these steps to rename the index pattern, please contact BiZZdesign Support for further assistance.

23 June 2020

No specific actions required.

28 May 2020 No specific actions required.

18 May 2020

New JDBC driver required for on-premise Team Server with MSSQL and integrated security

If you are working with an on-premise installation of the Team Server, using MSSQL, and using integrated security for the Team Server, you need to download a new JDBC driver for the Team Server before updating to the new version. If you are not sure whether you use integrated security, you can check it as follows:

  • Open the teamserver.config.json file (in TeamServerHome folder), and in the database section check if singleSignOn is set to true:

    "singleSignOn" : true,

    If set to true, you are using integrated security.
Steps:
  1. Uninstall the old Team Server (step 1 of the procedure for updating the Team Server).

  2. Download the file mssql-jdbc_auth.zip from https://github.com/microsoft/mssql-jdbc/releases/tag/v8.2.0.

  3. Unzip the file, get the correct .dll file (32 or 64 bit), and place the file in the folder where the current JDBC file is located. It is a directory listed in the java.library.path system property. On Windows, this is set to the value of the PATH environment variable.
    Do not remove the old JDBC file, unless you are certain that it is not used by other applications.

  4. Install the new Team Server (step 2 of the procedure for updating the Team Server ).
2 March 2020

No specific actions required.

24 January 2020 No specific actions required.
20 December 2019 No specific actions required.

5 November 2019

New licensing system available for on-premise solution

In this release the new licensing system is available for the on-premise installation, and requires the availability of a Team Server, which acts a the licensing server.

Customers running Enterprise Studio with a Team Server

After installing the new Team Server and new Enterprise Studio, and before upgrading any custom configurations and migrating model packages, perform the following instructions for registering your new license code:

  1. After installing the new Enterprise Studio, sign in to the new Team Server as a System Administrator user, and click Settings > License.

  2. In License key, enter the license key you have received, and click Apply to save the changes.

Continue upgrading custom configurations (if applicable) and migrating your model packages.

Customers running Enterprise Studio without a Team Server

Perform the procedure for installing a new Enterprise Studio with a Team Server to update to this release. Do not perform your regular update procedure. For instructions, please refer to Enterprise Studio and Team Server installation .

Team Server requires Java 11

As of this release the Team Server is no longer compatible with Java Runtime Environment (JRE) 1.8 or OpenJDK 8. You will need to update to Oracle JDK 11 or OpenJDK 11.  OpenJDK11 can be downloaded here: https://github.com/ojdkbuild/ojdkbuild . Choose the 11 version. For easier installation, it is advised to download the MSI file.

If you encounter any problems starting the Team Server after installing Java, please refer to Unable to start the Team Server after installing Java 11.

23 October 2019 No specific actions required.
5 September 2019 No specific actions required. Only available for hosted solution.
13 August 2019 No specific actions required. Only available for hosted solution.
2 August 2019 No specific actions required. Only available for hosted solution.
18 July 2019 No specific actions required. Only available for hosted solution.

11 July 2019

New licensing system, only available for hosted solution

This release comes with a new licensing system that requires the availability of a Team Server, which acts a the licensing server. The release is only available for customers with the hosted solution Enterprise Studio Online. Customers with the hosted solution can continue working with the release.

29 May 2019

No specific actions required.

18 April 2019No specific actions required.
11 March 2019No specific actions required.
8 February 2019No specific actions required.
6 February 2019No specific actions required.
1 February 2019

No specific actions required.

29 January 2019

Enterprise Studio compatibility with Team Server

Enterprise Studio versions older than 3.3 are not compatible with the Team Server of this 4 release. If you are running an Enterprise Studio version on premise that is older than 3.3, and your Team Server is running on premise or online, you need to update your Enterprise Studio to the 4 release in order to be able to use the Team Server of this 4 release.

20 November 2018No specific actions required.
5 November 2018No specific actions required.
31 October 2018No specific actions required.
24 October 2018No specific actions required.
19 October 2018No specific actions required.

Update to earlier releases

ReleaseDetails

Enterprise Studio 3.3.1

No specific actions required.

Enterprise Studio 3.3

Changes in software installation

As of this release, you will be prompted to close all open applications during the installation of Enterprise Studio. If you leave applications open, unsaved data may be lost.

Changes in Azure AD configuration for user authentication

If your organization is using Azure Active Directory for user authentication in the Team Server and HoriZZon (if applicable), please read the following information.

In Enterprise Studio 3.3 it is required to register a client application secret. If there is no secret registered, the Team Server will not be able to authenticate with Azure AD, and users will not be able to sign in to the Team Server and HoriZZon. To be able to retrieve the secret, a new BiZZdesign authentication application needs to be created in Azure AD. The secret, tenant ID, and client application ID of the new authentication app need to be registered on the Authentication settings page in the Team Server.

For instructions please refer to the following:

Changes in Active Directory configuration for user authentication

If your organization is using Active Directory for user authentication in the Team Server and HoriZZon (if applicable) and not using a keytab, please read the following information.

In Enterprise Studio 3.3 Kerberos (Windows Integrated Authentication) requires a keytab. If you do not use a keytab yet, please make the necessary changes in your Active Directory configuration in the Team Server, otherwise users will not be able to sign in to the Team Server and HoriZZon.

Enterprise Studio 3.2

If you have custom viewpoint definitions and/or custom ArchiMate® menu definitions in your custom tool configuration, follow the steps below to successfully upgrade them to the new tool configuration.

  1. Upgrade your current custom configuration to the new 3.2 tool configuration.

  2. Migrate your Team Server model packages to your new tool configuration.


If you only have custom viewpoint definitions, you are ready now.

If you have custom ArchiMate menu definitions (located in "AbstractContainer-new-menu.xml" and "AbstractView-new-menu.xml"), open the ArchiMate metamodel of your new tool configuration in the Metamodeler, and recreate your custom menu in the "Menu definition" file. For instructions, please refer to the Metamodeler Guide.

Enterprise Studio 3.1.7

No specific actions required.

Enterprise Studio 3.1.6

No specific actions required.

Enterprise Studio 3.1.5

No specific actions required.

Enterprise Studio 3.1.1

No specific actions required.

Enterprise Studio 3.0.4

No specific actions required.

Enterprise Studio 3.0.2

No specific actions required.

Enterprise Studio 3.0.0

Commit outstanding changes before installing new tool version

If you are updating from Enterprise Studio version 2.5.0 or lower to version 3.0.0, commit all outstanding changes in your Team Server model packages before updating to Enterprise Studio 3.0.0.

This is not needed if you are updating from version 2.6.0 to 3.0.0.

Enterprise Studio 2.6.0

Commit outstanding changes before installing new tool version

Commit all outstanding changes in your Team Server model packages before updating to Enterprise Studio version 2.6.0.

Enterprise Studio 2.5.0

No specific actions required.

Enterprise Studio 2.4.0

Update Team Server configuration file if using HTTPS

If you are using HTTPS for your Team Server installation (using certificates), you need to update the Team Server configuration file when updating your Team Server for this release, because the configuration properties for HTTPS have changed.

The following properties must be changed:

  • https.keyStore
  • https.keyStoreType
  • https.keyStorePassword

For the new property names, please refer to Enterprise Studio release-specific required actions.

Convert TDM models to DMN

If you are working with the TDM (The Decision Model) functionality, you need to convert your existing models to equivalent DMN models in order to continue working with them. To do this, follow the instructions in Enterprise Studio release-specific required actions.

Enterprise Studio 2.3.0

Changed Team Server password storage requires re-entering storage place credentials

The Activity Console no longer stores passwords to connect with the Team Server. It uses cookies instead. As a result of this existing storage places will fail to connect, because there is no cookie available yet. The Activity Console will also point this out by indicating that a specific storage place could not be synced.

To resolve this, the user needs to update each storage place connection in Enterprise Studio by reentering the credentials for the storage place. The storage places can found on the Storage Places tab of the Enterprise Studio Options (File > Options).


ArchiMate® is a registered trademark of The Open Group.