Roles

In the “Roles” area you can create new user roles as well as edit, duplicate or delete existing roles. Additionally, you can add user rights and users to the selected user role.

The tables in the various cards show the related users as well as the assigned rights. Using the column header tools you can filter table entries or adjust their sequence. In order to filter table entries you can also use the free-text search.

Roles

Create new roles

In order to create a new role, proceed as follows:

2. Enter a user role name in the “Identifier” field.

3. Enter short descriptions for the different locales.
   1. Click on the   button in the “Description” field. Then you will be directed to another slider that features individual input fields for the different locales.
   2. Enter the localized short descriptions in the respective input fields.
   3. Click on the  BACK button to get back to the previous slider.

4. Possibly select a client from the “Client” menu*.
5. In the input field “Order”, possibly enter an integer value. The integer value determines the position in which a toolbox role is situated in the sequence of toolbox roles in the toolbox section of the left sidebar. This setting is only relevant for toolbox roles.
6. In the input field “Configuration”, possibly enter the identifier of the icon by which a toolbox role is represented in the toolbox section of the left sidebar. The available icons are from the set of MaterialDesignIcons. This is only relevant for toolbox roles.
7. First introduced in version 5.5.1: From the master role menu, select the corresponding option to determine whether the role is a subordinate master role:
   • YES: The role is a master role to which subordinate roles can be assigned in order to group them**.
   • NO (default): The role can be assigned to a master role as a subordinate role.

8. Under “Role type”, select a role type. You can choose between the following options.
   • Standard: This is the standard role type in which you can group given user rights.
   • Standard (with worklists visibly): This role type extends the standard role type by the access to worklists which are shared with all the users***. In comparison, the standard role type only has access to the worklists created by the respective user.
   • Toolbox role: A toolbox role groups the rights to use particular apps. These apps will then appear in the toolbox section of the left sidebar for a quick access to them.
   • Workbox role: A workbox role can be used to grant the permission to use a related workbox (workflow task).

• In order to finish the process, click on the SAVE button. A success message is shown. The new role is now created and it appears in the list of roles.
• In order to cancel the process, click on the CANCEL button.

• *If a client is assigned to a role in which login rights are grouped, users to whom this role is assigned can only access this client.
• When creating a workbox role, an event type of the same name is established. This event type serves as a workbox (workflow task). Via a workbox role it can be specified which users can assign products to a workbox using the “Send to” action. Though, it is also possible to create an event type directly in order to specify a workbox. Such a workbox is independent from a workbox role. Users possessing the right “ipim-portal.actions.send-to” can assign products to it.
• ***This only applies to users that have the same role assigned to them.

**A master role can be used to group roles. By assigning a master role to a user, all the roles that are grouped in a master role are assigned to a user at once. And when removing a master role, all the grouped roles are revoked from a user at once.

Edit roles

In order to edit a role, proceed as follows:

1. Select a role as described above.
2. Click on the MANAGE button to call up the corresponding dialog box.
3. Make the desired changes.

• In order to save your changes, click on the SAVE button. A success message is shown.
• In order to cancel the process, click on the CANCEL button.

Delete roles

In order to delete a role, proceed as follows:

1. Select the role as described above.
2. Click on the button. The  CLICK TO CONFIRM button is shown.
3. Click on the  CLICK TO CONFIRM button to confirm the deletion. A success message is shown and the role vanishes from the list of roles.

Users

The table in the “Users” card lists all the users that are related to the selected role. Here you can relate the selected role to users and you can resolve existing relations to users.

Add users

In order to relate the selected role to a particular user, proceed as follows:

1. Click on the ADD button in the footer of the “Related users” table to call up the corresponding dialog box.

2. Possibly enter a search term in the search field to filter the list of users by a search term.
3. Select a user. You can also select multiple users:
   • In order to select a user, transfer it from the left column to the right column . To do so, click on the user .
   • In order to deselect a user, transfer it from the right column back to the left column. To do this, click on the user.

Using the button and the button you can transfer all the from one column to the other column at once.

Remove users

In order to resolve the relation between a user and the selected role, you need to remove it from the list of related users. To do so, proceed as follows:

