236 lines
9.3 KiB
Markdown
236 lines
9.3 KiB
Markdown
|
# Reporting
|
||
|
|
||
|
The *Reporting* section of the *Payroll* app offers a variety of reports to choose from, organized
|
||
|
by location.
|
||
|
|
||
|
The *Payroll* report, *Work Entry Analysis* report, and *Salary Attachment Report* are default
|
||
|
reports in the *Payroll* app, and are available for all companies, regardless of location.
|
||
|
|
||
|
Beneath the three default reports are all localization-based reports, organized by country, in
|
||
|
alphabetical order. These reports contain all the various information for the offered benefits and
|
||
|
local tax laws.
|
||
|
|
||
|
To view all the available reports for the database, including all the localization-specific ones,
|
||
|
navigate to {menuselection}`Payroll app --> Reporting` to view the available reports in a drop-down
|
||
|
menu. Click on a specific report to view it.
|
||
|
|
||
|
```{image} reporting/reports.png
|
||
|
:align: center
|
||
|
:alt: Report dashboard view showing extra reports for Belgium databases.
|
||
|
```
|
||
|
|
||
|
If a report is unavailable to a user, an {guilabel}`Invalid Operation` pop-up window appears,
|
||
|
stating: {guilabel}`You must be logged in to a (country) company to use this feature`, where
|
||
|
"(country)" is the specific country the company is configured for.
|
||
|
|
||
|
## Default reports
|
||
|
|
||
|
### Payroll
|
||
|
|
||
|
Click on {menuselection}`Payroll app --> Reporting --> Payroll` to display the {guilabel}`Payroll
|
||
|
Analysis` report. This report shows all the payslips generated in the last 365 days, due to the
|
||
|
default {ref}`filter <payroll/filters>`: `Last 365 Days Payslip`.
|
||
|
|
||
|
```{image} reporting/payroll-report.png
|
||
|
:align: center
|
||
|
:alt: Payroll overview report showing payroll for the last 365 days.
|
||
|
```
|
||
|
|
||
|
The report can display metrics for a variety of parameters. Click the {guilabel}`Measures` box to
|
||
|
view a drop-down menu with the various metric options to display. The default options available
|
||
|
include:
|
||
|
|
||
|
- {guilabel}`# Payslip`
|
||
|
- {guilabel}`Basic Wage`
|
||
|
- {guilabel}`Basic Wage for Time Off`
|
||
|
- {guilabel}`Days of Paid Time Off`
|
||
|
- {guilabel}`Days of Unforeseen Absence`
|
||
|
- {guilabel}`Days of Unpaid Time Off`
|
||
|
- {guilabel}`Gross Wage`
|
||
|
- {guilabel}`Net Wage`
|
||
|
- {guilabel}`Number of Days`
|
||
|
- {guilabel}`Number of Hours`
|
||
|
- {guilabel}`Work Days`
|
||
|
- {guilabel}`Work Hours`
|
||
|
- {guilabel}`Count`
|
||
|
|
||
|
{guilabel}`Net Wage` is the default metric for the {guilabel}`Payroll` report.
|
||
|
|
||
|
```{image} reporting/measures.png
|
||
|
:align: center
|
||
|
:alt: The various measures available to display for the Payroll Analysis report.
|
||
|
```
|
||
|
|
||
|
#### Line chart
|
||
|
|
||
|
A line chart is the default view for the *Payroll* report. If a different view is selected, click
|
||
|
the {guilabel}`Line Chart` button (represented by a {guilabel}`📈 (chart increasing)` icon) in the
|
||
|
menu bar to change the view back to a line chart.
|
||
|
|
||
|
Several options are available for the line chart. Click the corresponding button to activate the
|
||
|
selection, and change the way the data is presented. These icons appear at the end of the chart
|
||
|
options. The various options are:
|
||
|
|
||
|
(payroll-stacked)=
|
||
|
|
||
|
- {guilabel}`Stacked`: data is presented with each metric in its own line, "stacked" on top of each
|
||
|
other. This helps visualize the distribution and variances between different categories.
|
||
|
|
||
|
(payroll-cumulative)=
|
||
|
|
||
|
- {guilabel}`Cumulative`: data is presented with each metric on an individual line, with the total
|
||
|
amount calculated by combining all the lines. This provides a comprehensive view of the cumulative
|
||
|
data.
|
||
|
|
||
|
(payroll-descending)=
|
||
|
|
||
|
- {guilabel}`Descending`: data is shown with the largest values on the left side of the chart,
|
||
|
gradually decreasing towards the smallest values on the right side, along the x-axis. This
|
||
|
arrangement helps emphasize trends or outliers at the extremes.
|
||
|
|
||
|
(payroll-ascending)=
|
||
|
|
||
|
- {guilabel}`Ascending`: data is presented with the smallest values on the left side of the chart,
|
||
|
increasing towards the largest values on the right side, along the x-axis. This arrangement can be
|
||
|
useful for highlighting progressive growth or trends.
|
||
|
|
||
|
:::{note}
|
||
|
These options can be combined to create a variety of views.
|
||
|
:::
|
||
|
|
||
|
```{image} reporting/line-chart.png
|
||
|
:align: center
|
||
|
:alt: Menu buttons with the line chart called out, along with the other option buttons.
|
||
|
```
|
||
|
|
||
|
#### Bar chart
|
||
|
|
||
|
To display the data in a bar chart, click on the {guilabel}`Bar Chart` button (represented by a
|
||
|
{guilabel}`📊 (bar chart)` icon) in the menu bar.
|
||
|
|
||
|
Click the {ref}`Stacked <payroll/stacked>` icon to view the bar chart in a stacked format (where
|
||
|
multiple values appear in each column). {ref}`Cumulative <payroll/cumulative>` bar charts are useful
|
||
|
for visualizing the progression over time or other categories.
|
||
|
|
||
|
An option to display the columns in {ref}`Descending <payroll/descending>` or {ref}`Ascending
|
||
|
<payroll/ascending>` order appears at the end of the options.
|
||
|
|
||
|
```{image} reporting/bar-chart.png
|
||
|
:align: center
|
||
|
:alt: Menu buttons with the bar chart called out, along with the other option buttons.
|
||
|
```
|
||
|
|
||
|
:::{tip}
|
||
|
Clicking an option enables it. To turn off the option, click it again. When the option is enabled
|
||
|
the icon appears lighter, with a turquoise outline. When it is inactive, it appears gray, with no
|
||
|
outline.
|
||
|
:::
|
||
|
|
||
|
#### Pie chart
|
||
|
|
||
|
To display the data in a pie chart, click on the {guilabel}`Pie Chart` button (represented by a
|
||
|
{guilabel}`(pie chart)` icon) in the menu bar. There are no additional options available in this
|
||
|
view.
|
||
|
|
||
|
```{image} reporting/pie-chart.png
|
||
|
:align: center
|
||
|
:alt: Menu buttons with the pie chart called out.
|
||
|
```
|
||
|
|
||
|
#### Pivot table
|
||
|
|
||
|
To display the data in a pivot table, click on the {guilabel}`Pivot` button (represented by a
|
||
|
{guilabel}`(pivot)` icon) located in the far-right side of the top menu bar.
|
||
|
|
||
|
The default information displayed includes the number of payslips ({guilabel}`# Payslip`), the
|
||
|
{guilabel}`Net Wage`, the {guilabel}`Gross Wage`, the number of {guilabel}`Days of Paid Time Off`,
|
||
|
and the number of {guilabel}`Days of Unpaid Time Off`. The information is organized by department.
|
||
|
|
||
|
To display more information on the report, click the {guilabel}`Measures` button to reveal a
|
||
|
drop-down menu. Then, click on any other metric to display it on the pivot table.
|
||
|
|
||
|
```{image} reporting/pivot.png
|
||
|
:align: center
|
||
|
:alt: Pivot table view with the various metrics called out.
|
||
|
```
|
||
|
|
||
|
To sort the entries by a specific column, such as {guilabel}`Net Wage`, click on the column name
|
||
|
twice. The first click selects the column, and the second click sorts the information in descending
|
||
|
order.
|
||
|
|
||
|
To export the data in an XLSX format, click the {guilabel}`Download xlsx` button, represented by a
|
||
|
{guilabel}`⬇️ (down arrow above a horizontal bar)` icon, located at the far-right of the available
|
||
|
icons. The information is then downloaded into a spreadsheet.
|
||
|
|
||
|
```{image} reporting/xlsx.png
|
||
|
:align: center
|
||
|
:alt: The menu options with the download button highlighted.
|
||
|
```
|
||
|
|
||
|
Any report can be inserted into a spreadsheet by clicking the {guilabel}`Insert in Spreadsheet`
|
||
|
button. A {guilabel}`Select a spreadsheet to insert your (type of report)` pop-up window appears,
|
||
|
asking which spreadsheet to place the information in. Select an existing spreadsheet or dashboard,
|
||
|
or select a new {guilabel}`Blank spreadsheet`. Click the {guilabel}`Confirm` button to move to a
|
||
|
spreadsheet view with the report added to it.
|
||
|
|
||
|
```{image} reporting/spreadsheet.png
|
||
|
:align: center
|
||
|
:alt: The view of data sent to a spreadsheet.
|
||
|
```
|
||
|
|
||
|
(payroll-doc-storage)=
|
||
|
|
||
|
:::{note}
|
||
|
If the **Documents** app is **not** installed, the {guilabel}`Insert in Spreadsheet` option
|
||
|
places the newly-created spreadsheet in the **Dashboards** app.
|
||
|
|
||
|
If the **Documents** application *is* installed, the spreadsheet has the option to be stored in
|
||
|
either the **Dashboards** app or **Documents** app.
|
||
|
:::
|
||
|
|
||
|
(payroll-filters)=
|
||
|
|
||
|
## Filters
|
||
|
|
||
|
At the top of each report, the default filters are shown inside the {guilabel}`Search...` box.
|
||
|
|
||
|
Click the {guilabel}`⬇️ (down arrow)` icon in the search bar to display the available
|
||
|
{guilabel}`Filters`. Filters show information that match the specific filter parameters.
|
||
|
|
||
|
```{eval-rst}
|
||
|
.. example::
|
||
|
The :guilabel:`Work Entries Analysis` report has two default filters, the `Current month:(Month)
|
||
|
(Year)` filter, and the `Validated` filter.
|
||
|
|
||
|
.. image:: reporting/custom-filter.png
|
||
|
:align: center
|
||
|
:alt: Filters enabled for the Work Entries Analysis report.
|
||
|
|
||
|
The :guilabel:`Payroll` report has only one default filter, the `Last 365 Days Payslip` filter.
|
||
|
|
||
|
The :guilabel:`Salary Attachment Report` has only one default filter, the `Payslip End Date:
|
||
|
(Year)` filter.
|
||
|
```
|
||
|
|
||
|
All reports can include custom filters, or group information, by different metrics (employee,
|
||
|
department, company, etc.).
|
||
|
|
||
|
Some reports have the option to compare the current report to the previous time period or year (a
|
||
|
{guilabel}`Comparison` option).
|
||
|
|
||
|
Click on a parameter to select it and activate it. The report is immediately updated with the new
|
||
|
parameters.
|
||
|
|
||
|
The updated report can be set as a *favorite* report, meaning the parameters are stored for quick
|
||
|
access in the future. To do that, click {guilabel}`Save the current search`, under the
|
||
|
{guilabel}`Favorites` section, located in the search bar drop-down mega menu of filter options.
|
||
|
Doing so reveals two options and a {guilabel}`Save` button.
|
||
|
|
||
|
To set the current report as the default configuration when the report is accessed, check the box
|
||
|
next to {guilabel}`Default filter`. If the current report should be accessible to everyone in the
|
||
|
database, check the box next to {guilabel}`Share`.
|
||
|
|
||
|
Finally, click {guilabel}`Save`, which saves the currently configured report. Then, it appears
|
||
|
beneath the {guilabel}`Favorites` in the search bar drop-down mega menu of filter options.
|
||
|
|