# project roles

When a user is assigned to a project, they must also be assigned a project role.

## Create a new project role

Navigate to *Engineering -> Roles*

{% @supademo/embed demoId="FbyUVm0B-hzWFp2LFv5o6" url="<https://app.supademo.com/demo/FbyUVm0B-hzWFp2LFv5o6>" fullWidth="true" %}

## Configure project role

The following settings can be made via the project role options

<div data-full-width="true"><figure><img src="https://content.gitbook.com/content/Nyvwhz1kEMXcHf4HLuZ8/blobs/nC0enETmMDuAKLOOMAbH/Docs_Projektrolle%20U%CC%88berblickv2.png" alt=""><figcaption><p>Project role options</p></figcaption></figure></div>

{% hint style="info" %}
If you disable a universal switch: The corresponding menu item will be hidden for holders of this role.&#x20;
{% endhint %}

<table data-full-width="true"><thead><tr><th width="103.33333333333331">Element</th><th>Title</th><th>Details</th></tr></thead><tbody><tr><td><strong>[A]</strong></td><td>Name</td><td>Project role name</td></tr><tr><td><strong>[B]</strong></td><td>Location</td><td>Determines at which location the <a href="../map-and-floor/map">↗ map</a> is opened (<a href="../../map-and-floor/map#standard-kartenausschnitt-festlegen">↗ Default map section</a>)</td></tr><tr><td><strong>[C]</strong></td><td>Expert Mode</td><td><a href="#c-der-expert-mode">↗ Expert </a>enable/disable Mode</td></tr><tr><td><strong>[D]</strong></td><td>Used in projects</td><td>Shows in which projects this role is used</td></tr><tr><td><strong>[E]</strong></td><td>Tags</td><td>Allow the role access to specific tags only<a href="#e-asset-tags"> </a><a href="#e-asset-tags">↗ Asset Tags</a></td></tr><tr><td><strong>[F]</strong></td><td>Full access to assets without tags</td><td>If this switch is enabled, users with this role have full access to assets that are not tagged. <a href="#f-voller-zugriff-auf-assets-ohne-tags">↗ Full access to assets without tags</a></td></tr><tr><td><strong>[G]</strong></td><td>Tags</td><td>A list of all tags to which holders of this role have access</td></tr><tr><td><strong>[H]</strong></td><td><strong>Universal switch «Dashboards»</strong></td><td><strong>Enable/disable all write permissions and read permission for the «Dashboards» function</strong></td></tr><tr><td><strong>[H1]</strong></td><td>Dashboards</td><td>Enable/disable write and read access for the «Dashboards» function</td></tr><tr><td><strong>[H2]</strong></td><td>Widgets</td><td>Enable/disable write and read access for the «Widgets» function</td></tr><tr><td><strong>[I]</strong></td><td><strong>Universal switch «Alarm»</strong></td><td><strong>Enable/disable all write permissions and read permission for the «Alarms» function</strong></td></tr><tr><td><strong>[I1]</strong></td><td>Alarms</td><td>Enable/disable write and read access for the «Alarms» function</td></tr><tr><td><strong>[I2]</strong></td><td>Alarm history</td><td>Enable/disable write and read access for the «Alarm History» function</td></tr><tr><td><strong>[J]</strong></td><td><strong>Universal switch «Tickets»</strong></td><td><strong>Enable/disable all write permissions and read permission for the «Tickets» function</strong></td></tr><tr><td><strong>[J1]</strong></td><td>Augmented Reality</td><td>Enable/disable write and read access for the «Augmented Reality» function</td></tr><tr><td><strong>[K]</strong></td><td><strong>Universal switch «Rules»</strong></td><td><strong>Enable/disable all write permissions and read permission for the «Rules» function</strong></td></tr><tr><td><strong>[K1]</strong></td><td>Asset Editor</td><td>Grant write permission/read permission for the «Asset Editor»</td></tr><tr><td><strong>[L]</strong></td><td><strong>Universal switch «Assets»</strong></td><td><strong>Enable/disable all write permissions and read permission for the «Assets» function</strong></td></tr><tr><td><strong>[L1]</strong></td><td>Assets</td><td>Enable/disable write and read access for the «Assets» function</td></tr><tr><td><strong>[M]</strong></td><td><strong>Universal switch «Analytics and Reports»</strong></td><td><strong>Enable/disable all write permissions and read permission for the «Analytics and Reports» function</strong></td></tr><tr><td><strong>[M1]</strong></td><td>Analytics</td><td>Enable/disable write and read access for the «Analytics» function</td></tr><tr><td><strong>[M2]</strong></td><td>Reports</td><td>Enable/disable write and read access for the «Reports» function</td></tr><tr><td><strong>[N]</strong></td><td><strong>Universal switch «Smart View»</strong></td><td><strong>Enable/disable all write permissions and read permission for the «Smart View» function</strong></td></tr><tr><td><strong>[N1]</strong></td><td>Views</td><td>Enable/disable write and read access for the «Smart Views» function</td></tr><tr><td><strong>[O]</strong></td><td><strong>Universal switch «Map and Floor»</strong></td><td><strong>Enable/disable all write permissions and read permission for the «Map and Floor» function</strong></td></tr><tr><td><strong>[O1]</strong></td><td>Map and Floor</td><td>Enable/disable write and read access for the «Map and Floor» function</td></tr><tr><td><strong>[P]</strong></td><td><strong>Universal switch «BIM»</strong></td><td><strong>Enable/disable all write permissions and read permission for the «BIM» function</strong></td></tr><tr><td><strong>[P1]</strong></td><td>BIM</td><td>Enable/disable write and read access for the «BIM» function</td></tr><tr><td><strong>[Q]</strong></td><td><strong>Universal switch «Digital Twin»</strong></td><td><strong>Enable/disable all write permissions and read permission for the «Digital Twin» function</strong></td></tr><tr><td><strong>[Q1]</strong></td><td>Digital Twin</td><td>Enable/disable write and read access for «Digital Twin»</td></tr><tr><td><strong>[R]</strong></td><td><strong>Universal switch «Connection»</strong></td><td><strong>Enable/disable all write permissions and read permission for the "Connection" function</strong></td></tr><tr><td><strong>[R1]</strong></td><td>MQTT</td><td>Enable/disable write and read access for "MQTT"</td></tr><tr><td><strong>[R2]</strong></td><td>Webhook</td><td>Enable/disable write and read access for "Webhook"</td></tr><tr><td><strong>[R3]</strong></td><td>RESTful</td><td>Enable/disable write and read access for "RESTful"</td></tr><tr><td><strong>[R4]</strong></td><td>Kafka</td><td>Enable/disable write and read access for "Kafka"</td></tr><tr><td><strong>[R5]</strong></td><td>OPC UA</td><td>Enable/disable write and read access for "OPC UA"</td></tr><tr><td><strong>[R6]</strong></td><td>Legacy</td><td>Enable/disable write and read access for "Legacy"</td></tr><tr><td><strong>[R7]</strong></td><td>PKI</td><td>Enable/disable write and read access for "PKI"</td></tr><tr><td><strong>[R8]</strong></td><td>Node</td><td>Enable/disable write and read access for "Node"</td></tr><tr><td><strong>[S]</strong></td><td><strong>Universal switch «Engineering»</strong></td><td><strong>Enable/disable all write permissions and read permission for the "Settings" function</strong></td></tr><tr><td><strong>[S1]</strong></td><td>Users in other lists</td><td>If this function is enabled, users can under certain conditions see the names of other users, even if they are not enabled for this in the corresponding system role. ↗ More information</td></tr><tr><td><strong>[S2]</strong></td><td>escalation</td><td>Enable/disable write and read access for the "Escalation" function</td></tr><tr><td><strong>[S3]</strong></td><td>Script Engine</td><td>Enable/disable write and read access for the "Script Engine" function</td></tr><tr><td><strong>[S4]</strong></td><td>Asset Editor</td><td>Enable/disable write and read access for the "Asset Editor" function</td></tr><tr><td><strong>[T]</strong></td><td><strong>Universal switch «AR»</strong></td><td><strong>Enable/disable all write permissions and read permission for the "Smart Assist" function</strong></td></tr><tr><td><strong>[T1]</strong></td><td>AR</td><td>Enable/disable write permissions and read permission for the "Smart Assist" function</td></tr><tr><td><strong>[U]</strong></td><td>Save</td><td>You must save your selection</td></tr></tbody></table>

