Installing The Client Applications: © Auvesy GMBH

Download as pdf or txt
Download as pdf or txt
You are on page 1of 13

Installing the

client applications
© AUVESY GmbH

Last updated: 31 July 2018

Fichtenstrasse 38 B
D-76829 Landau
Germany
TOC

Installing the client applications 3

Licencing 3

Requirements for the installation 3

Where to find the setup files 3

Installation – step-by-step guide 4

First launch – important server configuration information 9

Zero installation client 11

Uninstalling the client applications 13

2
Installing the client applications

Licencing
You can install the versiondog client applications on any Windows-based computer running Windows
XP SP3 onward. With the versiondog system, it is the server applications that need to be licenced, the
client applications do not require a separate licence.

Requirements for the installation

l Setup.exefile (needs to be available for installation)

l User account with administrator rights

Where to find the setup files


When a versiondog server system is installed, there is the option to create a network share in which
all the client setup files can be found. If this was done when your server applications were installed,
then you can launch the versiondog Setup.exe from its directory on the share.

Access the setup directory (vdog client setup) on the network share of the versiondog server by nav-
igating to:
\\[versiondogServerName]\vdog client setup or \\[ipaddress]\vdog cli-
ent setup

If you are unable to access the client setup directory on a network share, you will need to obtain a
copy of the directory from your system administrator.

If you have a parallel server system, you can find the installation files on either server. It makes no

difference which you use.

3
Installation – step-by-step guide

1. Open the versiondog client setup directory and run the file Setup.exe (if when you right-click
the file you are given the option Run as administrator, then select this option).

When installing on Windows 10, you have to use Run as administrator if you want the

desktop shortcuts for the versiondog client applications to be created for all users (otherwise
they will only be created for the user who runs the Setup.exe file). In all cases, desktop short-
cuts will only be created if the corresponding option is checked in step 11 (below).

2. The setup wizard starts. On the first dialogue, select the language.

3. There is no action required on the welcome dialogue, just read it then click Next .

4. On the next dialogue, select Install versiondog applications:

5. On the licence agreement dialogue, you need to select I agree before you can proceed with the
installation.

4
6. On the next dialogue, select Install client applications:

7. On the next dialogue, specify your options as appropriate:

NOTES ON OPTIONS:

BackupClient

This option is available at no extra cost. Include it if you have devices that are not networked
but that you will want to backup using the PC on which you are running the installation. With
the BackupClient, you can execute a backup job for a device using a cable connection to the PC
and later synchronise the BackupClient with the versiondog server.
If you install the BackupClient now but never need it on this PC, it will not do any harm. If you
do not install it now, but need it later, then it can be installed at any time.

LibraryManagement

This option is included in the price of the Standard Edition EP and available at extra cost with
certain other editions. Include it if it is covered by your licence. LibraryManagement is used to

5
keep track of which standard blocks are used in which projects. This significantly eases the pro-
cess of updating standard library blocks across all projects.
If you install LibraryManagement now but it is not covered by your licence, it will not do any
harm. If you ever launch it, you will be reminded that your licence does not cover this feature
and you will be given the opportunity to upgrade your licence (which you can do if your ver-
siondog edition is one of those for which LibraryManagement is available). If you do not install
LibraryManagement now, but need it later, then it can be installed at any time.

Register file extension for SmartImport of supplier projects (selected by default)

This option exists because there are some customers who do not want any Windows Registry
entries. If this option is selected, a Windows Registry entry will be made which makes it possible
to open a versiondog supplier delivery note (*.vdog-sdn) file by double-clicking it in your file
manager (e.g. Windows Explorer). If this option is NOT selected, no Windows Registry entry will
be made and you will have to open these files from the versiondog UserClient (via the Start tab
> SmartImport for supplier projects).

8. On the next dialogue, either accept the default path to the directory of the versiondog client
applications or specify a path of your own choice. If you choose to specify a different path,
please be aware of the following:

l The applications cannot be installed on the root of a drive (so there needs to be at least
one directory in the path)

l You need to specify a target directory for the client applications (vdogClient by
default)

l The target directory must be exclusively for the versiondog client applications

l Do not choose the desktop as the target directory (this would not be exclusive)

l Do not choose Program Files as the target directory (this would not be exclusive)
The user must have write permissions in the installation folder of the versiondog client

applications to be able to perform SmartUpdates. From Windows 7 onward only admin-


istrators have write permissions in C:\Program Files\ by default. You have to either
grant write permissions for the folder C:\Program Files\vdogClient to the user or
choose a path the user has write permissions for (e.g. C:\vdClientArchive\Client\),

