Skip to main content
Version: 1.0.49

Permissions

Introduction​

This manual is intended to guide the reader through the following operations:

  • Description of the user creation and permission-granting process
  • Creating and updating a new user
  • Granting a user permissions to features

These actions are performed through the SETTINGS / ADMINISTRATION area of the platform.

Administration / Users screen listing the platform's user accounts

Overview​

General workflow​

A user's permissions grant or revoke access to Orkestra's features.

These permissions can be granted at a highly aggregated level, or acted upon at the finest level of granularity — namely, at the Module level for Data Fabrik, and at the Tag level for Data Shop.

They can be summarized as follows:

Summary diagram of the user creation and permission-granting process

Managing a User​

Creating a User​

Creating a user is done in two steps:

  • Creation
    • Procedure for authentication using an SSO (single sign-on) protocol such as SAML2 or OIDC, or using the LDAP protocol — i.e., connected to the company's identity provider.
    • Procedure for so-called "internal" authentication, i.e., not connected to the company's identity provider.
  • Granting permissions

How Single Sign-On (SSO – SAML2 or OIDC) Works​

Allows users to log in to the Orkestra platform using their corporate account, without having to manage a password specific to the platform.

Single sign-on (SSO) relies on either the SAML2 protocol or the OIDC protocol, and integrates with the company's existing identity system (Active Directory, Azure AD, etc.).

General Principle​

When a user accesses the Orkestra platform:

  1. They are redirected to their company's identity provider (Identity Provider – IdP).
  2. The IdP authenticates the user according to internal security rules (password policy, etc.).
  3. The IdP returns a signed assertion to Orkestra, confirming the user's identity.
  4. Orkestra creates or updates the user's session according to the rights associated with their account.

The user is thus automatically logged in to Orkestra, without having to re-enter their credentials.

Technical Configuration​

Enabling SAML2 requires the following elements:

ElementDescription
Valid X.509 certificateUsed to sign and validate SAML exchanges between Orkestra and the IdP.
IdP metadataProvided by the identity service (e.g., an XML file containing the endpoints and public keys).
Entry point URL (Single Sign-On URL)Redirect address to the identity provider.
Audience / Entity IDOrkestra's unique identifier with the IdP.

Enabling OIDC requires the following elements:

ElementDescription
AuthorityBase URL of the identity provider.
Client ID / Client SecretOrkestra's unique identifier with the IdP.
Entry point URL (Single Sign-On URL)Redirect address to the identity provider.

These settings are configured in the appsettings.json files.

Note

When enabled, SSO mode replaces LDAP or internal authentication. It must be enabled by a system administrator with rights on the IIS server and certificates. See the installation manuals.

Creating a User with SSO Enabled​

When Orkestra is configured with SSO:

  • Creating a user does not require a password in the administration interface.
  • The Login field must match the unique identifier sent by the identity provider (often the professional email address).
Managing Rights and Roles​

SSO authentication does not change how Orkestra's internal permissions are managed:

  • The roles (« Visualisateur » (Viewer), « Créateur » (Creator), « Super-Admin » (Super Admin)) remain defined in Administration / Users.
  • Application rights are assigned in the same way as for an SSO, LDAP, or internal user.

Procedure for the LDAP and SSO Protocols​

This process applies to Orkestra platforms installed with authentication linked to the company's identity provider.

Actions:

  1. Go to Settings/Administration/User
  2. Click "+ Ajouter" (+ Add) on the horizontal menu
  3. Enter the required information in the user creation pop-up

User creation pop-up with the fields filled in and the Internal Authentication checkbox unchecked (LDAP/SSO case)

Note
  • Operation type: keep the default value "Standard" when creating a user
  • Status: select Active/Inactive
  • DO NOT check the "Authentification interne" (Internal Authentication) box, and leave the "Password" fields empty
  • Login: enter the NETWORK login (the same one used, for example, to open a Windows session)
  1. Then click Save

Access to the platform is then done by entering the network login and password.

Procedure for Internal Authentication​

This procedure applies to Orkestra platforms installed on a network, but where user authentication is self-contained, i.e., not connected to the company's internal account.

Actions:

  1. Go to Settings/Administration/User
  2. Click "+ Ajouter" (+ Add) on the horizontal menu
  3. Enter the required information in the user creation pop-up
Note
  • Operation type: keep the default value "Standard" when creating a user
  • Status: select Active/Inactive
  • Check the "Authentification interne" (Internal Authentication) box
  • Login: enter a login of your choice
  1. Then click Save. The new user then appears in the list of created users.

User creation pop-up with the Internal Authentication box checked and a password entered

New user appearing in the list of created users

Once logged in under their profile, the user can change their password via the Profile screen, Security tab.

User profile drop-down menu with access to Profile, About, Register, and Log Out

