Вы находитесь на странице: 1из 42

Server installation

© AUVESY GmbH

Last updated: 12 November 2018

Fichtenstrasse 38 B
D-76829 Landau
Germany
TOC

Server installation 3

Install versiondog server with no client 4

Install new server with client 11

Install server with existing server archive 20

Install server with existing server archive plus client 26

Updating the server 34

Moving the server 37

Uninstall the server 40

2
Server installation

This tutorial aims to provide the user with information essential for installing, updating, moving and
uninstalling the versiondog server.

The information provided in this tutorial is based on versiondog 5.0 with Windows 7 operating sys-
tem. The text and images referred to here may vary depending on your versiondog software and oper-
ating system. The tutorial assumes that the user has basic knowledge of the versiondog system and
some knowledge of versiondog system administrators.

All information presented in this tutorial is based on single server systems. Parallel servers need to

be set up separately. For more information,see Setting up a parallel server system.

FAQ: Installation of the versiondog server fails. What could be the reason for this?

If at first the setup routine appears to be running smoothly, but then at a certain point stops and
suddenly fails, it is often due to an antivirus program preventing the installation.

SOLUTION

Temporarily deactivate the antivirus program and then install the versiondog server.

Do not forget to reactivate the antivirus program after the installation process has been completed!

If (rather than deactivating your antivirus program) you would prefer to create an exception for

the versiondog installation process in your anti-virus settings, please contact support for a list of ser-
vices/processes.

3
Install versiondog server with no client

The versiondog client applications are required for configuring and managing the versiondog server. If
you install the versiondog server with no client, you will need to install the client applications sep-
arately. For more information, see Installing the client applications .

Requirements for installation:

l Access to the versiondog setup file

l A valid versiondog licence file

l User account with administrator rights

l The drive used for storing the server archive has to allow files to run. There is a possibility that
existing antivirus programs will need to be temporarily deactivated if they interfere with files
being run
If you don't have administrative rights, you will not be able to run files and when you try to log
in to the system an error message (SQLException) will appear. Login is not possible

l The hardware and software requirements for the installation need to be met
If these requirements are not met, it is not possible to properly install the product. For more
information about the latest hardware and software requirements, see Installation require-
ments

To install a new versiondog server with no client, proceed as follows:

1. Start the setup on the PC (that you wish to use for the installation) by double-clicking on the file
Setup.exe

2. The installation wizard will prompt you to select a language. English and German are currently
available

3. On the welcome page of the setup wizard, click on Next

4
4. Select Install versiondog applications and click on Next

5. Select I agree. and click on Next

If you do not agree to the licencing requirements, the installation process will be ter-

minated.

6. Select Install server applications and click on Next

5
7. Select New server (no client) and click on Next

8. Enter the path to the versiondog licence file and click on Next

You can do this by entering it manually or you can click on Browse...

9. Specify a path and a directory for the program files of the versiondog server applications.

You can enter the path and directory manually or you can click Browse...

6
We recommend retaining the path suggested by the installation wizard:

l C:\Program Files\vdogServer

The Path to the client applications: is displayed, however, it is greyed out. If no client

applications are installed, it is not possible to make an entry in the field

10. Click on Next

11. Choose where to save the server archive. The following options are available:

l Local:
The server archive is saved in a local directory

l Remote:
The server archive is saved in a remote server archive

12. Click on Next

13. Enter the path and directory for the local server archive and the client setup files.

If you selected the option Remote: as the location of the server archive, the Path to the
project file on an external drive will be displayed. Enter the path to the remote server
archive (Format:\\Systemname\Release\Path)

You can enter the path and directory manually or you can click on Browse...

We recommend retaining the path suggested by the installation wizard:

7
l D:\vdServerArchive

l D:\vdServerArchive\vdog client setup

For technical reasons, if you select the option Remote: you need to also specify a

path to the local server archive

If you selected the optionRemote: the user account that runs the installation needs

to have read and write rights on the remote system

The server archive contains a wide variety of data types: versions, backups,

metadata etc. Make sure that you have enough space available for the server archive.

14. Click on Next

