Skip to content

Commit 008924d

Browse files
committed
[IMP] Employees: Update departments
closes #13055 Signed-off-by: Lara Martini (larm) <[email protected]>
1 parent c0f93e0 commit 008924d

File tree

6 files changed

+47
-66
lines changed

6 files changed

+47
-66
lines changed

content/applications/hr/employees/departments.rst

+47-66
Original file line numberDiff line numberDiff line change
@@ -2,40 +2,39 @@
22
Departments
33
===========
44

5-
All employees in the *Employees* app fall under specific departments within a company.
5+
All employees in the **Employees** app fall under specific departments within a company.
66

77
Create new departments
88
======================
99

10-
To make a new department, navigate to :menuselection:`Employees app --> Departments`, then click
11-
:guilabel:`New` in the top-left to reveal a blank department form. Fill out the following
12-
information on the department form:
13-
14-
.. image:: departments/department-form.png
15-
:align: center
16-
:alt: The department for with all fields filled out.
10+
To make a new department, navigate to :menuselection:`Employees app --> Departments`, then click the
11+
:guilabel:`New` button in the top-left corner to reveal a blank department form. Fill out the
12+
following information on the department form:
1713

1814
- :guilabel:`Department Name`: enter a name for the department.
1915
- :guilabel:`Manager`: using the drop-down menu, select the department manager.
2016
- :guilabel:`Parent Department`: if the new department is housed within another department (has a
2117
parent department), select the parent department using the drop-down menu.
22-
- :guilabel:`Custom Appraisal Templates`: if employees in this department require a specific
23-
appraisal form that is different from the default appraisal form, tick the checkbox. If this
24-
option is activated, an :guilabel:`Appraisal Templates` tab appears below the form. This field
25-
**only** appears if the *Appraisals* app is installed.
26-
- :guilabel:`Company`: using the drop-down menu, select the company the department is part of.
18+
- :guilabel:`Company`: using the drop-down menu, select the company the department is part of. This
19+
field only appears in a multi-company database.
20+
- :guilabel:`Color`: select a color for the department. Click the colored box to display all the
21+
color options. Click on a color to select it.
22+
- :guilabel:`Appraisal Templates`: using the drop-down menu, select the appraisal form to be used
23+
for all employee appraisals within this department. If a new appraisal is desired, enter the name
24+
for the appraisal, then click :guilabel:`Create and edit...` to modify the new appraisal form.
25+
This field **only** appears if the **Appraisals** app is installed.
2726
- :guilabel:`Appraisal Survey`: using the drop-down menu, select the default survey to use for the
28-
department when requesting feedback from employees. This field **only** appears if the
29-
*Appraisals* app is installed, **and** the *360 Feedback* option is enabled in the settings.
30-
- :guilabel:`Color`: select a color for the department. Click the default white color box to display
31-
all the color options. Click on a color to select it.
32-
- :guilabel:`Appraisal Templates` tab: this tab **only** appears if the :guilabel:`Custom Appraisal
33-
Templates` options is activated on the form. Make any desired edits to the appraisal form. The
34-
appraisal form is used for appraisals for all employees within this department.
27+
department when requesting feedback from employees within the department. The default options are
28+
:guilabel:`Employee Opinion Form`, :guilabel:`360 Feedback`, and :guilabel:`Employee Appraisal Form`.
29+
This field **only** appears if the **Appraisals** app is installed, *and* the *360 Feedback*
30+
option is enabled in the settings.
3531

3632
After the form is completed, click the :icon:`fa-cloud-upload` :guilabel:`(cloud upload)` icon to
37-
manually save the changes. When saved, a :guilabel:`Department Organization` chart appears in the
38-
top-right of the department card.
33+
manually save the changes. When saved, a :guilabel:`DEPARTMENT ORGANIZATION` chart appears in the
34+
top-right of the department card, illustrating where the department lies in the organization.
35+
36+
.. image:: departments/department-form.png
37+
:alt: The department for with all fields filled out.
3938

4039
.. note::
4140
The form auto-saves while data is entered, however the :guilabel:`Department Organization` chart
@@ -44,27 +43,33 @@ top-right of the department card.
4443
:guilabel:`Departments` dashboard.
4544

4645
.. seealso::
47-
Refer to the :doc:`../appraisals` documentation for more information.
46+
:doc:`../appraisals`
4847

4948
Departments dashboard
5049
=====================
5150