Profile screen, Security tab, used to change the password

Assigning Roles​

Now that the user has been created, roles must be assigned to them. To do this:

  1. Click the black arrow, then "+ Ajouter" (+ Add)

Expanded user row showing the (empty) list of associated permissions

Information to fill in:

  • Status: select Active/Inactive
  • Application: select the application
Note

ETL, MSO, and ParallelU are not applicable

  • Choose a role (from most restrictive to most open):
    • « Visualisateur » (Viewer)
    • « Créateur » (Creator)
    • « Data Driven » (only relevant for Data Fabrik)*
    • « Super-Admin » (also called « Administrateur » (Administrator))
    • « Personnalisé » (Custom) (only relevant for REF Manager)
  • Assignment description: enter a comment of your choice

‘Add a role’ pop-up with the Status, Application, Roles, and Assignment Description fields

  1. Click Save

*This role is only needed to grant a user access to a restricted list of UTD/Modules. It must therefore not be combined with « Visualisateur » (Viewer), « Créateur » (Creator), or « Administrateur » (Administrator) (see the "DTF Permissions – Restricting UTD/Module Access" section).

The user has been updated:

Updated user with two roles assigned: Super-Admin on Administration and Data Driven on Data Fabrik

Managing a User​

Editing General Information​

You can edit a user's general information by selecting the row and clicking "Editer" (Edit), or by double-clicking it.

Selecting a user row and clicking the Edit button

‘Edit User’ pop-up showing the editable general information

Editing Permissions​

Similarly:

  1. Select the user's row
  2. Click the black arrow
  3. Select the permission to edit
  4. Click "Editer" (Edit) or double-click the row

Role changes will be visible to the affected user the next time they log in to the site. If they are already logged in, they must log out and log back in.

Detailed User View​

The detailed user view (also called the 360° view) is a side panel accessible from the users grid.

Detailed view (360° view) of a user showing their general information and permissions

It displays a summary of all the information available for a user:

  • Their detailed identity (last name, first name, status, email, login, language, time zone, and authentication type),
  • The list of assigned permissions (with the name of the relevant application, the permission value, and its status),
  • The rights matrix, a summary table of permissions that cross-references applications with assigned permissions.

It also allows quick actions such as:

  • Applying rights to the user from a template (see the chapter on user rights templates).

List of Application / Role Actions​

The table below lists the roles required to access the application's pages or to perform actions.

Only the « Visualisateur » (Viewer), « Créateur » (Creator), and « Administrateur » (Administrator) roles are referenced. These so-called "level 1" roles display all data without restriction. To grant more restrictive permissions (by module, by reference dataset, etc.), known as "level 2", more specific roles are required — refer to the corresponding sections of this manual. Level 2 permissions take priority over level 1 permissions.

If a page is not listed, it is freely accessible with no role restrictions. If an action is not listed, it can be performed by any role that has access to the page.

ApplicationScreenTab / LevelAction« Visualisateur » (Viewer) (read)« Créateur » (Creator) (read/write)« Administrateur » (Administrator) (read/write/config)
Data GouvernanceUTD ProductionXXX
ProduceXX
Production CalendarCalendarXXX
SchedulingXXX
Edit the scheduleXX
Duplicate the scheduleXX
Disable the scheduleXX
Governance ActionsActionsXXX
Edit / double-click a rowXX
ManagementXXX
Edit / double-click a rowXX
Quick permission managementXX
HistoryXXX
Instantiated LineageXXX
Governance ContextXXX
Access the tree viewXXX
Production QualityXXX
Download the compendiumXX
Data ShopMarketplaceXXX
Data ProductXXX
OrdersListXXX
OrderXXX
Download documentsXX
Edit the orderXX
Cancel the orderXX
Duplicate the orderXX
TrackingXXX
Move tilesXXX
UTD ManagerManagementXXX
AddXX
EditXX
DisableXX
UTD VersionXXX
AddXX
EditXX
Download blank environmentXX
Manage blank environmentXX
CatalogXX
DuplicateXX
UTD Version ModuleXXX
AddXX
EditXX
Magnifying glass (view)XXX
Manage associationsXX
Tag ManagerConfiguratorTagged ObjectsXXX
AddXX
EditXX
DeleteXX
Edit a ruleXX
ScopesXXX
AddXX
EditXX
DeleteXX
DomainsXXX
AddXX
EditXX
DeleteXX
SimulatorEvaluate the tagXXX
Rule CustomizationGovernance RulesXXX
Rule ValuesXXX
Linked Rule ValuesXXX
ConfigurationObject FormatsXXX
AddX
EditX
Object TypesXXX
AddX
EditX
Domain TypesXXX
Tag CodificationXXX
Event TypesXXX
AddX
EditX
Resource Types (inputs)XXX
AddX
EditX
ActionsXXX
REF ManagerReference DatasetsDisplayXXX
Force reloadXX
CloneXX
ValidateXX
AddXX
EditXX
DeleteXX
HistoryXXX
ConfigurationConfigurationXXX
AddX
EditX
DeleteX
Connections
AddX
EditX
DeleteX

