.. doctest docs/specs/avanti/roles.rst
.. _avanti.specs.roles:

=========================
User types in Lino Avanti
=========================

.. contents::
  :local:

.. include:: /../docs/shared/include/tested.rst

>>> import lino
>>> lino.startup('lino_book.projects.avanti1.settings')
>>> from lino.api.doctest import *

>>> rt.show('users.UsersOverview')
========== ===================== ==========
 Username   User type             Language
---------- --------------------- ----------
 audrey     300 (Auditor)         en
 laura      100 (Teacher)         en
 martina    400 (Coordinator)     en
 nathalie   200 (Social worker)   en
 nelly      200 (Social worker)   en
 robin      900 (Administrator)   en
 rolf       900 (Administrator)   de
 romain     900 (Administrator)   fr
 sandra     410 (Secretary)       en
========== ===================== ==========
<BLANKLINE>

User roles
==========

The following table shows which roles are assigned to each user type.

>>> rt.show(users.UserRoles)
... #doctest: +ELLIPSIS +NORMALIZE_WHITESPACE +REPORT_UDIFF
================================ ===== ===== ===== ===== ===== ===== ===== =====
 Name                             000   100   200   300   400   410   800   900
-------------------------------- ----- ----- ----- ----- ----- ----- ----- -----
 about.SiteSearcher                                                   ☑     ☑
 avanti.Administrator                                                       ☑
 avanti.Auditor                                     ☑
 avanti.ClientsNameUser                 ☑     ☑           ☑     ☑     ☑     ☑
 avanti.ClientsStaff                                                  ☑     ☑
 avanti.ClientsUser                           ☑                 ☑     ☑     ☑
 avanti.Coordinator                                       ☑
 avanti.Secretary                                               ☑
 avanti.SiteStaff                                                     ☑     ☑
 avanti.SocialWorker                          ☑
 avanti.Teacher                         ☑
 beid.BeIdUser                                ☑                 ☑     ☑     ☑
 cal.GuestOperator                      ☑     ☑                       ☑     ☑
 checkdata.CheckdataUser                      ☑           ☑     ☑     ☑     ☑
 coachings.CoachingsStaff                                             ☑     ☑
 coachings.CoachingsUser                      ☑                       ☑     ☑
 comments.CommentsStaff                                               ☑     ☑
 comments.CommentsUser                        ☑                       ☑     ☑
 comments.PrivateCommentsReader                                             ☑
 contacts.ContactsStaff                                               ☑     ☑
 contacts.ContactsUser                        ☑                 ☑     ☑     ☑
 core.Explorer                                ☑     ☑                 ☑     ☑
 core.SiteAdmin                                                             ☑
 core.SiteUser                          ☑     ☑     ☑     ☑     ☑     ☑     ☑
 courses.CoursesTeacher                 ☑
 courses.CoursesUser                          ☑     ☑     ☑     ☑     ☑     ☑
 cv.CareerStaff                                                       ☑     ☑
 cv.CareerUser                                ☑                       ☑     ☑
 excerpts.ExcerptsStaff                                               ☑     ☑
 excerpts.ExcerptsUser                        ☑                 ☑     ☑     ☑
 office.OfficeOperator                        ☑           ☑     ☑     ☑     ☑
 office.OfficeStaff                                                   ☑     ☑
 office.OfficeUser                      ☑     ☑     ☑           ☑     ☑     ☑
 polls.PollsStaff                                                     ☑     ☑
 polls.PollsUser                              ☑                       ☑     ☑
 trends.TrendsStaff                                                   ☑     ☑
 trends.TrendsUser                            ☑                       ☑     ☑
================================ ===== ===== ===== ===== ===== ===== ===== =====
<BLANKLINE>



Site administrator
==================