15. If you wish to create a network that will make the versiondog client setup files available via your
network, check the box Create the above network share. The Create network share option is
not active by default. The name of the network share is vdog client setup.

By default, all users have read rights to this directory and administrators have full rights.

16. Click on Next

8
17. Select the user account from which the versiondog services will start. You can choose between
the options Local system account and Username. We recommend selecting the Username
option and enter a user account that has administrator rights

The user account needs to have full access rights to the server archive. The local system

account may not have the required rights

If you choose to use a domain account, the domain must always be specified. Format:

<Domain>\<User name> (Example: DATAMAN\TomT)

18. Click on Next

19. If you wish to install versiondog sample files, activate the option Install sample files

The Install sample files option is not active by default. The sample files are used only for

the purpose of illustration. The versiondog system is still fully functional without sample files.

20. Click on Next


A summary of your input will appear

21. Verify the displayed data. If everything is correct, click Next


The setup will begin. A dialogue will indicate when the installation process is complete

9
If the Windows Firewall service is not active during the installation of versiondog, a dialogue

will appear. To proceed with installation process, click on Continue

22. After successfully completing the installation, click on Finish to close the installation wizard

10
Install new server with client

When installing a new versiondog server with client, both the versiondog server applications and the
client applications are run on the same computer.

Requirements for installation:

l Access to versiondog server file

l A valid versiondog licence file

l User account with administrator rights.

l The drive used for storing the server archive has to allow files to run. Likewise, the drive used to
store the client archive has to also allow files to run. There is a possibility that existing antivirus
programs will need to be temporarily deactivated if they interfere with files being run.
If you don't have administrative rights you will not be able to run files and when you try to log
in to the system an error message (SQLException) will appear. Login is not possible

l The hardware and software requirements for the installation need to be met
If these requirements are not met, it is not possible to properly install the product. The latest
hardware and software requirements can be found in the tutorial Installation requirements

To install a new versiondog server with client, proceed as follows:

1. Start the setup on the PC you wish to use for the installation by double-clicking on the file
Setup.exe

2. The installation wizard will prompt you to select a language. English and German are currently
available

3. On the welcome page of the setup wizard, click on Next

11
4. Select the Install versiondog applications option and click on Next

5. Select I agree. and click on Next

If you do not agree to the licencing requirements, the installation process will be ter-

minated

6. Select Install server applications and click on Next

12
7. Select New server with client (both on this computer) and click on Next

8. Enter the path to the versiondog licence file and click on Next

You can enter the path manually or click on Browse...

9. Select the desired program add-ons

Options:

13
l BackupClient
This option is displayed, but cannot be selected when a server installation (with client) is
being setup. The versiondog BackupClient cannot be installed on a computer on which a
versiondog server is installed.
The BackupClient allows users to create backups for automation devices that otherwise
cannot be accessed by the versiondog system. It is used whenever there is no con-
nection between the production level networks and the versiondog server. For more
information, see BackupClient

l LibraryManagement
The LibraryManagement option is not active by default. However, the box can be
checked and the LibraryManagement add-on installed. Whether or not you can imme-
diately use LibraryManagement after the installation is complete, depends upon which
versiondog licence you have purchased. The LibraryManagment add-on is only included
in the versiondog EP Standard Edition. Users of other editions of versiondog need to pur-
chase a separate licence for LibraryManagement. The LibraryManagement is a version
control system used to track standard programming blocks. For more details, see
LibraryManagement

l Register file extension for SmartImport for supplier projects


This option is active by default, but it can be unchecked. If this option is selected, a Win-
dows Registry entry will be written which makes it possible to open a versiondog sup-
plier delivery note (*.vdog-sdn) file by double-clicking on it in file manager. If this option
is NOT checked, no Registry entry will be written and *.vdog-sdn files can only be opened
via versiondog UserClient
You can use the SmartImport for supplier projects to Check-In files that were changed
outside of the versiondog system. For more information, see SmartImport for supplier
projects

14
10. Click on Next

11. Specify the path to the versiondog server applications and to the client applications

You can specify the paths and directories manually or you can click on Browse...

We recommend retaining the path suggested by the installation wizard:

l C:\Program Files\vdogClient

l C:\Program Files\vdogServer

12. Click on Next

