MultiUser features

MultiUser features
Multi user − general description.....................................................................................................1

Server project (multi user)...............................................................................................................2

Client project (multi user)................................................................................................................3

Handling multi user projects...........................................................................................................4

Show project connection......................................................................................................4
Announcing or deleting libraries...........................................................................................4
Inserting, deleting or editing data type worksheets..............................................................5
Inserting, deleting or editing POUs.......................................................................................6
Global variables in multi user projects..................................................................................7
Downloading and debugging multi user projects..................................................................8

Multi user features − overview........................................................................................................9

Check out (multi user)..........................................................................................................9
Check in (multi user)..........................................................................................................10
Undo check out (multi user)...............................................................................................11
Get latest version (multi user)............................................................................................11
Insert to server project (multi user).....................................................................................12
Delete from server project (multi user)...............................................................................12
Update structure (multi user)..............................................................................................13

i
Multi user − general description
The multi user feature is a powerful tool to provide safe access to project source files while several
users are working on the same project at the same time. To achieve a safe and fast multi user
development environment, the project is stored as server project on a network server PC and each
user has to create a client project on his PC.

The multi user feature provides several functions to handle a multi user project in a fast and easy
way, e.g. automated server and client project creation, updating the client and server projects,
checking in and out source files or inserting and deleting parts of the projects.

In the client project all nodes (files) have read−only status by default. To be able to work on the
multi user project, the individual node(s) have to be checked out in the project tree of the client
project. After this, the checked out nodes are locked in the server project, i.e. no other user has
write access. Due to this, source files can not be changed by several users at the same time.

In addition, client projects can be compiled as known from single user projects and downloading
and debugging is possible if the corresponding resource is checked out.

1
Server project (multi user)
A multi user project always consists of a server project and a number of client projects. The server
project is stored on a server in the network. To be able to work on a multi user project (server
project), each user has to create a client project on his local workstation.

To create a server project, a "normal" developed project has to be opened and saved as server
project. By doing this, a copy of the local project is stored on the server PC as server project and
the local project becomes a client project.

How to create a server project:

• Open the project you want so save as server project.

• Select the menu item 'Project > Safe as server project'.
The dialog 'Safe as server project' appears.
• In the field 'Path to server folder' enter the path of the server project you want to create or
select a destination folder using the browse button. The path of the currently opened
project is displayed in the field 'Client project'.

• Confirm the dialog with 'OK'.

A copy of the project is stored in the destination folder on the server PC and the local
project becomes a client project.

It is not possible to open a server project. Only local copies (client projects) can be opened and
changed.

2
Client project (multi user)
A multi user project always consists of a server project and a number of client projects. To be able
to work on a multi user project (server project), each user has to create a client project on his local
workstation. This is only possible, if a server project has been saved before. A client project is
created using the dialog 'Create client project' (see below) and represents a complete copy of the
server project.

How to create a client project:

• Select the menu item 'Project > Create client project'.

The dialog 'Create client project' appears.
• In the field 'Server project' enter the path and name of the server project or select a server
project from which you want to create a client project using the browse button. In the field
'Client project' enter the path of the new client project or select a destination folder using
the browse button.

• Confirm the dialog with 'OK'.

A local copy of the server project, i.e. the client project is stored in the client folder and it is
opened automatically.

After a client project has been created, its nodes in the project tree have the status '(read−only)'. To
make changes in a read−only node, it has to be checked out before. Only the insertion of data
types, POUs, configurations and resources is possible without a check out.

3
Handling multi user projects
In a multi user project you can use several features for handling the client project.

These features are:

• Show project connection

• Announcing or deleting a library
• Inserting, deleting or editing a data type worksheet
• Inserting, deleting or editing a POU
• Global variables in multi user projects

Show project connection

The dialog 'Project connection' appears if you select 'Project > Show project connection'.

The dialog displays the paths of the current multi user project, i.e. of the server and the client
project. The paths can not be changed, i.e. the dialog serves for information purposes only.