>>> show_menu('robin')
... #doctest: +ELLIPSIS +NORMALIZE_WHITESPACE +REPORT_UDIFF -SKIP
- Contacts : Persons, Organizations, Clients, My Clients, Households, Partner Lists
- Calendar : My appointments, Overdue appointments, My unconfirmed appointments, My tasks, My guests, My presences, My overdue appointments, Calendar
- Office : My Comments, Recent comments, My Notification messages, My expiring upload files, My Upload files, My Excerpts, Data problems assigned to me
- Polls : My Polls, My Responses
- Activities : My Activities, Activities, -, Activity lines, Pending requested enrolments, Pending confirmed enrolments, Course planning, Absence control
- Configure :
  - System : Users, Site Parameters, Help Texts
  - Places : Countries, Places
  - Contacts : Organization types, Functions, Categories, Ending reasons, Household Types, List Types
  - Calendar : Calendars, Rooms, Recurring events, Guest roles, Calendar entry types, Recurrency policies, Remote Calendars, Absence reasons, Planner rows
  - Office : Comment Types, Library volumes, Upload types, Excerpt Types
  - Clients : Client Contact types
  - Career : Education Types, Education Levels, Activity sectors, Job titles, Work Regimes, Statuses, Contract Durations, Languages
  - Trends : Trend areas, Trend stages
  - Polls : Choice Sets
  - Activities : Topics, Timetable Slots
- Explorer :
  - System : Authorities, User types, User roles, Notification messages, Changes, Phonetic words, All dashboard widgets, content types, Data checkers, Data problems
  - Contacts : Contact persons, Partners, Clients, Household member roles, Household Members, List memberships
  - Calendar : Calendar entries, Tasks, Presences, Subscriptions, Entry states, Presence states, Task states, Planner columns, Access classes, Display colors
  - Office : Comments, Mentions, Reactions, Upload files, Upload areas, Excerpts
  - Clients : Client Contacts, Known contact types
  - Career : Language knowledges, Trainings, Studies, Job Experiences
  - Trends : Trend events
  - Polls : Polls, Questions, Choices, Responses, Answer Choices, Answer Remarks
  - Activities : Activities, Enrolments, Enrolment states, Course layouts, Activity states, Reminders
- Site : About, User sessions



Coordinator
===========

>>> rt.login('martina').user.user_type
<users.UserTypes.coordinator:400>

>>> show_menu('martina')
... #doctest: +ELLIPSIS +NORMALIZE_WHITESPACE +REPORT_UDIFF -SKIP
- Office : My expiring upload files, My Upload files, My Excerpts, Data problems assigned to me
- Activities : My Activities, Activities, -, Activity lines, Course planning
- Site : About


Secretary
=========

>>> rt.login('sandra').user.user_type
<users.UserTypes.secretary:410>

>>> show_menu('sandra')
... #doctest: +ELLIPSIS +NORMALIZE_WHITESPACE +REPORT_UDIFF -SKIP
- Contacts : Persons, Organizations, Clients, My Clients, Households, Partner Lists
- Calendar : My appointments, My unconfirmed appointments, My tasks, My guests, My presences, My overdue appointments, Calendar
- Office : My Notification messages, My expiring upload files, My Upload files, My Excerpts, Data problems assigned to me
- Activities : My Activities, Activities, -, Activity lines, Course planning
- Explorer :
  - Contacts : Partners
  - Activities : Reminders
- Site : About



Social worker
=============

>>> show_menu('nathalie')
... #doctest: +ELLIPSIS +NORMALIZE_WHITESPACE +REPORT_UDIFF -SKIP
- Contacts : Persons, Organizations, Clients, My Clients, Households, Partner Lists
- Calendar : My appointments, My unconfirmed appointments, My tasks, My guests, My presences, My overdue appointments, Calendar
- Office : My Comments, Recent comments, My Notification messages, My expiring upload files, My Upload files, My Excerpts, Data problems assigned to me
- Polls : My Polls, My Responses
- Activities : My Activities, Activities, -, Activity lines, Course planning, Absence control
- Configure :
  - Trends : Trend stages
- Explorer :
  - Contacts : Partners, Clients
  - Calendar : Calendar entries, Presences
  - Activities : Activities, Enrolments, Reminders
- Site : About

Teacher
=======

>>> rt.login('laura').user.user_type
<users.UserTypes.teacher:100>

>>> show_menu('laura')
... #doctest: +ELLIPSIS +NORMALIZE_WHITESPACE +REPORT_UDIFF -SKIP
- Calendar : My appointments, My unconfirmed appointments, My tasks, My guests, My presences, My overdue appointments
- Office : My Notification messages, My expiring upload files, My Upload files
- Activities : My Activities, -, My courses given
- Site : About

Supervisor
==========

