Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions content/applications/hr/employees/new_employee.rst
Original file line number Diff line number Diff line change
Expand Up @@ -258,6 +258,8 @@ this section to be visible.
add the location, or :guilabel:`Create and edit...` to add the location, assign a :guilabel:`Work
Address`, and a :guilabel:`Cover Image`.

.. _employees/approvers:

APPROVERS
---------

Expand Down
3 changes: 2 additions & 1 deletion content/applications/hr/time_off.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,8 @@ Enter the name for the particular type of time off in the blank line at the top
:guilabel:`Time Off Requests` and :guilabel:`Allocation Requests` sections **must** be
configured.

.. _time_off/time-off-requests:

Time off requests section
*************************

Expand Down Expand Up @@ -123,7 +125,6 @@ This section determines how allocation requests are handled for this time off ty
time off approver <employees/work-info-tab>` and the :ref:`Time Off Officer
<time_off/time-off-officer>` are required to approve the allocation request.


Configuration section
*********************

Expand Down
74 changes: 41 additions & 33 deletions content/applications/hr/time_off/request_time_off.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,41 @@
Request time off
================

Once time off has been allocated to an employee, a request to use it can be submitted.
When employees wish to take time off, they first submit a time off request through the **Time Off**
application. Once their request has been submitted, it is then reviewed by either the employee's
manager or their time off officer (depending on who the employee's :ref:`time off approver is
<employees/approvers>`).

Time off can be requested in one of two ways: either from the main *Time Off* application
:guilabel:`Dashboard` (:menuselection:`Time Off app --> My Time --> Dashboard`), or from the
:guilabel:`My Time Off` dashboard view (:menuselection:`Time Off app --> My Time --> My Time Off`).
.. note::
If the time off type the employee is requesting :ref:`does not require approval
<time_off/time-off-requests>`, the time off is automatically approved, and does not need to be
reviewed.

To create a new request for time off, click the :guilabel:`New` button on either the main *Time Off*
:guilabel:`Dashboard` or the :guilabel:`My Time Off` dashboard, in the default list view.
Submit time off request
=======================

.. note::
Both :guilabel:`New` buttons allow the user to request time off, but when requested from the
:guilabel:`Dashboard`, a :guilabel:`New Time Off` request form appears in a pop-up window. When
requested from the :guilabel:`My Time Off` list view, the screen navigates to a new time off
request page, instead.
To request time off, click the :guilabel:`New` button in the top-left corner of the **Time Off** app
dashboard, and a :guilabel:`New Time Off` pop-up form loads.

Fill out the :ref:`fields on the form <time_off/fields>`, and then click :guilabel:`Save & Close` to
submit the request.

.. tip::
Requesting time off can be done either form the main **Time Off** app dashboard, or by navigating
to :menuselection:`Time Off --> My Time --> My Time Off`, and clicking :guilabel:`New`.

.. image:: request_time_off/new-time-off.png
:alt: A time off request for three hours of vacation time off.

.. _time_off/fields:

Time off fields
---------------

Enter the following information on the :guilabel:`New Time Off` request form:

- :guilabel:`Time Off Type`: select the type of time off being requested from the drop-down menu.
- :guilabel:`Dates`: enter the dates that the time off falls under. There are two fields to
- :guilabel:`Time Off Type`: Using the drop-down menu, select the type of time off being requested.
- :guilabel:`Dates`: Enter the dates that the time off falls under. There are two fields to
populate: the start and end dates. Click on either date field and a popover calendar appears.

Click on the start date, then click on the end date. The selected start and end dates are circled,
Expand All @@ -36,35 +52,27 @@ Enter the following information on the :guilabel:`New Time Off` request form:
If the selected :guilabel:`Time Off Type` is configured to have the time off taken in hours, the
following two fields also appear:

- :guilabel:`Half Day`: if the time off request is for a half day, tick this checkbox. When this
- :guilabel:`Half Day`: If the time off request is for a half day, tick this checkbox. When this
is selected, the second date field disappears, and is replaced with a drop-down menu. From that
drop-down menu, select either :guilabel:`Morning` or :guilabel:`Afternoon` to indicate which
half of the day is being requested.
- :guilabel:`Custom Hours`: if the time off requested is not a whole or half day, tick this
half of the day is being requested off.
- :guilabel:`Custom Hours`: If the time off requested is not a whole or half day, tick this
checkbox. If selected, a :guilabel:`From` and :guilabel:`To` field appears beneath this option.
Using the drop-down menu, select the start and end time for the time off request.

- :guilabel:`Duration`: this field updates automatically once the :guilabel:`Date` section is
completed. If the :guilabel:`Date` section is modified, this section automatically updates to
reflect the total time off requested. This field is in either hours or days, depending on how the
selected :guilabel:`Time Off Type` is configured.
- :guilabel:`Description`: enter a description for the time off request. This should include any
- :guilabel:`Requested (Days/Hours)`: This field updates automatically once the :guilabel:`Date`
section is completed. If the :guilabel:`Date` section is modified, this section automatically
updates to reflect the total time off requested. This field is in either hours or days, depending
on how the selected :ref:`Time Off Type <time_off/time-off-types>` is configured.
- :guilabel:`Description`: Enter a description for the time off request. This should include any
details that managers and approvers may need to approve the request.
- :guilabel:`Supporting Document`: this field only appears if the :guilabel:`Time Off Type` selected
allows for the attachment of documents. Click the :guilabel:`Attach File` button, and a file
explorer window appears.
- :guilabel:`Supporting Document`: This field **only** appears if the :ref:`Time Off Type
<time_off/time-off-types>` selected allows for the attachment of documents. Click the
:icon:`fa-paperclip` :guilabel:`Attach File` button, and a file explorer window appears.

Navigate to the desired files that should be attached, select them, then click The
:guilabel:`Open` button. The files then appear on the time off request form. Multiple documents
can be attached, if necessary.

If the request was created from the :guilabel:`Dashboard`, click the :guilabel:`Save & Close` button
to save the information, and submit the request.

If the form was completed from the :guilabel:`My Time Off` list view, the information is
automatically saved as it is entered. However, the form can be saved manually at any time by
clicking the :icon:`fa-cloud-upload` :guilabel:`(cloud upload)` icon.

.. image:: request_time_off/time-off-request.png
:align: center
:alt: A time off request form filled out for an employee home sick for two days with the flu.
:alt: A time off request form filled out for an employee home sick with the flu.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.