13. Choose the desired location for the server archive. The following options are possible:

l Local:
The server archive is stored in a local directory

l Remote:
The server archive will be stored in a directory that is located on a remote computer

14. Click on Next

15
15. Enter the path to the local server archive, the client setup files directory and the local client
archive on the server

If you have selected the option Remote: as the location in which to store the server
archive, the field Path to the project files on an external drive: is displayed. Enter the
path to the remote directory in the field "Path to the project files on an external drive
(Format \\Systemname\share\path)

You can specify the paths and directories manually or you can click on Browse...

We recommend retaining the path suggested by the installation wizard. Examples:

l D:\vdServerArchive

l D:\vdServerArchive\vdog client setup

l D:\vdClientArchive

For technical reasons, even if you have selected the option Remote: you are still

required to enter the path to the local server archive

If the Remote option is chosen, the user account needs to have read and write rights

to the remote system.

16
The server archive contains a wide variety of data types: versions, backups,

metadata etc. Make sure that you have enough space available for the server archive

16. Click on Next

17. Grant all users with an account on the PC access to the versiondog client archives by checking
the box

The option Grant rights to "All Users" is active by default

18. Click on Next

19. If you wish to create a network share that will make the versiondog client setup files available
via your network, check the box Create the above network share. The option Create the
above network share is not active by default. The name of the network is vdog client setup.

17
By default, all users have read rights to this directory and administrators have full rights.

20. Click on Next

21. Specify the user account from which the versiondog services will be started. You can choose
between the options Local system account and Username. We recommend that you select the
Username option and enter a user account that has administrator rights

18
The account you specify needs to have full access to the server archive directory. The local

system account may not have the required rights

If you choose to use a domain account, the domain needs to be specified. Format:

<Domain>\<Username> (Example: DATAMAN\TomT)

22. Click on Next

23. Select how you would like to start the program. The following options are possible:

l Add entry to menu "All Programs"

l Create shortcuts on desktop

l Create shortcuts on Quick Launch Bar

You can choose more than one option

24. Click on Next

25. If you wish to install versiondog sample files, click on Install examples

Install examples is not active by default The sample files are used only for the purpose of

illustration. The versiondog system is still fully functional without sample files.

26. Click on Next


A summary will appear

27. Verify the information that is displayed. If everything is correct, click Next
The setup will begin. A dialogue will indicate when the installation process is complete

If the Windows Firewall service is not active during the installation of versiondog, a dialogue

will appear. To proceed with the installation process, click on Continue

28. Once the installation has been successfully completed, click on Finish to close the wizard

19
Install server with existing server archive

When installing a server with an existing server archive, the versiondog server applications and an
already existing server archive will be integrated. This type of installation allows you to continue to use
existing server archive data. You do not need to create a new server archive. No data will be lost.

The versiondog client applications required for configuring and managing the versiondog server need
to be installed separately. For more information, see Install client applications

Requirements for installation:

l Access to the setup file

l User account with administrator rights.

l The drive used for storing the server archive has to allow files to run. There is a possible that
existing antivirus programs will need to be temporarily deactivated if they interfere with files
being run.
If you don't have administrative rights, you will not be able to run files and when you try to log
in to the system an error message (SQLException) will appear. Login is not possible

l The hardware and software requirements for the installation need to met
If these requirements are not met, it is not possible to properly install the product. For more
information about the latest hardware and software requirements, see Installation require-
ments

To install a server with existing server archive, proceed as follows:

1. Start the setup on the PC you that wish to use for the installation by double-clicking on the file
Setup.exe

2. The installation wizard will prompt you to select a language. English and German are currently
available

3. On the welcome page of the setup wizard, click on Next

20
4. Select Install versiondog applications and click on Next

5. Select I agree. and click on Next

If you do not agree to the licencing requirements, the installation process will be ter-

minated.

6. Select Install server applications and click on Next

21
7. Select Install server with existing server archive and click on Next

8. Specify a path and a directory for the program files of the versiondog server applications

You can enter the path to the archive and the directory manually or click on Browse...

We recommend retaining the path suggested by the installation wizard:

l C:\Program Files\vdogServer