>>> show_menu('audrey')
... #doctest: +ELLIPSIS +NORMALIZE_WHITESPACE +REPORT_UDIFF -SKIP
- Calendar : My appointments, My unconfirmed appointments, My tasks, My guests, My presences, My overdue appointments
- Office : My Notification messages, My expiring upload files, My Upload files
- Activities : My Activities, Activities, -, Activity lines, Course planning
- Explorer :
  - Contacts : Clients
  - Calendar : Calendar entries
  - Activities : Activities, Enrolments
- Site : About



Windows and permissions
=======================

Each window is **viewable** for a given set of user types.

>>> print(analyzer.show_window_permissions())
... #doctest: +ELLIPSIS +NORMALIZE_WHITESPACE +REPORT_UDIFF
- about.About.show : visible for all
- avanti.Clients.detail : visible for user secretary staff admin
- avanti.Clients.merge_row : visible for admin
- cal.Calendars.detail : visible for staff admin
- cal.Calendars.insert : visible for staff admin
- cal.EntriesByGuest.insert : visible for teacher user coordinator secretary staff admin
- cal.EntriesByProject.insert : visible for teacher user coordinator secretary staff admin
- cal.EventTypes.detail : visible for staff admin
- cal.EventTypes.insert : visible for staff admin
- cal.EventTypes.merge_row : visible for admin
- cal.Events.detail : visible for staff admin
- cal.Events.insert : visible for staff admin
- cal.GuestRoles.detail : visible for admin
- cal.GuestRoles.merge_row : visible for admin
- cal.Guests.detail : visible for teacher user staff admin
- cal.Guests.insert : visible for teacher user staff admin
- cal.RecurrentEvents.detail : visible for staff admin
- cal.RecurrentEvents.insert : visible for staff admin
- cal.Rooms.detail : visible for staff admin
- cal.Rooms.insert : visible for staff admin
- cal.Tasks.detail : visible for staff admin
- cal.Tasks.insert : visible for staff admin
- calview.DailyView.detail : visible for user secretary staff admin
- calview.MonthlyView.detail : visible for user secretary staff admin
- calview.WeeklyView.detail : visible for user secretary staff admin
- changes.Changes.detail : visible for admin
- checkdata.Checkers.detail : visible for admin
- checkdata.Problems.detail : visible for teacher user auditor coordinator secretary staff admin
- clients.ClientContactTypes.detail : visible for staff admin
- comments.CommentTypes.detail : visible for staff admin
- comments.CommentTypes.insert : visible for staff admin
- comments.Comments.detail : visible for user staff admin
- comments.Comments.insert : visible for user staff admin
- comments.CommentsByRFC.insert : visible for user staff admin
- contacts.Companies.detail : visible for user secretary staff admin
- contacts.Companies.insert : visible for user secretary staff admin
- contacts.Companies.merge_row : visible for admin
- contacts.Partners.merge_row : visible for admin
- contacts.Persons.create_household : visible for user secretary staff admin
- contacts.Persons.detail : visible for user secretary staff admin
- contacts.Persons.insert : visible for user secretary staff admin
- contacts.Persons.merge_row : visible for admin
- countries.Countries.detail : visible for staff admin
- countries.Countries.insert : visible for staff admin
- countries.Places.detail : visible for staff admin
- countries.Places.insert : visible for staff admin
- courses.Activities.detail : visible for teacher user auditor coordinator secretary staff admin
- courses.Activities.insert : visible for user coordinator secretary staff admin
- courses.Activities.print_presence_sheet : visible for user auditor coordinator secretary staff admin
- courses.Activities.print_presence_sheet_html : visible for user auditor coordinator secretary staff admin
- courses.Enrolments.detail : visible for teacher user auditor coordinator secretary staff admin
- courses.Enrolments.insert : visible for teacher user coordinator secretary staff admin
- courses.EnrolmentsByCourse.insert : visible for teacher user coordinator secretary staff admin
- courses.EnrolmentsByPupil.insert : visible for user coordinator secretary staff admin
- courses.Lines.detail : visible for user auditor coordinator secretary staff admin
- courses.Lines.insert : visible for user coordinator secretary staff admin
- courses.Lines.merge_row : visible for admin
- courses.RemindersByEnrolment.detail : visible for user secretary staff admin
- courses.RemindersByEnrolment.insert : visible for user secretary staff admin
- courses.Slots.detail : visible for admin
- courses.Slots.insert : visible for admin
- courses.StatusReport.show : visible for user auditor coordinator secretary staff admin
- courses.Topics.detail : visible for admin
- cv.Durations.detail : visible for staff admin
- cv.EducationLevels.detail : visible for staff admin
- cv.Experiences.detail : visible for staff admin
- cv.ExperiencesByPerson.insert : visible for user staff admin
- cv.Functions.detail : visible for staff admin
- cv.LanguageKnowledgesByPerson.detail : visible for user staff admin
- cv.LanguageKnowledgesByPerson.insert : visible for user staff admin
- cv.Regimes.detail : visible for staff admin
- cv.Sectors.detail : visible for staff admin
- cv.Statuses.detail : visible for staff admin
- cv.Studies.detail : visible for staff admin
- cv.StudiesByPerson.insert : visible for user staff admin
- cv.StudyTypes.detail : visible for staff admin
- cv.StudyTypes.insert : visible for staff admin
- cv.Trainings.detail : visible for user staff admin
- cv.Trainings.insert : visible for user staff admin
- excerpts.ExcerptTypes.detail : visible for staff admin
- excerpts.ExcerptTypes.insert : visible for staff admin
- excerpts.Excerpts.detail : visible for user coordinator secretary staff admin
- gfks.ContentTypes.detail : visible for admin
- households.Households.detail : visible for user secretary staff admin
- households.Households.insert : visible for user secretary staff admin
- households.Households.merge_row : visible for admin
- households.HouseholdsByType.insert : visible for user secretary staff admin
- households.MembersByPerson.insert : visible for user secretary staff admin
- households.Types.detail : visible for staff admin
- languages.Languages.detail : visible for staff admin
- lists.Lists.detail : visible for user secretary staff admin
- lists.Lists.insert : visible for user secretary staff admin
- lists.Lists.merge_row : visible for admin
- lists.Members.detail : visible for user secretary staff admin
- lists.MembersByPartner.insert : visible for user secretary staff admin
- polls.AnswerRemarks.detail : visible for user staff admin
- polls.AnswerRemarks.insert : visible for user staff admin
- polls.ChoiceSets.detail : visible for staff admin
- polls.Polls.detail : visible for user staff admin
- polls.Polls.insert : visible for user staff admin
- polls.Polls.merge_row : visible for admin
- polls.Questions.detail : visible for staff admin
- polls.Responses.detail : visible for user staff admin
- polls.Responses.insert : visible for user staff admin
- system.SiteConfigs.detail : visible for admin
- trends.TrendAreas.detail : visible for staff admin
- trends.TrendStages.detail : visible for user staff admin
- trends.TrendStages.insert : visible for user staff admin
- trends.TrendStages.merge_row : visible for admin
- uploads.AllUploads.detail : visible for staff admin
- uploads.AllUploads.insert : visible for staff admin
- uploads.UploadTypes.detail : visible for staff admin
- uploads.UploadTypes.insert : visible for staff admin
- uploads.Uploads.detail : visible for teacher user auditor coordinator secretary staff admin
- uploads.Uploads.insert : visible for teacher user coordinator secretary staff admin
- uploads.UploadsByController.insert : visible for teacher user coordinator secretary staff admin
- uploads.Volumes.detail : visible for staff admin
- uploads.Volumes.insert : visible for staff admin
- uploads.Volumes.merge_row : visible for admin
- users.AllUsers.change_password : visible for admin
- users.AllUsers.detail : visible for admin
- users.AllUsers.insert : visible for admin
- users.AllUsers.send_welcome_email : visible for admin
- users.UsersOverview.sign_in : visible for all
<BLANKLINE>