Announcing or deleting libraries

This topic describes the special features for libraries when you are working with a multi user
project.

Announcing a library

If you want to announce a library in the server project, you first have to check out the 'Libraries'
node in the project tree. Now the context menu of the node contains the menu item 'Insert' to
announce a new library. After inserting a library you have to check in the libraries node to the
server project (refer to the following note).

If you have inserted a new library, you have to ensure, that all users in the multi user environment
have copies of the new library on their client workstations, before you check in the libraries node.

Deleting a library

Deleting from client project

To delete a library from the client project, you have to mark it and press <DEL> or select the
context menu item 'Delete'.

4
Handling multi user projects Inserting, deleting or editing data type worksheets

The library is only removed from the client project. It is still available in the server project. Next time
you select 'Update structure' on the 'Libraries' node, the deleted library is restored from the server
project.

Deleting from server project

If you want to delete an existing library from the server project, you first have to check out the
libraries node in the project tree. Now the library can be deleted by marking it and pressing <DEL>.

If you have deleted a library by mistake, you can retrieve the 'Libraries' node from the server using
the dialog 'Update structure'.

After deleting a library you have to check in the libraries node to the server project.

After you have checked in the 'Libraries' node to the server project, the deleted library is removed
from the project.

Inserting, deleting or editing data type worksheets

This topic describes the special features for data type worksheets when you are working with a
multi user project.

Inserting data type worksheets

You can insert a data type worksheet in the project tree without checking out the 'Data Types'
node.
After inserting the data type worksheet, it is only available in your client project. This is indicated by
the "disconnect" symbol which is displayed beneath the new inserted worksheet icon.

To add the data type worksheet to the server project, right click on the worksheet in the project tree
and select 'Insert to server project' in the context menu. The disconnect symbol is removed and the
worksheet is marked '(read−only)'. After updating their client structures, the worksheet is available
for all other users.

Deleting data type worksheets

Deleting data type worksheets from a server project is only possible, if no other user has checked
out the node. To delete a worksheet, two different menu items are available in the context menu of
a data type worksheet in the project tree:

Context menu item 'Delete from server project'

• Right click on the data type worksheet in the project tree and select 'Delete from server
project' in the context menu.
• You are asked whether you want do delete the data type worksheet from the server
project or not. After confirming the dialog with 'OK', the worksheet is deleted from the
server project but it is still available in your client project. The "disconnect" symbol is
displayed.
Note: At this point of time, you can restore the worksheet in the server project using the
context menu item 'Insert to server project' if you have deleted it by mistake.

5
Handling multi user projects Inserting, deleting or editing POUs

• To delete the data type worksheet from your client project too, select 'Delete' in the
context menu of the disconnected worksheet.

Context menu item 'Delete'

• Right click on the data type worksheet in the project tree and select 'Delete' in the context
menu.
• A dialog appears in which you have to confirm or abort the deletion. Click 'OK' to continue.
• Another dialog appears asking whether you want do delete the data type worksheet from
the server project and from the client project or only from the client project. If you click
− 'Yes', the data type worksheet is irretrievable deleted from your client project and from
the server project.
− 'No', the worksheet is deleted from your client project but is still available in the server
project. You can retrieve the node 'Data Types' from the server using the dialog 'Update
structure'.

Editing data type worksheets

Editing data type worksheets is only possible after checking out the corresponding worksheet. After
changing the content, you have to check in the worksheet again.

Inserting, deleting or editing POUs

This topic describes the special features for POUs when you are working with a multi user project.

Inserting new POUs

You can insert POUs in the project tree without checking out the 'Logical POUs' node.
After inserting the POU, it is only available in your client project. To indicate this, the new
worksheet icon is displayed together with the disconnect symbol: .
To add the POU to the server project, you have to right click on the POU in the project tree and
select 'Insert to server project' in the context menu. The disconnect symbol is removed and the icon
is marked '(read−only)'. After updating their client structures, the POU is available for all other
users.

