diff --git a/content/applications/hr/time_off/management.rst b/content/applications/hr/time_off/management.rst index 070ab07345d..e7bd4b46782 100644 --- a/content/applications/hr/time_off/management.rst +++ b/content/applications/hr/time_off/management.rst @@ -4,20 +4,23 @@ Management .. _time_off/approvals: -Time off and allocation requests undergo an approval process before being granted. Requests either -need one or two approvals, if any, depending on how the specific type of time off is configured. All -these configurations can be found under the *Management* section of the **Time Off** application. +Time off requests and allocation requests undergo an approval process before being granted. Requests +either need one or two approvals, if any, depending on how the specific type of time off is +configured. All these configurations can be found under the *Management* section of the **Time Off** +application. -Only users who can :ref:`approve allocation and time off requests ` see the -:guilabel:`Management` section in the **Time Off** application. +.. note:: + The *Management* section in the **Time Off** application is **only** visible to users who can + :ref:`approve allocation requests and time off requests `. .. _time_off/manage-time-off: -Manage time off -=============== +View time off requests +====================== -To view time off requests that need approval, navigate to :menuselection:`Time Off app --> -Management --> Time Off`. Doing so reveals the :guilabel:`All Time Off` page. +To view time off requests waiting for approval, navigate to :menuselection:`Time Off app --> +Management --> Time Off`. Doing so reveals the *All Time Off* page. All time off requests appear in +a default Kanban view. The only time off requests that are visible on this page belong to employees the user either has :guilabel:`Time Off Officer` or :guilabel:`Administrator` access rights for in the **Time Off** @@ -28,118 +31,120 @@ Me`. This filter only presents time off requests that need to be approved for cu the user's team, with a status of either :guilabel:`To Approve` or :guilabel:`Second Approval`. On the left side of the :guilabel:`All Time Off` page, there are various grouping options that can -be used to narrow down the presented time off requests, located beneath the :guilabel:`Status` and -:guilabel:`Department` headings. +be used to narrow down the presented time off requests, located beneath the :icon:`fa-folder` +:guilabel:`Status` and :icon:`fa-users` :guilabel:`Department` headings. -Since only time off requests that need to be approved are shown, the only :guilabel:`Status` options -are :guilabel:`All`, :guilabel:`To Approve`, and :guilabel:`Second Approval`. +Since only time off requests that need to be approved are shown, the only :icon:`fa-folder` +:guilabel:`Status` options are :guilabel:`All`, :guilabel:`To Approve`, and :guilabel:`Second +Approval`. The various departments the user is a member of, and manages employees under, also appear on the -left side of the page, under :guilabel:`Departments`. - -.. note:: - If no requests fall under one of the status options or departments, that status or department is - **not** visible on the left-side menu. +left side of the page, under :icon:`fa-users` :guilabel:`Departments`. To only display time off requests for specific departments, click on the :guilabel:`Department` on the left-hand side of the page. Only requests within the selected department are then presented. -The status column displays the status of each request, with the status highlighted in a specific -color. - -The :guilabel:`To Approve` and :guilabel:`Second Approval` requests are highlighted in yellow, and -are the only ones that appear in the list by default. - If the :icon:`fa-filter` :guilabel:`Waiting For Me` filter is removed, all statuses appear. -:guilabel:`Approved` requests are highlighted in green, :guilabel:`To Submit` (drafts) requests are -highlighted in blue, and the :guilabel:`Refused` requests are highlighted in gray. +.. note:: + If no requests fall under one of the status options or departments, that status or department is + **not** visible on the left-side menu. -To approve a time off request, click the :icon:`fa-thumbs-up` :guilabel:`Approve` button at the end -of the line. +.. image:: management/time-off-requests.png + :alt: Time off requests with the filter, groupings, and status sections highlighted. -To validate a time off request that has already been approved, and is waiting on a second approval, -click the :icon:`fa-check` :guilabel:`Validate` button at the end of the line. +Approve or refuse time off requests +=================================== -To refuse a request, click the :icon:`fa-times` :guilabel:`Refuse` button at the far end of the -line. +To approve or refuse a time off request, navigate to :menuselection:`Time Off app --> Management --> +Time Off`. At the end of each time off request Kanban card, two buttons appear: an +:guilabel:`Approve` or :guilabel:`Validate` button, depending on the status of the request, and a +:guilabel:`Refuse` button. -.. image:: management/time-off-requests.png - :alt: Time off requests with the filter, groupings, and status sections highlighted. +To approve a time off request, click the :guilabel:`Approve` button. To validate a time off request +that has already been approved and is waiting on a second approval, click the :guilabel:`Validate` +button. To refuse a request, click the :guilabel:`Refuse` button. -For more details, click anywhere on the time off request line (except for the :icon:`fa-thumbs-up` -:guilabel:`Approve`, :icon:`fa-check` :guilabel:`Validate` icon, and :icon:`fa-times` -:guilabel:`Refuse` buttons). Doing so loads that specific time off request form. Depending on the -rights of the user, changes can be made. +If more information is needed before approving a time off request, click anywhere on the Kanban card +(except for the :guilabel:`Approve`, :guilabel:`Validate`, or :guilabel:`Refuse` buttons). Doing so +loads the detailed time off request form. -To modify the request, make any desired changes to the form. All changes are automatically saved. +Depending on the rights of the user, changes can be made. To modify the request, make any desired +changes to the form. All changes are automatically saved. It is also possible to approve, validate, or refuse the request from this form. Click the :guilabel:`Approve` button to approve, the :guilabel:`Validate` button to validate, or the :guilabel:`Refuse` button to refuse the request. +Once a request has been approved, validated, or refused, the Kanban card disappears from the default +:guilabel:`All Time Off` page. To view *all* requests, including approved and refused requests, +clear the default filters in the search bar. + +.. image:: management/detailed-request.png + :alt: The detailed time off request form for the employee George Davis. + .. _time_off/manage-allocations: -Manage allocations -================== +View allocation requests +======================== -To view allocations that need approval, navigate to :menuselection:`Time Off app --> Management --> -Allocations`. Doing so reveals the :guilabel:`Allocations` page. +To view allocation requests waiting for approval, navigate to :menuselection:`Time Off app --> +Management --> Allocations`. Doing so reveals the :guilabel:`Allocations` page. All allocation +requests appear in a default Kanban view. -The user is only presented with allocations for employees they have either :guilabel:`Time Off -Officer` or :guilabel:`Administrator` access rights for in the **Time Off** application. +The only allocation requests that are visible on this page belong to employees the user either has +:guilabel:`Time Off Officer` or :guilabel:`Administrator` access rights for in the **Time Off** +application. + +The default filters on the :guilabel:`Allocations` page are :icon:`fa-filter` :guilabel:`First +Approval` and :icon:`fa-filter` :guilabel:`My Team`. These filters only present allocation requests +that need to be approved for current employees on the user's team, awaiting approval or validation. -The default filters configured on the :guilabel:`Allocations` page are :guilabel:`First Approval` -and :guilabel:`My Team`. These default filters only present employees that the user manages and are -awaiting their first approval. Approved and refused allocation requests are not shown. +On the left side of the :guilabel:`Allocations` page, there are various grouping options that can be +used to narrow down the presented allocation requests, located beneath the :icon:`fa-folder` +:guilabel:`Status` and :icon:`fa-users` :guilabel:`Department` headings. -The left side of the :guilabel:`Allocations` page has various grouping options to narrow down the -presented allocation requests. +Since only allocation requests that need to be approved are shown, the only :icon:`fa-folder` +:guilabel:`Status` options are :guilabel:`All`, :guilabel:`To Approve`, and :guilabel:`Approved`. -The :guilabel:`Status` options are: :guilabel:`All`, :guilabel:`To Approve`, :guilabel:`Refused`, -and :guilabel:`Approved`. Click on a specific :guilabel:`Status` to view only requests with that -specific status. +The various departments the user is a member of, and manages employees under, also appear on the +left side of the page, under :icon:`fa-users` :guilabel:`Departments`. -To view all allocation requests, regardless of status, click :guilabel:`All` under the -:guilabel:`Status` heading. +To only display allocation requests for specific departments, click on the :guilabel:`Department` on +the left-hand side of the page. Only requests within the selected department are then presented. -It is also possible to display allocation requests by department. Click on the desired -:guilabel:`Department` on the left side of the :guilabel:`Allocations` page, to only present -allocations for that specific department. +If the :icon:`fa-filter` :guilabel:`First Approval` and :icon:`fa-filter` :guilabel:`My Team` +filters are removed, all statuses appear. .. note:: - The groupings on the left side **only** present allocation requests that fall under the default - filters of :guilabel:`My Team` and :guilabel:`Active Employee`, if those default filters are not - removed from the :guilabel:`Search...` bar. Only the statuses for allocation requests that fall - under those filters are presented on the left side. - - For example, if there are no requests with a status of :guilabel:`To Submit`, that status option - does not appear in the left-hand side of the :guilabel:`Allocations` page. + If no requests fall under one of the status options or departments, that status or department is + **not** visible on the left-side menu. - All departments for the user's employees appear in the list. If there are no allocation requests - that fall under that department matching the preconfigured filters, the list is blank. +.. image:: management/allocations-requests.png + :alt: Allocations dashboard showing unapproved allocation requests. - It is always possible to remove any of the preconfigured filters, by clicking the - :icon:`fa-times` :guilabel:`(remove)` icon on the specific filter to remove it. +Approve or refuse allocation requests +===================================== -The status column displays the status of each request, with the status highlighted in a specific -color. The :guilabel:`To Approve` requests are highlighted in yellow, and if the default -:guilabel:`First Approval` filter is removed, the :guilabel:`Approved` requests are highlighted in -green, and the :guilabel:`Refused` requests are highlighted in gray. +To approve or refuse an allocation request, navigate to :menuselection:`Time Off app --> Management +--> Allocations`. At the end of each allocation request Kanban card, two buttons appear: an +:guilabel:`Approve` or :guilabel:`Validate` button, depending on the status of the request, and a +:guilabel:`Refuse` button. -To approve an allocation request, click the :icon:`fa-thumbs-up` :guilabel:`Approve` button at the -end of the line. To refuse a request, click the :icon:`fa-times` :guilabel:`Refuse` button. +If more information is needed before approving an allocation request, click anywhere on the Kanban +card (except for the :guilabel:`Approve`, :guilabel:`Validate`, or :guilabel:`Refuse` buttons). +Doing so loads the detailed allocation request form. -.. image:: management/allocations.png - :alt: Allocations with the filter, groupings, and status sections highlighted. +Depending on the rights of the user, changes can be made. To modify the request, make any desired +changes to the form. All changes are automatically saved. -If more details are needed, click anywhere on the allocation request line (except for the -:icon:`fa-thumbs-up` :guilabel:`Approve` or :icon:`fa-times` :guilabel:`Refuse` buttons) to view the -specific request in detail, via the allocation request form. +It is also possible to approve, validate, or refuse the request from this form. Click the +:guilabel:`Approve` button to approve, the :guilabel:`Validate` button to validate, or the +:guilabel:`Refuse` button to refuse the request. -Depending on the rights of the user, changes can be made to the allocation request form that -appears. To modify the request, make any desired changes to the form. All changes are automatically -saved. +Once a request has been approved, validtaed, or refused, the Kanban card disappears from the default +:guilabel:`Allocations` page. To view *all* requests, including approved and refused requests, clear +the default filters in the search bar. -It is also possible to approve or refuse the request from this form. Click the :guilabel:`Approve` -button to approve, or the :guilabel:`Refuse` button to refuse the request. +.. image:: management/approve-allocation.png + :alt: An allocation request in detail. diff --git a/content/applications/hr/time_off/management/allocations-requests.png b/content/applications/hr/time_off/management/allocations-requests.png new file mode 100644 index 00000000000..99882b3a955 Binary files /dev/null and b/content/applications/hr/time_off/management/allocations-requests.png differ diff --git a/content/applications/hr/time_off/management/allocations.png b/content/applications/hr/time_off/management/allocations.png deleted file mode 100644 index 30465bfa460..00000000000 Binary files a/content/applications/hr/time_off/management/allocations.png and /dev/null differ diff --git a/content/applications/hr/time_off/management/approve-allocation.png b/content/applications/hr/time_off/management/approve-allocation.png new file mode 100644 index 00000000000..87716090754 Binary files /dev/null and b/content/applications/hr/time_off/management/approve-allocation.png differ diff --git a/content/applications/hr/time_off/management/detailed-request.png b/content/applications/hr/time_off/management/detailed-request.png new file mode 100644 index 00000000000..b1cff854bb6 Binary files /dev/null and b/content/applications/hr/time_off/management/detailed-request.png differ diff --git a/content/applications/hr/time_off/management/time-off-requests.png b/content/applications/hr/time_off/management/time-off-requests.png index 70467200d9c..446f1ce4152 100644 Binary files a/content/applications/hr/time_off/management/time-off-requests.png and b/content/applications/hr/time_off/management/time-off-requests.png differ