{% hint style="warning" %}
Don't forget to **Save** **\[U]**
{% endhint %}

{% hint style="info" %}
It is not possible to have write permissions but no read permissions.
{% endhint %}

{% hint style="info" %}
More information about the different permissions can be found [-> here](https://docs.buildings.ability.abb/collection/english-v14/documentation/roles/..#leseberechtigung-und-schreibberechtigung)
{% endhint %}

### \[C] The Expert Mode

If Expert Mode is enabled, [↗ Entities](https://docs.buildings.ability.abb/collection/english-v14/foreword/glossary#entitaeten) (e.g. tickets, digital twins, etc.) that are assigned to assets to which the role actually has no access can be accessed.

#### Example 1

* An asset is tagged with «A», «B» and «C»
* The user has read permission for tag A
* The user has no read permission for tag B and tag C
* The "Expert Mode" option is irrelevant in this example

▷ The user sees the asset in the asset overview&#x20;

▷ The user sees tickets related to this asset&#x20;

▷ In a ticket, the user sees the name of the asset. By clicking on the asset name, the user can open the asset details.

<figure><img src="https://content.gitbook.com/content/Nyvwhz1kEMXcHf4HLuZ8/blobs/4vMiXitcD7FZWJhHEBDW/Docs_Roles_Pg3%20-%201%20Expert%20Mode.png" alt=""><figcaption></figcaption></figure>

#### Example 2

* An asset is tagged with «A», «B» and «C»
* The user has no read permission for the 3 tags
* The "Expert Mode" option is **not** enabled

▷ The user does not see the asset in the asset overview&#x20;

▷ The user does not see any tickets related to this asset

#### Example 3

* An asset is tagged with «A», «B» and «C»
* The user has no read permission for any of the tags
* The "Expert Mode" option is enabled

▷ The user does not see the asset in the asset overview&#x20;

▷ The user sees tickets related to this asset&#x20;

▷ In these tickets, the user does not see the name of the asset

<figure><img src="https://content.gitbook.com/content/Nyvwhz1kEMXcHf4HLuZ8/blobs/Vgrz9czMXNQjnQ31ElzH/Docs_Roles_Pg3%20-%202%20Expert%20Mode.png" alt=""><figcaption></figcaption></figure>

### \[E] Asset Tags

If you add one or more tags here, this role can only see assets that are tagged with these tags. All other assets will be hidden.

Example: You add the tag "ventilation systems". This role will be able to access only assets that are tagged with "ventilation systems".

{% hint style="warning" %}
If multiple tags are assigned to an asset: The role has access to the asset even if it is enabled for only one tag of the asset.
{% endhint %}

### \[F] Full access to assets without tags

If this option is enabled: Users have full access to all assets that have no (0) tags.

### **\[S1] - Users in other lists**&#x20;

Whether a user can see the usernames of other users is actually defined in the system role. In certain cases, it may be desirable for users to be able to view the names of other users even though they do not have the rights for this in the system role.

For this, the switch **\[S1]** can be enabled.

In the example below, a user can see the usernames after this option has been enabled.

<figure><img src="https://content.gitbook.com/content/Nyvwhz1kEMXcHf4HLuZ8/blobs/eEBBAOp6JDiHQRAz5o92/Docs%20Roles%20-%20Can%20be%20seen%20by%20other%20Roles.png" alt=""><figcaption></figcaption></figure>

## Assign a project role to a user

{% @supademo/embed demoId="oukZv4RR6w0t7GGGkoFUS" url="<https://app.supademo.com/demo/oukZv4RR6w0t7GGGkoFUS>" fullWidth="true" %}
