From 5235671db70470dda1b6a679d06079e4cd245e5e Mon Sep 17 00:00:00 2001 From: StevenHosper Date: Tue, 6 Feb 2024 16:55:10 +0100 Subject: [PATCH 1/7] Update m_managers_threedi.rst --- source/m_managers_threedi.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/source/m_managers_threedi.rst b/source/m_managers_threedi.rst index 52cf7dbf..b3d4f112 100644 --- a/source/m_managers_threedi.rst +++ b/source/m_managers_threedi.rst @@ -1,5 +1,10 @@ :orphan: +======== +Managers +======== + + Wat zijn de taken die vallen op een Manager van een organisatie =============================================================== From 0c62d479f54bfd620690b908d02725e1ac2fab17 Mon Sep 17 00:00:00 2001 From: StevenHosper Date: Wed, 7 Feb 2024 14:28:35 +0100 Subject: [PATCH 2/7] Convert to english and fix hyperlinks. --- source/m_managers_threedi.rst | 165 +++++++++++++++++----------------- 1 file changed, 82 insertions(+), 83 deletions(-) diff --git a/source/m_managers_threedi.rst b/source/m_managers_threedi.rst index 52cf7dbf..8a2a0afb 100644 --- a/source/m_managers_threedi.rst +++ b/source/m_managers_threedi.rst @@ -1,135 +1,134 @@ :orphan: -Wat zijn de taken die vallen op een Manager van een organisatie -=============================================================== +======== +Managers +======== -De rol van manager is belangrijk voor het beheer van de data van een organisatie. -Als manager verleent u rechten voor uw organisatie, of neemt u deze af. -Een manager heeft voornamelijk twee taken: +What are the tasks that fall under a Manager of an organization +=============================================================== -1. Het onderhouden van de rechten van bestaande gebruikers -2. Het verlenen van rechten aan nieuwe medewerkers of externe partijen +The role of a manager is important for managing the data of an organization. +As a manager, you grant or revoke rights for your organization. +A manager mainly has two tasks: -**Onderhouden rechten van bestaande gebruikers** +1. Maintaining the rights of existing users +2. Granting rights to new employees or external parties -De rechten van gebruikers die onder uw organisatie vallen vervallen niet automatisch. -Het is dus van belang dat u met enige regelmaat controleert of gebruikers hun rechten nog nodig hebben. -Dit kan dan gaan om werknemers die de organisatie verlaten, maar ook om een project wat af loopt. -Soms hoeven niet alle rechten afgenomen te worden, ook dit is mogelijk. -Het is aan u om te bepalen hoe vaak u dit wil controleren. +**Maintaining rights of existing users** -**Verlenen rechten nieuwe gebruikers** +The rights of users under your organization do not expire automatically. +So, it is important that you regularly check whether users still need their rights. +This can include employees leaving the organization or projects coming to an end. +Sometimes, not all rights need to be revoked, this is also possible. +It is up to you to determine how often you want to perform this check. -Als een gebruiker rechten nodig heeft voor uw organisatie bent u hiervoor verantwoordelijk. -Voor het spoedig verloop van een project is het handig om dit soort verzoeken met enige spoed af te handelen. -Het verlenen van rechten hoeft ook geen langdradige klus te zijn, met een minuut zijn de rechten al verleend. -Hoe dit exact in zijn werk gaat leest u in `Een extern of nieuwe projectmedewerker rechten geven tot de organisatie.`_. +**Granting rights to new users** -.. tip:: Gebruik een bookmark om direct naar de Management-pagina te komen. Op deze manier kan je binnen no-time een gebruiker rechten geven. +If a user needs rights for your organization, you are responsible for granting them. +For the smooth progress of a project, it is useful to handle such requests promptly. +Granting rights also doesn't have to be a lengthy task; rights can be granted in a minute. +You can learn exactly how this works in `Inviting new users`_ and `Adjusting existing rights`_. +.. tip:: Use a bookmark to go directly to the Management page. This way, you can give a user rights in no time. -Welke rechten zijn er te verdelen en wanneer is dit nodig? -========================================================== +Roles and their rights +====================== **Viewer** -De basis van de basis. -Als viewer kan je data lezen vanuit de API van de desbetreffende organisatie, en je kan simulaties van andere volgen. -Deze gebruikers kunnen zelf geen simulaties starten of maken. +The basics of basics. +As a viewer, you can read data from the API of the respective organization, and you can follow simulations of others. +These users cannot start or create simulations themselves. **Simulation Runner** -Met deze rol kunnen gebruikers zelf simulaties starten met schematisaties en modellen die aangeleverd zijn vanuit de organisatie. -Deze rol gaat altijd in combinatie met de viewer rol om te zorgen dat de gebruiker de simulatie ook kan volgen. - +With this role, users can start simulations themselves with schematics and models provided by the organization. +This role always goes in combination with the viewer role to ensure that the user can also follow the simulation. **Creator** -De creator rechten zijn nodig om nieuwe schematisaties en modellen aan te leveren aan 3Di. -Creator's kunnen ook data lezen in de API. -Om de aangeleverde modellen te draaien zijn de voorgaande rechten nodig. - -**Manager** +Creator rights are needed to provide new schematics and models to 3Di. +Creators can also read data from the API. +To run the provided models, the previouslty mentioned roles are necessary. -De manager geeft en neemt rechten van andere. -Een manager kan ook de rechten van een andere manager afnemen. -Zorg dus dat u alleen vertrouwde partijen managers rechten geeft. - -.. tip:: In sommige situaties ontstaant organisaties voor specifieke projecten. - Als de data binnen dit project onder uw organisatie valt en u wilt hiervoor een manager aanstellen, - neem dan contact op met de `servicedesk `_. +**Manager** +The manager gives and takes roles from other users. +A manager can also revoke the rights of another manager. +So, make sure to only give manager role to trusted parties. -Het managementscherm -==================== +.. tip:: In some situations, organizations arise for specific projects. + If the data within this project falls under your organization and you want to appoint a manager for this, + please contact the `servicedesk `_. -Het managementscherm bied de mogelijkheid om verschillende aspecten van je organisatie te beheren. -Denk hierbij aan het beheren van uw data: schematisaties, scenario's, gebruikers en meer. -Voor het complete gebruik van deze managementschermen kunt u terecht op de `3Di documentatie `_. -Belangrijkste is in dit geval het "User Management". -Alleen managers hebben toegang tot het "Users" scherm. -Het is in dit scherm dat u: +The management screen +===================== -1. Nieuwe gebruikers kunt uitnodigen. -2. Bestaande rechten kunt aanpassen. +The management screen offers the opportunity to manage various aspects of your organization. +This includes managing your data: schematics, scenarios, users, and more. +For complete use of these management screens, refer to the `3Di documentation `_. +Only managers have access to the "Users" screen. +This is where the user management takes places, which is at the heart of this page. +In this screen, you can: +1. Invite new users. +2. Adjust existing rights. -Nieuwe gebruikers uitnodigen ----------------------------- +Inviting new users +------------------ -Als een nieuwe gebruiker toegang tot Lizard nodig heeft vanuit de organisatie kunnen deze verleend worden door de Manager. -Dit gebeurt als volgt: +If a new user needs access to Lizard from the organization, this can be granted by the Manager. +This is done as follows: -1. U logt in op het portaal van de organisatie (https://management.3di.live/). -2. Ga naar het gebruikersgedeelte in het managementscherm (https://api.3di.live/management/users/). -3. Klik op `+ NEW USER` rechts boven in het scherm (afbeelding 1). -4. Type het e-mail van de gebruiker in de 'e-mail' balk (afbeelding 2). -5. Selecteer de rollen die de gebruiker krijgt. Voor de rechten die aan de rollen gekoppeld zitten kunt terug vallen op `rechten `_. -6. Klik op `SAVE`. -7. Het is gelukt! De uitnoding is verstuurd en zal binnen 5 minuten in de mailbox van de nieuwe gebruiker belanden. +1. Log in to the organization's portal (https://management.3di.live/). +2. Go to the user section in the management screen (https://api.3di.live/management/users/). +3. Click on `+ NEW USER` at the top right of the screen (image 1). +4. Type the user's email in the 'email' field (image 2). +5. Select the roles the user will have. For the rights associated with the roles, refer to `Roles and their rights`_. +6. Click `SAVE`. +7. Success! The invitation has been sent and will be in the new user's mailbox within 5 minutes. -.. tip:: Als u `need help?` klikt krijgt u ook een overzicht van de rollen en de daaraan gekoppelde rechten te zien. +.. tip:: Clicking `need help?` will also show you an overview of the roles and the rights associated with them. -.. tip:: Wanneer de e-mail niet in de inbox verschijnt na 5 minuten, controleer dan eerst uw spam. Mocht de uitnodiging hier ook niet zijn, dan kunt u altijd de `servicedesk `_ benaderen. +.. tip:: If the email does not appear in the inbox after 5 minutes, first check your spam folder. If the invitation is not there either, you can always contact the `servicedesk `_. -.. figure:: /image/m_threedi_overzicht_rechten.png +.. figure:: /images/threedi/threedi_overzicht_rechten.png :scale: 50% :alt: Overview of the 3Di management page with multiple users. - Afbeelding 1: Een overzicht van het gebruikersgedeelte in het managementscherm van 3Di. + Image 1: An overview of the user section in the management screen of 3Di. -.. figure:: /image/m_threedi_uitnodiging_rechten.png +.. figure:: /images/threedi/threedi_uitnodiging_rechten.png :scale: 50% - :alt: Invitation screen for new users of 3Di. Enter an e-mail and select the roles for the new user. - - Afbeelding 2: Het uitnodigingscherm voor nieuwe gebruikers. U selecteert de rollen door er op te klikken. + :alt: Invitation screen for new users of 3Di. Enter an email and select the roles for the new user. + Image 2: The invitation screen for new users. You select the roles by clicking on them. -Bestaande rechten aanpassen ---------------------------- +Adjusting existing rights +------------------------- -In het gebruikersrechten overzicht scherm kunt u de rechten van bestaande gebruikers beheren. -U ziet hier de volgende informatie van gebruikers die rechten hebben voor uw organisatie: +In the user rights overview screen, you can manage the rights of existing users. +Here you see the following information of users who have rights for your organization: -1. Gebruikersnaam / Username -2. Rollen / Roles +1. Username +2. Roles 3. Email -Door op het plusje achter de rollen van een gebruiker te klikken kunt u de rechten gaan aanpassen. -De plus knop veranderd dan ook in `SAVE`. Zodra de rechten naar wens zijn klikt u op `SAVE` om dit te bevestigen. +By clicking on the plus sign next to the roles of a user, you can start adjusting the rights. +The plus button will then change to `SAVE`. Once the rights are as desired, click `SAVE` to confirm. -.. figure:: /image/m_threedi_rechten_bestaande.png +.. figure:: /images/threedi/threedi_rechten_bestaande.png Tips ============= -.. tip:: Zorg dat direct aan het begin van een project rechten worden besproken en verleend. - Dit voorkomt dat er later vertraging plaats vindt doordat iemand moet wachten op zijn rechten. +.. tip:: Ensure that rights are discussed and granted at the beginning of a project. + This prevents delays later due to someone waiting for their rights. -.. tip:: Vergeet na het afsluiten van een project niet de rechten van gebruikers niet te verwijderen. - Op deze manier houd u actief de gebruikersdatabase bij en is uw data onder uw controle. - Controleer hierbij wel of er geen scripts draaien op een API KEY van een van deze gebruikers. +.. tip:: Don't forget to remove users' rights after a project is completed. + This way, you actively maintain the user database and keep your data under control. + However, be sure to check if any scripts are running on an API KEY of any of these users. -.. tip:: Mocht u accounts willen deactiveren, neem dat contact op met de `servicedesk `_ +.. tip:: If you want to deactivate accounts, contact the `servicedesk `_ for assistance. From 2e3251c1597f91ccf7444e4e1f6277cb94bb3bd1 Mon Sep 17 00:00:00 2001 From: StevenHosper Date: Wed, 7 Feb 2024 14:41:25 +0100 Subject: [PATCH 3/7] Improve first headline m_managers_threedi.rst --- source/m_managers_threedi.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/m_managers_threedi.rst b/source/m_managers_threedi.rst index 8a2a0afb..e49269a0 100644 --- a/source/m_managers_threedi.rst +++ b/source/m_managers_threedi.rst @@ -4,8 +4,8 @@ Managers ======== -What are the tasks that fall under a Manager of an organization -=============================================================== +What are the tasks of Manager in an organization +================================================ The role of a manager is important for managing the data of an organization. As a manager, you grant or revoke rights for your organization. From 10b85209e0e546807575b18e4a4b4eea70f78bf5 Mon Sep 17 00:00:00 2001 From: StevenHosper Date: Wed, 7 Feb 2024 14:42:00 +0100 Subject: [PATCH 4/7] Update m_managers_threedi.rst --- source/m_managers_threedi.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/m_managers_threedi.rst b/source/m_managers_threedi.rst index e49269a0..21ce9256 100644 --- a/source/m_managers_threedi.rst +++ b/source/m_managers_threedi.rst @@ -4,8 +4,8 @@ Managers ======== -What are the tasks of Manager in an organization -================================================ +What are the tasks of a Manager in an organization +================================================= The role of a manager is important for managing the data of an organization. As a manager, you grant or revoke rights for your organization. From 9064aad7769f5af3420717bcf6512164748c978f Mon Sep 17 00:00:00 2001 From: StevenHosper Date: Wed, 7 Feb 2024 15:06:26 +0100 Subject: [PATCH 5/7] Fix images m_managers_threedi.rst --- source/m_managers_threedi.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/source/m_managers_threedi.rst b/source/m_managers_threedi.rst index 21ce9256..6ccbf91b 100644 --- a/source/m_managers_threedi.rst +++ b/source/m_managers_threedi.rst @@ -92,14 +92,14 @@ This is done as follows: .. tip:: If the email does not appear in the inbox after 5 minutes, first check your spam folder. If the invitation is not there either, you can always contact the `servicedesk `_. -.. figure:: /images/threedi/threedi_overzicht_rechten.png +.. figure:: /image/m_threedi_overzicht_rechten.png :scale: 50% :alt: Overview of the 3Di management page with multiple users. Image 1: An overview of the user section in the management screen of 3Di. -.. figure:: /images/threedi/threedi_uitnodiging_rechten.png +.. figure:: /image/m_threedi_uitnodiging_rechten.png :scale: 50% :alt: Invitation screen for new users of 3Di. Enter an email and select the roles for the new user. @@ -118,7 +118,7 @@ Here you see the following information of users who have rights for your organiz By clicking on the plus sign next to the roles of a user, you can start adjusting the rights. The plus button will then change to `SAVE`. Once the rights are as desired, click `SAVE` to confirm. -.. figure:: /images/threedi/threedi_rechten_bestaande.png +.. figure:: /image/m_threedi_rechten_bestaande.png Tips From cbf7eeff570dd39ac8c05893ffcb69812996eafc Mon Sep 17 00:00:00 2001 From: leendertvanwolfswinkel Date: Wed, 7 Feb 2024 16:01:46 +0100 Subject: [PATCH 6/7] Eindredactie --- source/d_guide_management_portal.rst | 2 + source/d_overview_management_portal.rst | 96 ++++++++++++++++- source/f_manager_role.rst | 43 ++++++++ source/m_managers_threedi.rst | 134 ------------------------ 4 files changed, 136 insertions(+), 139 deletions(-) create mode 100644 source/f_manager_role.rst delete mode 100644 source/m_managers_threedi.rst diff --git a/source/d_guide_management_portal.rst b/source/d_guide_management_portal.rst index 2a79bd77..a8690069 100644 --- a/source/d_guide_management_portal.rst +++ b/source/d_guide_management_portal.rst @@ -1,3 +1,5 @@ +.. _threedi_management: + 3Di Management ============== diff --git a/source/d_overview_management_portal.rst b/source/d_overview_management_portal.rst index 0164c64f..7b95f553 100644 --- a/source/d_overview_management_portal.rst +++ b/source/d_overview_management_portal.rst @@ -66,12 +66,98 @@ When you click the *Personal API Key* tile in the overview, you will be presente Users ===== -When you click the *Users* tile in the overview, you will access a list of all the users associated with your organisation along with their respective roles: -- *Viewer*: This role is capable of reading data and monitoring simulations. -- *Simulation Runner*: This role has the authority to read data and execute simulations. -- *Creator*: Users with this role possess the ability to read data and make modifications such as adding, altering, or removing schematizations and 3Di models. -- *Manager*: Users holding this role are empowered to manage users by performing tasks such as addition, modification, or removal. +You only have access to this functionality if you have the *Manager* role. + +In this screen, you can: + +1. :ref:`Invite new users` +2. :ref:`Adjust existing rights` + +.. _inviting_new_users: + +Inviting new users +------------------ + +If a new user needs access to 3Di from the organisation, this can be granted by the Manager. +This is done as follows: + +3. Click `+ NEW USER` at the top right of the screen (image 1). +4. Type the user's email in the 'email' field (image 2). +5. Select the roles the user will have (see :ref:`roles`) +6. Click *SAVE*. +7. Success! The invitation has been sent and will be in the new user's mailbox within 5 minutes. + +.. tip:: Clicking `need help?` will also show you an overview of the roles and the rights associated with them. + +.. tip:: If the email does not appear in the inbox after 5 minutes, first check your spam folder. If the invitation is not there either, you can always contact the `servicedesk `_. + +.. figure:: /image/m_threedi_overzicht_rechten.png + :scale: 50% + :alt: Overview of the 3Di management page with multiple users. + + Image 1: An overview of the user section in the management screen of 3Di. + + +.. figure:: /image/m_threedi_uitnodiging_rechten.png + :scale: 50% + :alt: Invitation screen for new users of 3Di. Enter an email and select the roles for the new user. + + Image 2: The invitation screen for new users. You select the roles by clicking on them. + +.. _adjusting_existing_rights: + +Adjusting existing rights +------------------------- + +In the *User rights* overview screen, you can manage the rights of existing users. +Here you see the following information of users who have rights for your organisation: + +1. Username +2. Roles +3. Email + +By clicking on the plus sign next to the roles of a user, you can start adjusting the rights. +The plus button will then change to *SAVE*. Once the rights are as desired, click *SAVE* to confirm. + +.. figure:: /image/m_threedi_rechten_bestaande.png + +.. _roles: +User roles +---------- + +Each user is assigned one or more *Roles*, which give them the rights to perform certain sets of actions. + +Viewer +^^^^^^ + +As a viewer, you can read data from the API of the respective organisation, and you can follow simulations of others. +These users cannot start or create simulations themselves. + +Simulation runner +^^^^^^^^^^^^^^^^^ + +With this role, users can start simulations themselves with 3Di models provided by the organisation. +This role always goes in combination with the *Viewer* role to ensure that the user can also follow the simulation. + +Creator +^^^^^^^ + +Creator rights are needed to provide new schematisations and models to 3Di. Creators can also change or remove schematisations and 3Di models, and read data from the API. +To run simulations, the *Simulation runner* role is necessary, also if you already have the *Creator* role. + +Manager +^^^^^^^ + +*Managers* give and take roles from other users. +A manager can also revoke the rights of another manager. +So, make sure to only give manager role to trusted parties. + +.. tip:: In some situations, organisations are created for specific projects. + If the data within this project falls under your organisation and you want to appoint a manager for this, + please contact the `servicedesk `_. + + .. _3di_management_simulations: diff --git a/source/f_manager_role.rst b/source/f_manager_role.rst new file mode 100644 index 00000000..75ca389e --- /dev/null +++ b/source/f_manager_role.rst @@ -0,0 +1,43 @@ + +.. _manager_role: + +Tasks of a Manager +================== + +As the person(s) with the *Manager* role, you manage your organisation's 3Di account and its users. You grant or revoke rights for your organisation. A manager has two main tasks: + +1. :ref:`maintaining_rights` +2. :ref:`granting_rights` + +You can do this in the :ref:`Users<3di_management_users>` section of 3Di Management (`management.3di.live `_). + +.. _maintaining_rights: + +Maintaining rights of existing users +------------------------------------ + +The rights of users under your organisation do not expire automatically. +So, it is important that you regularly check whether users still need their rights. +This can include employees leaving the organisation or projects coming to an end. +Sometimes, not all rights need to be revoked; it is also possible to revoke only specific rights. +It is up to you to determine how often you want to perform this check. + +.. _granting_rights: + +Granting rights to new users +---------------------------- + +If a user needs rights for your organisation, you are responsible for granting them. +For the smooth progress of a project, it is useful to handle such requests promptly. +Granting rights does not have to be a lengthy task; rights can be granted in a minute. +For instructions, see :ref:`inviting_new_users` and :ref:`adjusting_existing_rights`. + +.. tip:: Use a bookmark to go directly to 3Di Management. This way, you can give a user rights in no time. + +.. tip:: Ensure that rights are discussed and granted at the beginning of a project. + This prevents delays later due to someone waiting for their rights. + +.. tip:: Don't forget to remove users' rights after a project is completed. + This way, you actively maintain the user database and keep your data under control. + +.. tip:: If you want to deactivate accounts, contact the `servicedesk `_ for assistance. diff --git a/source/m_managers_threedi.rst b/source/m_managers_threedi.rst deleted file mode 100644 index 6ccbf91b..00000000 --- a/source/m_managers_threedi.rst +++ /dev/null @@ -1,134 +0,0 @@ -:orphan: - -======== -Managers -======== - -What are the tasks of a Manager in an organization -================================================= - -The role of a manager is important for managing the data of an organization. -As a manager, you grant or revoke rights for your organization. -A manager mainly has two tasks: - -1. Maintaining the rights of existing users -2. Granting rights to new employees or external parties - -**Maintaining rights of existing users** - -The rights of users under your organization do not expire automatically. -So, it is important that you regularly check whether users still need their rights. -This can include employees leaving the organization or projects coming to an end. -Sometimes, not all rights need to be revoked, this is also possible. -It is up to you to determine how often you want to perform this check. - -**Granting rights to new users** - -If a user needs rights for your organization, you are responsible for granting them. -For the smooth progress of a project, it is useful to handle such requests promptly. -Granting rights also doesn't have to be a lengthy task; rights can be granted in a minute. -You can learn exactly how this works in `Inviting new users`_ and `Adjusting existing rights`_. - -.. tip:: Use a bookmark to go directly to the Management page. This way, you can give a user rights in no time. - -Roles and their rights -====================== - -**Viewer** - -The basics of basics. -As a viewer, you can read data from the API of the respective organization, and you can follow simulations of others. -These users cannot start or create simulations themselves. - -**Simulation Runner** - -With this role, users can start simulations themselves with schematics and models provided by the organization. -This role always goes in combination with the viewer role to ensure that the user can also follow the simulation. - -**Creator** - -Creator rights are needed to provide new schematics and models to 3Di. -Creators can also read data from the API. -To run the provided models, the previouslty mentioned roles are necessary. - -**Manager** - -The manager gives and takes roles from other users. -A manager can also revoke the rights of another manager. -So, make sure to only give manager role to trusted parties. - -.. tip:: In some situations, organizations arise for specific projects. - If the data within this project falls under your organization and you want to appoint a manager for this, - please contact the `servicedesk `_. - -The management screen -===================== - -The management screen offers the opportunity to manage various aspects of your organization. -This includes managing your data: schematics, scenarios, users, and more. -For complete use of these management screens, refer to the `3Di documentation `_. -Only managers have access to the "Users" screen. -This is where the user management takes places, which is at the heart of this page. -In this screen, you can: - -1. Invite new users. -2. Adjust existing rights. - -Inviting new users ------------------- - -If a new user needs access to Lizard from the organization, this can be granted by the Manager. -This is done as follows: - -1. Log in to the organization's portal (https://management.3di.live/). -2. Go to the user section in the management screen (https://api.3di.live/management/users/). -3. Click on `+ NEW USER` at the top right of the screen (image 1). -4. Type the user's email in the 'email' field (image 2). -5. Select the roles the user will have. For the rights associated with the roles, refer to `Roles and their rights`_. -6. Click `SAVE`. -7. Success! The invitation has been sent and will be in the new user's mailbox within 5 minutes. - -.. tip:: Clicking `need help?` will also show you an overview of the roles and the rights associated with them. - -.. tip:: If the email does not appear in the inbox after 5 minutes, first check your spam folder. If the invitation is not there either, you can always contact the `servicedesk `_. - -.. figure:: /image/m_threedi_overzicht_rechten.png - :scale: 50% - :alt: Overview of the 3Di management page with multiple users. - - Image 1: An overview of the user section in the management screen of 3Di. - - -.. figure:: /image/m_threedi_uitnodiging_rechten.png - :scale: 50% - :alt: Invitation screen for new users of 3Di. Enter an email and select the roles for the new user. - - Image 2: The invitation screen for new users. You select the roles by clicking on them. - -Adjusting existing rights -------------------------- - -In the user rights overview screen, you can manage the rights of existing users. -Here you see the following information of users who have rights for your organization: - -1. Username -2. Roles -3. Email - -By clicking on the plus sign next to the roles of a user, you can start adjusting the rights. -The plus button will then change to `SAVE`. Once the rights are as desired, click `SAVE` to confirm. - -.. figure:: /image/m_threedi_rechten_bestaande.png - - -Tips -============= - -.. tip:: Ensure that rights are discussed and granted at the beginning of a project. - This prevents delays later due to someone waiting for their rights. - -.. tip:: Don't forget to remove users' rights after a project is completed. - This way, you actively maintain the user database and keep your data under control. - However, be sure to check if any scripts are running on an API KEY of any of these users. - -.. tip:: If you want to deactivate accounts, contact the `servicedesk `_ for assistance. From 2254f183fd49b4bbd582348005b3fd934d21a4a8 Mon Sep 17 00:00:00 2001 From: leendertvanwolfswinkel Date: Wed, 7 Feb 2024 16:14:27 +0100 Subject: [PATCH 7/7] Nieuwe tekst verdeeld over bestaande paginas --- source/d_overview_management_portal.rst | 16 +++++ source/f_authentication_user_management.rst | 65 +++++++++------------ source/f_manager_role.rst | 43 -------------- 3 files changed, 42 insertions(+), 82 deletions(-) delete mode 100644 source/f_manager_role.rst diff --git a/source/d_overview_management_portal.rst b/source/d_overview_management_portal.rst index 7b95f553..6d6db711 100644 --- a/source/d_overview_management_portal.rst +++ b/source/d_overview_management_portal.rst @@ -79,6 +79,10 @@ In this screen, you can: Inviting new users ------------------ +By default the new user is granted a 'Viewer' role. At least one role is required when inviting a new user. +Press the 'Save' button to finish the invitation process, which results in an invitation email sent to the (new) user. An existing user can use the invitation link to accept the invitation. +A new user can create an account by using the :ref:`a_singing_up` guide. When accepted, the user will appear in the User Management overview. + If a new user needs access to 3Di from the organisation, this can be granted by the Manager. This is done as follows: @@ -122,6 +126,18 @@ The plus button will then change to *SAVE*. Once the rights are as desired, clic .. figure:: /image/m_threedi_rechten_bestaande.png + +.. _removing_users: + +Removing users +-------------- + +You can remove a user from your organisation by removing all the user's roles. +This will not delete the account of the user, but just revoke that user's right to your organisation. If you want to entirely deactivate a user's account, contact the :ref:`servicedesk`. + +You cannot revoke your own *Manager* role. + + .. _roles: User roles ---------- diff --git a/source/f_authentication_user_management.rst b/source/f_authentication_user_management.rst index 00baa01e..2517f3c4 100644 --- a/source/f_authentication_user_management.rst +++ b/source/f_authentication_user_management.rst @@ -52,57 +52,44 @@ Existing users should use the same method as they used when signing in for the f .. _a_user_management: -User management ---------------- +User management: tasks of the *Manager* +--------------------------------------- +Users rights are managed by the person(s) in your organisation that have the *Manager* role. As *Manager*, you manage your organisation's 3Di account and its users. You grant or revoke rights for your organisation. A manager has two main tasks: -.. figure:: /image/a_usermanagement1.png - :alt: The User Management interface. +1. :ref:`maintaining_rights` +2. :ref:`granting_rights` - The User Management interface. +You can do this in the :ref:`Users<3di_management_users>` section of 3Di Management (`management.3di.live `_). +.. _maintaining_rights: -Users can be managed in the User Management interface. This interface can be reached via https://api.3di.live/management/users/. -The example above shows the list of users in the example organisation '3Di Test', with for each user options for 4 roles. These role are desribed as: +Maintaining rights of existing users +------------------------------------ -* A **Viewer**, who can only *read* data and *follow* simulations -* A **Simulation runner**, who can *read* data and *run* simulations -* An **Creator**, who can *read* data and can *add*, *change* or *delete* schematisations and 3Di models -* A **Manager**, who can *manage* other roles in the organisation. A manager can not read or write data by default. This role should be appointed separately. +The rights of users under your organisation do not expire automatically. +So, it is important that you regularly check whether users still need their rights. +This can include employees leaving the organisation or projects coming to an end. +Sometimes, not all rights need to be revoked; it is also possible to revoke only specific rights. +It is up to you to determine how often you want to perform this check. -The User Management interface gives you an overview of all users in your organisation. As manager you can distribute the roles to all users within the organisation. -This is done by clicking the '+' next to the user and choose the roles you want to assign tot the user. Click “Save” to save the changes. -If you are Manager of multiple organisations you can switch between organisations by using the selection menu next to your username. - - -.. note:: - A manager role is required to access the User Management interface. - If you wish to obtain one for your organisation, please contact the application manager within your organisation or our :ref:`servicedesk` at servicedesk@nelen-schuurmans.nl. - - -**Adding a new user** - -You can add a new user by clicking the “NEW USER” icon in the upper right corner. This will lead you to the screen to add a new user. +.. _granting_rights: +Granting rights to new users +---------------------------- -.. figure:: /image/a_usermanagement2.png - :alt: The interface for adding a user. +If a user needs rights for your organisation, you are responsible for granting them. +For the smooth progress of a project, it is useful to handle such requests promptly. +Granting rights does not have to be a lengthy task; rights can be granted in a minute. +For instructions, see :ref:`inviting_new_users` and :ref:`adjusting_existing_rights`. - The interface for adding a user. - - -By default the new user is granted a 'Viewer' role. At least one role is required when inviting a new user. -Press the 'Save' button to finish the invitation process, which results in an invitation email sent to the (new) user. An existing user can use the invitation link to accept the invitation. -A new user can create an account by using the :ref:`a_singing_up` guide. When accepted, the user will appear in the User Management overview. - - -.. note:: - * The invitation email might end up in your spam folder. - * Deselecting all roles will remove the user from the organisation, but will not delete the account of the user. - * You cannot remove your own manager role. +.. tip:: Use a bookmark to go directly to 3Di Management. This way, you can give a user rights in no time. +.. tip:: Ensure that rights are discussed and granted at the beginning of a project. + This prevents delays later due to someone waiting for their rights. - +.. tip:: Don't forget to remove users' rights after a project is completed. + This way, you actively maintain the user database and keep your data under control. Authorisation ------------- diff --git a/source/f_manager_role.rst b/source/f_manager_role.rst deleted file mode 100644 index 75ca389e..00000000 --- a/source/f_manager_role.rst +++ /dev/null @@ -1,43 +0,0 @@ - -.. _manager_role: - -Tasks of a Manager -================== - -As the person(s) with the *Manager* role, you manage your organisation's 3Di account and its users. You grant or revoke rights for your organisation. A manager has two main tasks: - -1. :ref:`maintaining_rights` -2. :ref:`granting_rights` - -You can do this in the :ref:`Users<3di_management_users>` section of 3Di Management (`management.3di.live `_). - -.. _maintaining_rights: - -Maintaining rights of existing users ------------------------------------- - -The rights of users under your organisation do not expire automatically. -So, it is important that you regularly check whether users still need their rights. -This can include employees leaving the organisation or projects coming to an end. -Sometimes, not all rights need to be revoked; it is also possible to revoke only specific rights. -It is up to you to determine how often you want to perform this check. - -.. _granting_rights: - -Granting rights to new users ----------------------------- - -If a user needs rights for your organisation, you are responsible for granting them. -For the smooth progress of a project, it is useful to handle such requests promptly. -Granting rights does not have to be a lengthy task; rights can be granted in a minute. -For instructions, see :ref:`inviting_new_users` and :ref:`adjusting_existing_rights`. - -.. tip:: Use a bookmark to go directly to 3Di Management. This way, you can give a user rights in no time. - -.. tip:: Ensure that rights are discussed and granted at the beginning of a project. - This prevents delays later due to someone waiting for their rights. - -.. tip:: Don't forget to remove users' rights after a project is completed. - This way, you actively maintain the user database and keep your data under control. - -.. tip:: If you want to deactivate accounts, contact the `servicedesk `_ for assistance.