Skip to content
help-admin.html 5.51 KiB
Newer Older
Sonia Zorba's avatar
Sonia Zorba committed
<!DOCTYPE html>
<html>
    <head>
        <title>GMS - Help Page for Administrators</title>
        <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.5.0/css/bootstrap.min.css" integrity="sha384-9aIt2nRpC12Uk9gS9baDl411NQApFmC26EwAOH8WgZl5MYYxFfc+NcPb1dKGj7Sk" crossorigin="anonymous" />
    </head>
    <body>
        <div class="container">
            <h1 class="mt-5 text-center mb-4">GMS - Help Page for Administrators</h1>

            <p>Groups inside the GMS are organized in a tree structure (parent groups contain child groups).
                You can navigate the structure clicking on the group names.
                The parent of all groups is called ROOT.</p>

            <p class="text-center">
                <img src="img/gms-admin-groups.jpg" alt="" class="mb-3" />
            </p>

            <p>Each group has its own members and permissions.</p>

            <p>GMS supports the following permissions:</p>
            <ul>
                <li><code>ADMIN</code>: the user can edit the group, create/delete subgroups, add/remove members, add/remove permissions.</li>
                <li><code>MANAGE_MEMBERS</code>: the user can add/remove members. The system will automatically assign
                    a <code>VIEW_MEMBERS</code> permission to those members.</li>
                <li><code>VIEW_MEMBERS</code>: the user can see the other members.</li>
            </ul>

            <p>Memberships and permissions are handled separately, for example:</p>
            <ul>
                <li>A person can be a member of a group without having any permission on it.
                    In this case applications using the GMS (like a portal) know that the user
                    is a member of the group but he/she can't do anything on the GMS.</li>
                <li>A person can have a permission (for example <code>ADMIN</code>) on a group without being
                    a member of that group. In this case applications using the GMS don't see
                    the user as a member of the group but he/she can administrate it on the GMS interface.</li>
                <li>A person can be a member of a group and also have a permission on it (for example <code>MANAGE_MEMBERS</code>).
                    This is the case of Principal Investigators.</li>
            </ul>

            <p>Memberships and permissions defined in a parent group are inherited by child groups.</p>

            <h2 class="mt-4 mb-3">Managing groups</h2>

            <p>Go to the "Groups" tab and click on the "Add group" button:</p>

            <p>
                <img src="img/gms-add-group-btn.jpg" alt="" />
            </p>

            <p>The following modal dialog is displayed:</p>

            <p>
                <img src="img/gms-admin-add-group-modal.jpg" alt="" class="mb-3" />
            </p>

            <p>If you select the "is leaf" checkbox, the group will be a leaf of the tree: this means that
                it will not be possible to create sub-groups inside it. You can change this setting in any moment
                clicking on the "Edit group" button (pencil icon <img src="img/pencil-icon.jpg" alt="" />).</p>

            <p>You can delete groups using trash icons (<img src="img/trash-icon.jpg" alt="" />).
                A dialog will ask for confirming the operation before deleting the group.</p>

            <h2 class="mt-4 mb-3">Managing memberships</h2>

            <p>Go to the "Members" tab and click on the "Add member" button:</p>

            <p>
                <img src="img/gms-add-member-btn.jpg" alt="" />
            </p>

            <p>The following modal dialog is displayed:</p>

            <p>
                <img src="img/gms-admin-add-member-modal.jpg" alt="" class="mb-2 mt-2" />
            </p>

            <p>Type the name or the email of the user in the search input in order to select the desired user.</p>

            <p>You can delete memberships using the trash icons (<img src="img/trash-icon.jpg" alt="" />).
                The application will ask you if you want to remove
                also the associated permission.</p>

            <h2 class="mt-4 mb-3">Managing permissions</h2>

            <p>Go to the "Permissions" tab and click on the "Add permission" button:</p>

            <p>
                <img src="img/gms-add-permission-btn.jpg" alt="" />
            </p>

            <p>The following modal dialog is displayed:</p>

            <p>
                <img src="img/gms-admin-add-permission-modal.jpg" alt="" class="mb-2 mt-2" />
            </p>

            <p>Type the name or the email of the user in the search input in order to select the desired user.</p>

            <p>You can delete permissions using the trash icons (<img src="img/trash-icon.jpg" alt="" />).
                Remember that removing permissions doesn't remove memberships.
                You can also use the edit icon (<img src="img/pencil-icon.jpg" alt="" />)
                in order to change a permission.</p>

            <h2 class="mt-4">Seeing information about users</h2>

            <p>You can click on the user names in the Members or Permissions tab in order to see a detailed page about a specific user.</p>

            <h2 class="mt-4">Generic search</h2>

            <p>On the top menu bar there is the generic search input. You can use it for searching both users and groups.</p>

            <p>
                <img src="img/gms-generic-search.jpg" alt="" />
            </p>

            <p class="text-center mt-5 mb-3"><a href="index.html">Back</a></p>
        </div>
    </body>
</html>