System Roles

The System Roles page is designed to empower administrators to efficiently handle system roles within ADOIT. You can create, edit, and delete system roles, and assign individual users and entire user groups to system roles. Additionally, you can import and export system roles.

What are System Roles for?

System roles serve two functions in ADOIT. You can use them to:

1. Grant access to ADOIT features. For example, you can specify whether users can create matrix charts or which application scenarios are available to them in ADOIT.

2. Assign user rights for the available metamodel elements (= metamodel rights). For example, you can specify whether users can create models of a certain type or only open them read-only.

About the System Roles Page Layout

The System Roles page consists of two panes, the catalogue and the workspace:

• Catalogue

  The catalogue is the left pane of the System Roles page. Select a system role here to show its details and assigned members in the workspace.

• Workspace

  The workspace is the right pane of the System Roles page. You can edit details of system roles here, such as the name and description. Additionally, you can add or remove members from system roles.

Default System Roles

The default system roles are always available when you are using the ArchiMate Application Library.

Here are the default system roles:

Application Scenarios

• Reader

  Members of the system role Reader have access to the "Read & Explore" scenario.

• User

  Members of the system role User have access to ALL scenarios: "Design & Document", "Workspaces", "Control & Release" and "Read & Explore".

note

The "Control & Release" scenario is only avalaible if the EA workflow is enabled.

The "Read & Explore" scenario is read-only. Users have no write access to repository content (including all models and objects and their relations).

For more information on the application scenarios, see ADOIT Scenarios.

Organisation Portal

• Organisation Portal

  Typically only one technical user account will have this system role. This user account is used when users access the Organisation Portal via the link on the ADOIT login page.

note

The Organisation Portal is read-only. Users have no write access to repository content (including all models and objects and their relations).

Metamodel Profile Configurator

• MM and Integration Administrator

  Members of the system role MM and Integration Administrator can choose between various predefined metamodel profiles in ADOIT. Metamodel profiles reduce the number of available metamodel elements and are applied to all users on login.

EA Workflow

• Contributor

  Contributors submit objects to review. They can also create new versions of already released objects in order to adapt them.

• Architect

  Architects can execute all transitions. Unlike Contributors, they can also release or reject objects.

• Administrator

  Administrators can also execute all transitions, but they do not receive automatic notifications.

note

EA workflow roles are only available if the EA workflow is enabled.

Create System Role

To create a new system role

1. Go to the System Roles page and click Create system role.

2. In the Unique name box, type a name for the system role, and then click Create. This language-independent name uniquely identifies the system role.

3. In the Details form in the middle, fill out the role details:

   • Select Default role if this system role should apply to all users on login.

   • Enter a name for each language ADOIT supports. These names will be visible on the user interface.

   • Enter a description.

4. Click Add members and add user groups or individual users from the user catalogue. Then, click Add.

5. Click Save.

The new system role is added to the System roles catalogue.

Edit System Role

To edit a system role:

1. Go to the System Roles page.

2. In the System roles catalogue on the left side, select the system role you want to edit. The details of the system role and the assigned members will be shown in the workspace.

3. Modify the role data as required.

4. Click Save.

Modifying role data is restricted to user-created system roles. The predefined default system roles provided with ADOIT are read-only and cannot be changed; you can only assign or remove members.

note

You can find more information about the various role data in the section Create System Role.

Manage System Role Members

To manage system roles members:

1. Go to the System Roles page.

2. In the System roles catalogue on the left side, select the system role whose members you want to manage. The details of the system role and the assigned members will be shown in the workspace.

3. Now do one of the following:

   • To assign members to a system role, click Add members and add user groups or individual users from the user catalogue.

   • To remove an individual member from a system role, click Remove member.

   • To remove all members from a system role at once, click Remove all.

4. Click Save.

Assign Permissions to System Roles

Various permissions can be assigned to system roles. When you assign members to a system role, they are granted all of the permissions of that system role, permitting or restricting them access to specific features and actions within ADOIT.

• Default System Roles

  ADOIT provides default system roles with pre-defined permissions that cannot be modified. These system roles grant users access to different application scenarios and the EA workflow in ADOIT.

• Modules

  You can assign modules (plug-ins) to system roles to grant access to specific features in ADOIT. For example, this allows you to manage permissions for creating matrix charts or performing Excel imports. To assign these modules, head over to the Settings page.

• Manage Metamodel Rights

  Metamodel rights allow you to control access to metamodel elements, such as model types and attributes, in ADOIT. To assign metamodel rights to a system role, head over to the Rights page.

Delete System Role

To delete a system role:

• Go to the System Roles page.

• In the System roles catalogue on the left side, find the system role you want to delete.

• Hover over the system role, click More, and then click Delete.

The predefined default system roles created by ADOIT are read-only and cannot be deleted.

Import System Roles

To import system roles:

1. Go to System Roles > More options, and then click Import system roles.

2. Click Browse and select the file with the system roles you want to import. You can also drag a file from your computer to the Drag and drop files here to upload area. Then, click Next.

3. Optional: If the import file is encrypted, enter the password and click OK.

4. Select the system roles you wish to import. To quickly select all system roles, click Select all. Then, click Next.

5. Optional: Select Including metamodel rights to import all metamodel rights together with the system roles.

6. From the Conflict strategy, if a system role in the file does already exist in the repository list, select the behaviour if a system role already exists:

   • Insert (new system role data from the import file is added, data existing in a different form is updated): Inserts the system role, combining information from both sources (default selection).

   • Overwrite (the system role from the import file replaces the one from the database): Overwrites the system role in the database.

   • Ignore (the system role in the database remains untouched): Ignores the data in the import file, preserving the original system role.

7. Click Import. The system roles are imported.

When the import is complete, a success message appears. Close the message to complete the process.

Export System Roles

To export system roles:

1. Go to System Roles > More options, and then click Export system roles.

2. Select the system roles you wish to export. To quickly select all system roles, click Select all. Then, click Next.

3. Optional: Select Export with metamodel rights to export all metamodel rights together with the system roles.

4. Optional: Select Protect export file with password to encrypt the export file.

5. Click Export. The system roles are exported.

When the export is complete, a success message appears. Close the message to complete the process.

Copy Role Info to Clipboard

To copy system role information to the clipboard:

• Go to the System Roles page.

• In the System roles catalogue on the left side, find the system role whose info you want to copy.

• Hover over the system role, click More, and then click Copy role info to clipboard.

A JSON representation of the system role, including details such as the mfbID required for creating a user mapping for specific authentication mechanisms, will be copied to your clipboard.