Logs: applicable via the "Administration" application in a user's configuration.

ApplicationScreenTab / LevelAction« Visualisateur » (Viewer) (read)« Créateur » (Creator) (read/write)« Administrateur » (Administrator) (read/write/config)
LogsWorkersXX
Stopping a running job (Stop job)XX
Service started/Service stoppedXX
Orkestra LogsXX
UTDLogsXXX
TrackingXXX
DownloadXX
AdministrationUsersXXX
AddXX
EditXX
Add roleXX
Edit roleXX
Delete roleXX
User TemplatesXXX
AddXX
EditXX
Add roleXX
Edit roleXX
Delete roleXX
PermissionsDTF / AssociationsXXX
AddXX
EditXX
DTF / Duplicate RightsXXX
SaveXX
DTSXXX
AddXX
EditXX
UsersXXX
SaveXX
REF ManagerXXX
Modify rolesX

Configuration: the Tag Manager and REF Manager submenus are described above (pages 14 to 16 of the source manual). Application "Rôles" (Roles) are not configurable.

ApplicationScreenTab / LevelAction« Visualisateur » (Viewer) (read)« Créateur » (Creator) (read/write)« Administrateur » (Administrator) (read/write/config)
ConfigurationEmail TemplatesXXX
AddXX
EditXX
UTD ManagerCategoriesXXX
AddX
EditX
DeleteX
ServersXXX
AddX
EditX
DeleteX
Server SettingsXXX
AddX
EditX
WorkersXXX
AddX
EditX
DeleteX
FarmsXXX
AddX
EditX
DeleteX
Parallel U Client FarmsXXX
AddX
EditX
Software VendorsXXX
AddX
EditX
Software VersionsXXX
AddX
EditX
Structure Control by SoftwareXXX
AddX
EditX
StatusesXXX
AddX
EditX
Application RolesX

DTF Permissions – Restricting UTD/Module Access​

The « CREATEUR » (Creator) and « ADMINISTRATEUR » (Administrator) roles, when assigned to a user on the Data Fabrik application, grant access to the production function on ALL UTDs and ALL MODULES.

If it is necessary to restrict this access to certain UTDs and/or MODULEs, the « DATA DRIVEN » role must be assigned to the user instead. The « CREATEUR » (Creator) or « ADMINISTRATEUR » (Administrator) roles must then be DISABLED. It will then be possible to configure the user's access through the Permissions menu described below.

To do this, go to the SETTINGS/Administration/Permissions menu, available in the left-hand vertical menu.

Left-hand vertical Settings / Administration menu with the Permissions entry selected

Creating a DTF Permission​

Data Fabrik and Associations tabs on the Permissions page, with the + Add button

Information to enter:

  • User: select the relevant user
  • Profile (see the summary of rights granted per profile below):
    • « Contremaitre » (Foreman)
    • « Contrôleur » (Controller)
    • « Producteur » (Producer)
  • Category: filters the list of UTD/Modules in the next field among the existing categories
  • Module: selects the UTD and/or module(s) for which the user will be granted access
  • Comment: enter a free-text comment

‘Add permissions’ pop-up with the User, Profile, Category, Module, and Comment fields

Then:

  • Click Save

Summary of rights granted per profile:

FunctionActions/Profile« Producteur » (Producer)« Contrôleur » (Controller)« Contremaitre » (Foreman)
DATA PROCESSING UNIT (UTD)Produce1
DATA PROCESSING UNIT (UTD)Stop a request1
DATA PROCESSING UNIT (UTD)Download resources11
DATA PROCESSING UNIT (UTD)Download controls11
DATA PROCESSING UNIT (UTD)Download results111
DATA PROCESSING UNIT (UTD)Information111
DATA PROCESSING UNIT (UTD)View requests111
SCHEDULESDuplicate a schedule1
SCHEDULESEdit a schedule1
SCHEDULESCancel a schedule1
SCHEDULESView a schedule11
SCHEDULESDownload resources11

The result appears as follows:

Result of creating DTF permissions: list of User / Profile / UTD / Module associations

Duplicating a DTF Permission​

You can duplicate a user's rights based on another user's permissions using the "DUPLIQUER LES DROITS" (Duplicate Rights) function.

  1. Select the Target user
  2. Then the Template user
  3. Click Save

‘Duplicate Rights’ tab filled in with the target user and the template user

Note

The Template user's permissions are ADDED to those already in place on the TARGET user

Editing a DTF Permission​

Editing a permission consists of making it inactive.

