Skip to end of metadata
Go to start of metadata

This topic describes the installation and setup of Enterprise Studio and the Team Server. The Team Server is a component of the Team Platform functionality in Enterprise Studio. It facilitates working together on model packages, stores the administration of shared model packages and the participating users, and acts as license server.

The Enterprise Studio and Team Server installer files are available at request. Please  contact  BiZZdesign Support, and request the latest software release.

These instructions apply to new  installations, and to the latest release of Enterprise Studio. For updating your existing Enterprise Studio to a newer version, please refer to Updating to a new Enterprise Studio release.

Installation and setup should only be done by application administrators who are familiar with installing and configuring software and databases.


On this page:


Installing and setting up a Team Server

Contents of the installation bundle

The Team Server installation bundle contains the following files:

File

Explanation

3rdparty\

Legal documents of third-party libraries (licenses etc.)

service\

Files needed to install the Team Server

license.txt

BiZZdesign software license

readme.txt

-

Installing the database

The Team Server can run on a Microsoft SQL Server or PostgreSQL database.

  1. Create a new empty SQL Server or PostgreSQL database.

  2. Create a database user having at least read and write rights for the created database. The user needs the "db_owner" role.

Configuring network access for SQL Sever

Perform this procedure only if you have installed an SQL Server database.

Enterprise Studio uses the network to connect to an SQL database, even when it is locally installed. The following steps must be performed to successfully connect to the SQL Express database.

  1. Open the SQL Server Configuration Manager.

  2. In the SQL Server Configuration Manager window, expand the SQL Server Network Configuration and click Protocols for SQLEXPRESS, or something similar if your are using a different SQL.

  3. In the list of protocols for SQLEXPRESS, right click TCP/IP, and then click Enable.



  4. Right click TCP/IP once again and subsequently click Properties.

  5. Click the IP Addresses tab and scroll down to IPAll. Set the TCP Port, for example to 1433.



  6. In the SQL Server Configuration Manager window, select the SQL Server Services and restart SQL Server (SQLEXPRESS) by right clicking it and then clicking Restart.

Installing the Team Server as a Windows service

After installing the database, follow the procedure below to install Team Server as a Windows service.

  1. Unzip the Team Server installer file to a location on the hard drive where the Team Server must be installed.

  2. Rename the unzipped folder teamserver-bundle- version number to TeamServerHome, and move the contents of the service folder (not the folder itself) to the TeamServerHome folder. The structure of your Team Server installation should look similar to this:



  3. In the TeamServerHome\conf folder, open the wrapper.conf file in a text editor, and configure the following parameters.

    Make sure that each parameter you add is unique. Each parameter has a property name which starts with "wrapper.java.additional.n". The "n" component is an integer number counting from 1. By default, the numbering should be in sequence without gaps.

    Update the HTTP port: Update the HTTP port under which the server must be running. By default, port 9000 is set. You can choose your own port by editing the port number:

    wrapper.java.additional.2 = -Dhttp.port=9000

    Set the JVM memory settings (optional): If desired, set your own JVM memory settings. Set the initial size (xms) and max size (xmx).

    wrapper.java.additional.3 = -Xms<initial size>m

    Set the initial size to at least 768 MB. Example:  wrapper.java.additional.3 = -Xms768m

    wrapper.java.additional.4 = -Xmx<max size>m

    The max size depends on how much memory you want to allocate. Make sure to leave some memory left for other applications and the OS. Example: wrapper.java.additional.4 = -Xmx2048m

    Use HTTPS instead of HTTP (optional): If you want to use HTTPS instead of HTTP, please refer to Using an official HTTPS certificate for the Team Server, and follow the instructions.

    Configure Team Server log rotation (optional): The Team Server logs contain technical information about events when running the Team Server. By default, the logs will be rolled based on the size of the log file with a maximum of 10 MB, and a maximum of 10 files will be kept. If you want to use log rotation with different limits, or configure log rotation based on date, please refer to Configuring Team Server log rotation, and follow the instructions.

  4. Verify that the Team Server is correctly configured:

    1. In the TeamServerHome\bat folder, run the runConsole.bat file. When it's finished, leave the Command prompt open.



      If the text in the Command prompt ends with "Press any key to continue", then an error occurred during the execution. Check the information in the Command prompt, press any key to close the window and fix the reported problem.

    2. Open your web browser and point locally to http://servername:portnumber . Replace servername with the name of the computer you are installing the server on and replace portnumber with the specified port number. You should see the Team Server setup page:



      If the page is not displayed immediately, refresh it.

  5. If everything is running correctly, close the web page. Press Ctrl+C in the Command prompt to stop the Team Server, type Y and press Enter to terminate the batch job and close the window.

  6. Install the service by running the Command prompt as administrator, navigating to the TeamServerHome\bat folder, and running the installService.bat file.

  7. Also in the Command prompt, start the service by navigating to the TeamServerHome\bat folder and running the startService.bat file, or go to Control Panel > Administrative Tools > Services and start the service there. The service is called Team Server version.

    If the service does not start properly, and an error message appears, please refer to Windows service cannot be started during Team Server installation for more information and the solution.