Deleting POUs

Deleting POUs from a server project is only possible, if no other user has checked out the node. To
delete a POU, two different menu items are available in the context menu of a POU in the project
tree:

Context menu item 'Delete from server project'

• Right click on the POU in the project tree and select 'Delete from server project' in the
context menu.
• You are asked whether you want do delete the POU from the server project or not. After
confirming the dialog with 'OK', the POU is deleted from the server project but it is still
available in your client project. The "disconnect" symbol is displayed.
Note: At this point of time, you can restore the POU in the server project using the context
menu item 'Insert to server project' if you have deleted it by mistake.

6
Handling multi user projects Global variables in multi user projects

• To delete the POU from your client project too, select 'Delete' in the context menu of the
disconnected POU.

Context menu item 'Delete'

• Right click on the POU in the project tree and select 'Delete' in the context menu.
• A dialog appears in which you have to confirm or abort the deletion. Click 'OK' to continue.
• Another dialog appears asking whether you want do delete the POU from the server
project and from the client project or only from the client project. If you click
− 'Yes', the POU is irretrievable deleted from your client project and from the server
project.
− 'No', the POU is deleted from your client project but is still available in the server project.
You can retrieve the deleted POU from the server using the dialog 'Update structure'. This
dialog is called using the menu item 'Update structure' in the context menu of the node
'Logical POUs'.

Editing POUs and POU worksheets

Editing POUs is only possible after checking out the corresponding POU node. After changing the
name, content or the properties of the POU, you have to check in the POU node again.

To insert or delete individual worksheets of a POU, the complete POU has to be checked out.
After this, the context menu of the worksheet in the project tree provides the menu items 'Insert...'
and 'Delete' to add and remove individual worksheets (description and code worksheets).

Global variables in multi user projects

This topic describes the special features for global variables when you are working with a multi
user project.

The following description applies to the resource global variables. It is also applicable for
configuration global variables, if available.

If you want to edit the global variables grid worksheet, you first have to check out the resource
where the global variables grid worksheet is located. Afterwards you can add, delete or change the
global variables.

If you have not checked out the resource where the global variables grid worksheet is located, you
can only view, sort or filter the global variables. Changes are not possible.

How to edit the global variables grid worksheet:

• Check out the resource where the global variables grid worksheet is located by right
clicking on the resource node and selecting 'Check out' in the context menu.
The resource node is marked by the check out symbol: .
• Double click on the global variables grid worksheet in the project tree to open it.
The context menu in the global variables grid worksheet now contains all entries for
editing.
• Perform your changes.
• Check in the resource by right clicking on the resource node and selecting 'Check in' in

7
Handling multi user projects Downloading and debugging multi user projects

the context menu (refer to the following note).

Before you check in changed resource nodes, you have to ensure, that the project still can be
compiled without errors.

Downloading and debugging multi user projects

Downloading

Downloading a project means that the whole project with all configuration data is sent to each
connected simulation or PLC. The system recognizes, whether only one or several target resources
are available to which the program should be downloaded. In the project tree, the target resources
are available in the subtree 'Physical Hardware'.

To download a multi user project to a resource, the corresponding resource node has to be
checked out first. Afterwards the download procedure can be performed.

If a resource has already been checked out by an other user, downloading to this resource is not
possible. The resource node is locked in the project tree.

Debugging

Once the project has been downloaded to the target resource you can perform a cold start and
switch the worksheets to online mode. In online mode you can verify whether the program works
correctly. For that purpose the program provides different debug tools.

To debug a multi user project in online mode, the client project has to be identical with the program
stored in the resource. In this case you can debug the project without checking out the resource
node.

If your client project is not identical to the program on the resource, you first have to check out the
resource in the project tree and download the project to the resource (see above).

8
Multi user features − overview
This topic describes the general features available for multi user projects. The features are
provided via the context menu of each node in the project tree. The entries in the context menu
differ depending on the type of node.