22
The Path to the client applications: will be displayed, however, it will be greyed out. If no

client applications are installed, it is not possible to make an entry in the field.

9. Click on Next

10. Specify the location of the server with existing server archive:

l Local:
The server archive is stored in a local directory

l Remote:
The server archive is stored in a remote directory

11. Click on Next

12. Specify the path to the existing local server archive and the path to the client setup files dir-
ectory

You can enter the paths and the directories manually or click on Browse...

If the server archive has been stored in a remote directory the user or user account

(used for carrying out the installation) needs to have read and write rights on the remote
system.

If no versiondog server archive exists under the given address, an error message will

appear. The setup can only be continued if all entries are correct.

13. Click on Next

If a dialogue appears, informing you that the procedure can take some time and should not

be cancelled, click on OK

14. If you wish to create a network share that will make the versiondog client setup files available
via your network, click the box Create the above network share

23
The option Create the above network share is not active by default

15. Click on Next

16. Specify the user account from which the versiondog services will be started. You have two
options: Local system account and Username. We recommend that you select Username and
enter a user account that has administrator rights

24
The account you specify needs to have full access to the server archive directory. The sys-

tem account may not have the required rights

If you choose to use a domain account, the domain needs to be specified. Format:

<Domain>\<Username>; Example: DATAMAN\TomT

17. Click on Next

18. A summary will appear

19. Verify the information that is displayed. If everything is correct, click Next
The setup will begin. A dialogue will indicate when the installation process is complete

If the Windows Firewall service is not active during the installation of versiondog, a dialogue

will appear. To proceed with the installation process, click on Continue

20. Once the installation has been successfully completed, click on Finish to close the wizard

25
Install server with existing server archive plus client

When installing a server with existing server archive plus client, the versiondog server and client applic-
ations and an already existing server archive will be integrated. This type of installation allows you to
continue to use existing server archive data. You do not need to create a new server archive. No data
will be lost.

If you so wish, an existing client archive can also be integrated.

Requirements for installation:

l Access to the setup file

l User account with administrator rights

l The drive used for storing the server archive must allow files to run. Likewise, the drive used to
store the client archive must also allow files to run. There is a possibility that existing antivirus
programs will need to be temporarily deactivated if they interfere with files being run.
If you don't have administrator rights you will not be able to run files and when you try to login
to the system an error message (SQLException) will appear. Login is not possible

l The hardware and software requirements for the installation need to be met
If these requirements are not met, it is not possible to properly install the product. For more
information about the latest hardware and software requirements, see Installation require-
ments

To install the versiondog server with existing server archive plus client, proceed as follows:

1. Start the setup on the PC you wish to use for the installation by double-clicking on the file
Setup.exe

2. The installation wizard will prompt you to select a language. English and German are currently
available

3. On the welcome page of the setup wizard, click on Next

26
4. Select Install versiondog applications and click on Next

5. Select I agree. and click on Next

If you do not agree to the licencing requirements, the installation process will be ter-

minated.

6. Select Install server applications and click on Next

27
7. Select Install server with existing server archive plus client and click on Next

8. Select the desired program add-ons

Options:

l BackupClient
This option is displayed, but cannot be selected when an server installation plus client is

28
being setup. The BackupClient cannot be installed on a computer on which a versiondog
server is installed.
The versiondog BackupClient allows users to create backups for automation devices that
otherwise cannot be accessed by the versiondog system. The versiondog BackupClient is
used whenever there is no connection between the production level networks and the
versiondog server. For more information, see BackupClient

l LibraryManagement
The LibraryManagement option is not active by default. It can be selected and
LibraryManagement installed. Whether or not you can immediately use LibraryMan-
agement after the installation is complete, depends upon which versiondog licence you
have purchased. The LibraryManagment add-on is only included in the the versiondog
EP Standard Edition. Users of other editions of versiondog will need to purchase a sep-
arate licence for LibraryManagement. The LibraryManagement is a version control sys-
tem used to track standard blocks. For more information, see LibraryManagement

l Register file extension for SmartImport for supplier projects