Not everybody can see the names of participants
===============================================

The names of the participants are confidential data in :ref:`avanti`.

A :term:`site administrator` can see the full names:

>>> obj = courses.Course.objects.get(pk=1)
>>> rt.login('rolf').show('courses.EnrolmentsByCourse', obj, show_links=True)
... #doctest: +NORMALIZE_WHITESPACE -REPORT_UDIFF
================= ================================================ ======== ============= =========== ======== ===== ========= ======== ============== ==================================================
 ID                Participant                                      Gender   Nationality   Childcare   School   Bus   Evening   Remark   Missing rate   Workflow
----------------- ------------------------------------------------ -------- ------------- ----------- -------- ----- --------- -------- -------------- --------------------------------------------------
 `31 <Detail>`__   `ARNOLD Alexei (129/nathalie) <Detail>`__        Male                   No          No       No    No                 25,00          **Confirmed** → [Cancelled] [Requested] [Trying]
 `25 <Detail>`__   `ABDELNOUR Aámir (125/nelly) <Detail>`__         Male                   No          No       No    No                                **Requested** → [Confirm] [Cancelled] [Trying]
 `22 <Detail>`__   `ARENT Afánásiiá (124/robin) <Detail>`__         Female                 No          No       No    No                 25,00          **Trying** → [Requested]
 `19 <Detail>`__   `DEMEULENAERE Dorothée (121/nelly) <Detail>`__   Female                 No          No       No    No                 25,00          **Confirmed** → [Cancelled] [Requested] [Trying]
 `13 <Detail>`__   `ABBASI Aáishá (118/romain) <Detail>`__          Female                 No          No       No    No                                **Requested** → [Confirm] [Cancelled] [Trying]
 `10 <Detail>`__   `ALEKSANDROV Akim (116/nathalie) <Detail>`__     Male                   No          No       No    No                 25,00          **Trying** → [Requested]
 `7 <Detail>`__    `ABBAS Aábid (115/nelly) <Detail>`__             Male                   No          No       No    No                 25,00          **Confirmed** → [Cancelled] [Requested] [Trying]
 `1 <Detail>`__    `ABEZGAUZ Adrik (112/nelly) <Detail>`__          Male                   No          No       No    No                                **Requested** → [Confirm] [Cancelled] [Trying]
