Upgrading to new version

When Visual Paradigm has released a new version of client products such as VP-UML, SDE, BP-VA, Agilian and DB-VA, you may want to upgrade to it as soon as possible. For users of Teamwork Server, do not forget to upgrade also the Teamwork Server. Otherwise, you will not be able to perform teamwork operations in the upgraded client products due to compatibility issues.

In this page, server administrator will learn how to manage and execute the upgrade process of Teamwork Server. Although the upgrade of Teamwork Server has to be done by server administrator, clients are also involved in ensuring the works are all committed to server prior to upgrading.

1. Get ready for the license keys and installers of the latest version of both Teamwork Server and client products. You can download them from your customer account by logging into our Customer Service Center.
2. Ask all team members to commit their works.
   

   Commit the changes in client products

3. In the server machine, stop the Teamwork Server by running %Teamwork_Server_Dir%\scripts\shutdown.bat (shutdown.sh for Linux and Mac OS X). If Teamwork Server was installed as a Windows service (for Windows users), run %Teamwork_Server_Dir%\scripts\remove_service.bat.
4. Zip the %Teamwork_Server_Dir%. Rename the zip file by appending the current date to filename.
5. Having downloaded the new version of VP Server server program to the server machine, extract it to the folder where you want the Teamwork Server to install to.
   

   Extracting the zipped Teamwork Server server program

6. Start up the server by running the VPServer\scripts\startup.bat file (startup.sh for Linux and Mac OS X). You may see a command console appear. Do NOT close it or else the server will be stopped.
   

   Command console

7. Open your Web browser and visit: http://127.0.0.1:1999/
8. The server installation page appears. Check Import Existing Server and specify the path of the old Teamwork Server installation (e.g. C:\Program Files\VPTeamworkServer).
   

   Enter the folder of old Teamwork Server installation

9. Click Select Module at bottom right to proceed.
10. In the Select Module page, keep Teamwork Module selected and optionally select the other module(s) you need to activate.
    

    Select Teamwork Module

    NOTE:

    You can select more than one modules. In this user's guide only the Teamwork Module will be covered. If you want to know the details about the other supported modules, please check from their user's guides.

11. Click Configure Database/Module at bottom right. The Configure Database page appears.
12. There is data that VP Server need to make persistent, such as your login name, password, server repository path, etc. All these have to be stored in a database. You need to prepare such database and fill in the connection information in this page. First, select your database management system from the Database drop down menu.

    Going to select a database

    NOTE:

    If you do not have a database available and if you just want to run Teamwork Server for evaluation, you may select Embedded DB as database, which is a ready-to-use database managemnet system built into the server. In other words, no additional database setup has to be made by choosing Embedded DB. However, it is NOT recommended to use Embedded DB for production purpose due to its genuine limitations.

13. Fill in the other fields. Click Test Connection to verify the connection.
    

    Database settings filled

14. Click Configure Module at bottom right. The Configure Teamwork Module page appears.
15. Specify the folder path of repository. Repository is where the project files will be stored. If you are uncertain, just leave it unchanged.
16. Click Configure Teamwork Module (ii) at bottom right.
17. The users added and defined in old Teamwork Server is listed here. Enter their Email addresses and new passwords.
    

    Enter email and password for users

18. Click Finish at bottom right to complete the installation. Now, you can start editing users and projects. For detailed instruction, read the next section for server administration. You should now see the users and projects appear the administration screen.
19. Ask ONE of the upgraded clients to update project from server.
20. Ask that client to commit to server.
21. Ask all the other team members to update project from server. This completes the upgrade process. Team members can continue their work now with the new version.