This option is active by default, but it can be unchecked. If this option is selected, a Win-
dows Registry entry will be written which makes it possible to open a versiondog sup-
plier delivery note (*.vdog-sdn) file by double-clicking on it in file manager. If this option
is NOT checked, no Registry entry will be written and *.vdog-sdn files can only be opened
via versiondog UserClient
You can use the SmartImport for supplier projects to Check-In files that were changed
outside of the versiondog system. For more information, see SmartImport for supplier
projects

29
9. Click on Next

10. Specify the path to the versiondog server applications and to the client applications

You can specify the paths and directories manually or you can click on Browse...

We recommend retaining the paths and directories suggested by the installation wizard:

l C:\Program Files\vdogClient

l C:\Program Files\vdogServer

11. Click on Next

12. Specify the location of the existing server archive:

l Local:
The server archive is stored in a local directory

l Remote:
The server archive will be stored in a directory that is located on a remote computer

13. Click on Next

14. Enter the path to the existing local server archive, the client setup files directory and the local cli-
ent archive on the server.

You can enter the paths and directories manually or click on Browse...

30
If the server archive has been stored in a remote directory the user account needs to

have read and write rights to the remote system.

If no versiondog server archive exists under the given address, an error message will

appear. The setup can only be continued if all entries are correct.

An existing client archive can also be integrated if necessary.

15. Click on Next

16. Grant all users with an account on the PC access to the versiondog client archives by checking
the box

The option Grant rights to "All Users" is active by default

17. If you wish to create a network share that will make the versiondog client setup files available
via your network, click the box Create the above network share. The option Create the above
network share is not active by default.
The name of the network share is vdog client setup.

By default, all users have read rights to this directory and administrators have full rights.

31
18. Click on Next

19. Specify the user account from which the versiondog services will be started. You have two
options: Local system account and Username. We recommend that you select the Username
option and choose an account with administrator rights

The account you specify needs to have full access to the server archive directory. The local

32
system account may not have the required rights

If you choose to use a domain account, the domain needs to be specified. Format:

<Domain>\<Username>; Example: DATAMAN\TomT

20. Click on Next

21. Select how you would like to start the program. The following options are available:

l Add entry to menu "All Programs"

l Create shortcuts on desktop

l Create shortcuts on Quick Launch Bar

You can select more than one option

22. Click on Continue


A summary will appear

23. Verify the information that is displayed. If everything is correct, click Next
The setup will begin. A dialogue will indicate when the installation process is complete

If the Windows Firewall service is not active during the installation of versiondog, a dialogue

will appear. To proceed with the installation process, click on Continue

24. Once the installation has been successfully completed, click on Finish to close the wizard

33
Updating the server

A server update will incorporate the latest developments and changes into an existing versiondog sys-
tem. The server update is carried out via the versiondog software package Setup.exe file.

During a server update, you do not have to choose between a server installation with client or a server
installation with no client. The update process is always the same. Only the server will be updated. Cli-
ent applications are automatically updated after a server update.

Both the server and the client need to have the same version, otherwise it is not possible to work

with versiondog.

Requirements for server update:

l Access to the setup file

l The user account with administrator rights

l The drive used for storing the server archive has to allow files to run. There is a possibilitythat
existing antivirus programs will need to be temporarily deactivated if they interfere with files
being run.
If you don't have administrator rights you will not be able to run files and when you try to log in
to the system an error message (SQLException) will appear. Login is not possible

l The hardware and software requirements for the installation need to be met
If these requirements are not met, it is not possible to properly update the product. For more
information about the latest hardware and software requirements, see Installation require-
ments

To update the versiondog server proceed as follows:

1. Start the setup on the PC (that you wish to use for the update) by double-clicking on the file
Setup.exe

2. The installation wizard will prompt you to select a language. English and German are currently
available

3. On the welcome page of the setup wizard, click on Next


All currently running versiondog processes will be displayed

34
4. You can stop these by clicking on Next

If you cannot stop the processes from the setup wizard, stop them via the Windows Task

Manager

5. Select Install versiondog applications and click on Next

6. Select I agree. and click on Next

If you do not agree to the licencing requirements, the installation process will be ter-

minated.

7. Select Install server applications and click on Next

35
A dialogue appears, telling you that versiondog is already installed

