Installation, Startup and Update: Teamwork Server

Installation and Startup - Teamwork Server and Teamwork Server Administrator Console

NOTE. On this page all of the following tools will be referred as modeling platform: MagicDraw, Cameo Enterprise Architecture, Cameo Business Modeler, and Cameo Systems Modeler.

1. Installing Teamwork Server and Teamwork Server Administrator Console

1.1. Installing Teamwork Server

1.1.1. Installing Teamwork Server - using installer

Windows 98/ NT/ 2000/ XP/ Vista/ 7/ 8

  1. Before you begin, ensure that your computer meets the minimal system requirements for running the program.
  2. Download either:
    • MagicDraw_<version number>_teamwork_server_win.exe for 32-bitWindows.
    • MagicDraw_<version number>_teamwork_server_win64.exe for 64-bit Windows.
  3. Double-click the installer.
  4.  If the User Account Control dialog appears asking permission for the installer to make changes in your computer, click Yes.
  5. Follow the on-screen instructions to install Teamwork Server.
  6. To start Teamwork Server, do one of the following:
    • On the taskbar in Windows, click the Start button, and then, click MagicDraw Teamwork Server.
    • Open the MagicDraw Teamwork Server installation\bin folder and double-click the teamwork_server.exe file.

Mac OS X

  1. Before you begin, ensure that your computer meets the minimal system requirements for running the application.
  2.  If you use earlier versions than modeling platform 17.0.5, 17.0.4 SP2, you must have the JVM installed on your computer.  See the list of recommended Java versions: http://www.nomagic.com/support/jvm-list.html
  3.  Download MagicDraw_<version number>_teamwork_server_mac.dmg.
  4.  Double-click the installer.
  5.  In the Teamwork Server installation window, drag the MagicDraw Teamwork Server folder to the Applications folder.
  6.  Close the MagicDraw Teamwork Server installation window.
  7.  To start Teamwork Server, open the Application / MagicDraw Teamwork Server installation folder and double-click the MagicDraw Teamwork Server.app file.
  8.  If the message appears asking permission to open the file, click Open.

Unix

  1. Before you begin ensure that your computer meets the minimal system requirements for running the application.
  2. You must have the JVM installed on your computer. See the list of recommended Java versions: http://www.nomagic.com/support/jvm-list.html
  3. Download MagicDraw_<version number>_teamwork_server_unix.sh.
  4. Double-click the installer.
  5.  Follow the on-screen instructions to install Teamwork Server.
  6. To start Teamwork Server, open the MagicDraw Teamwork Server installation/bin folder and double-click the teamwork_server file.

1.1.2. Installing Teamwork Server - using no-installer

You can download the no-install package to run the product on any operating system compatible with Java 6 or 7.

  1. You must have the JVM installed on your computer.  See the list of recommended Java versions: http://www.nomagic.com/support/jvm-list.html
  2. Ensure that your computer meets the minimal system requirements for running the application.
  3. Download either:
    • On Windows OS, Unix - MagicDraw_<version number>_teamwork_server_no_install.zip.
    • On Mac OS - MagicDraw_<version number>_teamwork_server_no_instal.mac.zip.
  4. Extract the files.
  5. To start Teamwork Server, based on the OS, do one of the following:
    • On Windows OS - open the MagicDraw_<version number>_teamwork_server_no_install\bin folder and double click the teamwork_server.exe file.
    • On Unix – open the MagicDraw_<version number>_teamwork_server_no_install/bin folder and double-click the teamwork_server file.
    • On Mac OS - open the MagicDraw_<version number>_teamwork_server_no_install_mac folder and double-click the MagicDraw Teamwork Server.app file.

1.2. Uninstalling Teamwork Server

1.2.1. Uninstalling Teamwork Server - using installer

Windows 98/ NT/ 2000/ XP/ Vista/ 7/ 8

To uninstall Teamwork Server, in the MagicDraw Teamwork Server installation > UninstallerData folder, double-click the Uninstall MagicDraw Teamwork Server.exe file.

Mac OS X