6
to allow SmartUpdates.
When client applications are being installed, the path to the directory of the versiondog server
applications is shown but it is greyed-out and inactive.

9. On the next dialogue, either accept the default path to the versiondog client archive dir-
ectory or specify a path of your own choice. The client archive directory must be on a local
drive on the client machine.

10. On the next dialogue, grant rights to the Windows user group All Users is selected by default –
uncheck this option to restrict rights to the currently logged on Windows user.

11. On the next dialogue, decide which shortcuts you would like to have to the versiondog client
applications:

7
12. Check the locations that have been set for the program files and client archive:

Start the installation by clicking Next

13. The next dialogue is the Installation successful! dialogue . The installation of the client applic-
ations has now been completed.

See also

First launch - important server configuration information

FAQ: Installation of versiondog server fails. What could be the


reason for this?

8
First launch – important server configuration information

You may need to obtain some information from your system administrator for the server con-

figuration. We recommend reading through this section carefully before you start so that you can
gather all the questions that you will need to ask.

1. The first time the UserClient is launched, the dialogue Communication parameters is displayed
and you will need to go through the server configuration process.

2. Click on Add

3. Enter a name for this server configuration in the field Configuration name

Your system administrator will be able to tell you if there is a specific name that you should

use. If there is not, you can give the configuration any name that you want.

4. Enter the name of the versiondog server into the field Computer name
OR
Enter the IP address of the versiondog server into the field IP address

5. Edit the port numbers if necessary.

Your system administrator will be able to tell you if this is required.

6. Click on Save

7. Click on Close

8. You will now see the versiondog splashscreen, with the newly configured server selected.

9. Enter a valid username, password and domain (if applicable).

versiondog is supplied with the following defaults:

Username: versiondog
Password: change-it
These should have been changed immediately after the initial installation of the versiondog sys-
tem. Your system administrator will be able to give you the information you need to log in.

10. Click on Log in

9
11. If you have a versiondog parallel server system, a dialogue will appear asking you for the name
of the parallel server system.
Enter a name in Name of the server group then click on OK

Your system administrator will be able to tell you if there is a specific name that you should

use. If there is not, you can give the parallel server system any name that you want.

12. The server configuration is now complete and the versiondog UserClient will open.

10
Zero installation client

Portable installation option – how to install the versiondog client applications on an external
drive, such as a USB stick.

If you want to use the versiondog software, but do not want to install the client applications on a PC,
you can install them on an external drive. If you do this, versiondog will have no impact on the PC that
you use for the zero client installation process and no impact on any other PC from which you later
run the client applications. And you will have a fully portable installation of the versiondog client applic-
ations.

If you are using clients that have been installed without a connection to a server, you will require a

separate licence. For more information, please contact support.

To install the versiondog client applications on an external drive, proceed as follows:

1. Perform steps 1 to 7 of Installation – step-by-step guide

In step 7, the following applies for a portable installation:

l Do not select BackupClient


If you do, you will not be allowed in the next step to select an external drive as the des-
tination of the program files

l The only selectable option for a portable installation is LibraryManagement

l Do not select Register file extension for SmartImport of supplier projects


If you do, you will still be able to proceed with the installation but the file extension will
not be registered; this is because no Windows Registry entries can be made for a port-
able installation/zero installation client)

2. In step 8, choose a path on the local server

3. Carry out the rest of the installation steps

4. At the end of the installation, the Installation successful! dialogue appears. The installation of
the client applications has now been completed

5. Copy the directory vdogClient to an external drive

11
6. You now need to complete the configuration by launching a client application on an external
drive
The client archive will be created automatically on your external drive when you first launch a cli-
ent. The name of the client archive directory for a portable installation is vdogData.

When you install the client applications on a PC, the name of the client archive directory is

vdClientArchive; in either case, the contents are the same.

7. Launch the versiondog UserClient by running VDogClient.exe (which can be found in the ver-
siondog client applications directory on your external drive)

8. See: First launch – important server configuration information

12
Uninstalling the client applications

The requirements for uninstalling the client applications are that same as the requirements for the
installation. There is no dedicated setup tool for uninstalling the versiondog client applications. Run
the file Setup.exe and select Uninstall versiondog applications then Uninstall client applications.
The client archive will not be deleted when client applications are uninstalled.

All client applications including LibraryManagement and the BackupClient will be uninstalled when

you run Setup.exe > Uninstall client applications.

See also

Installing/uninstalling versiondog LibraryManagement

Installing/uninstalling the BackupClient

13

You might also like