Easyclient Basics
Easyclient Basics
© AUVESY GmbH
Fichtenstrasse 38 B
D-76829 Landau
Germany
TOC
EasyClient Basics 3
Installing EasyClient 5
Logging in to EasyClient 8
Toolbar (EasyClient) 12
2
EasyClient Basics
One of the versiondog client applications is the versiondog EasyClient. versiondog EasyClient contains
all the basic functions necessary for managing data in an automated production environment. It is a
greatly simplified alternative to the UserClient and, as its name suggests, the versiondog EasyClient is
exceptionally easy to use. The following screenshot of the versiondog EasyClient user interface shows
the degree to which the process of making changes to a project has been simplified:
Another feature of versiondog EasyClient is the project tree. The project tree visualises the file struc-
ture of the project data.
3
versiondog EasyClient can also be configured so that a user can only see and edit specific com-
ponents. If, for example, a user is currently working on a visualisation panel, it is possible to configure
versiondog EasyClient so that only the components relevant to that panel are displayed to the user.
This provides the user with a better overview and leads to fewer errors.
This tutorial aims to provide the user with the knowledge required for using the versiondog EasyCli-
ent to edit existing project data within the versiondog system. The tutorial assumes that the user has
a basic knowledge of the versiondog system.
4
Installing EasyClient
There is no dedicated setup procedure for installing the versiondog EasyClient. Like all other ver-
siondog client applications, versiondog EasyClient is also installed as part of the standard versiondog
setup procedure.
The versiondog setup procedure is run using the Setup.exe file. The Setup.exe file is included in the
versiondog installation package.
If you have any questions, please contact your versiondog system administrator.
5
Launching versiondog EasyClient
After the installation process is complete, you can launch the EasyClient. versiondog EasyClient can be
launched using shortcuts or directly.
Not all options may be available. The individual setup determines how the versiondog applic-
ations are launched. If only one option has been selected in the setup, for example, via "All programs"
(from the Start menu), only that option will be available to you.
2. Under Open, enter the path to the VDogEasyClient.exe file with the /at:c and the /rd: {vdCli-
entArchive} start parameters.
The /at:c parameter specifies the application type. at stands for application type, c for client.
The /at:c parameter has to be entered every time EasyClient is launched. The /rd: {vdCli-
entArchive} parameter specifies the path to the client archive. rd stands for root directory.
Example:
C:\Program Files (x86)\vdogClient\VDogEasyClient.exe /at:c "/rd:C:\vdClientArchive"
3. Click on OK.
In the versiondog EasyClient, a user can see all components to which they have at least read rights
by default. However, the versiondog EasyClient can also be configured so that only specific
6
components are displayed to the user in the project tree. versiondog EasyClient can also be launched
directly using this preconfigured component list. For more information, see Project tree component
view.
7
Logging in to EasyClient
After the launch of versiondog EasyClient, the versiondog login dialogue will appear. To log in, proceed
as follows:
1. In the Server selection field, select the server you want to connect with.
4. Click on Login.
In order to log in to versiondog EasyClient, you must be a registered user of the versiondog sys-
tem. User registration is carried out in another versiondog application known as the AdminClient. If
you experience any problems during login or if you have any questions regarding domain or server set-
tings, please contact your versiondog system administrator.
8
The user interface of versiondog EasyClient
The user interface of versiondog EasyClient is made up of various elements. This tutorial provides a
brief overview of those elements.
You can find more detailed information about the various elements of the versiondog EasyClient
1 Title bar
The title bar of versiondog EasyClient shows the name of the application.
2 Address bar
The address bar of versiondog EasyClient enables you to navigate through the project tree.
For more details, see Address bar.
3 Toolbar
You can use the toolbar of versiondog EasyClient to switch to versiondog UserClient and access
the client settings.
For more details, see Toolbar.
4 Project tree
9
The versiondog EasyClient project tree visualises the file structure of the project data.
For more details, see Project tree.
5 Component view
The component view of versiondog EasyClient displays information about a component selec-
ted in the project tree. If the selected component is editable, possible editing steps are dis-
played and each step can be completed using the component view.
For more details, see Component view.
6 Status bar
The status bar of versiondog EasyClient shows information about the program.
For more details, see Status bar.
10
Address bar (EasyClient)
The address bar of versiondog EasyClient enables you to navigate through the project tree.
The following buttons are located in the address bar of versiondog EasyClient:
Back
Scroll back to previously selected element.
Forward
Scroll to next (previously selected) element.
History
Show list of recently selected elements; click on a list entry to pick the desired element.
Favourites
Add favourites.
Save as favourite
Save current path to the list of favourites; icon appears when you move the mouse pointer
over the star icon.
Show path
The path of the currently selected element is displayed.
Show and edit path
The path of the currently selected element is displayed and can be changed.
Show favourites
6
Show list of favourites; click on a list entry to display the desired element.
Delete favourites
Delete favourites (icon is displayed in list of favourites); click on a list entry to delete the cor-
responding element.
11
Toolbar (EasyClient)
You can use the toolbar to switch to versiondog UserClient and to access the client settings.
Settings
Open client settings (this will enable you to change a couple of standard settings and the
changes will be made via the client settings.)
UserClient
Switch to versiondog UserClient; the versiondog EasyClient will be closed and the ver-
siondog UserClient will be opened (same user, no new login necessary, selected element
in the project tree will remain the same).
12
Project tree (EasyClient)
The project tree visualises the file structure of the project data.
<Search> Search
Opens the search function, various search options are displayed.
The user can perform various actions via the project tree. These actions are launched by functions
within the Project tree menu 6.
13
Edit component (Alt + Return)
Use this function to edit an existing component.
Refresh (F5)
Use this function to refresh the view of the project tree.
Delete (Del)
Use this function to delete a local directory/component.
Delete on server (Shift + Del)
Use this function to delete a directory/component on the server.
Not every user can perform every action. It depends on the rights granted to a user in versiondog
which actions can be performed. Furthermore, it will depend on the user's current location in the pro-
ject tree whether a given action can be performed or not. If an action cannot be performed at a par-
ticular location, the corresponding menu item is greyed out and thus inactive.
14
Component view (EasyClient)
The component view of versiondog EasyClient displays information on a component selected in the
project tree. If the selected component is editable, the possible editing steps are displayed. You can
complete each step via the component view. The component view is organised into the following
areas:
Information area
The information area of the component view displays the component name, the component type and
the status of the selected component.
The following icons are included in the information area of the component view:
Editable
No status set, status of the currently selected component can be changed.
Locked
The currently selected component has been locked by the logged in user. In
addition, the name of the user who has locked the component is displayed.
Any comment entered while locking the component is displayed. If no com-
ment was entered when locking the component, the timestamp is displayed.
Locked
The currently selected component has been locked by another user than the
logged in user. In addition, the name of the user who has locked the com-
ponent is displayed. Any comment entered when locking the component is
displayed. If no comment was entered when locking the component, the
timestamp is displayed.
Under development
The currently selected component is under development. In addition, the
name of the user who has locked the component is displayed. Any comment
entered when locking the component is displayed. If no comment was
entered when locking the component, the timestamp is displayed.
15
A user who has the corresponding administrator rights can change the status of a component. Status
changes are made using menu functions.
The following menu items are available for changing the status:
Editable
Lock
6 Lock the currently selected component for other users (only the user who
has locked the component can perform the Check-In of new components).
Mark as Under development
Tabs
Details tab
The Details tab shows information on the status of the local version and the server version of a com-
ponent selected in the project tree (e.g. version number and timestamp).
The following icons are included in the Details tab of versiondog EasyClient:
Equal
The local version and the server version are identical.
Different
The local version and the server version are not identical.
Not present
Neither a local version nor a server version is existing or no connection to
server (local login).
16
Masterdata tab
The Masterdata tab shows general information on a component selected in the project tree (e.g. cus-
tomer and project).
Check-Out
Check-Out
Load current version of the component from the server.
View conflict
Compare local backup with working directory (button will only be displayed in
case of conflict).
Marked as Solved
Mark conflict as solved and continue working (button will only be displayed in
case of conflict).
Delete
Delete local component.
Edit
17
Check-In
Check-In
Load version created locally onto the server.
Delete
Delete local component. A component not (no longer) existing locally is
greyed out in the project tree of versiondog EasyClient.
18
Status bar (EasyClient)
l Licence holder
l Logged in user
l Name of the server to which a user is logged in (LOCAL is shown for local login)
19
Working with versiondog EasyClient
versiondog EasyClient gives you a variety of functions to work with. This tutorial focusses on the basic
functions provided by EasyClient and aims to provide the user with the knowledge necessary for using
the EasyClient to edit existing project data within the versiondog system. The tutorial assumes that
the user has a basic knowledge of the versiondog system.
20
Displaying project data in versiondog EasyClient
In versiondog, project data is organised within a hierarchical folder structure. This structure is created,
maintained and displayed in the project tree. The structure consists of directories (folders) and com-
ponents. A component is the smallest unit in versiondog and is always part of exactly one project.
Directories and components that only exist on the server (i.e. they are not present locally) are greyed
out in the project tree. Local directories and components are displayed normally (with a black font) in
the project tree, which means that they have been copied from the server to the client using the
Check-Out procedure.
There are several options when it comes to displaying directories and components in the project tree.
It is possible to display all directories and components, i.e. both those located on the server and those
located on the local client. If necessary, you can restrict the view so that the project tree only shows
the local directories and components. To switch between views, proceed as follows:
If the button is highlighted in orange, both local directories and directories located on the ver-
siondog server are displayed. Directories and components that only exist on the server are
shown but greyed out. If the button is not highlighted in orange, the directories and directories
located on the versiondog server are not displayed at all. Only those directories and com-
ponents that exist locally are shown.
If the Server directories button is inactive and the server icon greyed out, no server connection
exists. In such instances, only those directories and components that are present locally are shown.
This can occur if a user is only logged in locally and not in to a server. The status bar shows whether a
user is logged in locally or to a server.
21
Managing project data in versiondog EasyClient
The project tree determines in which structure project data is stored in versiondog. The project tree is
displayed in both the versiondog EasyClient and the versiondog UserClient. The functions are the
same for both applications.
l Create directory
l Create component
l Edit component
l Refresh
l Delete
l Delete on server
Not every user can use all functions. The rights granted to the user in versiondog determine which
functions are available to the user in the project tree. The user's current location in the project tree
also determines which functions are available. If an action cannot be performed at a particular loc-
ation, the corresponding function is greyed out and thus inactive.
22
Checking out a version in versiondog EasyClient
If a change has to be made to an existing program, the user responsible for the making the change will
load the current version from the server onto the local client. The files required for making the change
to the program are stored in a component within versiondog.
The process of copying the files of a component from the versiondog server to the local client is
referred to as Check-Out. During a Check-Out, versiondog will automatically copy the current versions
of the files to the local working directory of the components for editing.
1. In the project tree, locate the component containing the version you wish to download and
edit, then click on that component.
The component view will be opened. The component view shows information on the selected
component.
l Details tab:
The Details tab shows whether the local version and the server version of the selected
component are equal or not. If no data matching the selected component are available
locally, this is signalled to the user by a red dot.
l Masterdata tab
The Masterdata tab shows additional information on the component (e.g. customer,
project, plant …).
2. In the component view, click on the Check-Out button to copy the current version of the selec-
ted component from the versiondog server to your local client.
During a Check-Out, versiondog will automatically copy the current versions of the files to the
local working directory of the component for editing purposes. Once a Check-Out has been
completed successfully, the local version and the server version are identical. A green dot with
an equal sign shows that the local version and the server version are identical. If a component
23
has been locked by another user at the time the Check-Out is attempted, a message is dis-
played. A message will also appear if a conflict has occurred.
The user has the option to either lock a component or mark it as Under development. This
The changed status tells other users that the component is being worked on. Options are as follows:
l Under development
If a user has marked a component as Under development, other users will still be able to check
out the component, edit the data contained in it, create new versions and check the com-
ponent back in. The Under development status is for information only and does not involve
any restrictions. The program will display a message if a component has been marked as Under
development by a user.
The status is changed via the Editable button. To change the component status, proceed as fol-
lows:
24
1. In the component view, click on the Editable button and select the desired status in the
dropdown menu.
2. Enter a comment if necessary (i.e. reason or expected duration of the editing process) and click
on OK.
To reset the status, click on the status button and select Unlock and reset component in the drop-
down menu.
The status is changed via the client settings. To change the component status, proceed as follows:
3. Under Check-Out options, select one of the following options: Check-Out always in lock state
"Under development" or Check-Out always in lock state "Lock for other users".
4. Click on OK.
Solving a conflict
If a user checks out a component locally, makes changes to it without checking those changes in and
then checks out exactly the same component again, the system will report a conflict.
If a conflict occurs, any local changes are moved to the backup directory(<drive>:\vdClientArchive\
{Project}\{Projectname.$B$}) and the current server version is copied to the local client. In addition,
the component will be locked to prevent further editing until the conflict is solved. To solve a conflict,
you have the following options:
25
Mark conflict as solved
Note: If you wish to compare the working directory with the local backup, click on the View con-
26
Editing a version in versiondog EasyClient
Once the current version of a component has been copied from the server to the local system via
Check-Out, it can be edited.
3. Edit the file, save your changes and close the editor
The user has the option to either lock a component or mark it as Under development. This
Immediately after editing the files of a component, the changes you have made only exist in the work-
ing directory of the component on the local client. In order to copy these changes to the server, you
first have to create a new version. That newly created local version has to then be checked in on the
server. For more information, see Creating a new version and Checking in a version.
Another method involves adding new content to a component in the form of new files. To add new
files to a component, you have the following options:
l Saving data directly in the working directory of the component with the data of the current ver-
sion. It is possible to save a new file directly to the working directory, eliminating the need to
move the file.
27
l Files can be saved outside the working directory of a component and added to the current ver-
sion in the working directory of that component at a later time. Files located anywhere outside
the working directory of a component can be moved to the working directory of that com-
ponent at a later time.
Files can be moved within the file manager or moved from the file manager to the component in the
project tree of versiondog EasyClient via drag & drop. Immediately after new files have been added to
a component, those new files only exist in the working directory of the component on the local client.
In order to copy the new files to the server, you have first to create a new version. That newly created
local version has then to be checked in on the server. For more information, see Creating a new ver-
sion and Checking in a version.
Deleting content
It is possible to delete content from a component. One way of accomplishing this is to delete content
from existing files.
Another method to delete content from a component involves deleting complete files from the com-
ponent. To delete complete files from a component, you have the following options:
l Files can be deleted directly from the current version in the working directory of the com-
ponent.
Content deleted from a component can be deleted from the working directory of the component on
the local client only. In order to remove content that has been deleted locally also from the com-
ponent on the server, a new version has to be created. That newly created local version has then to be
checked in on the server. For more information, see Creating a new version and Checking in a version.
28
Creating a new version in versiondog EasyClient
After you have made and saved the new changes, you can create a new version. To create a new ver-
sion, proceed as follows:
1. In the project tree, select the component you made changes to and for which you want to cre-
ate a new version.
3. Create a new version. In the ribbon of the Hometab, click on one of the following items:
Create local version will create a new version locally without copying it to the ver-
siondog server.
Create version and Check-In will create a new version and automatically copy it to the
server.
29
Checking in a version with versiondog EasyClient
A Check-In has to be performed in order to copy a newly created version from the local client to the
versiondog server. The following options are available to you:
1. In the project tree, select the component you made changes to and for which you want to cre-
ate a new version.
3. Create a new version. In the ribbon of the Home tab, click on Create version and Check-In .
A new version is created. The new local version and the server version are identical. A green dot
with an equal sign shows that the local version and the server version are identical.
A local version has never been copied to the server. For more details on creating versions refer to this
document.
1. In the project tree, select the component you wish to check in.
A blue dot with a not equal sign shows that the local version and the server version are dif-
ferent.
If the local version and the server version are identical, no Check-In is possible.
30
31
Deleting a component locally in versiondog EasyClient
A component that is no longer needed locally can be deleted. To delete a component locally, you have
the following options:
4. Click on OK.
32
Configuring versiondog EasyClient
A user who has the necessary access rights and knowledge can configure a number of settings for
EasyClient. One way to configure EasyClient is customising the component view in the project tree.
Furthermore, versiondog EasyClient can be configured in such a way that a user can see and edit only
specific components on a given computer.
33
The component view in the project tree
In versiondog EasyClient a user can see all components for which that user has at least reading rights
by default. However, versiondog EasyClient can be configured in such a way that only specific com-
ponents are shown in the project tree. If, for example, a user is currently working on a visualisation
panel, it is possible to configure versiondog EasyClient so that only the components relevant to that
panel are displayed to the user.
l The configuration file for the component list is passed via the /NodeList:{absolute path of the
configuration file} parameter.
l The individual components are configured through the Node_{n} key. Please note:
l {n} should be consecutive but double entries or index jumps will be tolerated.
l A node can include either the ID of a component or the path of the project tree.
l If a node configuration is to be ignored, it can be commented out in the INI file using a semi-
colon ;.
By default, a user can see only those components for which that user has at least reading rights. If
a configuration file containing predefined components for the component view exists, the user sees
only those components for which they have reading rights. Other components for which the user has
reading rights but which are not listed in the configuration file will not be displayed.
34
To configure the component view, proceed as follows:
1. Create an INI file with a predefined component list on the computer on which versiondog
EasyClient is to be launched. Choose the directory and the file name at your discretion.
Example:
D:\vdClientArchive\VD$A\Configuration\HMI-Panel-PLCs.ini
2. Enter the desired components in the configuration file. It is up to you whether you specify the
corresponding component ID or the path to the component.
Syntax:
[NodeList]
Node_1= {Component ID}
Node_2= {Path to component}
Example:
[NodeList]
Node_1= 6532F81942F8547393GC8879DEGC4GEF
Node_2= \Plant 2\Hall 2\Area 2
3. Customise the links (Desktop, Start menu, Quick Launch bar). The path to the configuration file
has to be specified in the links for versiondog EasyClient as follows: "/NodeList:{absolute path
of the configuration file}".
Example:
C:\Program Files\vdogClient\VDogEasyClient.exe /at:c "/rd:D:\vdClientArchive" "/NodeList:
D:\vdClientArchive\VD$A\Configuration\HMI-Panel-PLCs.ini"
The /at:c parameter specifies the application type. at stands for application type, c for cli-
ent. The /at:c parameter has to be specified every time the application is launched. The /rd:
{vdClientArchive} parameter specifies the path to the client archive. rd stands for root dir-
ectory.
A user needs at least reading rights for the components in order to be able to view the com-
NodeList]
35
Node_1= 5412E70831E7436292FB7768CDFB3FDE
Node_2= D4CFD4DE77E8426C982D25192E21AB87
;Node_3=
Node_4= \Plant 1\Hall 1\Area 1
Node_4=\Plant 1\Hall 1\Area 2
Notes:
l Node_3 will be ignored because the corresponding entry has been commented out with a semi-
colon at the beginning of the line.
l Node_4 has been allocated twice. Both occurrences of Node_4 will be accounted for.
36