To uninstall Teamwork Server, right-click the MagicDraw Teamwork Server installation folder, from the shortcut menu, select Move to Trash.

Unix

To uninstall Teamwork Server, in the MagicDraw Teamwork Server installation > UninstallerData folder, double-click the Uninstall MagicDraw Teamwork Server file.

1.2.2. Uninstalling Teamwork Server - using no-installer

Windows 98/ NT/ 2000/ XP/ Vista/ 7/ 8

To remove Teamwork Server, delete the MagicDraw Teamwork Server installation folder.

Mac OS X

To remove Teamwork Server, right-click the MagicDraw Teamwork Server installation folder, then, from the shortcut menu, select Move to Trash.

Unix

To remove Teamwork Server, delete the MagicDraw Teamwork Server installation folder.

1.3. Installing Teamwork Server Administrator Console

1.3.1. Installing Teamwork Server Administrator Console - using installer

Windows 98/ NT/ 2000/ XP/ Vista/ 7/ 8

  1. Before you begin, ensure that your computer meets the minimal system requirements for running the program.
  2.  Download one of the following:
    •  MagicDraw_<version number>_teamwork_admin_win.exe for 32-bit Windows.
    •  MagicDraw_<version number>_teamwork_admin_win64.exe for 64-bit Windows.
  3.  Double-click the installer.
  4.  If the User Account Control dialog appears asking permission for the installer to make changes in your computer, click Yes.
  5.  Follow the on-screen instructions to install Teamwork Server Administrator Console.
  6.  To start Teamwork Server Administrator Console, do one of the following:
    • On the taskbar in Windows, click the Start button, and then, click MagicDraw Teamwork Administrator's Console.
    •  Open the MagicDraw Teamwork Console installation\bin folder and double-click the teamwork_admin.exe file.

Mac OS X

  1. Before you begin, ensure that your computer meets the minimal system requirements for running the application.
  2. If you use earlier versions than modeling platform 17.0.5, 17.0.4 SP2, you must have the JVM installed on your computer.  See the list of recommended Java versions: http://www.nomagic.com/support/jvm-list.html
  3. Download MagicDraw_<version number>_teamwork_admin_mac.dmg.
  4. Double-click the installer.
  5. In the Teamwork Server Administrator Console installation window, drag the MagicDraw Teamwork Server Administrator Console folder to the Applications folder.
  6. Close the MagicDraw Teamwork Server Administrator Console installation window.
  7. To start Teamwork Server Administrator Console, open the Application / MagicDraw Teamwork Server Administrator Console installation folder and double-click the MagicDraw Teamwork Console.app file.
  8.  If the message appears asking permission to open the file, click Open.

Unix

  1. Before you begin ensure that your computer meets the minimal system requirements for running the application.
  2.  You must have the JVM installed on your computer. See the list of recommended Java versions: http://www.nomagic.com/support/jvm-list.html
  3.  Download MagicDraw_<version number>_teamwork_admin_unix.sh.
  4.  Double-click the installer.
  5. Follow the on-screen instructions to install Teamwork Server Administrator Console.
  6.  To start Teamwork Server Administrator Console, open the MagicDraw Teamwork Console installation/bin folder and double-click the teamwork_administrator file.

1.3.2. Installing Teamwork Server Administrator Console - using no-installer

You can download the no-install package to run the product on any operating system, compatible with Java 6 or 7.

  1. You must have the JVM installed on your computer.  See the list of recommended Java versions: http://www.nomagic.com/support/jvm-list.html
  2.  Ensure that your computer meets the minimal system requirements for running the application.
  3.  Download MagicDraw_<version number>_teamwork_admin_no_install.zip.
  4.  Extract the files.
  5.  To start MagicDraw Teamwork Server Administrator Console, based on the OS, do one of the following:
    • On Windows OS - open the MagicDraw_<version number>_teamwork_admin_no_install\bin folder and double click the teamwork_admin.exe file.
    • On Unix – open the MagicDraw_<version number>_teamwork_admin_no_install folder and double-click the teamwork_administrator file.
    • On Mac OS - open the MagicDraw_<version number>_teamwork_admin_no_install_mac folder and double-click the MagicDraw Teamwork Administrators Console.app file.

