BackupClient Basics

© AUVESY GmbH

Last updated: 03 February 2016

Fichtenstrasse 38 B
D-76829 Landau
Germany
TOC

BackupClient Basics 3

Installing/uninstalling the BackupClient 4

Launching the BackupClient 6

Logging in to the BackupClient 7

The user interface of versiondog BackupClient 8

The ribbon toolbar and tabs of the BackupClient 10

The three panes of the BackupClient window 15

The status bar of the BackupClient 17

Working with the BackupClient 18

Synchronising jobs from the server to the client 19

Executing jobs 21

Synchronising job results from the client to the server 23

2
BackupClient Basics

The versiondog BackupClient allows users to create backups of automation devices that cannot be
accessed by the versiondog system. The versiondog BackupClient is used whenever there is no con-
nection between the production level networks and the versiondog server. This type of connection
may not be permitted for security reasons, such as the prevention of unauthorised access to pro-
duction facilities.

The difference with the BackupClient is that data is transferred via a cable connection with the auto-
mation device. A portable PC (usually a laptop) with the BackupClient installed is synchronised with
the versiondog server and receives the scheduled backup jobs. A member of staff then physically
takes the PC to the production area. The PC is connected to the automation device and the backup is
carried out. When all the required backups have been done, the PC is re-connected to the network
and the BackupClient synchronises again with the versiondog server, transferring the backup data
from the client to the server.

This guide assumes that the user has a basic knowledge of the concepts of the versiondog sys-

tem. Knowledge of job configuration within the versiondog AdminClient is also required.

3
Installing/uninstalling the BackupClient

A licence is not required for the installation of the versiondog BackupClient. The versiondog BackupCli-
ent will be licenced automatically when the user logs in for the first time. There is no dedicated setup
tool for installing the versiondog BackupClient. As with other versiondog applications, the BackupCli-
ent is installed using the versiondog setup.

The computer used for the installation of the BackupClient must not have a versiondog server

installed on it.

To install the BackupClient on a system that has other versiondog client applications already

installed, you need to uninstall the client applications then reinstall them. During the reinstallation,
check the box BackupClient:

To uninstall the BackupClient, you need to uninstall all the client applications then reinstall them.
During the reinstallation, do not check the box BackupClient. The client archive will not be deleted
when client applications are uninstalled.

4
See also

Installing the client applications

Installation – step-by-step guide

Uninstalling the client applications

5
Launching the BackupClient

After the installation process has been completed successfully, you can launch the versiondog
BackupClient. In Windows 7, you can launch the versiondog BackupClient in the following ways:

l By selecting Start/All Programs/versiondog/BackupClient

l By double-clicking on the BackupClient icon on the desktop

l By clicking on the BackupClient icon on the Quick Launch bar

You may not be able to use all of these options. The options for launching the versiondog

BackupClient are chosen during the installation. If you only selected one option during the setup (e.g.
to launch the program using the desktop icon) then only this option will be available.

6
Logging in to the BackupClient

When you launch the versiondog BackupClient, the login dialogue will appear. To log in, take the fol-
lowing steps:

1. Using the server selection field, select the Server you wish to connect to

The first login will always take place on the server. Once you have logged on to the server,

you will also be able to log in locally. The versiondog BackupClient will be licenced automatically
when you log on via the server for the first time.

2. Enter your user name in the Username field.

3. Enter your password in the Password field.

4. Click on Login

In order to log in to the versiondog BackupClient, you must be a registered user in the versiondog

system. You will need a different versiondog application called AdminClient to register users. If you
encounter any problems during the login process, please contact your versiondog system admin-
istrator. The system administrator will also help you with questions regarding the domain or server
settings.

7
The user interface of versiondog BackupClient

The versiondog BackupClient features an adjustable user interface. You can adjust the various sec-
tions of the BackupClient to suit your needs. For example, the windows can be rearranged and the pro-
ject tree can either be displayed or hidden.

The following information is based on the default user interface you will find after opening the ver-
siondog BackupClient for the first time.

Each element of the BackupClient user interface will be covered in greater detail in their respective

sections. These sections contain information on the individual elements and their features.

1 Title bar
The title bar in the versiondog BackupClient shows the name of the application.

2 Ribbon toolbar with tabs

8
 The ribbon toolbar is a command bar which groups together the functions of the applic-
ation in the form of tabs
See The ribbon toolbar and tabs of the BackupClient for more details