1. In the “Related users” table, tick the user from which you want to revoke the relation to the selected role. You can also tick multiple entries.
2. Click on the REMOVE button. The CLICK TO CONFIRM button is shown.
3. Click on the CLICK TO CONFIRM button to confirm the removal of the respective user. A success message is shown and the user will vanish from the list of related users.

Instead of using the REMOVE button, you can also use the "Delete" icon () icon in the respective table row to delete resp. remove individual entries.

Edit users

In order to edit a particular user, you have to switch to the “Users” area. To do so, proceed as follows:

• In the “Related users” table, click on the user name of the respective user. Then you will be directed to the “Users” area where this particular user is called up and can be edited.

Rights

The table in the “Rights” card lists all the rights which are assigned to the selected role. Here you can assign rights to the selected role or you can revoke rights from it. And you can copy the rights of the selected role and assign them to other roles.

Add rights

In order to add rights to the selected role, proceed as follows:

1. Click on the ADD button in the footer of the “Rights” table to call up the corresponding dialog box.

2. Possibly enter a search term in the search field to filter the list of rights by a search term.
3. Select a right. You can also select multiple rights:
   • In order to select a right, transfer it from the left column to the right column . To do so, click on the right .
   • In order to deselect a right, transfer it from the right column back to the left column. To do this, click on the right.

Using the button and the button you can transfer all the from one column to the other column at once.

Remove rights

In order to revoke a right from the selected role, you need to remove it from the list of assignd rights. To do so, proceed as follows:

1. In table of the “Rights” table, tick the right which you want to revoke from the selected role. You can also tick multiple entries.
2. In the footer of the “Rights” table, click on the REMOVE button. The CLICK TO CONFIRM button is shown.
3. Click on the A success message is shown and the revoked right will vanish from the table. CLICK TO CONFIRM button to confirm the revoking of the right. 

Instead of using the REMOVE button, you can also use the "Delete" icon () icon in the respective table row to delete resp. remove individual entries.

Copy rights

Using the “Copy rights” function you can copy rights which are assigned to the selected role and assign them to one or more target roles. To do so, proceed as follows:

1. Click on the COPY RIGHTS button in the footer of the “Rights” table, to call up the corresponding dialog box.
2. Select the target user role(s) by transfering it/them from the “Available roles” column to the “Selected roles” column:
   • In order to transfer a single user role from the “Available roles” column to the “Selected roles” column, click on the respective role.
   • In order to transfer all the user roles from the “Available roles” column to the “Selected roles” column, click on the  button.

• In order to finish the process, click on the APPLY button. A success message is shown. The rights of the selected role are now assigned to the target role(s).
• In order to cancel the process, click on the CANCEL button.

The copying of rights will be applied to all the listed rights. Selecting particular rights by ticking them does not work.

Edit rights

In order to edit a particular right, you have to switch to the “Rights” area. To do so, proceed as follows:

• In the “Rights” table, click on the key of the respective right. Then you will be directed to the “Rights” area where this particular right is called up and can be edited.

FAQ

Which role types are available?

When creating a role, you can choose between the role types Standard, Standard (with worklist visibility), Toolbox role and Workbox role. Standard is the standard role type in which you can group given user rights. Standard (with worklist visibility) extends the standard role type by the access to worklists which are shared with all the users. A toolbox role groups the rights to use particular apps so that these apps appear in the toolbox section of the left sidebar for a quick access to them. A workbox role can be used to grant the permission to use a related workbox.

What is a master role?

First introduced in version 5.5.1, the master role menu lets you determine whether a role is a subordinate master role. A master role can be used to group roles: by assigning a master role to a user, all the roles that are grouped in the master role are assigned to the user at once. And when removing the master role, all the grouped roles are revoked from the user at once.

Why can users with a particular role only log in to a particular client?

If a client is assigned to a role in which login rights are grouped, users to whom this role is assigned can only access this client.

What happens when I create a workbox role?

When creating a workbox role, an event type of the same name is established. This event type serves as a workbox (workflow task). Via a workbox role it can be specified which users can assign products to a workbox using the “Send to” action. Though, it is also possible to create an event type directly in order to specify a workbox independent from a workbox role. Users possessing the right “ipim-portal.actions.send-to” can assign products to it.

Why can’t I select particular rights when copying rights?

The copying of rights will be applied to all the listed rights. Selecting particular rights by ticking them does not work.