1.4. Uninstalling Teamwork Server Administrator Console

1.4.1. Uninstalling Teamwork Server Administrator Console - using installer

Windows 98/ NT/ 2000/ XP/ Vista/ 7/ 8

To uninstall Teamwork Server Administrator Console, in the MagicDraw Teamwork Server Administrator Console installation> UninstallerData folder, double-click the Uninstall MagicDraw Teamwork Administrators Console.exe file.

Mac OS X

To uninstall Teamwork Server Administrator Console, right-click the MagicDraw Teamwork Server Administrator Console installation folder and from the shortcut menu, select Move to Trash.

Unix

To uninstall Teamwork Server Administrator Console, in the MagicDraw Teamwork Console installation > UninstallerData folder, double-click the Uninstall MagicDraw Teamwork Administrators Console file.

1.4.2. Uninstalling Teamwork Server Administrator Console - using no-installer

Windows 98/ NT/ 2000/ XP/ Vista/ 7/ 8

To remove Teamwork Server Administrator Console, delete the MagicDraw Teamwork Console installation folder.

Mac OS X

To remove Teamwork Server Administrator Console, right-click the MagicDraw Teamwork Console installation folder, then, from the shortcut menu, select Move to Trash.

Unix

To remove Teamwork Server Administrator Console, delete the MagicDraw Teamwork Console installation folder.

2. Starting Teamwork Server for the first time and activating license

2.1. Starting Teamwork Server with evaluation license

  1. Save the license key file locally (after purchasing Teamwork Server the license key file is emailed to you).
  2. Start Teamwork Server for the first time.
  3. In the Import Configuration dialog, do one of the following:
    • If you want to import projects and environment options from an earlier Teamwork Server version, select the location and click Import.
    • If you want to use the default options, click Use Default.
  4. In the Teamwork Server License Agreement window, read the license agreement and click I agree.
  5. In the Teamwork Server License Manager dialog, click the Select License Key Files button, and then in the Select License Key File dialog, select the license key file. Click Open.
  6. In the License Configuration dialog, check the demo expiration day, and then click OK.
  7. To start the Teamwork Server, in the Teamwork Server dialog, click the Start Server button.

2.2. Starting Teamwork Server with commercial license

Preconditions: You have purchased the product and received the license keys.

Starting Teamwork Server

  1.  Save the license key file locally (after purchasing Teamwork Server the license key file is emailed to you).
  2. In the Import Configuration dialog, do one of the following:
    • If you want to import projects and the environment options from an earlier Teamwork Server version, select the location and click Import.
    •  If you want to use the default options, click Use Default.
  3.  In the Teamwork Server License Agreement window, read the license agreement and click I agree if you want to continue using software. The Teamwork Server License Manager dialog appears.

Activating Teamwork Server license

The commercial license activation is required after the purchase transaction has been completed. The activation process allows receiving the commercial license dedicated for the particular computer.

Note that the Teamwork Server license activation is performed at www.nomagic.com

  1. In the Teamwork Server License Manager dialog, copy the text from the Host ID box. Note that without Host ID you will not be able to activate online.
  2. Open a new document, paste the Host ID and then save the document. Do not close dialogs in Teamwork Server. You will return back to them after the few steps.
  3. Go to www.nomagic.com.
  4. In the upper-right corner, click the Login button and then login with the license owner account.
  5.  Click to open the Licenses tab, and then the Activation tab.
  6. Under the Activation Records table, click the Create License Activation button (the button is active only if you are logged in as the license owner).
  7. In the Create New License Activation Record window, type the email address, click the Host ID box, paste the Host ID, and then select the Teamwork Server license to activate.