3 The three panes of the BackupClient window

The display area provides an overview of jobs, job results and the components for which
these jobs have been scheduled
See The three panes of the BackupClient window for more details

3a Project tree
The project tree shows all components for which jobs have been scheduled for execution
using the BackupClient
See The three panes of the BackupClient window for more details

3b Job table
The job table displays jobs that have been created in AdminClient for execution using the
BackupClient
See The three panes of the BackupClient window for more details

3c Job results table

The job results table displays all results of a selected job
See The three panes of the BackupClient window for more details

4 Status bar
The status bar in the versiondog BackupClient shows information about the application
See The status bar of the BackupClient for more details

9
The ribbon toolbar and tabs of the BackupClient

The ribbon toolbar allows you to quickly access the commands needed to carry out tasks. Commands
are grouped together according to their respective function and displayed in the form of tabs.

The following tabs are displayed in the versiondog BackupClient:

File
Close
Close the versiondog BackupClient

Home
Synchronise
Synchronise jobs and job results. This button is only active when the user is logged on to
the server.

l Synchronising jobs from the versiondog server to the versiondog BackupClient

Select the job you wish to synchronise from the versiondog server to the ver-
siondog BackupClient and click on Synchronise

The most recent version of the component for which the job was created will

always be the version that is synchronised from the versiondog server to the ver-
siondog BackupClient
Jobs that are only present on the versiondog server and not on the versiondog
BackupClient will be greyed out and assigned the status Does not exist on
BackupClient. A job cannot be executed if it does not exist on the versiondog
BackupClient. In order to execute a job it must first be synchronised to the ver-
siondog BackupClient. Jobs that have already been synchronised to the versiondog
BackupClient will be displayed in black. These jobs will be updated the next time
they are synchronised

You can select more than one job by holding down the CTRL key and clicking on

the desired jobs with the left mouse button.

l Synchronising job results from the versiondog BackupClient to the versiondog

server

10
 Select the job whose results you want to synchronise from the versiondog
BackupClient to the versiondog server

You can select more than one job by holding down the CTRL key and clicking on

the desired jobs with the left mouse button.

Start a job
Initiate job execution. This button is only active when the user is logged on locally.

Stop job
Stop job execution. This button is only active when the user is logged on locally.

Show progress information

Show job progress information when executing a job. This button is only active when the
user is logged on locally

This information is shown in the job's Progress information field

Show synchronisation log

Show details about the synchronisation process
Close
Close the window
Log file
Select log file
Select the log file
Visible columns
Select the columns you want to show in the table. Various possibilities.
Select via dropdown menu.
Show column filter
Show/hide the table column filters
Remove filter
Reset table column filter. This button is only active if a filter is selected
Reset columns
Reset the layout of the columns in the table
Adjust layout
Adjust the table layout. Various possibilities. Select via dropdown menu.

11
 Show row numbers
Show/hide table row numbers
UTC
Show the timestamp in Coordinated Universal Time (UTC)
Local
Show the timestamp in local time
Show events for selected jobs
Show an overview of the job history with a list of individual events. Button only active
when there are events for a selected job
Close
Close the window
Visible columns
Select the columns you want to show in the table. Various possibilities.
Select via dropdown menu.
Show column filter
Show/hide the table column filters
Remove filter
Reset table column filter. This button is only active if a filter is selected
Reset columns
Reset the layout of the columns in the table
Adjust layout
Adjust the table layout. Various possibilities. Select via dropdown menu.
Show row numbers
Show/hide row numbers
UTC
Show the timestamp in Coordinated Universal Time (UTC)
Local
Show the timestamp in local time

View

12
 Project tree
Show/hide the project tree
Arrange windows
Adjust the display area. Various possibilities. Select via dropdown menu.
Visible columns
Select the columns you want to show in the selected table. Various possibilities. Select
via dropdown menu.
Show column filter
Show/hide the column filter in the selected table
Remove filter
Reset the column filter in the selected table. This button is only active if a filter is selec-
ted
Reset columns
Reset the column layout in the selected table
Adjust layout
Adjust the table layout. Various possibilities. Select via dropdown menu.
Show row numbers
Show/hide the row numbers in the selected table
UTC
Show the timestamp in Coordinated Universal Time (UTC)
Local
Show the timestamp in local time

Extras
English
Select the language of the user interface
To change the language, the application must be restarted. The language of the