If the user needs to have a Profile change applied (« Contremaitre » (Foreman), « Contrôleur » (Controller), or « Producteur » (Producer)), then the existing permission should be deactivated and a new one created.

Actions:

  1. Select a row to edit
  2. Click Edit

Selecting an association row and clicking the Edit button

  1. Change the status to "Inactif" (Inactive)
  2. Save

‘Edit Permission’ pop-up with the Inactive status selected

DTS Permissions​

Permissions can also be used to grant usage rights directly on a tag — that is, on a production result. The effects are the same as those of a distribution governance action (see the "Governance Manual" guide).

This is configured via the Settings/Administration/Permissions/DTS menu:

Data Shop / Associations tab on the Permissions page, with the + Add button

Creating a DTS Permission​

To create an access right to a tag for a user, the tag must be associated with that user. To do this:

  1. Click "+ Ajouter" (+ Add)
  2. User: select the relevant user
  3. Tag: select the relevant tag
  4. Comment: enter a free-text comment
  5. Save

‘Add Permission’ pop-up with the User, Tag, and Comment fields

The new row appears.

New DTS permission row added to the list

The user will then see the dataset associated with this tag in the Data Shop.

Editing a Permission​

  1. Select the row to edit

Selecting the DTS permission row to edit

  1. Click "Editer" (Edit), or double-click
  2. Change the status to "Inactif" (Inactive)
  3. Comment: enter a free-text comment
  4. Save

‘Edit DTS Permission’ pop-up with the Inactive status selected

REF Manager Permissions​

Custom Permissions​

For users with the « Personnalisé » (Custom) role for the REF Manager application, the reference datasets they can access and their rights on those datasets must be defined. This chapter describes the procedure to follow.

  1. In the "Paramètres" (Settings) menu, select "Administration", then go to the "Habilitations" (Permissions) page.
  2. On the "Habilitations" (Permissions) page, select the "Ref Manager" tab.
  3. Select the user whose access you want to modify. The list of reference datasets is displayed.

Permissions page, Ref Manager tab, with the drop-down menu of roles per reference dataset

For each reference dataset, a role can be assigned to the user from the following:

  • « Lecteur » (Reader), grants read-only access to the reference dataset.
  • « Contributeur » (Contributor), allows viewing, editing, and adding data in the reference dataset.
  • « Administrateur » (Administrator), has the same permissions as the Contributor, can modify the reference dataset's configuration, and can also delete it (if in Draft status).

Summary of rights granted per profile:

Configuration Page — RefAdministration

Custom Role (level 2)Visible Reference DatasetsOpen DetailEditAddDelete
No permissionNone✗✗✗✗
« Lecteur » (Reader)Their own permissionsRead-only✗✗✗
« Contributeur » (Contributor)Their own permissionsRead-only✗✗✗
« Administrateur » (Administrator)Their own permissionsEditable✔✗If Draft

Operations Page — RefExploitation

Custom Role (level 2)Visible Reference DatasetsView DataAdd / Edit / DeleteValidateForce ReloadCloneExcel Import
No permissionNone✗✗✗✗✗✗
« Lecteur » (Reader)Their own permissions✔✗✗✗✗✗
« Contributeur » (Contributor)Their own permissions✔✔✔✔✔✔
« Administrateur » (Administrator)Their own permissions✔✔✔✔✔✔

History Page — RefHistorical

Custom Role (level 2)Visible HistoryAvailable Actions
No permissionNoneNone
« Lecteur » (Reader)Their own permissions onlyRead-only
« Contributeur » (Contributor)Their own permissions onlyRead-only
« Administrateur » (Administrator)Their own permissions onlyRead-only

User Templates​

The Administration → User Templates page simplifies role configuration by allowing the creation of template accounts that serve as a reference for quickly assigning consistent sets of rights to other users.

A template is a special user account configured by an administrator:

  • It cannot log in to the platform.
  • Its operation type is Template.
  • It has a complete permission configuration (applications and roles).
  • Its rights can be duplicated onto one or more real users.

Examples of templates:

  • MODELE_SUPERADMIN: has full rights over all modules.
  • MODELE_DTF_CREATOR: configured for a "Data Fabrik Creator" profile.
  • MODELE_REF_VIEWER: reserved for viewing reference datasets.

Interface and Duplicating Rights​

A new feature, "Dupliquer les droits à partir d'un utilisateur modèle" (Duplicate rights from a template user), is available from the menu:

Settings / Administration / Permissions / Users

The template user's rights replace those of the target user.

The KADMIN User​

By default, when the platform is installed, an initial user is created named KADMIN.

Default Password

A default password is set during installation (see the installation guide).

After installation, the first login must be performed with this user, and the password must be changed.

It is then necessary to:

  • Create a new USER of type Administrator
  • Change KADMIN's access password or disable the account.