================= ================================================ ======== ============= =========== ======== ===== ========= ======== ============== ==================================================
<BLANKLINE>

Teachers and coordinators *can* see the full names (they need it
because they must register presences and absences), but they cannot
click on a name to see any detail.

>>> rt.login('laura').show('courses.EnrolmentsByCourse', obj, show_links=True)
... #doctest: +NORMALIZE_WHITESPACE -REPORT_UDIFF
================= ===================================== ======== ============= =========== ======== ===== ========= ======== ============== ==================================================
 ID                Participant                           Gender   Nationality   Childcare   School   Bus   Evening   Remark   Missing rate   Workflow
----------------- ------------------------------------- -------- ------------- ----------- -------- ----- --------- -------- -------------- --------------------------------------------------
 `31 <Detail>`__   *ARNOLD Alexei (129/nathalie)*        Male                   No          No       No    No                 25,00          **Confirmed** → [Cancelled] [Requested] [Trying]
 `25 <Detail>`__   *ABDELNOUR Aámir (125/nelly)*         Male                   No          No       No    No                                **Requested** → [Confirm] [Cancelled] [Trying]
 `22 <Detail>`__   *ARENT Afánásiiá (124/robin)*         Female                 No          No       No    No                 25,00          **Trying** → [Requested]
 `19 <Detail>`__   *DEMEULENAERE Dorothée (121/nelly)*   Female                 No          No       No    No                 25,00          **Confirmed** → [Cancelled] [Requested] [Trying]
 `13 <Detail>`__   *ABBASI Aáishá (118/romain)*          Female                 No          No       No    No                                **Requested** → [Confirm] [Cancelled] [Trying]
 `10 <Detail>`__   *ALEKSANDROV Akim (116/nathalie)*     Male                   No          No       No    No                 25,00          **Trying** → [Requested]
 `7 <Detail>`__    *ABBAS Aábid (115/nelly)*             Male                   No          No       No    No                 25,00          **Confirmed** → [Cancelled] [Requested] [Trying]
 `1 <Detail>`__    *ABEZGAUZ Adrik (112/nelly)*          Male                   No          No       No    No                                **Requested** → [Confirm] [Cancelled] [Trying]
================= ===================================== ======== ============= =========== ======== ===== ========= ======== ============== ==================================================
<BLANKLINE>