user interface will only be changed in the versiondog BackupClient. Other versiondog
applications will not be affected
Configure gateways
Configure interfaces (SIMATIC S5, SIMATIC S7, SINUMERIK 840D ...)

13
 Delete selected jobs locally
Selected jobs will be deleted from the backup archive
Deleting jobs locally. This does not delete the selected jobs from the server. If delet-

ing a job locally means there are no more jobs for a component on the BackupClient,
then the component will also be deleted from the backup archive.

Help
Help
Show the program's help feature
About versiondog
Show information regarding the program version and developer

14
The three panes of the BackupClient window

The three main panes of the BackupClient consist of a project tree, job table and job results table:

Project tree
The project tree shows all components for which jobs have been scheduled for execution in the ver-
siondog BackupClient. The directories above the components are also shown in the project tree. The
jobs themselves are displayed in a table next to the project tree.

Job table
The job table shows jobs that have been created in the versiondog AdminClient to be executed using
the versiondog BackupClient. For a job to be displayed in the versiondog BackupClient, the option
Using versiondog BackupClient must be selected during job configuration under Execute.

Jobs that are only present on the versiondog server and not on the versiondog BackupClient are
greyed out and assigned the status Does not exist on BackupClient. A job cannot be executed if it
does not exist on the versiondog BackupClient. In order to execute a job, it must first be synchronised
to the versiondog BackupClient. Jobs that have already been synchronised to the versiondog
BackupClient will be displayed in black. These jobs will be updated the next time they are syn-
chronised.

One or more jobs can be selected from the table for synchronisation. You can select multiple jobs by
holding the CTRL key and clicking on the desired jobs with the left mouse button.

When the versiondog BackupClient is opened, the top directory level is selected in the project tree

by default. All jobs that are present on the BackupClient are shown. If you select an individual com-
ponent, then only the jobs scheduled for this component will be displayed.

Job results table

Executing a job will produce a certain result. When you select a job in the job table, all results per-
taining to this job will be shown in the job results table.

15
 You can also select more than one job by holding down the CTRL key and clicking on the desired

jobs with the left mouse button. All results of the selected job will then be shown in the job results
table.

16
The status bar of the BackupClient

The status bar in the versiondog BackupClient shows information about the application.

The following information is displayed:

l Version number

l Logged-in user

l Name of the server to which a user is logged in ("localhost" is shown for local login)

17
Working with the BackupClient

Users will now learn how to work with the versiondog BackupClient. The following section will illustrate
how to use the versiondog BackupClient to create backups of automation devices that cannot oth-
erwise be accessed by the versiondog system.

The individual steps are:

l versiondog BackupClient – Synchronising jobs from the server to the client

l versiondog BackupClient – Executing jobs

l versiondog BackupClient – Synchronising job results from the client to the server

More detailed information can be found in the individual sections.

18
Synchronising jobs from the server to the client

Jobs you wish to execute using the versiondog BackupClient must first be created in the versiondog
AdminClient on the versiondog server. The versiondog BackupClient is located on a client computer,
also known simply as "the client". Jobs are transferred from the versiondog server to the versiondog
BackupClient via synchronisation.

Requirements:

l The versiondog BackupClient and the versiondog server can be connected to one another

l The jobs you wish to execute using the versiondog BackupClient have been created in the ver-
siondog AdminClient

When configuring a job, the option Using versiondog BackupClient must be selected

under Execute. If the option Using versiondog BackupClient is not selected, the job will not be
displayed at all in the versiondog BackupClient and can therefore not be synchronised.

To synchronise jobs from the versiondog server to the versiondog BackupClient, the following steps
must be taken:

1. Open the versiondog BackupClient and log on to the versiondog server with your username
and password.
The Home tab in the versiondog BackupClient will open. The project tree displays all com-
ponents for which jobs have been scheduled for execution in the versiondog BackupClient. The
parent directories of the components are also displayed in the project tree. The jobs them-
selves are displayed in a table next to the project tree

When the versiondog BackupClient is opened, the top directory level is selected in the pro-

ject tree by default. All jobs that are present on the BackupClient are shown. If you select an
individual component, then only this component's jobs are displayed.

2. Select the job you want to synchronise from the versiondog server to the versiondog BackupCli-
ent
Jobs that are only present on the versiondog server and not on the versiondog BackupClient
are greyed out and assigned the status Does not exist on BackupClient. A job cannot be
executed if it is not present on the versiondog BackupClient. In order to execute a job, it must

