Team Platform Guide - bizzdesign community

Enterprise Studio
Team Platform Guide
2017-05-18
Team Platform Guide
Table of contents
1 About Team Platform
6
1.1 Features
6
1.2 Components
7
1.3 Required tool license
7
1.4 About working together
7
1.4.1
Participation
8
1.4.2
Collaboration
8
2 Tracking progress of a model package
10
2.1 Starting
10
2.2 Working on the model package
10
3 Working together on a model package
12
3.1 Starting
12
3.2 Working on the model package
12
3.3 Additional operations
13
4 Working together on a project
14
4.1 Starting
14
4.2 Working on the project
14
4.3 Additional operations
15
5 Timeline of a model package or project
17
5.1 Contributions
17
5.2 Viewing the timeline
18
5.3 Viewing additional contributions
19
6 Creating, opening and saving model packages and projects
20
6.1 Saving a model package in your personal storage
20
6.2 Saving a model package on the Team Server
21
6.3 Opening a model package from your personal storage
21
6.4 Opening a model package from the Team Server
22
6.5 Creating a project
23
6.6 Opening a project from the Team Server
25
2
Team Platform Guide
6.7 Creating a copy of a model package from your personal storage or
the Team Server
26
6.8 Inviting people to work together on a model package
27
6.9 Inviting people to work together on a project
29
6.10 Unregistered Team Server users
31
6.11 Limitations on inviting people to collaborate
32
6.12 Entering invalid e-mail addresses or unknown names when inviting
people
33
7 Working on model packages and projects
35
7.1 Possibilities and limitations in editing model elements while working
together
35
7.2 Committing changes to a model package or project
7.2.1
Temporarily keeping changes to yourself
36
37
7.3 Undoing changes to a model package or project
37
7.4 Viewing a previous state of a model package or project
38
7.5 Restoring a model package or project to a previous state
40
7.6 Updating model packages and projects
42
7.6.1
Updating a model package or project with contributions from
other users
7.6.2
Applying contributions from a project to its master model
package
7.6.3
42
44
Updating a project with contributions from its master model
package
7.7 Editing models offline
44
46
7.7.1
Taking a model offline
46
7.7.2
Editing the model offline
47
7.7.3
Returning the model to regular editing
49
7.8 Viewing the participants of a shared model package
50
7.9 Viewing the participants of a project
50
7.10 Termination of collaboration on a model package or project
51
7.10.1
Stop contributing to a model package or project
51
7.10.2
Suspend contributing to a model package or project
52
8 About the Activity Console
54
8.1 Function of the Activity Console
54
3
Team Platform Guide
8.2 Registration of activities
55
8.3 Viewing the Activity Console
56
8.4 Possible statuses and messages from the Activity Console
57
9 About the Team Server
60
9.1 Sections
60
9.2 Registration with the Team Server
63
9.3 Team Server installation
64
9.4 Registering with the Team Server
64
9.5 Logging in to the Team Server
69
9.6 User roles and rights in the Team Server
72
9.6.1
Roles
72
9.6.2
Individual rights versus group rights
74
9.7 Adding users to the Team Server
76
9.8 Creating user groups in the Team Server
79
9.9 Managing user group members
80
9.9.1
Adding users to a user group
82
9.9.2
Removing users from a user group
84
9.10 Inviting people to a model package via the Team Server
87
9.11 Inviting people to a project via the Team Server
90
9.12 Revoking invitations to model packages and projects
94
9.12.1
Revoking a user's invitation to a model package
94
9.12.2
Revoking a user's invitation to a project
98
9.12.3
Revoking a user group's invitation to a model package
101
9.12.4
Revoking a user group's invitation to a project
103
9.13 Modifying user, user group, model package and project
information
9.14 Changing the permissions of a user or user group
107
108
9.14.1
Changing a user's permissions
109
9.14.2
Changing a user group's permissions
110
9.15 Changing the scope of a project
111
9.16 Removing a user's claims on a shared model package or project
114
9.17 Removing users from the Team Server
116
9.18 Removing user groups from the Team Server
118
9.19 Removing model packages from the Team Server
120
4
Team Platform Guide
9.20 Removing projects from the Team Server
121
9.21 Filtering and sorting items in Team Server list pages
123
9.21.1
Sorting list items
124
9.21.2
Filtering list items
125
10 Team Platform configuration
126
10.1 Changing the location where the team data is stored
126
10.2 About storage places
127
10.2.1
Manually adding storage places
127
10.2.2
Storage place options
131
11 Frequently asked questions about Team Platform
134
12 Problem solving in Team Platform
136
Index
142
PDF guides
147
5
Team Platform Guide
1 About Team Platform
With the Team Platform functionality, you can track progress of your model
packages and work on model packages together with other people.
1.1
Features
Tracking progress of model packages
By tracking progress of model packages, you can keep track of the
development of your model packages. All changes made to a model package
are shown in a timeline. At any time can be seen what changes have been
made. In addition, changes can be undone, or the model package can be
restored to a previous point in time.
Working together on model packages
When working together on model packages, users together contribute to
model packages that are stored on a central location (the Team Server).
Users share model packages and committed changes are directly shared
between the participants by means of synchronization. Each participant has
the possibility to include the contributions of others in his copy of the model
package. When working together on a model package, progress is also
automatically tracked.
Working together on projects
Working together on projects offers the possibility to collaborate on parts of
a model package instead of an entire model package. This type of
collaboration is the same as working on model packages; projects are stored
on the Team Server and are shared between users that can contribute.
6
Team Platform Guide
1.2
Components
Team Server
When working together on model packages and projects, the Team Server is
used. The Team Server is a central storage place for shared model packages
and projects, and a management environment for the packages, projects
and the participating users. Working together on model packages or projects
is not possible until the Team Server is installed and users are registered.
Activity Console
For the registration of all actions performed within the context of the Team
Platform work, Enterprise Studio uses the Activity Console. The Activity
Console registers all activities you have performed, but also those from
other users when working together on model packages and projects.
1.3
Required tool license
The Team Platform functionality includes three key features. Which features
are available to you, depends on your Enterprise Studio tool license:
Package
Feature
Tracking progress
Pro EA
Pro BPM
Advanced
Enterprise
ü
ü
ü
ü
ü
ü
Working together on model
packages
Working together on
ü
projects
1.4
About working together
When working together, different users work together on (parts of) a model
package that is stored on the Team Server. Each participating user can
contribute to the model package from his own computer and include
contributions from other users in his copy of the model package.
7
Team Platform Guide
1.4.1
Participation
In order to be able to work together on a model package, people must be
invited. You can invite people yourself to work together on a model package,
but you can also be invited by others.
Inviting others
You can invite users in Enterprise Studio, but also via the Team Server
where the model package is located. The latter is only possible if you have
admin user rights in the Team Server.
Being invited
If you are invited to a model package and you are already registered with
the Team Server where the model package is located, you see the invitation
in the Activity Console. The model package is also immediately available to
contribute to. If you have not registered yet, you will receive an e-mail with
an invitation. You must then first register at the Team Server. After that you
can start contributing to the model package.
1.4.2
Collaboration
Each user has a local copy of the model package, in which he or she applies
his changes. When a user commits his changes, his contribution is saved in
the central model package on the Team Server, and stored on the other
participating users' computers by means of synchronization.
By viewing the Activity Console in the task bar of your computer you can see
which activities have been performed within the context of the collaboration.
Each user has the possibility to include the contributions of the other users in
his own copy of the model package, or leave them out. Additionally, changes
to the model package can be undone, or the model package can be restored
to a previous state.
At some point the collaboration on a model package may end. You may do
that yourself, or you may be removed from the collaboration by another.
8
Team Platform Guide
Tracking progress
When working together, the timeline does not only show your own
contributions, but also the contributions of the participating users you have
included in your local copy of the model package to keep track of the
progress of the model package.
Projects
An extended form of collaboration is working together on projects. Projects
support working together on parts of a model package instead of an entire
model package. When working together on a project, users can
simultaneously work on a specific part of a model package. If you want to
work on a project, you can claim a part of the model package for yourself
and make changes to it. By committing the changes your contributions are
made available to other users.
Working on projects also offers the possibility to apply your contributions to
the master model package where the project is based on, or to update your
project with changes made to the master model package.
9
Team Platform Guide
2 Tracking progress of a model package
By tracking progress of a model package you can keep track of the
development of the model package. You can see at any time what changes
have been made to the model package via the timeline of the model
package.
2.1
Starting
Saving the model package in the personal storage
To be able to track the progress of a model package, the model package
needs to be saved on a location that supports tracking progress: your
personal storage.
Alternatively, you may choose to save the model package on the Team
Server. To do this, you need to have a Team Server available. Instead of
sharing the model package, you keep the package to yourself.
2.2
Working on the model package
Editing the model package
The shared model package can be edited in the way you are used to. You can
add new elements, change existing elements or remove elements.
Committing changes
The changes you have made to your model package must be committed.
That way the changes will be registered in the model package's timeline for
tracking progress.
Undoing changes
Changes made to a tracked model package can be undone as long as they
have not yet been committed.
10
Team Platform Guide
Restoring the model package to a previous state
To revert changes to a model package that have already been committed,
the model package can be restored to a previous state.
11
Team Platform Guide
3 Working together on a model package
3.1
Starting
1. Saving the model package on the Team Server
To be able to share a model package with others and work on it together, the
model package first needs to be saved on a location that supports working
together: the Team Server.
2. Inviting users to the model package
To work together on a model package, people must be invited and registered
with the Team Server.
If a user has been invited, but has not yet registered with the Team Server,
he will receive an e-mail with an invitation. He must then first register with
the Team Server. After that he can start contributing to the model package.
If a user has already been registered with the Team Server where the model
package is located, he will see the invitation in the Activity Console. The
model package will be available to contribute to after synchronizing the
Activity Console.
3.2
Working on the model package
Editing the model package
The shared model package can be edited in the way you are used to. You can
add new elements, change existing elements or remove elements.
When you start working on a shared model package, the elements you are
working on are automatically claimed and they cannot or limited be worked
on by the other contributing users until you have committed your changes.
While working on the model package, you are continuously connected to the
Team Server.
12
Team Platform Guide
Committing changes
In order to save the changes you have made to your model package, and to
make them available to the other users, you need to commit the changes.
You can also just save the changes, but that should only be done you want to
temporarily keep changes to yourself.
3.3
Additional operations
Updating the model package with contributions from other users
When modeling in a model package you are working on together with other
users, it is possible to include contributions from other users in your local
copy of the shared model package. Contributions of others that are included
in your copy of the model package are shown in your model package's
timeline.
Undoing changes
Changes that have been made to the model package can be undone as long
as they have not yet been committed. When undoing changes, the model
package will be restored to its last state, presented at the top of the timeline
of the model package.
Editing a model offline
If you want to work on a shared model package without being connected to
the Team Server, you can edit a model offline.
Restoring the model package to a previous state
To revert changes to a model package that have already been committed,
the model package can be restored to a previous state.
13
Team Platform Guide
4 Working together on a project
4.1
Starting
1. Saving the model package on the Team Server
To be able to share a project with others and work on it together, the model
package the project will be based on, must be saved on a location that
supports working together: the Team Server.
2. Creating a project
The next step is creating the project. A project is very suitable to work on
parts of a model package. The parts of the model package that must be
included in the project must be determined. The entire model package can
be included, but also parts from the model package, for example a specific
model.
3. Inviting users to the project
To work together on a project, people must be invited and registered with
the Team Server.
If a user has been invited, but has not yet registered with the Team Server,
he will receive an e-mail with an invitation. He must then first register with
the Team Server. After that he can start contributing to the project.
If a user has already been registered with the Team Server where the
project is located, he will see the invitation in the Activity Console. The
project will be available to contribute to after synchronizing the Activity
Console.
4.2
Working on the project
Editing the model package
The part of the model package that is included in the project can be edited in
the way you are used to. You can add new elements, change existing
14
Team Platform Guide
elements or remove elements. Any parts that are not included, are read-only
and cannot be edited.
When you start working on a project, the elements you are working on are
automatically claimed and they cannot or limited be worked on by the other
contributing users until you have committed your changes. While working on
the project, you are continuously connected to the Team Server.
Committing changes
In order to save the changes you have made to your project, and to make
them available to the other users, you need to commit the changes. You can
also just save the changes, but that should only be done if you want to
temporarily keep changes to yourself.
4.3
Additional operations
Updating the project with contributions from other users
When modeling in a project you are working together with other users, it is
possible to include contributions from other users in your local copy of the
project. Contributions of others that are included in your copy of the project
are shown in your project's timeline.
Applying project contributions to the master model package
Changes that have been made to the project may also be desired in the
model package it is created from. To do this, the user's contributions can be
applied from the project to its master model package.
Updating the project with contributions from the master model package
The master model package of a project may be changed while working on
the project. It is possible to include these changes into the project by
updating your project with the contributions from its master model package.
15
Team Platform Guide
Undoing changes
Changes that have been made to the project can be undone as long they
have not yet been committed. When undoing changes, the project will be
restored to its last state, presented at the top of the timeline of the project.
Editing a model offline
If you want to work on a project without being connected to the Team
Server, you can edit a model offline.
Restoring the project to a previous state
To revert changes to a project that have already been committed, the
project can be restored to a previous state.
16
Team Platform Guide
5 Timeline of a model package or project
When tracking progress of a model package, or working together on a model
package, a history of the model package is created and displayed in a
timeline. In case of a project, the timeline not only shows the history of the
project, but also that of the model package the project is based on.
Figure 5.1 Example of a model package timeline
5.1
Contributions
Model package
The timeline of a model package shows the contributions to the model
package. If you are just tracking progress of your own model package, you
can see your own contributions in the timeline. If you are working together
with other people on the model package, you can also see the contributions
17
Team Platform Guide
of the participating users you have included in your copy of the model
package.
Project
The timeline of a project shows the following:
l
your own contributions,
l
contributions of other participating users you have included in your copy
of the project,
l
contributions of the model package where the project is based on (the
master), prior to the creation of the project, and
l
contributions of the master model package you have included in your copy
of the project.
A contribution contains the changes a user has made to the model package
or project that have been included in one commit action. Each contribution
generates a new point in time on the timeline, representing a certain state of
the model package.
Restore to previous state
Contributions cannot be removed from the timeline. However, you can
restore the model package or project to a previous state. With restoring, all
changes to a model package or project that have been committed after the
point in time you choose to restore, are reverted and the model package or
project returns to the state of that point in time. Restore actions are added
as (part of) a contribution to the timeline.
Before restoring a model package or project to a previous state, you can
view the state to check if it is the right one. But you can also view a previous
state just to see the state of the model package or project at a specific point
in time.
5.2
Viewing the timeline
To view the timeline of a model package or project, do this:
18
Team Platform Guide
l
On the File tab, click Timeline, and then click View Timeline.
Notes:
If the Timeline tab is not available, go to the model browser first, click any
component of the model package to set the focus on the package, and then
try again.
If the View Timeline tab is not available, the model package has not yet
been saved on a location that supports tracking progress or sharing. In
that case, first save the model package to the storage place of your
choice: your personal storage or a Team Server.
5.3
Viewing additional contributions
The timeline shows a limited amount of contributions to the model package
or project. At one point the amount will no longer fit the window it is
presented in. To view more contributions, do this:
1. On the File tab, click Timeline, and then click View Timeline.
2. At the bottom of the timeline, click on:
More if you want to see more contributions. Depending on the number of
available contributions, clicking More may show all contributions.
All if you want to see all contributions.
After leaving the timeline tab and returning to it, the number of contributions
presented in the timeline is set back to the limited amount.
19
Team Platform Guide
6 Creating, opening and saving model
packages and projects
6.1
Saving a model package in your personal storage
To be able to track progress of a model package you need to save your
model package in your personal storage. To save a model package, follow
these steps:
1. Create a new model package or open an existing model package that
you want to start tracking.
2. On the File tab, click Save As, and then click on your personal storage
. Example:
3. In Title and Description, enter a name and possible additional description
for the model package.
4. Click Save.
The model package is now saved in your personal storage and you can start
working on it. If you click Timeline in the Backstage view, you can see the
newly saved model package with its timeline.
20
Team Platform Guide
6.2
Saving a model package on the Team Server
To be able to share a model package with other users you need to save your
model package on the Team Server, a central storage place that can be
accessed by all participating users.
To save a model package on the Team Server, follow these steps:
1. Create a new model package or open an existing model package that
you want to start sharing.
2. On the File tab, click Save As, and then click on the Team Server
.
Example:
3. In Title and Description, enter a name and possible additional description
for the new model package.
4. Click Save.
The model package is now saved on the Team Server and you can start
working on it. If you click Timeline in the Backstage view, you can see the
newly saved model package with its timeline.
6.3
Opening a model package from your personal
storage
To open a tracked model package that is stored in your personal storage, do
the following:
21
Team Platform Guide
1. On the File tab, click Open, and click in the list on your personal storage
.
2. Click on the model package
you want to open.
The model package is now opened in the model browser. You can start
working on the model package.
6.4
Opening a model package from the Team Server
To open a model package that is stored on the Team Server, follow these
steps:
1. On the File tab, click Open, and click in the list on the Team Server
where the model package is located.
2. Click on the model package
you want to open.
The model package is now opened in the model browser. You can start
working on it.
Notes:
When you open a model package from the Team Server for the first time,
it is downloaded and a copy of the model package is placed on your
computer. This is your working copy of the centrally stored model
package.
The very first operation you perform on a downloaded model package may
take a bit longer. This is a one time thing.
22
Team Platform Guide
6.5
Creating a project
In order to work together on a project, a project must be created from a
shared model package. Before you do, determine what parts of the model
package you want to include in the project. You can choose to include the
entire model package.
To create a project, follow these steps:
1. Make sure the model package you want to start a project from is open.
2. On the File tab, click Manage Package, and then click Start Project.
Example:
3. In Title and Description, enter a name and possible additional description
for the new project.
23
Team Platform Guide
4. In Models, select the models from the model package you want to
include in the project by clicking the boxes on the right. Selected models
have a green box.
5. Click Create project.
After creating, the new project is opened. In the model browser, the parts of
the model package that are excluded from the project are displayed in gray.
Example:
24
Team Platform Guide
6.6
Opening a project from the Team Server
To open a project that is stored on the Team Server, follow these steps:
1. On the File tab, click Open, and click in the list on the Team Server
where the project is located.
2. Click on the project
you want to open.
The project is now opened in the model browser. You can start working on it.
25
Team Platform Guide
Notes:
When you open a project from the Team Server for the first time, it is
downloaded and a copy of the project is placed on your computer. This is
your working copy of the centrally stored project.
The very first operation you perform on a downloaded project may take a
bit longer. This is a one time thing.
6.7
Creating a copy of a model package from your
personal storage or the Team Server
If a model package is saved in your personal storage or on the Team Server,
it contains historical information (contributions), and may also contain
claims from working together on the model package.
It is possible to create a copy of a model package from your personal
storage or the Team Server, and continue working with the copy while
maintaining your claims, but without the historical information. When
creating a copy:
l
Any uncommitted changes you have made are saved in the new model
package.
l
Any unsaved claims are included in the new model package, but are NOT
maintained in the original model package.
l
Claims that have been saved via a local save (File > Save) or via the
automatic save, are included in the new model package, and are also
maintained in the original model package. If you want to discard or
commit these claims in the original model package, re-open this model
package to do so.
To create a copy of a tracked or shared model package, follow these steps:
26
Team Platform Guide
1. Make sure that the model package you want to copy is open.
2. On the File tab, click Save As, and then click on the storage place where
you want to save the model package: your personal storage or the Team
Server.
3. In Title and Description, enter a name and possible additional description
for the new model package.
4. Click Save.
You can now start working on the newly created copy of the model package.
If you open the model package and click Timeline in the Backstage view, you
will see that its timeline is empty.
6.8
Inviting people to work together on a model
package
People can be invited to a model package via the Team Server, but also from
Enterprise Studio.To invite people in Enterprise Studio to work together on a
model package, follow these steps:
1. Make sure the model package you want to share is open.
2. On the File tab, click Manage Package, and then click Invite People.
3. In the first box, type the e-mail address of the person you want to invite.
If you want to invite users that are already registered in the Team
Server or if you want to invite user groups, you can also type their
names.
27
Team Platform Guide
If you enter multiple addresses or names, additional fields will be added
automatically.
4. Click Invite to send the invitation.
Invited people that are not registered in the Team Server yet, will receive an
e-mail with an invitation to register. After registration they can start
contributing to the model package.
Note: Invited people that are already registered in the Team Server
where the model package is located, do not receive an e-mail. Instead,
they are informed about the invitation via their Activity Console. They can
directly start contributing to the model package after opening it.
28
Team Platform Guide
Tip: Use the link below the Invite button to see which people have been
invited to the model package. When clicking the link, the Team Server is
opened in your web browser showing the model package with its projects
and participants.
6.9
Inviting people to work together on a project
People can be invited to a project via the Team Server, but also from
Enterprise Studio. To invite people in Enterprise Studio to work together on a
project, follow these steps:
1. Make sure the project you want to share is open.
2. On the File tab, click Manage Project, and then click Invite People.
3. In the first box, type the e-mail address of the person you want to invite.
If you want to invite users that are already registered in the Team
Server or if you want to invite user groups, you can also type their
names.
29
Team Platform Guide
If you enter multiple addresses or names, additional fields will be added
automatically.
4. Click Invite to send the invitation.
Invited people that are not registered in the Team Server yet, will receive an
e-mail with an invitation to register. After registration they can start
contributing to the project.
Note: Invited people that are already registered in the Team Server
where the project is located, do not receive an e-mail. Instead, they are
informed about the invitation via their Activity Console. They can directly
start contributing to the project after opening it.
30
Team Platform Guide
Tip: Use the link below the Invite button to see which users have been
invited to the project. When clicking the link, the Team Server is opened in
your web browser showing the project with its models and participants.
6.10 Unregistered Team Server users
If a person who has been invited to the Team Server has registered with the
Team Server, he is depicted with an avatar with his initials in it. These
initials are visible in the Team Server and in Enterprise Studio, for example
in the timeline of a shared model package, but also when being invited to a
model package or project.
If a person is not yet a (registered) user of the Team Server, then his avatar
shows three dots.
Below is an example of a registered user and an unregistered user in
Enterprise Studio.
31
Team Platform Guide
In the Team Server it looks as follows:
6.11 Limitations on inviting people to collaborate
Inviting other people in Enterprise Studio to collaborate on model packages
and projects may be limited to users that already exist in the Team Server.
These are users who have already been created in the Team Server. They
need not have registered yet though.
Enterprise Studio
If the limitation is active, and (one or more of) the e-mail address(es) you
have entered in Enterprise Studio does not belong to an existing user, then a
message will be shown below the entered e-mail addresses, and the Invite
button is deactivated. The person's avatar is red.
32
Team Platform Guide
Team Server
If one or more of the e-mail addresses that is entered when inviting users
via the Team Server does not belong to an existing user, the borders of the
e-mail address box turn red.
Invitations cannot be sent until all boxes have their regular border color.
The limitation to invite only existing users can be deactivated in the Team
Server settings by users with admin rights.
6.12 Entering invalid e-mail addresses or unknown
names when inviting people
If you enter an invalid e-mail address or unknown user or user group name
when inviting people to collaborate on a model package or project, it is
indicated immediately. Check the address or name and correct it.
33
Team Platform Guide
Enterprise Studio
When entering an invalid e-mail address or unknown name in Enterprise
Studio, the person's avatar to the left of the e-mail box is displayed in red:
Team Server
When entering an invalid e-mail address or unknown name in the Team
Server, the borders of the box the e-mail address is entered in, are
displayed in red:
34
Team Platform Guide
7 Working on model packages and
projects
7.1
Possibilities and limitations in editing model
elements while working together
When working together on model packages and projects, users edit models
in these packages and projects. While working, users are continuously
connected to the Team Server. The changes users commit are immediately
synchronized and can directly be processed by the other contributing users.
When a user starts editing a model in a shared model package or project,
only the element he is editing is automatically claimed. Other contributing
users cannot, or have limited options to edit this element.
Basically, all elements in a model are claimed individually, except for views
and diagrams. If a user is editing a view or diagram, which often contains
multiple elements, other users cannot make visual changes to it like moving,
removing and adding elements. Renaming elements remains possible.
Below are a few examples to illustrate the possibilities and limitations of
editing a claimed object.
Examples:
If one user moves an object within the model, another user cannot
remove, rename or move the claimed object.
If one user removes an object from the model, another user cannot edit
this claimed object at all; he cannot remove or rename it, or link any
relations to the object.
If one user creates a relation between two objects, another user cannot
remove these claimed objects, but he can rename them or move them
within the model.
35
Team Platform Guide
If a user tries to perform an action that is not allowed on a claimed element,
a message will appear in his Messages window addressing a collaboration
conflict.
Figure 7.1 Example of a collaboration conflict message
Editing offline
If a user chooses to edit a model offline when working together, he can
safely edit the model offline without being overruled by other users' changes
to the model.
Any claims done by the other users are affected by the offline edited model.
Any claims already made by the other users before the model is taken
offline, remain active with the users who have made the claims.
The other users will not see the changes of offline editing in their model
browser until their Activity Console has been synchronized.
7.2
Committing changes to a model package or
project
In order to make the changes you have made to a model package or project
available for tracking progress or sharing with other users, you need to
commit them. Do as follows:
36
Team Platform Guide
1. On the File tab, click Commit, or click on
at the top of the model
browser. The overview that pops up shows the changes you are going to
commit.
2. In Remarks, enter any additional remarks regarding your contribution
and click Commit.
7.2.1
Temporarily keeping changes to yourself
If you do not immediately want to make the changes available for tracking
progress or for sharing with other users, but you do want to retain your data,
save your model package or project by clicking Save on the File tab. Your
changes are saved locally in your working copy of the model package or
project.
If you at any time want to make the changes available for tracking or
sharing, commit the changes. All changes that have been saved locally until
then, will be available after all.
Note: If you close Enterprise Studio without committing or locally saving
the changes you have made, a window appears asking you if you still want
to save the changes. Answering the question with "Yes" will save the
changes locally (not commit them!).
The next time you start Enterprise Studio, you can simply reopen the
model package.
7.3
Undoing changes to a model package or project
If you have made changes to your model package or project that you do not
want in your model package or project after all, you can undo them. This is
only possible for changes that you have not yet committed.
When undoing changes, all changes made to the working copy are removed.
The model package or project will be restored to its last state, presented at
the top of its timeline.
37
Team Platform Guide
Note: If you want to revert your model package or project to an earlier
point in time, use the restore function.
To undo changes to your model package or project, follow these steps:
1. On the File tab, click Timeline, and then click Undo Changes. The
overview shows the changes that are going to be removed.
2. At the bottom of the overview, click Undo.
3. Click OK.
Next, the model browser is presented, showing the model package or project
in the state to which it has been restored.
7.4
Viewing a previous state of a model package or
project
A previous state of a model package or project can be viewed via its
timeline. To view a previous state, follow these steps:
38
Team Platform Guide
1. On the File tab, click Timeline, and then click View Timeline.
If the Timeline tab is not available, go to the model browser. Click any
component of the model package or project so that the focus is on the
package or project, and try again.
2. In the timeline, click View below the point in time you want to view.
The model package or project is opened in the model browser as read-only.
It is indicated by the gray bars in the components of the model package or
project. The date of the contribution is also listed next to the name of the
model package or project. Example:
Figure 7.2 Read-only model package
39
Team Platform Guide
7.5
Restoring a model package or project to a
previous state
If you wish to revert a model package or project to the way it looked at an
earlier point in time, you can restore the model package or project to its
state at that time.
When restoring, a new contribution will be made in which all changes made
in the contributions since the chosen point in time will be reverted. For
example, deleted objects are re-created, changed object names are restored
to their value at the selected point in time, etc.
Before deciding to restore to a previous state, you can first view the state by
clicking View in the timeline.
To restore a model package or project to a previous state, follow these
steps:
1. On the File tab, click Timeline, and then click View Timeline.
2. In the timeline, click Restore below the point in time (contribution) you
want to return to.
All contributions to the model package or project that were made after the
selected point in time are now reverted. When it is finished, the model
browser displays the model package or project in the state to which you
have restored it.
Restore limitations
If a model package has been migrated to a new configuration at some point
in time, it can only be restored to the contribution containing the last
40
Team Platform Guide
configuration migration, or a newer contribution.
The model package cannot be restored to a point in time before the last
configuration migration. It would cause objects to be re-created, and
property values to be restored, based on an old configuration. Depending on
the changes made to the configuration, this may result in invalid or
incomplete objects.
Figure 7.3 Restoring possible to last migration
41
Team Platform Guide
7.6
7.6.1
Updating model packages and projects
Updating a model package or project with contributions
from other users
When working together on a model package or project, different people
contribute to the model package or project. During the collaboration
contributions of the other users are placed on your computer by
synchronization. However, they are not automatically included in your model
package or project. This prevents unwanted changes from unsolicited
entering your copy of the model package or project.
Contributions you want to include must be manually brought in by updating
your model package or project.
Notes:
When updating your model package or project all available contributions
will be included. It is not possible to include only part of the contributions.
If your copy of the model package or project still has uncommitted
changes when a configuration contribution becomes available, you cannot
commit these changes until you have updated your model package or
project with the configuration contribution.
To update your model package or project with contributions from other
users, follow these steps:
1. On the File tab, click Update, or click on
at the top of the model
browser. The Update page shows the available contributions.
42
Team Platform Guide
If a contribution contains configuration changes, the contribution is
indicated by the
icon:
2. Click Update to include the contributions in your model package or
project.
After updating the model package or project is shown in the model browser.
You can view the changes and continue working on the model package or
project.
If you have updated with a configuration contribution, your model package
or project now has the new configuration.
43
Team Platform Guide
7.6.2
Applying contributions from a project to its master
model package
The changes you have made to a project you are working on may also be
desired in the model package it is created from. To do this you need to
manually apply your contributions from the project to its master model
package. They are not automatically included in the master model package.
Note: When applying contributions to the master model package all
available contributions will be included. It is not possible to include only
part of the contributions.
To apply your contributions to the master model package, follow these
steps:
1. On the File tab, click Manage Project, and then click Apply Contributions.
The tab shows all available contributions.
2. Click Apply to include the contributions in the master model package.
After updating the master model package is shown in the model browser.
You can view the changes and continue working on the model package.
7.6.3
Updating a project with contributions from its master
model package
The master model package of a project may be changed while working on
the project. It is possible to include these changes into the project. They are
44
Team Platform Guide
not automatically included in your project. This prevents unwanted changes
from unsolicited entering your copy of the project.
Contributions you want to include must be manually brought in by updating
your project with contributions from the model package.
Notes:
When updating your project all available contributions will be included. It
is not possible to include only part of the contributions.
If your copy of the project still has uncommitted changes when a
configuration contribution becomes available, you cannot commit these
changes until you have updated your project with the configuration
contribution.
To update a project with contributions from its master model package, follow
these steps:
1. On the File tab, click Manage Project, and then click Update Project. The
available contributions are shown here.
If a contribution contains configuration changes, the contribution is
indicated by the
icon:
45
Team Platform Guide
2. Click Update to include the contributions from the model package in your
project.
After updating, the project is shown in the model browser. You can view the
changes and continue working on the project.
If you have updated with a configuration contribution, your project now has
the new configuration.
7.7
Editing models offline
Editing offline offers you the possibility to work on a shared model package
or project on a location where is no connection to the Team Server, for
example when you are out of the office.
With editing offline, you are doing a claim that overrules any other new
claims to be done on the model, so that you can go offline and safely edit it.
7.7.1
Taking a model offline
To take a model offline, follow these steps:
1. In the model browser, right click the model you want to edit offline, and
then click Edit offline to activate it.
46
Team Platform Guide
A message appears informing you that you next need to take your tool
license offline to be able to work offline. Otherwise you will not be able
to edit the offline model when there is no connection to the Team
Server. Close the message.
2. On the File tab, click About, and then click License management.
3. On the General tab of the License Management window, in Number of days
to use current license offline, enter the number of days you want to take
the license offline. You can enter a number between 1 and 14.
4. Click Take offline.
5. Click OK to close the window, and click OK again.
The entire license, listed by Current license is now moved to your local
machine and you can now work offline.
If another user tries to edit a model that has just been taken offline, but
Enterprise Studio has not noticed it yet, the user will receive a message
about it.
7.7.2
Editing the model offline
After you have taken a model offline, the model browser shows your initials
next to the model.
47
Team Platform Guide
Figure 7.4 Model taken offline by user JD
Other contributing users will see the same in their model browser. They will
see the offline edited model as read-only:
Figure 7.5 Model taken offline as seen by other users
Editing a model offline works the same as regularly editing a shared model;
you make changes to the model and commit these changes. Your committed
changes are shown in your Activity Console. There is an arrow
next to
them indicating that they have not been synchronized yet (because there is
no connection to the Team Server).
48
Team Platform Guide
Figure 7.6 Activity Console showing unsynchronized contributions
The other users will not see your contributions in their Activity Console until
the connection to the Team Server has been re-established, and your
contributions have been synchronized.
7.7.3
Returning the model to regular editing
When you are done editing offline, you can return to regular editing by
returning your offline license and deactivating offline editing. To do this,
follow these steps:
1. On the File tab, click About, and then click License management.
2. On the General tab of the License Management window, click Return.
3. Click OK to close the window, and click OK again.
4. In the model browser, right click the model you have taken offline and
click Edit offline to remove the check mark.
49
Team Platform Guide
The license is now moved back to the network you can continue working on
the network license. Your contributions will be synchronized when the
connection to the Team Server has been re-established, and other users can
update their model package or project with your contributions.
7.8
Viewing the participants of a shared model
package
The participants of a shared model package can be viewed from two
locations in Enterprise Studio. To see which users are participating in a
shared model package, do one of the following:
l
On the File tab, click Info, and then click the link View this model package
online to see who's invited.
or
l
On the File tab, click Manage Package, and then click the link See everyone
who is invited to <model package name>.
Next, the Team Server opens in the web browser, showing the model
package with its projects (if present) and participants.
7.9
Viewing the participants of a project
The participants of a project can be viewed from two locations in Enterprise
Studio. To see which users are participating in a project, do one of the
following:
l
On the File tab, click Info, and then click the link View this project online to
see who's invited.
or
l
On the File tab, click Manage Project, and then click the link See everyone
who is invited to <project name>.
50
Team Platform Guide
Next, the Team Server opens in the web browser, showing the project with
its models and its participants.
7.10 Termination of collaboration on a model package
or project
At some point the collaboration on a model package or project may end. The
user may want to withdraw from a model package or project, or he is
removed from a model package or project by someone else. If the user
wants to temporarily stop working on a model package or project, he can
also suspend contributing to it.
If a user is removed from a model package or project, his invitation to it is
revoked. Revoking invitations can only be done from the Team Server. A
user can also revoke his own invitations to a model package or project he is
contributing to.
When an invitation has been revoked, the user can no longer work on the
model package or project nor can he synchronize changes with the Team
Server. Additionally, all changes to the model package or project claimed by
him will be blocked. However, the user will still have the possibility to save
the model package or project locally for his own use.
7.10.1
Stop contributing to a model package or project
If you do not need or want to work on a shared model package or project
anymore, you can stop contributing.
If you stop contributing to a model package or project, your copy of the
model package or project will be removed, and any changes you have not
committed yet will be lost. If you do not want to loose these changes,
commit them first before stopping.
Stop contributing to a model package or project to which you have been
invited through a user group is not possible. Contributing to such a model
package or project only stops if the invitation for the user group is revoked
via the Team Server.
51
Team Platform Guide
Attention: Stopping with contributing is permanent. In order to be able to
work together on the model package or project again, you will need to be
re-invited to this model package or project.
To stop contributing to a model package or project, follow these steps:
1. On the File tab, click Open, and then click the Team Server where the
model package or project is located.
2. Click on the
control next to the model package or project.
3. Click OK.
After that, the model package or project is removed from your list of Team
Server model packages and projects, unless you have also been invited to
this model package or project through a user group. In that case, the model
package or project remains in the list.
7.10.2
Suspend contributing to a model package or project
If you want to temporarily stop working on a shared model package or
project, you can suspend contributing to it. You can at any time resume
contributing by opening the model package or project, and continue working
on it.
52
Team Platform Guide
Note: If you suspend contributing to a model package or project, your
copy of the model package or project will become inactive, and any
changes you have not committed yet will be lost. If you do not want to
loose these changes, commit them first before suspending.
The model package or project must be closed before you can suspend
contributing to it.
To suspend contributing to a model package or project, follow these steps:
1. On the File tab, click Open, and then click the Team Server where the
model package or project is located.
2. Click on the
control next to the model package or project.
3. Click OK.
Any model package or project you have suspended contributing to, is
marked by a gray suspend control
.
Figure 7.7 Overview with one model package with suspended contribution
53
Team Platform Guide
8 About the Activity Console
One of the components that is used within the Team Platform functionality is
the Activity Console. The Activity Console is automatically installed during
the installation of Enterprise Studio, initially appears as a red triangle
in
the system tray of your computer after starting the tool, but moves shortly
after to the hidden icons in the system tray.
Figure 8.1 Activity Console icon directly after starting (left) and with the hidden icons (right)
8.1
Function of the Activity Console
The Activity Console keeps track of the different types of actions performed
by the users in the context of the Team Platform work.
54
Team Platform Guide
The Activity Console logs include the following activities:
l
Sending invitations to users to register with the Team Server and/or work
together on model packages.
l
Saving model packages for tracking progress and working together.
l
Changes to model packages made the by users.
In addition, the Activity Console keeps track of whether contributions from
other users are already included in your own model package, and informs
you when your own contributions are not yet synchronized.
8.2
Registration of activities
Registration in the Activity Console takes place the moment an activity has
occurred. If you just track progress of your own model packages, the
console only shows your own activities. If you work together with other
people on model packages, the console also shows the activities of the other
participating users.
Once the Activity Console is running, it stays active, even after you have
closed Enterprise Studio. This is particularly useful for model packages
55
Team Platform Guide
people work on together. This way you can keep track of all activities related
to these model packages, even if you are not working with Enterprise Studio.
8.3
Viewing the Activity Console
To open the Activity Console to view the activities that have been performed
when tracking model packages or collaborating on them, click the Activity
Console icon
in the message area (system tray) of your task bar. Next,
the window appears showing messages regarding activities.
Figure 8.2 The Activity Console window
The most recent activity is always located at the top. Your own activities are
displayed on the right of the window. Any activities from the other users are
always displayed on the left.
A message shows the type of activity, the model package the activity relates
to, and the moment the activity is performed, possibly supplemented with
remarks.
Who has performed the activity is indicated by the colored block with the
user's initials that is presented next to the activity. When moving the mouse
pointer over the block, you see the name and e-mail address of the user.
56
Team Platform Guide
When moving over the activity, you see the complete description of the
activity.
8.4
Possible statuses and messages from the Activity
Console
The Activity Console is part of the Team Platform functionality. The Activity
Console keeps track of the different types of actions performed in this
context and informs you about them.
The Activity Console icon in the system tray of your computer may change to
indicate a certain status or to share something. In addition, the activities in
the console may have additional icons to explain something.
The overview below shows the possible statuses with messages and their
meaning.
Symbol
Meaning
Activity Console is running
This is the default status of the Activity Console. When the
console is active and there are no details, it looks like this.
There are unseen activities
If there are activities in the Activity Console that you have not
yet read, the console indicate it with a text balloon.
Once you open the Activity Console to view the activities the
default icon view will return.
Busy synchronizing
When working together on a model package, the changes
committed by you to your local copy of the model package are
automatically shared with the other participating users by
means of synchronization. During synchronization your
changes are transferred to the shared model package on the
Team Server, and from there your contribution is made
available on the computers of the other users working on the
model package.
57
Team Platform Guide
Symbol
Meaning
Basically, synchronization takes place when you commit your
changes. At that point, your computer needs to be connected to
the Team Server where the model package is located,
otherwise there will be no synchronization.
Automatic synchronization takes place every five minutes.
During this the contributions of all participating users are
retrieved and exchanged. If you want to synchronize in
between, you can do it manually. To do this, right click the
Activity Console icon and click Sync all, or move your mouse
pointer over Recent activities at the top of the opened Activity
Console and click when it changes to Synchronize all.
Disturbance in the synchronization
It may occur that your contributions cannot be synchronized
because there is (temporarily) no connection to the Team
Server where the model package is located. These
contributions are visible in the Activity Console, but they are
not yet synchronized. The Activity Console displays the
disturbance with an exclamation mark. The contribution in the
console is also marked to indicate it is not yet synchronized.
Once the connection has been restored, the icon of the Activity
Console returns to its default view and the automatic
synchronization is resumed.
Activity has not yet been synchronized
When you have committed the changes to your local copy of
the model package, they are usually automatically
synchronized to make them available to the other users.
If there is no connection to the Team Server where the model
package is located, your changes are not synchronized. In the
Activity Console, this is indicated by an outgoing arrow next to
the activity.
Changes have not yet been processed
If changes from other users are available that you have not yet
58
Team Platform Guide
Symbol
Meaning
processed in your model package, it is indicated by an
incoming arrow in the Activity Console.
59
Team Platform Guide
9 About the Team Server
To be able to work together on a model package, the model package must be
saved to a central storage place that can be accessed by all participating
users.
The Team Server forms the basis for the central storage place. The model
packages are stored and managed there. The users working on the model
packages are registered and managed here too. The Team Server is installed
before users start working on model packages.
9.1
Sections
User home page
After logging in to the Team Server the user's personal home page is
displayed. This page shows a link to the Team Server configuration file, the
user's invitations to model packages and projects, and the user groups he is
part of. Which information is visible to the user depends on his permissions
in the Team Server.
If a user has been invited to a model package more than once, for example
individually and through a user group, then the model package is shown
more than once in the invitations list.
60
Team Platform Guide
Figure 9.1 Example of a Team Server user home page
Model packages
The model packages that are stored on the Team Server are shown on the
model package overview page. They are represented by a model package
icon
. On this page, users with administrator rights see all model
packages available in the Team Server. Users with lower permissions only
see the model packages they are invited to directly or through a user group,
and the model packages of the projects they are invited to directly or
through a user group.
Any projects the users are invited to are shown on the detail page of a model
package. Projects are represented by a project icon
.
61
Team Platform Guide
Figure 9.2 Overview of model packages in the Team Server
Users and user groups
Users in the Team Server are represented by a colored round icon with their
initials in it. Users can be added manually to the Team Server, but can also
be imported from Windows Active Directory.
Figure 9.3 Overview of users in the Team Server
User groups can be created to assign permissions to groups of users.
62
Team Platform Guide
Figure 9.4 Overview of user groups in the Team Server
The information a user or user group can see on the Team Server pages and
the operations that can be performed, depends on rights the user or user
group has in the Team Server. The Team Server distinguishes different user
permissions.
Team Server settings
The Team Server toolbar has a settings menu. Via this menu, several
settings for the Team Server can be configured like e-mail settings, setting a
limitation on inviting users, changing the Team Server database
configuration. The settings menu can also be used for configuring user
import from Active Directory and viewing the Team Server audit log.
The settings menu is only visible for users with administrator rights. For
more information about the Team Server settings, please refer to the
Enterprise Studio Installation and Configuration Guide (PDF, online).
9.2
Registration with the Team Server
To be able to register with the Team Server, a user will receive an e-mail
with an invitation, from which he can access the registration page of the
Team Server to register. After registration he can download a configuration
file that must be included in Enterprise Studio. This file is necessary to make
the Team Server available as storage place in the tool.
63
Team Platform Guide
9.3
Team Server installation
The Team Server must be installed before working together is possible. The
installation is usually performed by an application manager. For more
information about the Team Server installation, please refer to the
Enterprise Studio Installation and Configuration Guide (PDF, online).
Using multiple Team Servers
Basically, one Team Server is sufficient for working together on model
packages. However, multiple Team Servers with model packages may have
been defined. When working together on model packages on different
servers, each Team Server should be available as storage place in
Enterprise Studio.
9.4
Registering with the Team Server
If you are invited to work together on a model package, you need to be
registered with the Team Server to be able to contribute. If you are not
registered yet, you can do this via the link in the invitation mail you have
received.
Note: If you are working with a hosted version of Enterprise Studio, only
follow steps 1 an 2. After that, continue with manually adding the Team
Server. Do NOT download the configuration file. It cannot be used in a
hosted environment.
64
Team Platform Guide
1. Click the link in the invitation mail.
2. The registration page of the Team Server is opened in your web
browser. Enter you details and a password and click Register.
65
Team Platform Guide
3. The registration confirmation appears. Click the Configuration for
Team Server link and store the configuration file (*.jssc) somewhere
local on your computer.
4. Drag the saved configuration file onto Enterprise Studio, and release the
mouse button when it's somewhere above the tool. Example:
Instead of dragging the configuration file to add the Team Server, you
can also manually add the Team Server.
5. The Add Storage Place window appears. Depending on how you log in to
the Team Server, do one of the following:
Log in with your Team Server account
66
Team Platform Guide
l
In Username and Password, enter the e-mail address and password
you use to log in to the Team Server, and click Finish.
Optional: If HTTPS is used to connect to the Team Server, the Accept all
server certificates check box is available. If you select the check box,
checking on certificates is relaxed, meaning that one could possibly
communicate with an imposter Team Server. Leave the check box blank
if you do not want this.
Log in with your Windows account
67
Team Platform Guide
l
Click Finish to add the Team Server.
Optional: If HTTPS is used to connect to the Team Server, the Accept all
server certificates check box is available. If you select the check box,
checking on certificates is relaxed, meaning that one could possibly
communicate with an imposter Team Server. Leave the check box blank
if you do not want this.
If you cannot log in with your Windows account, or if you want to log in
as a different user, clear the Log in with your Windows account check box,
enter the e-mail address and password to log in to the Team Server in
Username and Password, and click Finish.
68
Team Platform Guide
The Team Server is now available as a storage place in Enterprise Studio.
Any model packages you may already have been invited to, are available on
this location. You can open the model packages and start working on them.
9.5
Logging in to the Team Server
Once you have registered at the Team Server to collaborate on model
packages or projects, you can log in to the Team Server to view your user
69
Team Platform Guide
data and the model packages and projects you are contributing to, or even
perform additional operations, depending on your rights in the Team Server.
How you can log in to the Team Server depends on whether the Team Server
supports logging in with your Team Server account or Windows account, or
supports automatically logging in with your Windows account.
When logging in with a Team Server account, your username is the e-mail
address that was used for sending you the invitation to register on the Team
Server. When logging in with your Windows account, your credentials are
your Windows username and password.
Team Server supports logging in with a Team Server or Windows
account
If the Team Server supports logging in with your Team Server account or
Windows account, the login window looks like this:
To log in, enter your username and password, and click Log in.
70
Team Platform Guide
Team Server supports automatically logging in with a Windows account
If the Team Server supports automatically logging in with your Windows
account, the login window looks like this:
Depending on your account, use one of the following options to log in:
l
Click Log in using your Windows account if you use your Windows account
to access the Team Server and want to automatically log in.
l
In Username and Password, enter your Windows credentials if you use
your Windows account to access the Team Server and if you want to log in
from outside the domain, or log in as a different user.
l
In Username and Password, enter your Team Server credentials if you
have an original Team Server account for logging in.
Remember password
If you log in with your username and password, and want the Team Server
to remember them the next time you log in, select the Remember me check
box before clicking Log in.
71
Team Platform Guide
Password forgotten
If you have forgotten your Team Server password, click Forgot password,
enter your e-mail address and click Send. You will receive an e-mail in which
you need to click a link to reset the password and enter a new one.
Note: Requesting for a new password is not possible if you are logging in
with your Windows account. In that case, please contact your system
administrator.
After logging in, your personal home page appears showing a link to the
Team Server configuration file, your invitations to model packages and
projects, and the user groups you are part of.
9.6
User roles and rights in the Team Server
The Team Server distinguishes three types of users, bases on the roles that
are set when a user is added to the Team Server. A role determines the
user's rights in the Team Server and Team Platform-related work in
Enterprise Studio. The role also determines which information in the Team
Server is visible to the user. Roles can be linked to individual users but also
to user groups.
9.6.1
Roles
The following roles can be distinguished:
Administrator
An administrator user can manage all users, model packages and projects
that are stored in the Team Server. In Enterprise Studio, an administrator
can add model packages to the Team Server. In the Team Server he can:
l
View all model packages and projects stored in the Team Server.
l
View all user pages and changes the users' Team Server permissions.
l
Add new users and invite them directly to model packages and projects.
72
Team Platform Guide
l
Invite users to work together on model packages and projects.
l
Revoke users' invitations to model packages and projects.
l
Remove users.
l
Remove model packages and projects.
l
Remove users' claims on model packages and projects.
In order to be an administrator user, his permissions in the Team Server
must be set to Administrator. This permission includes the Create model
packages permission.
Create model packages
A user with the permission to create model packages can add model
packages to the Team Server from Enterprise Studio. In the Team Server he
can:
l
View the model packages and projects he is contributing to.
l
View all user pages.
l
Invite users to work together on the model packages and projects he is
contributing to.
l
Revoke his own invitations to model packages and projects.
l
Revoke other users' invitations to the model packages and projects he is
contributing to.
For this type of user the permissions in the Team Server must be set to
Create model packages.
If none of the permissions above has been set for a user, the user can only
work on the model packages he is invited to in Enterprise Studio. He cannot
add new model packages to the Team Server. In the Team Server he can:
l
View the model packages and projects he is contributing to.
l
View all user pages.
73
Team Platform Guide
l
Invite users to work together on the model packages and projects he is
contributing to.
l
Revoke his own invitations to model packages and projects.
The user's permissions are shown in the Permissions section of the user
page:
A check mark
next to a role means that it is assigned. The
icon
indicates that the role is not assigned.
Note: The check boxes next to the icons are only visible to users with
administrator rights. By selecting and clearing the check boxes the user's
individual permissions can be changed.
9.6.2
Individual rights versus group rights
The role(s) assigned to a user give him individual rights for the Team Server
and in Enterprise Studio. If user groups have been defined in the Team
74
Team Platform Guide
Server, then the role(s) assigned to a group give all users in that group these
rights.
The participation of a user in a user group may result in different
combinations of rights for the user. Not only his individual rights are shown,
but also the rights inherited from the user group(s) he is part of.
If the role assigned individually to a user and the role assigned to the group
he is part of differ, then the role with the most rights overrules. A few
examples:
Example 1
A user has not been assigned any role ("None"). The user is also part of a
user group. This user group has been assigned the role "Create model
packages". The user's permissions will look as follows:
Since the user's role inherited from the group includes more rights, the
user has the rights belonging to "Create model packages", which is more
than has been assigned individually.
75
Team Platform Guide
Example 2
A user has been assigned the role "Administrator". The user is also part of
a user group. This user group has been assigned the role "Create model
packages". The user's permissions will look as follows:
Since the user's individual role includes more rights than he has via the
user group, he keeps the administrator rights. In this situation, the
individual rights overrule the group rights. Because of this, the lower-level
role ("Create model packages") cannot be changed on the individual level;
the check mark is disabled, and when hovering it, a message appears
indicating this:
9.7
Adding users to the Team Server
Users need to be registered in the Team Server to be able to work together
on model packages and projects. In the Team Server admin pages, users
can be added manually to have them registered.
You can only add new users to the Team Server if you have admin user
rights in the Team Server.
To manually add users to the Team Server, follow these steps:
76
Team Platform Guide
1. In the Team Server toolbar, click on User management > Users, and then
click Add users.
2. Enter the e-mail addresses of the users you want to add to the Team
Server. If you enter multiple addresses, additional fields will be added
automatically.
3. Optional: If you directly want to invite the users to contribute to one or
more model packages, select the desired model packages by selecting
the check boxes in front of the model packages.
77
Team Platform Guide
If there are no model packages available yet, or if you only want the
users to register with the Team Server, go directly to step 3.
4. Select the permissions the user(s) must have. If you select:
Create model packages, the user can add new model packages to the
Team Server from Enterprise Studio.
Administrator, the user cannot only work on the model packages and add
new model packages, but he is also allowed to manage these model
packages in the Team Server.
If you leave both options blank, the user can only work on the model
packages he is invited to. He cannot add new model packages to the
Team Server or manage model packages in the Team Server.
5. Click Invite to send the invitation.
Next, an e-mail message with an invitation to register is sent to the user(s).
78
Team Platform Guide
9.8
Creating user groups in the Team Server
Note: You can only add user groups to the Team Server if you have admin
user rights in the Team Server.
To create a user group in the Team Server, follow these steps:
1. In the Team Server toolbar, click on User management > User groups, and
then click Add user group.
2. Enter the name of the user group, and a description if desired. The user
group name must be unique.
3. Select the permissions the user group must have. If you select:
79
Team Platform Guide
Create model packages, the users in the group can add new model
packages to the Team Server from Enterprise Studio.
Administrator, the users cannot only work on the model packages and
add new model packages, but they are also allowed to manage these
model packages in the Team Server.
If you leave both options blank, the users can only work on the model
packages they are invited to. They cannot add new model packages to
the Team Server or manage model packages in the Team Server.
4. Click Add to add the group.
9.9
Managing user group members
The members of a user group in the Team Server may vary. Users may be
added or removed from the group. It is done on the manage group members
page.
To open the group members page of a user group, follow these steps:
1. In the Team Server toolbar, click on User management > User groups, and
then click on the user group of which you want to manage the members.
80
Team Platform Guide
2. On the user group page, click Manage group members.
The group member page appears:
81
Team Platform Guide
9.9.1
Adding users to a user group
To add users to a user group follow these steps:
1. In the Team Server toolbar, click on User management > User groups.
2. On the user group overview page, click on the user group to which you
want to add users.
82
Team Platform Guide
3. On the user group page, click Manage group members.
4. On the group members page, select the check boxes in front of the users
that must be added to the group.
If you want to select all users in the list at once, click Include all.
5. Click Apply to save the changes.
The users that have been added are shown on the user group page.
83
Team Platform Guide
Membership notification
When a user has been added to a user group and the user group has no
invitations to model packages and/or projects yet, the user will not be
informed.
If the user group already does have invitations, the user is automatically
invited to the model packages and projects the user group is contributing to.
The model packages and projects will be available to contribute to after
synchronizing the Activity Console. The user is informed about the invitation
(s) via the Activity Console on his computer, unless he is already
contributing to these packages and/or projects otherwise (through individual
invitations or through another user group).
If the user has not yet registered with the Team Server, he will receive an email with an invitation. He must then first register with the Team Server.
After that he can start contributing to the model package.
9.9.2
Removing users from a user group
To remove users from a user group follow these steps:
1. In the Team Server toolbar, click on User management > User groups.
2. On the user group overview page, click on the user group from which
you want to remove users.
84
Team Platform Guide
3. On the user group page, click Manage group members.
4. On the group members page, clear the check boxes in front of the users
that must be removed from the group.
If you want to clear all users in the list at once, click Remove all.
85
Team Platform Guide
5. Click Apply to save the changes.
Removal notification
When a user has been removed from a user group and the user group has no
invitations to model packages and/or projects, the user will not be informed.
If the user group does have invitations, the user's invitations will be
revoked. He is informed about this via the Activity Console on his computer.
Unless the user is still otherwise invited to these model packages or
projects, he can no longer contribute to the model packages and projects of
the user group, nor can he synchronize changes with the Team Server.
Additionally, all changes to the model packages or projects claimed by him
will be blocked.
However, the user will still have the possibility to save the model package or
project locally for his own use. If the user opens a model package or project
for which his invitation has been revoked, or tries to make changes to it if it
is already open, a message will appear saying his invitation has been
revoked. The user can choose to close the model package, or save it locally
in a different location for personal use. For more information, see Problem
solving in Team Platform.
86
Team Platform Guide
9.10 Inviting people to a model package via the Team
Server
People can be invited to a model package from Enterprise Studio, but also
via the Team Server. To invite people via the Team Server, follow these
steps:
1. In the Team Server toolbar, click on Model packages, and then click on
the model package you want to invite people to.
2. On the model package page, under Users, click Invite users.
87
Team Platform Guide
3. Enter the e-mail address of the person(s) you want to invite.
88
Team Platform Guide
If you want to invite users that are already registered in the Team
Server or if you want to invite user groups, you can also type their
names. The Team Server will show the available users and user groups.
If you enter multiple addresses or names, additional fields will be added
automatically.
4. Click Invite users to send the invitation.
The invited people are added to the list of users contributing to the model
package. The invitation to the model package is also added to the user page
and/or user group page in the Team Server of the invited people and groups.
89
Team Platform Guide
Invitation notification
Invited people that are not registered in the Team Server yet, will receive an
e-mail with an invitation to register. After registration they can start
contributing to the model package.
Invited people that are already registered in the Team Server where the
model package is located, do not receive an e-mail. Instead, they are
informed about the invitation via their Activity Console. They can directly
start contributing to the model package after opening it.
9.11 Inviting people to a project via the Team Server
People can be invited to a project from Enterprise Studio, but also via the
Team Server. To invite people via the Team Server, follow these steps:
1. In the Team Server toolbar, click on Model packages, and then click on
the model package the project belongs to.
2. On the model package page, under Projects, click on the project you
want to invite people to.
90
Team Platform Guide
3. On the project page, under Users, click Invite users.
91
Team Platform Guide
4. Enter the e-mail address of the person(s) you want to invite.
92
Team Platform Guide
If you want to invite users that are already registered in the Team
Server or if you want to invite user groups, you can also type their
names. The Team Server will show the available users and user groups.
If you enter multiple addresses or names, additional fields will be added
automatically.
5. Click Invite users to send the invitation.
The invited people are added to the list of users belonging to the project. The
invitation to the project is also added to the user page and/or user group
page in the Team Server of the invited people and groups.
93
Team Platform Guide
Invitation notification
Invited people that are not registered in the Team Server yet, will receive an
e-mail with an invitation to register. After registration they can start
contributing to the project.
Invited people that are already registered in the Team Server where the
project is located, do not receive an e-mail. Instead, they are informed
about the invitation via their Activity Console. They can directly start
contributing to the project after opening it.
9.12 Revoking invitations to model packages and
projects
Users and user groups can be uninvited from collaborating on a model
package or project by revoking their invitation to the model package or
project in the Team Server.
When an invitation has been revoked, the user can no longer contribute to
the model package or project, nor can he synchronize changes with the
Team Server. Additionally, all changes to the model package or project
claimed by him will be blocked.
However, the user will still have the possibility to save the model package or
project locally for his own use. If the user opens a model package or project
for which his invitation has been revoked, or tries to make changes to it if it
is already open, a message will appear saying his invitation has been
revoked. The user can choose to close the model package, or save it locally
in a different location for personal use. For more information, see Problem
solving in Team Platform.
The user whose invitation has been revoked will also be informed via the
Activity Console on his computer.
9.12.1
Revoking a user's invitation to a model package
A user can be uninvited from collaborating on a model package by revoking
his invitation to the model package in the Team Server, but he can also
revoke his own invitations.
94
Team Platform Guide
If you have admin user rights in the Team Server, you can revoke any
invitation of any user. If you have the rights to create model packages, you
can only revoke your own invitations to model packages and projects, and
other users' invitations to the model packages and projects you are
contributing to.
Revoking an invitation via the user page
1. In the Team Server toolbar, click on User management > Users, and then
click on the user whose invitation you want to revoke.
2. On the user page, under Invitations, click Revoke invitation next to the
model package for which you want to revoke the invitation.
95
Team Platform Guide
If an invitation is through one or more user groups, the user groups are
shown instead of the Revoke invitation button.
In that case, the invitation can be revoked through the user group. You
can click on a user group to open its page.
3. Click OK to revoke the invitation.
96
Team Platform Guide
Revoking an invitation via the model package page
1. In the Team Server toolbar, click on Model packages, and then click on
the model package for which you want to revoke the invitation.
2. On the model package page, under Users, click Revoke invitation next to
the user whose invitation you want to revoke.
97
Team Platform Guide
3. Click OK to revoke the invitation.
9.12.2
Revoking a user's invitation to a project
A user can be uninvited by another user from collaborating on a project by
revoking his invitation to the project in the Team Server, but the user can
also revoke his own invitation.
If you have admin user rights in the Team Server, you can revoke any
invitation of any user. If you have the rights to create model packages, you
can only revoke your own invitations to model packages and projects, and
other users' invitations to the model packages and projects you are
contributing to.
To revoke a user's invitation to a project, follow these steps:
98
Team Platform Guide
1. In the Team Server toolbar, click on User management > Users, and then
click on the user whose invitation you want to revoke.
2. On the user page, under Invitations, click Revoke invitation next to the
project for which you want to revoke the invitation.
99
Team Platform Guide
If an invitation is via one ore more user groups, the user groups are
shown instead of the Revoke invitation button.
In that case, the invitation can be revoked through the user group. You
can click on a user group to open its page.
100
Team Platform Guide
3. Click OK to revoke the invitation.
9.12.3
Revoking a user group's invitation to a model package
A user group can be uninvited from collaborating on a model package by
revoking its invitation to the model package in the Team Server.
Only if you have admin user rights in the Team Server, you can revoke
invitations of user groups.
Revoking an invitation via the user group page
1. In the Team Server toolbar, click on User management > User groups, and
then click on the user group of which you want to revoke the invitation.
2. On the user group page, under Invitations, click Revoke invitation next to
the model package for which you want to revoke the invitation.
101
Team Platform Guide
3. Click OK to revoke the invitation.
Revoking an invitation via the model package page
1. In the Team Server toolbar, click on Model packages, and then click on
the model package for which you want to revoke the invitation.
102
Team Platform Guide
2. On the model package page, under User groups, click Revoke invitation
next to the group of which you want to revoke the invitation.
3. Click OK to revoke the invitation.
9.12.4
Revoking a user group's invitation to a project
A user group can be uninvited from collaborating on a project by revoking its
invitation to the project in the Team Server.
103
Team Platform Guide
Only if you have admin user rights in the Team Server, you can revoke
invitations of user groups.
Revoking an invitation via the user group page
1. In the Team Server toolbar, click on User management > User groups, and
then click on the user group of which you want to revoke the invitation.
2. On the user group page, under Invitations, click Revoke invitation next to
the project for which you want to revoke the invitation.
104
Team Platform Guide
3. Click OK to revoke the invitation.
Revoking an invitation via the project page
1. In the Team Server toolbar, click on Model packages, and then click on
the model package the project belongs to.
105
Team Platform Guide
2. On the model package page, under Projects, click on the project for
which you want to revoke the invitation.
3. On the project page, under User groups, click Revoke invitation next to
the group of which you want to revoke the invitation.
106
Team Platform Guide
4. Click OK to revoke the invitation.
9.13 Modifying user, user group, model package and
project information
The information of a user, user groups, model package and project in the
Team Server can be modified. It may be needed for example to change a
user's e-mail address, or his user rights for the Team Server.
Note: The name and e-mail address of LDAP users cannot be edited. Any
changes in these data are regulated via the user synchronization with
Active Directory.
107
Team Platform Guide
Basic information like a name and description can be modified by clicking the
control next to the box, and edit the data. Click the
control to confirm
the changes.
To cancel the changes before having them confirmed, click the
control. If
you have already confirmed the changes, edit the data again and confirm
your changes.
Figure 9.5 Editing a user name
In addition to modifying basic information, several other actions can be
performed on the page like changing permissions, removing claims,
revoking invitations, managing models, and even removing the user, user
group, model package or project from the Team Server.
Which information a user can change on a page, depends on his user rights in
the Team Server. A user with admin user rights can make all possible
changes. A user with the rights to create model packages has limited
possibilities to make changes.
9.14 Changing the permissions of a user or user
group
The permissions that have initially been set for a single user or for a user
group when it was created, can be changed any time.
You can only change a user's or user group's permissions if you have admin
user rights in the Team Server.
108
Team Platform Guide
9.14.1
Changing a user's permissions
To change the individual permissions of a user, follow these steps:
1. In the Team Server toolbar, click on User management > Users, and then
click on the user whose permissions you want to change.
2. On the user page, in the Permissions section, select or clear the check
boxes of the roles you want to change.
109
Team Platform Guide
If a user has permissions inherited from one or more user groups, the
user groups are shown next to the role.
These permissions can be changed via the user group. You can click on a
user group to open its page.
9.14.2
Changing a user group's permissions
To change the permissions of a user group, follow these steps:
1. In the Team Server toolbar, click on User management > User groups, and
then click on the user group of which you want to change the
permissions.
2. On the user group page, in the Permissions section, select or clear the
110
Team Platform Guide
check boxes of the roles you want to change.
9.15 Changing the scope of a project
When a project is created in Enterprise Studio, the models from the model
package the project is based on, are selected to determine the scope of the
project.
In the Team Server you change the scope of a project by including and/or
removing models from the project.
Note: You can only change the scope of a project if you have admin user
rights in the Team Server.
To change the scope of a project, follow these steps:
111
Team Platform Guide
1. In the Team Server toolbar, click on Model packages, and then click on
the model package the project belongs to.
2. On the model package page, under Projects, click on the project of which
you want to change the scope.
3. On the project page, under Models, click Manage models.
112
Team Platform Guide
4. On the manage models page, include the models you want in your
project and exclude the ones you want out of the project by selecting
and clearing the check boxes in front of the models in the list.
If you want to select all models from the list, click Include all.
113
Team Platform Guide
5. Click Apply to save the changes.
9.16 Removing a user's claims on a shared model
package or project
If a user is contributing to a model package or project, the parts of the
shared model package or project he is editing, are automatically claimed.
Other contributing users cannot, or have limited options to edit these parts.
These claims remain active until the user's contributions have been
synchronized with the Team Server. Also, if a user is editing a model offline,
the model stays blocked until his contributions have been synchronized with
the Team Server.
For various reasons, a user's contributions may remain blocked. If needed,
this blockage can be removed by removing the user's claims in the Team
Server.
Take note that when a user's claims are removed, all work of the user that
has not yet been synchronized with the Team Server will get lost.
114
Team Platform Guide
Note: You can only remove a user's claims if you have admin user rights
in the Team Server.
To remove a user's claims on a shared model package or project, follow
these steps:
1. In the Team Server toolbar, click on User management > Users, and then
click on the user whose claims you want to remove.
2. On the user page, under Invitations, click Remove claims next to the
model package or project for which you want to remove the user's
claims.
115
Team Platform Guide
3. Click OK to remove the claims.
9.17 Removing users from the Team Server
Users can be removed from the Team Server. If a user has been removed
from the Team Server he can no longer contribute to the model packages
and projects he was invited to nor can he synchronize changes with the Team
Server. Additionally, all changes to the model packages and projects claimed
by him will be blocked.
However, the user will still have the possibility to save the model packages
and projects locally for his own use. If a user opens a model package or
project on which he has been contributing before he was removed, or if he
tries to make changes to it if it is already open, a message will appear
116
Team Platform Guide
saying he is no longer registered. The user can choose to close the model
package or project, or save it locally in a different location for personal use.
For more information about the possibilities, see Problem solving in Team
Platform.
The user who has been removed will also be informed about this via the
Activity Console on his computer.
LDAP users cannot be removed via the Team Server. They can only be
removed or by deleting them in the LDAP server, and then synchronizing the
users in the Team Server with Active Directory.
Removing a user
Only if you have admin user rights in the Team Server, you can remove
users.
To remove a user follow these steps:
1. In the Team Server toolbar, click on User management > Users, and then
click on the user you want to remove.
2. On the user page, click Remove user.
If the user is an LDAP user, the button is not present.
117
Team Platform Guide
3. Click OK to permanently remove the user from the Team Server.
9.18 Removing user groups from the Team Server
User groups can be removed from the Team Server. When removing a user
group, the users that are member of the group will not be removed from the
Team Server.
If the user group that is removed does not have any invitations to model
packages and projects yet, the members of the group are not informed about
the removal.
If the user group does have invitations to model packages and projects
(visible on the user group page, section Invitations), its invitations will be
removed from these model packages and projects. The user group (and its
members) is no longer participant in these model packages and projects.
Unless a member is still otherwise invited to one or more of these model
packages or projects, he can no longer contribute to them nor can he
synchronize changes with the Team Server. Additionally, all changes to
these model packages and projects claimed by him will be blocked.
However, the member will still have the possibility to save the model
packages and projects locally for his own use. If a user opens a model
package or project on which he has been contributing before the group was
removed, or if he tries to make changes to it if it is already open, a message
will appear saying his invitation has been revoked. He can choose to close
the model package or project, or save it locally in a different location for
personal use. For more information, see Problem solving in Team Platform.
118
Team Platform Guide
The members of the removed group are also informed via the Activity
Console on their computer.
Removing a user group
You can only remove user groups if you have admin user rights in the Team
Server.
To remove a user group, follow these steps:
1. In the Team Server toolbar, click on User management > User groups, and
then click on the user group you want to remove.
2. On the user group page, click Remove user group.
119
Team Platform Guide
3. Click OK to permanently remove the user group from the Team Server.
9.19 Removing model packages from the Team
Server
Model packages can be removed from the Team Server. If a model package
has been removed from the Team Server users that haven been contributing
to it can no longer contribute nor can they synchronize changes with the
Team Server. Additionally, all changes to the model package claimed by
them will be blocked.
However, the user will still have the possibility to save the model package
locally for his own use. If a user opens the model package after it has been
removed from the Team Server, or if he tries to make changes to it if the
package is already open, a message will appear saying that the model
package has been removed. The user can choose to close the model
package, or save it locally in a different location for personal use. For more
information about the possibilities, see Problem solving in Team Platform.
The user will also be informed via the Activity Console on his computer.
Removing a model package
You can only remove model packages from the Team Server if you have
admin user rights in the Team Server.
To remove a model package, follow these steps:
120
Team Platform Guide
1. In the Team Server toolbar, click on Model packages, and then click on
the model package you want to remove.
2. On the model package page, click Delete model package.
3. Click OK to permanently remove the model package from the Team
Server.
9.20 Removing projects from the Team Server
Projects can be removed from the Team Server. If a project has been
removed from the Team Server users that haven been contributing to it can
no longer contribute nor can they synchronize changes with the Team
Server. Additionally, all changes to the project claimed by them will be
blocked.
121
Team Platform Guide
However, the user will still have the possibility to save the project locally for
his own use. If a user opens the project after it has been removed from the
Team Server, or if he tries to make changes to it if the project is already
open, a message will appear saying that the project has been removed. The
user can choose to close the project, or save it locally in a different location
for personal use. For more information about the possibilities, see Problem
solving in Team Platform.
The user will also be informed via the Activity Console on his computer.
Removing a project
You can only remove projects from the Team Server if you have admin user
rights in the Team Server.
To remove a project, follow these steps:
1. In the Team Server toolbar, click on Model packages, and then click on
the model package the project belongs to.
2. On the model package page, click on the project you want to remove.
122
Team Platform Guide
3. On the project page, click Delete project.
4. Click OK to permanently remove the project from the Team Server.
9.21 Filtering and sorting items in Team Server list
pages
The items on the manage group members page and the manage models page
in the Team Server are displayed in a list. The items in these lists can be
sorted. The items in the manage group members page can also be filtered.
123
Team Platform Guide
Figure 9.6 Group member list
9.21.1
Sorting list items
The items in the list can be sorted on all columns that have a title. A column
can be sorted ascending or descending by clicking on its title.
Figure 9.7 Group member list sorted descending on first name
124
Team Platform Guide
9.21.2
Filtering list items
You can easily limit the items in the group members list by typing the search
text in the box at the top of the list. The list is automatically filtered. All
items that contain (part of) the entered filter text will be shown on the page.
You can filter on the following data (columns): first name, last name, and email address.
Figure 9.8 Filtering the group member list
125
Team Platform Guide
10 Team Platform configuration
10.1 Changing the location where the team data is
stored
The following team data are stored locally on your computer when working
with the Team Platform functionality:
l
Activity Console information
l
working copies of your tracked and shared models and projects
l
Team Servers you are registered with
l
Team Platform configuration data
By default, the team data is located in your Local folder:
C:\Users\<username>\AppData\Local\BiZZdesign.
To change the team data location, follow these steps:
1. On the File tab, click Options.
2. Click Data Storage.
3. In Team Data Location, click Use the following location, and select the
desired location in the box beneath it, or click Browse to navigate to the
location.
4. Click OK.
Return to the default location
Click Use the default location in Team Data Location to return to the standard
location.
126
Team Platform Guide
10.2 About storage places
The Team Platform functionality uses two types of storage places that can be
used for saving model packages. A storage place enables tracking progress
of a model package and working together on it with other users.
Personal storage
The personal storage is a storage place located on your own computer. When
saving a model package in your personal storage, you are only able to track
progress of the model package, you cannot share it with others. The
personal storage usually has your user name, for example:
Team Server
The Team Server is a centrally located storage place that supports working
together and can be accessed by all participating users. Usually a Team
Server is installed on a central server. Example:
The Team Server is not only a central storage place, it is also serves as an
administration facility for the shared model packages and the participating
users. The model packages and users can be registered there and managed.
To be able to do this, you need admin user rights in the Team Server.
10.2.1
Manually adding storage places
Shared model packages are stored in a predefined shared storage place
called the Team Server. Usually, the storage place is added to Enterprise
Studio when you register with the Team Server.
127
Team Platform Guide
However, it is also possible to manually add storage places. It is even
needed if you are working with a hosted version of Enterprise Studio.
To be able to add the Team Server in Enterprise Studio, the server must
already be installed. Also, you need to have registered with the Team
Server. Storage places can be added via the Enterprise Studio Options
window, or via the Backstage view.
1. Choose one of the following:
Backstage view: On the File tab, click Save As, and then click Add storage
place.
Options: On the File tab, click Options, and then click Storage places.
Next, click Add.
2. In the Add Storage Place wizard, in Server, enter the address of the
defined Team Server, and click Next.
Optional: If HTTPS is used to connect to the Team Server, the Accept all
server certificates check box is available. If you select the check box,
checking on certificates is relaxed, meaning that one could possibly
communicate with an imposter Team Server. Leave the check box blank
if you do not want this.
128
Team Platform Guide
3. How you can log in to the Team Server depends on whether the Team
Server supports logging in with your Team Server account or Windows
account, or supports automatically logging in with your Windows
account. Depending on how you can log in, do one of the following:
Log in with your Team Server or Windows account
The window looks as follows:
129
Team Platform Guide
l
In Username and Password, enter your credentials, and click Finish.
When logging in with a Team Server account, your username is the email address that was used for sending you the invitation to register
on the Team Server. When logging in with your Windows account,
your credentials are your Windows username and password.
Automatically log in with your Windows account
The window looks as follows:
130
Team Platform Guide
Depending on your account, use one of the following options to log in:
l
If you use your Windows account to access the Team Server and want
to automatically log in:
Click Finish to add the Team Server.
l
If you use your Windows account to access the Team Server and if you
want to log in from outside the domain, or log in as a different user:
a. Clear the Log in using your Windows account check box.
b. In Username and Password, enter your Windows credentials.
c. Click Finish to add the Team Server.
l
If you have an original Team Server account for logging in:
a. In Username and Password, enter your Team Server credentials.
b. Click Finish to add the Team Server.
10.2.2
Storage place options
On the Storage Places tab of the Enterprise Studio Options window you can
manage the connections from Enterprise Studio with the available Team
131
Team Platform Guide
Servers.
Shared model packages are stored in a predefined shared storage place
called the Team Server. A connection with a Team Server is necessary to be
able to share model packages and projects between users.
Section/Button/Check box
Description
Available storage places
The list shows the Team Servers that
have been defined in Enterprise Studio.
It is possible to connect with multiple
Team Servers.
Here, you can add new Team Servers,
change existing ones, or remove them.
Add
Click to add a new storage place.
Usually, the storage place is added to
Enterprise Studio when you register
with the Team Server. However, it is
also possible to manually add storage
places.
132
Team Platform Guide
Section/Button/Check box
Description
To be able to do this the respective
Team Server must already be installed.
Also, you need to have registered
yourself with the Team Server.
When adding a new storage place, you
enter the name of a defined Team
Server, the e-mail address you are
registered with at the Team Server,
and the password to log in to the Team
Server.
Change
Click to edit the storage place selected
in the list.
Remove
Click to remove the storage place
selected in the list.
133
Team Platform Guide
11 Frequently asked questions about
Team Platform
How can I find out who are invited to a model package or
project?
Make sure you have opened the model package or project and perform one
of the steps:
l
On the File tab, click Info, and then click the link View this project online to
see who's invited.
or
l
On the File tab, click Manage Package or Manage Project, and then click the
link See everyone who is invited to <project name>.
How can I see if contributions from other people are available to
process in my copy of the model package?
The Update tab of the Backstage view shows the contributions that can be
processed in your model package. If the overview is empty, no contributions
are available.
The
button at the top of the model browser indicates that contributions
are available.
134
Team Platform Guide
Click the button to navigate to the Update tab in the Backstage view and
update your model package. If the arrow is light gray
, no contributions
are available.
Unprocessed changes are also indicated in the Activity Console. They are
marked by a
next to the activity.
When updating my model package, is it possible to process only
part of the available contributions of other people?
It is not possible to process only part of the available contributions. When
you update you copy of the model package via File > Update, all available
contributions are retrieved.
135
Team Platform Guide
12 Problem solving in Team Platform
Enterprise Studio
The Commit, Timeline, and Manage Package tabs in the
Backstage view are not available although the model package is
stored for tracking progress or working together.
You probably have not selected the model package or a component of the
package in the model browser, so the focus is not on the model package. You
first need to click on (a random component of) the model package, so the
focus is on the model package. After that the tabs are also active.
Also, the available tool license determines whether the Manage Package tab
is available or not. The tab is only available to you if your Enterprise Studio
license includes the tool package Advanced or Enterprise.
It is not possible to manually add a new storage place (Team
Server) at the storage place options
You probably have not installed the Team Server yet. In order to be able to
manually add a storage place at the storage place options, the respective
Team Server must already be installed. Additionally you need to have
registered yourself with this Team Server. After that you can manually add a
storage place.
When starting up Enterprise Studio, a message is shown saying
that the team data location cannot be accessed
When starting up Enterprise Studio, a check is performed to determine if the
team data location is accessible and writable. The team data location is the
location where various data used in the Team Platform functionality are
stored. If the team data location cannot be accessed, a message is shown
indicating this. Example:
136
Team Platform Guide
Choose one of the following options to proceed.
l
Click Stop if you want to close Enterprise Studio so you can try to resolve
the issue.
l
Click Retry if you have already resolved the issue and want to retry to
connect to the current location.
l
Click Select new location if you want to select a new team data location, for
example because the current location is not available (any more). Please
note that selecting a new location will discard any model packages that
are present in your personal storage, and any uncommitted work, or
commits that are not yet synchronized with the Team Server will be lost
as well.
Inviting users is not possible
Inviting users in Enterprise Studio is bound to the number of users registered
in your software license. If the number of users of your software license is
exceeded when inviting users, an error message appears on your screen. To
solve the problem you need to reduce the number of active users. Depending
on the software license you have, you can do the following.
Advanced license: Remove the users that are not using the Team Platform
functionality anymore from the Team Server.
Enterprise license: Remove the users that are not using the Team Platform
functionality anymore from the Team Server, or revoke their invitation to all
model packages and projects they are not working on from the Team Server.
If you are not sure which license you have, you can check it via File > About
> License management.
137
Team Platform Guide
Note: You can only remove users or revoke their invitation in the Team
Server if you have admin user rights in the Team Server.
If you are not able to reduce the number of users, it is also possible to
expand your software license with additional users. You can contact
BiZZdesign Sales for this.
A contributing user has taken a model offline for offline editing,
but he is no longer available to put it back for regular editing.
How can the offline model be retrieved?
If a model has been taken offline by a contributing user and it cannot be put
back for regular editing, the model stays blocked. To release the model
again, there are two options:
l
If the user is temporarily unavailable to revert the offline editing himself
(for example because he is on holiday), you can retrieve the offline model
by removing the user's claims on the model package or project in the
Team Server. Go to the user's page in the Team Server and click the
Remove claims button next to the model package or project with the
offline model. The user's changes to the model will still be available
locally on his computer.
l
If the user is no longer working on model packages anymore, remove this
user from the Team Server. By removing the user any existing claims on
his model packages and projects will be removed too. Go to the user's
page in the Team Server and click the Remove user button.
I get a message saying that my invitation to a model package or
project has been revoked, or that it has been removed, or that I
am not registered anymore. What to do?
You see a message saying that your invitation to a model package or project
you have been contributing to, has been revoked or has been removed. Or
you see a message that you are not registered anymore. Example:
138
Team Platform Guide
Choose one of the following options to proceed.
l
Click Close if you want to close the model package or project. The model
package or project will then be removed from your list of Team Server
packages and projects, and you can no longer work on the model package
or project.
l
Click Save as if want to keep the model package or project for your own
use. After clicking the button, you can save the model package or project
locally in a different location. The model package or project will also be
removed from your list of Team Server packages and projects.
l
Click Cancel if you want to do nothing (yet). When trying to open the
model package or project again, or change it if it is already open, the
message will appear again until you have made a choice about what to do
with it.
Note: If you close the model package or project, or save it locally after
your invitation has been revoked, and the model package or project
remains in your list, it means that you also been invited by other means to
this model package or project. In that case, you can still work on the
shared model package or project.
Activity Console
The changes just committed by other users are not visible the
Activity Console
The Activity Console synchronizes the activities every five minutes. The
activities will therefore appear in the Activity Console within a few minutes.
139
Team Platform Guide
To see the activities immediately, synchronize manually. To do this, right
click the Activity Console icon in the system tray and click Sync all, or click
on Synchronize all at the top of the open console window.
The Activity Console cannot synchronize a storage place
If the Activity Console cannot synchronize a certain storage place, it will post
an activity with the reason. The reason for this could be a network failure,
authentication failure, license failure, or another, unknown reason. An
authentication failure could be caused by a failing automatic login. Check the
next item for more information, or consult your application administrator for
this.
As soon as synchronization succeeds again, the Activity Console will post an
activity telling so.
The Activity Console shows the message "Could not log in to
"TeamServerName"
Your password for authentication with the Team Server is not stored by
Enterprise Studio or the Activity Console. Instead, the Activity Console
stores cookies received by the Team Server. These cookies stay valid for
two weeks. Every time the Activity Console authenticates with these cookies,
it will receive new cookies, which are valid for another two weeks again.
However it is possible that the cookies expire. If that is the case, you get the
message in the Activity Console saying that it could not log in to the Team
Server.
To solve this problem, follow these steps:
1. In Enterprise Studio, on the File tab, click Options, and then click the
Storage Places tab.
2. In the available storage places, select the Team Server, and click
Change.
140
Team Platform Guide
3. Re-enter your username and password for the Team Server and click
Finish.
Team Server
Adding new users or inviting users is not possible
Adding new users and inviting users in the Team Server is bound to the
number of users registered in your software license. If the number of users
of your software license is exceeded when adding new users or inviting
users, an error message appears on your screen. To solve the problem you
need to reduce the number of active users. Depending on the software
license you have, you can do the following.
Advanced license: Remove the users that are not using the Team Platform
functionality anymore from the Team Server.
Enterprise license: Uninvite one or more users to all model packages and
projects they are invited to by revoking their invitation.
If you are not sure which license you have, you can check it via File > About
> License management in Enterprise Studio.
If you are not able to reduce the number of users, it is also possible to
expand your software license with additional users. You can contact
BiZZdesign Sales for this.
141
Team Platform Guide
Index
suspend
52
contributions
A
Activity Console
busy synchronizing
54
57
applying to master model
package
44
including in model package or
project
42
creating
disturbance in the
synchronization
58
function
54
manually synchronizing
messages and statuses
58
copy of model package from
personal storage or
Team Server
26
57
projects
23
non-processed contributions
58
Team Server user groups
79
non-synchronized activity
58
registration of activities
55
unseen activities
57
viewing
56
adding
storage places
D
data location
team data
E
127
Team Server users
76
users to user group
82
e-mail address for invitation,
invalid
audit log Team Server
models offline
44
33
editing
applying
contributions to master
model package
126
46
F
63
features, Team Platform
C
6
filtering
Team Server list items
changes to model package or
project
non-processed
undoing
Team Platform
58
project scope
37
Activity Console
111
51
36
7
configuration file, Team Server63, 66
contributing
stop
74
home page Team Server
60
individual rights Team Server
74
installation Team Server
64
invalid e-mail address for
33
I
components
Team Platform
group rights Team Server
H
committing
changes in model package
54
G
114
collaboration
terminating
134
functions
changing
claims, removing
123
frequently asked questions
51
142
Team Platform Guide
invitation
invitations,
revoking
storage
94, 98, 101, 103
inviting people
opening from Team Server
22
overview page
61
read-only
39
invalid e-mail address or
unknown name
33
removing user's claims
limitations
32
restoring limitations
40
40
removing from Team Server 120
114
to model packages
27, 87
restoring to previous state
to projects
29, 90
revoking invitation
L
limitations
94, 101
revoking invitations
94
saving in personal storage
20
saving on Team Server
21
in editing shared model
elements
stop contributing
51
35
suspend contributing
52
in restoring model packages
40
terminating collaboration
51
on inviting people
32
tracking progress
10
list pages Team Server, filtering
and sorting
123
undoing changes
37
updating with contributions
42
location
viewing previous state
38
viewing timeline
17
working together
12
changing team data location 126
logging in to Team Server
69
models
M
manually synchronizing the
Activity Console
editing offline
modifying
58
master model package
applying contributions
44
members user group
adding
82
managing
80
removing
84
57
model elements
editing possibilities and
limitations
107
multiple Team Servers, using
64
name for invitation, unknown
33
N
offline
editing models
46
opening
35
model packages
committing changes
36
creating copy
26
inviting people
basic information in Team
Server
O
messages
Activity Console
46
27, 87
modifying information
107
opening from personal
21
model package from personal
storage
21
model package from Team
Server
22
project from Team Server
25
options
storage places
131
143
Team Platform Guide
P
participants
viewing
50
21
saving model package
20
possibilities
in editing shared model
elements
38
136
changing scope
44
29, 90
modifying information
107
opening from Team Server
25
removing
121
removing user's claims
114
restoring to previous state
revoking invitation
40
98, 103
revoking invitations
94
stop contributing
51
suspend contributing
52
terminating collaboration
51
undoing changes
37
updating with contributions
42
updating with contributions
master model package
44
viewing participants
50
viewing previous state
38
118
users from Team Server
116
84
limitations
40
model packages
40
projects
40
94
to model package
94, 101
to project
98, 103
individual versus group
23
inviting people
user groups from Team
Server
roles and rights for Team Server
111
creating
120
revoking invitations
projects
applying contributions to
master model package
121
shared model packages
restoring
problem solving
Team Platform
projects
users from user group
35
previous state model package or
project, viewing
71
removing
personal storage
opening model package
39
63-64
remember password for Team
Server
108
26
14
registering with Team Server
29, 90
copying model packages
working together
read-only model package
inviting to model packages 27, 87
permissions Team Server,
changing
17
R
people
inviting to projects
viewing timeline
72
74
S
saving
model package on Team
Server
21
model packages in personal
storage
20
scope of project, changing
settings menu Team Server
111
63
shared model packages
removing
120
removing user's claims
114
revoking invitation
94, 101
revoking invitations
94
viewing participants
50
sorting
Team Server list items
123
statuses, Activity Console
57
144
Team Platform Guide
stop contributing to model
package or project
registering
51
63-64
remember password
71
storage places
127
removing model packages
120
adding
127
removing projects
121
options
131
removing user groups
118
removing users
116
suspend contributing to model
package or project
52
saving model package
21
synchronization activities
57
settings menu
63
58
sorting list items
disturbance
T
team data
123
unregistered users
31
user group overview
62
user home page
60
changing storage location
126
user overview
62
location not accessible
136
user roles and rights
72
using multiple
64
Team Platform
6
Activity Console
54
components
7
features
6
frequently asked questions
134
problem solving
136
registering with Team Server
storage places
working together
Team Server
adding users
64
127
7
60
76
changing project scope
111
changing user (group)
permissions
108
configuration file
66
copying model packages
26
creating user groups
79
filtering list items
123
forgot password
72
installation
64
inviting people
logging in
87, 90
69
terminating collaboration
51
tracking progress of model
package
10
U
undoing
changes to model package or
project
uninviting
94
user groups
101, 103
users
94, 98
unknown name for invitation
33
unregistered users
31
updating
model package with
contributions
42
project with contributions
42
project with contributions
master model package
44
user claims, removing
114
user groups
adding users
82
managing user group
members
80
changing permissions
model packages overview
61
creating in Team Server
modifying basic information
107
37
inviting
108
79
27, 29, 87, 90
opening model package
22
managing members
opening project
25
modifying information
80
107
145
Team Platform Guide
overview page
62
removing from Team Server 118
removing users
84
uninviting
101, 103
user import Team Server
63
user overview Team Server
62
user roles and rights Team
Server
72
individual versus group
74
users
adding to Team Server
76
adding to user group
82
changing permissions
108
invalid e-mail address
32
inviting
27, 29, 87, 90
modifying information
107
overview page
62
removing from Team Server 116
removing from user group
uninviting
84
94, 98
unregistered
31
V
viewing
Activity Console
56
model package or project
timeline
17
participants of project
50
participants of shared model
package
50
previous state of model
package or project
38
timeline
17
W
working together
7
creating projects
23
on model package
12
on project
14
possibilities and limitations
35
146
Team Platform Guide
PDF guides
The following PDF guides are available for download from the BiZZdesign
community:
Advanced Modeling Guide
Amber Getting Started Guide
ArchiMate Getting Started Guide
Analysis Guide
BPMN Getting Started Guide
BiZZdesign Connect Guide
DMN Getting Started Guide
Enterprise Analytics Guide
Enterprise Portfolio Management Guide
Enterprise Studio Options Guide
Enterprise Studio User Guide
ERD Getting Started Guide
ERSM Getting Started Guide
License Management Guide
Metamodeler Guide
Reporting and Printing Guide
Scripting Reference
TDM Getting Started Guide
Team Platform Guide
Time Modeling and Analysis Guide
147
Contact BiZZdesign
Service desk
For questions and information regarding
service and support.
Phone: +31 - 53 - 4 878 171
E-mail: servicedesk@bizzdesign.com
Academy
For questions and information regarding
training and education.
Phone: +31 - 33 - 7 600 284
E-mail: academy@bizzdesign.com
Inside sales
For questions and information regarding
commercial conditions, new modules, and
prices for use.
E-mail: sales@bizzdesign.com
Head office
For general questions and information.
Phone: +31 - 53 - 4 878 151
E-mail: info@bizzdesign.com
Website
http://www.bizzdesign.com
Customer portal
http://community.bizzdesign.com
Open as PDF
Similar pages