>>> rt.login('martina').show('courses.EnrolmentsByCourse', obj, show_links=True)
... #doctest: +NORMALIZE_WHITESPACE -REPORT_UDIFF
================= ===================================== ======== ============= =========== ======== ===== ========= ======== ============== ==================================================
 ID                Participant                           Gender   Nationality   Childcare   School   Bus   Evening   Remark   Missing rate   Workflow
----------------- ------------------------------------- -------- ------------- ----------- -------- ----- --------- -------- -------------- --------------------------------------------------
 `31 <Detail>`__   *ARNOLD Alexei (129/nathalie)*        Male                   No          No       No    No                 25,00          **Confirmed** → [Cancelled] [Requested] [Trying]
 `25 <Detail>`__   *ABDELNOUR Aámir (125/nelly)*         Male                   No          No       No    No                                **Requested** → [Confirm] [Cancelled] [Trying]
 `22 <Detail>`__   *ARENT Afánásiiá (124/robin)*         Female                 No          No       No    No                 25,00          **Trying** → [Requested]
 `19 <Detail>`__   *DEMEULENAERE Dorothée (121/nelly)*   Female                 No          No       No    No                 25,00          **Confirmed** → [Cancelled] [Requested] [Trying]
 `13 <Detail>`__   *ABBASI Aáishá (118/romain)*          Female                 No          No       No    No                                **Requested** → [Confirm] [Cancelled] [Trying]
 `10 <Detail>`__   *ALEKSANDROV Akim (116/nathalie)*     Male                   No          No       No    No                 25,00          **Trying** → [Requested]
 `7 <Detail>`__    *ABBAS Aábid (115/nelly)*             Male                   No          No       No    No                 25,00          **Confirmed** → [Cancelled] [Requested] [Trying]
 `1 <Detail>`__    *ABEZGAUZ Adrik (112/nelly)*          Male                   No          No       No    No                                **Requested** → [Confirm] [Cancelled] [Trying]
================= ===================================== ======== ============= =========== ======== ===== ========= ======== ============== ==================================================
<BLANKLINE>


Auditors cannot even see the name. They see only the pupil's number and place:

>>> rt.login('audrey').show('courses.EnrolmentsByCourse', obj, show_links=True)
... #doctest: +NORMALIZE_WHITESPACE -REPORT_UDIFF
================= ==================== ======== ============= =========== ======== ===== ========= ======== ============== ===============
 ID                Participant          Gender   Nationality   Childcare   School   Bus   Evening   Remark   Missing rate   Workflow
----------------- -------------------- -------- ------------- ----------- -------- ----- --------- -------- -------------- ---------------
 `31 <Detail>`__   *(129) from Eupen*   Male                   No          No       No    No                 25,00          **Confirmed**
 `25 <Detail>`__   *(125) from Eupen*   Male                   No          No       No    No                                **Requested**
 `22 <Detail>`__   *(124) from Eupen*   Female                 No          No       No    No                 25,00          **Trying**
 `19 <Detail>`__   *(121) from Eupen*   Female                 No          No       No    No                 25,00          **Confirmed**
 `13 <Detail>`__   *(118) from Eupen*   Female                 No          No       No    No                                **Requested**
 `10 <Detail>`__   *(116) from Eupen*   Male                   No          No       No    No                 25,00          **Trying**
 `7 <Detail>`__    *(115) from Eupen*   Male                   No          No       No    No                 25,00          **Confirmed**
 `1 <Detail>`__    *(112) from Eupen*   Male                   No          No       No    No                                **Requested**
================= ==================== ======== ============= =========== ======== ===== ========= ======== ============== ===============
<BLANKLINE>


Teachers can see the names of their pupils, but must not see all the clients in
the database.  Accordingly they cannot create new enrolments or new presences
since this would require them to specify a client in the combobox (which would
show all clients). OTHO a teacher *can* edit other fields on these records (e.g.
change the workflow or write a remark).  Since we cannot make the whole record
read-only, we disable the fields.

>>> ar = rt.login("laura")
>>> "pupil" in courses.Enrolment.objects.first().disabled_fields(ar)
True
>>> "partner" in cal.Guest.objects.first().disabled_fields(ar)
True

For a coordinator these fields are not disabled:

>>> ar = rt.login("sandra")
>>> "pupil" in courses.Enrolment.objects.first().disabled_fields(ar)
False
>>> "partner" in cal.Guest.objects.first().disabled_fields(ar)
False