8. In the displayed dialogue, click on Update to execute a server update

9. Confirm the path to the directory of the versiondog server applications by clicking on Next
The server update will begin. A dialogue will indicate when the update process is complete

10. After the server has been successfully updated, click on Finish and close the wizard

36
Moving the server

From time to time, it may be necessary to move an existing versiondog server to a new server system.
One reason for doing this is that the server system, which has been used up until now, is out-of-date
and no longer dependable.

During the process of moving the server, it is NOT possible to access versiondog. We recommend

to move the versiondog server at off-peak times (i.e. overnight or on weekends)

Requirements for moving the server

l Access to the setup file

l The user account with administrator rights.

l The drive used for storing the server archive must allow files to run. Likewise, the drive used to
store the client archive has to also allow files to run. There is a possibility that existing antivirus
programs will need to be temporarily deactivated if they interfere with files being run
If you don't have administrator rights you will not be able to run files and when you try to login
to the system an error message (SQLException) will appear. Login is not possible

l The hardware and software requirements for the installation need to be met
If these requirements are not met, it is not possible to properly install the product. For more
information about the latest hardware and software requirements, see Installation require-
ments

l Specify all communication ports

In addition to the ports listed under the hardware and software requirements the following

ports also need to be specified (depending on upload class):

Port Upload class


TCP 1200; TCP 445 CODESYS
TCP 21, TCP 20 FTP
TCP 139, TCP 445, UDP 137, UDP 138 UNC
TCP 102 SimaticS7
TCP 102 Sinumerik840D

37
l Install editors needed for conducting backups and comparisons on the server

l Set up a domain account with the following rights:

l Administrator on the server system

l Full access rights to the program directory

l Full access rights to the server archive

l Full access rights to the remote archive (in the event that a remote archive exists)

To move the versiondog server, proceed as follows:

1. Open AdminClient and place your server into maintenance mode (AdminClient > Maintenance
Mode)

Maintenance mode ensures that the data in the versiondog server archive remains

in a consistent state. While the server is in maintenance mode, write access (= Check-In)
is blocked. Read access (=Check-Out) is still possible

2. Uninstall the versiondog server

For more information, see Uninstall server

3. Copy the server archive to the new location

4. Install the versiondog server and specify the existing server archive

For more information, see Install server with existing server archive

5. Check the following functions

l Check-In/Check-Out

l Project structure

l Error messages

l Jobs

l and so on.

Moving the versiondog server causes the system ID to change, and therefore versiondog must be

reactivated. Once the installation has been successfully completed, please send us the new system ID

38
in order to receive a new activation code.
The new system ID can be found by going into the versiondog AdminClient Licencing, Activation, Sys-
tem ID

39
Uninstall the server

Uninstalling a versiondog server causes it to be completely removed from the system. The uninstalling
process is carried out via the versiondog software package Setup.exe file.

If a versiondog server is uninstalled, only the versiondog server applications are uninstalled. The

versiondog client applications are not uninstalled. If necessary, the versiondog client applications can
be uninstalled separately. For more information about client applications, see Uninstall the client
applications.

Requirements for uninstalling the server:

l Access to the versiondog setup file

l User account with administrator rights

l The drive used for storing the server archive has to allow files to run. There is a possibility that
existing antivirus programs will need to be temporarily deactivated if they interfere with files
being run

To uninstall a versiondog server, proceed as follows:

1. Start the setup on the PC (that you wish to use for uninstalling the versiondog server) by
double-clicking on the file Setup.exe

2. The installation wizard will prompt you to select a language. English and German are currently
available

3. On the welcome page of the setup wizard, click on Next


A list of ongoing versiondog processes will be displayed

4. You can close these by clicking on Next

If you cannot stop the processes from the setup wizard, stop them via the Windows Task

Manager

40
5. Select Uninstall versiondog applications and click on Next

6. Select Uninstall server applications and click on Next

The versiondog server will be uninstalled. A dialogue will appear reminding you that the archive
was not deleted (archives are never deleted when you carry out an uninstallment)

7. Acknowledge that you have understood the dialogue by clicking on OK

41
8. After successfully uninstalling the the server, click on Finish to close the wizard

42