5251
To view the currently configured departments, navigate to :menuselection:`Employees app -->
53-
Departments`. All departments appear in a Kanban view, by default, and are listed in alphabetical
54-
order.
52+
Departments`. All departments appear in a Kanban view, and are listed in alphabetical order.
53+
54+
The default view for the :guilabel:`Departments` dashboard is a :ref:`Kanban view
55+
<employees/department-kanban>`. It is possible to view the departments in two other forms: a
56+
:ref:`list view <employees/department-list>` and a :ref:`hierarchy view
57+
<employees/department-hierarchy>`.
5558

5659
.. image:: departments/departments.png
57-
:align: center
5860
:alt: The departments dashboard view with all the department cards in a Kanban view.
5961

62+
.. _employees/department-kanban:
63+
6064
Kanban view
6165
-----------
6266

63-
Each department has its own Kanban card on the main :guilabel:`Departments` :icon:`oi-view-kanban`
64-
:guilabel:`(Kanban)` dashboard view, that can display the following information:
67+
Each department has its own Kanban card on the main :guilabel:`Departments` dashboard. Each
68+
department card displays the following information, if available:
6569

66-
- Department name: the name of the department.
67-
- Company: the company the department is part of.
70+
- :guilabel:`Name`: the name of the department.
71+
- :guilabel:`Manager`: the name and image of the department manager.
72+
- :guilabel:`Company`: the company the department is part of, including the location icon.
6873
- :guilabel:`Employees`: the number of employees within the department.
6974
- :guilabel:`Appraisals`: the number of appraisals scheduled for employees in the department.
7075
- :guilabel:`Time Off Requests`: the number of unapproved time off requests for employees in the
@@ -74,21 +79,19 @@ Each department has its own Kanban card on the main :guilabel:`Departments` :ico
7479
department :ref:`awaiting approval <time_off/manage-allocations>`. This **only** appears if there
7580
are requests to approve.
7681
- :guilabel:`New Applicants`: the number of :ref:`new applicants <recruitment/new>` for a position
77-
in this department. This **only** appears if there are new applicants.
82+
within the department. This **only** appears if there are new applicants.
7883
- :guilabel:`Expense Reports`: the number of employees in the department with :doc:`open expense
7984
reports to approve <../../finance/expenses/approve_expenses>`. This **only** appears if there are
8085
any expense reports waiting for approval.
81-
- :guilabel:`Absence`: the number of absences for the current day.
86+
- :guilabel:`Absence`: the number of employees with approved time off for the current day.
8287
- Color bar: the selected color for the department appears as a vertical bar on the left side of the
8388
department card.
8489

8590
.. note::
8691
Click on an alert in a department card, such as :guilabel:`Time Off Requests`, to reveal a list
87-
view of the requests to approve. This list includes **all** open requests to approve, not just
88-
from the specific department.
92+
view of the requests to approve for that department
8993

90-
The default view for the :guilabel:`Departments` dashboard is a Kanban view. It is possible to view
91-
the departments in two other forms: a list view and a hierarchy view.
94+
.. _employees/department-list:
9295

9396
List view
9497
---------
@@ -101,51 +104,29 @@ in the top-right corner. The departments appear in a list view, which displays t
101104
The departments are sorted alphabetically by :guilabel:`Department Name`, by default.
102105

103106
.. image:: departments/list.png
104-
:align: center
105107
:alt: The departments presented in a list view.
106108

107-
.. tip::
108-
When in list view, departments can be managed in batch by selecting one or multiple record's
109-
checkbox, then select the :icon:`fa-cog` :guilabel:`Actions` button to reveal a drop-down menu of
110-
actions.
109+
.. _employees/department-hierarchy:
111110

112111
Hierarchy view
113112
--------------
114113

115114
To view the departments in a hierarchy view, click the :icon:`fa-share-alt fa-rotate-90`
116-
:guilabel:`(hierarchy)` icon in the top-right corner. The departments appear in an organizational
117-
chart format, with the highest-level department at the top (typically :guilabel:`Management`), and
115+
:guilabel:`(Hierarchy)` icon in the top-right corner. The departments appear in an organizational
116+
chart format, with the highest-level department at the top (typically `Executive Management`), and
118117
all other departments beneath it. All child departments of the first-level child departments are
119118
folded.
120119

121120
Each department card displays the :guilabel:`Department Name`, the :guilabel:`Manager` (and their
122-
profile image), the :guilabel:`Number of Employees` in the department, and the ability to expand the
123-
department (:guilabel:`Unfold`) if there are child departments beneath it.
121+
profile image), the :guilabel:`Number of Employees` in the department, and the number of any child
122+
departments.
124123

125124
Click the :guilabel:`Unfold` button on a department card to expand it. Once expanded, the
126125
:guilabel:`Unfold` button changes to a :guilabel:`Fold` button. To collapse the department, click
127126
the :guilabel:`Fold` button. Only **one** department *per row* can be unfolded at a time.
128127

129128
Click anywhere on a department card to open the department form. Click the :guilabel:`(#) Employees`
130-
smart button to view a list of all the employees in that department, including all employees in the
131-
child departments beneath it, organized by individual department.
132-
133-
.. example::
134-
In the hierarchy view, if the :guilabel:`(2) Employees` button on the :guilabel:`Management` card
135-
is clicked (the highest-level department card), **all** employees appear in a list view, grouped
136-
by department. This is because **all** departments are children of the :guilabel:`Management`
137-
department.
138-
139-
If the :guilabel:`(3) Employees` button in the :guilabel:`Sales` department card is clicked, the
140-
employees from the :guilabel:`Sales` department, as well as its two child departments
141-
(:guilabel:`East Coast Territory` and :guilabel:`West Coat Territory`), appear in the list.
142-
143-
.. image:: departments/hierarchy.png
144-
:align: center
145-
:alt: The departments presented in a hierarchy view.
146-
147-
.. image:: departments/employee-list.png
148-
:align: center
149-
:alt: The list view of employees for the department that was clicked, including all child
150-
departments.
129+
smart button to view a list of all the employees in that department.
151130

131+
.. image:: departments/hierarchy.png
132+
:alt: The departments presented in a hierarchy view.
Loading
Loading
Binary file not shown.
Loading
Loading

0 commit comments

Comments
 (0)