IMPORTANT! If you are going to use Teamwork Server 17.0.4 or later, you can specify the client versions that are compatible with the server (Teamwork Server 17.0.4 or later can accept connections from newer versions of client applications). For this, select the appropriate client version number in the Teamwork Server Client Version Limit drop-down list. In the result, the selected version, and all the prior versions of clients, will be able to connect to the server.  For more information about the client and Teamwork Server compatibility, see http://www.nomagic.com/support/compatibility.html#teamwork_server

  1. Click Save when you have finished. In the Activation Records table, the new record is displayed.
  2. In the Activation Records table, in the Get key column, click the send Send button to receive the license key by email or click the download Download button to save the key locally. You will receive the activated license key file, for example, Activated_key_For_<first name>_<last name>_.lic.
  3. In the Teamwork Server License Manager dialog (see the 3rd step of this procedure), click the Select License Key Files button.
  4.  In the Select License Key Files dialog, select the Activated_Key_For_<first name>_<last name>_.lic file and click Open.
  5. In the License Configuration dialog, learn about the license information and click OK.
  6. To start the Teamwork Server, in the Teamwork Server dialog, click the Start Server button.

2.3. Starting Teamwork Server without using GUI

To start Teamwork Server from the command line, start the teamwork_server_nogui executable file.

3. Stopping Teamwork Server

To stop Teamwork Server

  • In the <Teamwork Server installation>/bin folder, double click the stop_teamwork_server.

To stop Teamwork Server on Red Hat Linux

  • In the command line, type the following command:

service teamwork stop

4. Deactivating Teamwork Server license

The deactivation is the process which allows the return of activated licenses. You may remove and return all activated (locked to the particular computer) commercial licenses by deactivating them.

4.1.  Deactivating Teamwork Server license

  1. Start Teamwork Server.
  2. In the Teamwork Server dialog, click the License Manager button.
  3.  In the Teamwork Server License Manager dialog, click the Deactivate button.
  4. In the Offline License Deactivation dialog, copy the text from the License Deactivation ID box. Note that without Host ID you will not be able to activate online.
  5. Open a new document, paste the Host ID and then save the document.
  6. Go to www.nomagic.com.
  7. In the upper-right corner, click the Login button and then login with the license owner account. Note that you can deactivate the license only from the license owner account.
  8. Click to open the Licenses tab, and then the Activation tab.
  9. Click the Enter License Deactivation ID box and paste the License Deactivation ID.
  10. Click the Submit button. At the top of the window, under the Licenses tab, you can see the text: Successfully deactivated products.

4.2. Deactivating Teamwork Server license if the installation has been lost or corrupted

IMPORTANT! This deactivation should be used only if the deactivation in the product is not available: if the installation has been lost or corrupted. This manner of deactivation decreases the available rehost limit.

  1. Go to www.nomagic.com.
  2. In the upper-right corner, click the Login button and then login with the license owner account.
  3. Click the Licenses tab, and then click the Activation tab.
  4. In the Activated products column, click the edit Edit button.
  5. In the Edit Activation window, click to open the Deactivate tab.
  6.  Click to select the license and click the Deactivate Selected button.
  7. When you receive a message asking if you want to deactivate selected licenses, click OK. The license is deactivated. In the Products available to activate table, under the Rehosts column you will see that the allowed rehost number decreased. For example, if the rehost number is 1 of 2, you may deactivate offline only once.

5. Moving Teamwork Server to another computer (rehosting license)

Moving activated (locked to the particular computer) license from one computer to another is called rehosting.

  1. Deactivate the license on the old installation. For more Information, see Deactivating.

NOTE. Use deactivation from the software side or the deactivation with the License Deactivation ID. It is treated as the confirmed deactivation and does not decrease available rehost limit.

  1. Install the Teamwork Server on the new computer.
  2. Start the Teamwork Server.

6. Updating Teamwork Server

  1. Stop Teamwork Server.
  2. Start Teamwork Server. The Teamwork Server dialog appears.
  3. Click the Check for Updates button. The Update Information dialog appears.
  4. Do one of the following:
  • Click Update to New Version, to apply the latest released product version.
  •  Click Apply Patch, to apply the latest released service pack.
  1. If the new version or service pack uses the newer Java version, the message appears to download the required Java version. Click Yes. For more information about the recommended Java version, see http://www.nomagic.com/support/jvm-list.html.
  2. If you are updating to the new version, in the message informing that the deactivation is successful, click OK. Then start Teamwork Server.