The feature ... is used to ...

Check out get exclusive access rights to a node in the project tree.
Check in write back changed nodes to the server project.
Undo check out reset all changes that have been made in the client project after the last check
out.
Get latest version copy the selected node from the server project to the client project.
Insert to server add new nodes to the server project.
project
Delete from delete specific nodes from the server project.
server project
Update structure add new nodes to the server project or to update the client project with new
nodes of the server project. The dialog 'Update structure' appears.

Check out (multi user)

The feature 'Check out' is only available in the client project of a multi user project.

Once you have created a client project on your local PC, all project data have read−only status
(displayed in the project tree for each node separately). To be able to work on parts of the project,
the individual project nodes have to be checked out. This means, the data of the selected node are
copied from the server project to the client project and you get exclusive write access to this node.
Checked out project nodes are locked in the server project, i.e. all other users have read−only
access at this time. A check out is done via the context menu of the concerning node.

When using the check out feature for the first time, a login dialog appears where you have to enter
your user name (see also note at the end of this topic).

After checking out a node, you can change its contained data. The symbol is added to checked
out nodes in the project tree.

The menu item 'Check out' is available in the context menu of the following nodes:

• Data type worksheets

• POU folders
• Configuration folder
• Resource folder
• Libraries folder

When checking out a configuration folder, the child nodes e.g. resource folders contained in the
configuration folder are not automatically checked out. Each subnode has to be checked out

9
Multi user features − overview Check in (multi user)

separately.

How to check out a node:

• Right click on the node to be checked out.

• Select the context menu item 'Check out'.
The node is checked out and marked with .

Please note, that no other user can work on the nodes you have checked out. So don't forget to
check in the nodes when you have finished editing.

If you try to check out a node which is already checked out by an other user, a message appears,
displaying the user name and the computer name of the client station where the node has been
checked out. In this case you have the possibility to get the latest version of the node to update
your client project, but you can not check out the node.

Check in (multi user)

The feature 'Check in' is only available in the client project of a multi user project.

After changing a node which has been checked out before, you have to check in the node again to
the server project. By checking in a node, its data are copied from the client project to the server
project. Once you have checked in a node, it is available for all client users. In the project tree the
symbol is removed and the status '(read−only)' is added to the node.

The menu item 'Check in' is available in the context menu of the following nodes:

• Data type worksheets

• POU folders
• Configuration folder
• Resource folder
• Libraries folder

How to check in a node:

• Right click on the node to be checked in.

• Select the context menu item 'Check in'.
The node is checked in, the symbol is removed and the node is marked with
'(read−only)'.

Before checking in changed project nodes, you have to ensure, that the project still can be
compiled without errors.

10
Multi user features − overview Undo check out (multi user)

Undo check out (multi user)

The feature 'Undo check out' is only available in the client project of a multi user project.

The feature 'Undo check out' allows to remove all changes that have been made in the client
project after the last check out of a node. The unchanged sources of the server project are copied
to the client project. After this, the node is no longer checked out and therefore available for all
client users. In the project tree the symbol is removed and the status '(read−only)' is added to the
node.

Please note, that all changes you have made in the node of your client project are lost after
undoing the check out.

The menu item 'Undo check out' is available in the context menu of the following nodes, if the
particular node is currently checked out.

• Data type worksheets

• POU folders
• Configuration folder
• Resource folder
• Libraries folder

How to undo a check out:

• Right click on the node which should be replaced by the server data.
• Select the context menu item 'Undo check out'.
A dialog appears asking you whether the local copy should be replaced. Confirm the
dialog with 'OK'. The node is replaced by the server data, the symbol is removed and the
node is marked with '(read−only)'.

Get latest version (multi user)

The feature 'Get latest version' is only available in the client project of a multi user project.

The feature 'Get latest version' copies the selected node from the server project to the client
project, i.e. the client project is updated with the latest version of the server project node.