Configuring the Windows firewall (optional)

Verify that the specified port number is open to other users. If not, configure your Windows firewall in order to make it accessible. Use Windows Firewall with Advanced Security to create a new incoming rule for the port by right clicking Inbound Rules and then clicking New Rule. Make sure you clear the Public check box in the list of network profiles while adding the new rule.


Setting up the Team Server

After installing the Team Server, set up the server and create the initial administrator user.

  1. Open your web browser and enter the address the users will use to access the Team Server. Example: http://bizzteamserver:9000

    The Team Server setup page appears.

  2. Under Configure Team Server identity, identify the installed server by entering a display name and specifying its server protocol, hostname and port.



  3. Under Configure database connection, select the type of database you use, and configure the connection. Test the connection by clicking Test connection.



  4. Optional: Select the Integrated security check box if you want to enable logging in on the Team Server using a Windows account, and perform the following steps.
    This option is not available if you use a PostgreSQL database.



    1. If you are using the JDBC driver, download the sqljdbc_auth.dll file from: https://msdn.microsoft.com/en-us/library/ms378428.aspx . Make sure you download the correct version.

    2. Save this dll file on a location that is accessible in Windows, for example C:\Windows\System32 or ..\Program Files\Java…

    3. After that, restart the Team Server Service.

    4. Make sure the login user for the Team Server Service has rights to be able to access the database and Team Server. Per default your service will be added as "local system" account. It might be necessary to change this login for a user who has access to those components.

  5. Under Configure e-mail settings , specify the e-mail settings for the Team Server.



  6. Test the e-mail settings. In Recipient, fill out an e-mail address that is outside your mail server domain, and then click Send test e-mail.



  7. Under Configure initial system administrator, create the initial system administrator user for the Team Server.



  8. Under Finish Team Server setup, click Finish setup to complete the Team Server setup.

Activating the license

  1. Sign in to the Team Server as a System administrator user, and in the sidebar menu, go to Settings > License.

  2. Copy the license key you have received from BiZZdesign, and paste it in License key.

    If you have not received a license key, please contact BiZZdesign Support.



  3. Click Apply to save the changes.


If activation is successful, License status is set to 'Active', and Expires on shows an end date for the license.

Installing Enterprise Studio

Install Enterprise Studio on the computers on which it should run. To install Enterprise Studio, you must have administrator rights on that computer.

During installation of Enterprise Studio you will be prompted to close all open applications. If you leave applications open, unsaved data may be lost.

  1. Save the Enterprise Studio installer file (zip) somewhere local to a temporary location.

  2. Extract the zip file and double-click the EnterpriseStudioSetup.exe file to start the installation.

  3. The installation wizard starts. If you want to install Enterprise Studio on a different location than the default, or if you want to deactivate file associations with Enterprise Studio, click Options and make the desired changes before you proceed. Otherwise, follow the steps of the wizard.



  4. After installation is complete, click Close.


To continue, each user requires a license, enabling him or her to work with Enterprise Studio. This license can be acquired by registering with the Team Server.  Add users to the Team Server (manually or via an identity provider) using the initial System administrator user. Once users are registered with the Team Server, they can download the Team Server configuration file and add it to Enterprise Studio in order to receive a license and access to the Team Server.