7. Other

7.1. Changing Teamwork Server license key

  1. Start Teamwork Server. The Teamwork Server dialog appears.
  2.  Click the License Manager button.
  3.  In the Teamwork Server License Manager dialog, click the Select License Key Files button.
  4. In the Select License Key Files dialog, select the license key file and click Open.
  5.  In the License Configuration dialog, learn about the license information and click OK.

7.2. Determining the Host ID

The Host ID is required when activating or deactivating Teamwork Server.

  1. Start Teamwork Server. The Teamwork Server dialog appears.
  2. Click the License Manager button.  In the Teamwork Server License Manager dialog, the Host ID box, the Host ID is displayed.

NOTE. A Host ID is the media access control address (MAC address) of the computer on which the program will run.

7.3. Importing projects from earlier versions of Teamwork Server

If you have projects stored in earlier versions of Teamwork Server, you can import them automatically from the modeling platform, or do this manually.

To import projects using the modeling platform:

  1. After the installation is complete and the Teamwork Server is launched for the first time, the Import Configuration dialog opens.
  2. The path to the previous Teamwork Server installation is specified in the Location text box. You can change this path by clicking the "…" button.
  3. Click Import.

To import projects manually:

  1. Stop the earlier version of Teamwork Server.
  2. Replace the projects folder of the updated Teamwork Server with the projects folder of the earlier version of Teamwork Server. The location of the projects folder depends on the Teamwork Server version (see the following table).
Teamwork Server version Location of projects folder
17.0.3 or earlier

<Teamwork Server installation directory>\projects on all operating systems

17.0.4 or later

C:\ProgramData\.magicdrawserver\<version number>\projects on Windows 7/8

C:\Documents and Settings\All Users\ApplicationData\.magicdrawserver\<version number>\projects on Windows 2000/XP

C:\WINNT\Profiles\All Users\ApplicationData\.magicdrawserver\<version number>\projects on Windows NT4

<install.root>/projects on other operating systems

IMPORTANT! If you cannot find the particular directory, start Teamwork Server and then stop it. In the result, the directory will be created.

Migrating from the SVN/ClearCase repository to the Built-In repository type:

  1. Start the server on the SVN/ClearCase repository.
  2. Open the Administrator's Console, trigger project export. Select a directory to dump the permanently stored projects. This will be the directory in which the server will subsequently operate.
  3. In the Administrator's Console, reconfigure the server for the Built-In repository. Specify the directory where you stored the projects as the directory to work with.
  4. Restart the server in order to use this new repository. Projects are now in a new Built-In repository.

7.4. Changing the server port for the current launch

  1. Start Teamwork Server. The Teamwork Server dialog appears.
  2.  Click the Change Server Port button.
  3. In the Enter Port dialog, type the new server port. This port is used when launching the server, or when adding the Windows service.

NOTE. The Teamwork Server exports remote objects through one port: the RMI registry port.

7.5. Adding and Removing Teamwork Server to / from Windows services

7.5.1. Adding Teamwork Server to Windows services

  1. Start Teamwork Server. The Teamwork Server dialog appears.
  2. Click the Add Windows Service button. After the service is added, do one of the following:
  • Start this service from the Windows Services list.

  • Reboot the computer and the Service will start automatically.

  • To run the server, click the Start Server button.

NOTE. This feature is available only on Windows operating systems.

IMPORTANT! Windows 7 OS and Windows Vista OS Firewall do not allow remote connections. After adding Teamwork Server to Windows 7 or Windows Vista services, you must add the Teamwork Server port number 1100 in Windows Firewall Exceptions list. Only then all remote connections to Teamwork Server will be allowed.

7.5.2. Removing Teamwork Server from the Windows services

  1. Start Teamwork Server. The Teamwork Server dialog appears.
  2. Click the Remove Windows Service button.

NOTE. This feature is available only on Windows operating systems.

omg-member-logo

nomagic gartner-ad 2013

facebook 32 linkedin 32 twitter 32 youtube 32 rss 32