After selecting the menu item 'Get latest version', the status bar displays the copying progress.

The menu item 'Get latest version' is available in the context menu of the following nodes:

• Data type worksheets

• POU folders
• Configuration folder

11
Multi user features − overview Insert to server project (multi user)

• Resource folder

Using the feature 'Get latest version', all changes in the corresponding node of your client project
which have not yet been checked in to the server project are removed.

Insert to server project (multi user)

The feature 'Insert to server project' is only available in the client project of a multi user project.

The command 'Insert to server project' can be used to add new nodes (POUs, data type
worksheets, etc.) to the server project. Due to this, each client user is able to update the server
project with new developed parts of his client project.

The context menu item 'Insert to server project' is only available for new inserted nodes. An already
existing project node has to be checked out and checked in again after working on it.

Inserting a new configuration or a resource to the server project is only possible if the
corresponding node is not currently checked out by another user.

The menu item 'Insert to server project' is available in the context menu of the following nodes:

• Data type worksheets

• POU folders
• Configuration folder
• Resource folder

How to insert a new node to the server project:

• Right click on the node which should be inserted to the server project.
• Select the context menu item 'Insert to server project'.
The new node is added to the server project and the node is marked with '(read−only)'.

Delete from server project (multi user)

The feature 'Delete from server' is only available in the client project of a multi user project.

The feature ''Delete from server project' can be used to remove nodes (POUs, data type
worksheets, etc.) from the server project. Due to this, each client user is able to update the server
project, if nodes have been removed from the client project.

Deleting a configuration or a resource from the server project is only possible if the corresponding
node is not currently checked out by another user.

The menu item 'Delete from server project' is available in the context menu of the following nodes:

12
Multi user features − overview Update structure (multi user)

• Data type worksheets

• POU folders
• Configuration folder
• Resource folder

How to delete nodes from the server project:

• Right click on the node which should be deleted from the server project.
• Select the context menu item 'Delete from server project'.
Confirm the security message with 'OK' to delete the selected node permanently from the
server project. In the client project the node is marked disconnected: .

It is possible to insert a deleted node to the server project again, by choosing the context menu
item 'Insert to server project'. To delete a node irretrievable from the client project, it has to be
deleted from the project tree using the context menu item 'Update structure'.

Update structure (multi user)

The feature 'Update structure' is only available in the client project of a multi user project.

The dialog 'Update structure' appears, if you select the context menu item 'Update structure' on one
of the following nodes:

• Libraries (folder node)

• Data Types (folder node)
• Logical POUs (folder node)
• Physical Hardware (folder node)
• Configuration

The dialog is used to add new nodes of the client project to the server project or to add new nodes
of the server project to the client project. Additionally it is possible to delete nodes from the client
project.

Available options in the dialog:

Process folder_name nodes which are not part of the server project

Add nodes to server project

If you activate this check box, all new inserted nodes of the current folder in the client project are
added to the server project. Nodes which are not available in the server project are displayed with
the symbol. Once the system has added the nodes to the server project, the symbol is removed.

Delete nodes from client project

Activating this check box, deletes all nodes of the current folder which are only available in the
client project but not in the server project. These nodes are displayed with the symbol. Before
the nodes are deleted, the dialog 'Confirm delete action' appears, where you have to confirm the

13
Multi user features − overview Update structure (multi user)

deletion.

Process folder_name nodes which are not part of the client project

Add nodes to client project

If you activate this check box, all nodes of the current folder are added to the client project, which
are not available in the client project but in the server project.

Process folder_name client nodes

Get latest version

Using this check box, the latest version of already existing nodes in the current folder is recovered
from the server project. This option is useful before changing existing nodes, to ensure that you are
working on the latest version of the project.

If you are using the feature 'Get latest version' and the system detects nodes which you have
checked out, the dialog 'Confirm update action' appears. Here, the checked out nodes are
displayed and you can confirm the update process for each node.

14