19
 be synchronised to the versiondog BackupClient. Jobs that have already been synchronised to
the versiondog BackupClient will be displayed in black. These jobs will be updated the next time
they are synchronised

You can also select more than one job by holding down the CTRL key and clicking on the

desired jobs with the left mouse button.

3. Click on the Synchronise

button. Synchronisation will begin. A message box will tell you when the synchronisation is
completed. If you want to see detailed information regarding the synchronisation, click on Syn-

chronisation log

The most recent version of the component for which the job was created will always be the

version that is synchronised from the server to the client

Synchronise the jobs regularly so you always have the latest version on the versiondog BackupCli-

ent. Any changes you make to existing jobs will only reach the versiondog BackupClient through syn-
chronisation.

20
Executing jobs

Jobs to be executed by the versiondog BackupClient are created in the versiondog AdminClient on the
versiondog server. The jobs are then synchronised to the versiondog BackupClient. After syn-
chronisation, the jobs can be executed using the versiondog BackupClient.

Requirements:

l Jobs to be executed using the versiondog BackupClient are present and have been syn-
chronised from the versiondog server to the versiondog BackupClient.

l The automation device you wish to back up and the versiondog BackupClient are connected

To execute a job, take the following steps:

1. Open the versiondog BackupClient and log in with your username and password under Local

Do not log on to the versiondog server! To execute jobs using the versiondog BackupCli-

ent, you must always be logged on locally

The Home tab in the versiondog BackupClient will open. The project tree shows all components
for which jobs are available for execution using the versiondog BackupClient. The directories
above the components are also shown in the project tree. The jobs themselves are displayed in
a table next to the project tree.

When the versiondog BackupClient is opened, the top directory level is selected in the pro-

ject tree by default. All jobs that are present on the BackupClient are shown. If you select an
individual component, then only this component's jobs are displayed.

2. Select the job you wish to execute

You can also select more than one job by holding down the CTRL key and clicking on the

desired jobs with the left mouse button. The jobs can be filtered by the content of their
columns before they are selected.

3. Click on the Show progress information button if you want to see information on the

job's progress while it is being carried out. The button's orange background confirms that this

21
 feature is active. The information is shown in the Progress information field of a job
If you do not need this information, please skip this step

Information regarding a job's progress will be saved and can be accessed at any time. Just

highlight the job result and click on the buttonDisplay all events for selected jobs . This

gives you an overview of the job history with a list of individual events.

4. Click on the Start job

button. The job will then be executed. If the job is executed successfully, a backup will be cre-
ated. The result of an executed job will be saved. As soon as a job is selected, all results related
to that job will be shown in their own table

The exact processes involved in a job depend on the job's configuration settings in the ver-

siondog AdminClient

22
Synchronising job results from the client to the server

After the jobs have been executed using the versiondog BackupClient, the results are saved to the
backup archive on the client computer. To transfer the job results to the versiondog server, syn-
chronisation must be carried out.

Requirements:

l The versiondog BackupClient and versiondog server can be connected to one another

l Job results are present

To synchronise job results from the versiondog BackupClient to the versiondog server, take the fol-
lowing steps:

1. Open the versiondog BackupClient and log on to the versiondog server with your username
and password.
The Home tab in the versiondog BackupClient will open. The project tree displays all com-
ponents for which jobs have been scheduled for execution in the versiondog BackupClient. The
directories above the components are also shown in the project tree. The jobs themselves are
displayed in a table next to the project tree

When the versiondog BackupClient is opened, the top directory level is selected in the pro-

ject tree by default. All jobs that are present on the BackupClient are shown. If you select an
individual component, then only this component's jobs will be displayed

2. Select the job whose results you want to synchronise from the versiondog BackupClient to the
versiondog server

You can select more than one job by holding down the CTRL key and clicking on the desired

jobs with the left mouse button.

3. Click on the Synchronise

button. Synchronisation will be carried out. A message box will tell you when the syn-
chronisation is completed. If you want to display detailed information about the syn-

chronisation, click on the buttonSynchronisation log

23
 After a job has been selected in the versiondog AdminClient, the relevant job results will be

shown in a separate table. You can also select more than one job by holding down the CTRL key
and clicking on the desired jobs with the left mouse button. All results of the selected job will
then be shown in the table.

24