Creating Reports

From Subscribe-HR Wiki Help
Jump to: navigation, search
(Creating Reports)
(46 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{page.name: Core Human Resources: Creating Reports - Subscribe-HR Wiki}}
+
{{page.name: Reports: Creating Reports - Subscribe-HR Wiki}}
 
{{page.head: Creating Reports}}
 
{{page.head: Creating Reports}}
  
 
__TOC__
 
__TOC__
  
==Creating Reports in the Human Resources Module==
+
==Creating Reports==
The Subscribe-HR Software system is Object orientated and this is the same for Reports.
+
The Subscribe-HR Software system is Object Orientated and this is the same for Reports.
 
The ability to add particular fields into a report solely relies on that field being part of the object.
 
The ability to add particular fields into a report solely relies on that field being part of the object.
 
<br>
 
<br>
 
<br>
 
<br>
Example: We want to create a report that lists all Benefits grouped by department.
+
# After logging into the Subscribe-HR HCM Platform, select "REPORTS" from the left hand navigation located under "TOOLS".  
<br>
+
# You will arrive on the "STANDARD" Tab.
I would not get very far if I created this report under the Benefits Object, as the Benefits Object only provides me limited information on the benefit itself and not who has the benefit assigned.
+
# Click on a Standard Report to open this Report.
<br>
+
# You will then arrive on the "GENERAL" tab.
It is important to know what type of report you want to create and what Object the data is found in.
+
# If you want to create a "NEW" Report. You will need to select the "MY REPORTS" tab, when you arrive from the "REPORTS" option when you first click on this option from the left hand side navigation under "TOOLS".
 
+
# When you are creating a new report: Select the '''Public''' check box<br>By selecting the Public check box you are making all information in this report available to all users, regardless of Self Service permission settings. <br>By removing the check from the Public check box you are making this report private and only available to users with permissions.
# After logging into the Subscribe-HR portal, select the Human Resources TAB.
+
# Select the '''Report Type'''  from the drop-down, such as ‘Human Resources’, ‘Recruitment’, etc. This selection is to assist in finding the correct type of report, but doe not mechanically affect the report.
# Select '''New Report.'''<br>[[File:list_report.gif]]
+
# Enter the '''Report Name'''. Ensure the report name is descriptive.
# Select the '''create''' button.
+
# Select the '''Object''' this Report is to be based upon.
# Select the '''Public''' check box<br>By selecting the Public check box you are making this report available to all users.<br>By removing the check from the Public check box you are making this report private and only available to users with permissions.
+
# If you want to retrieve data from more than one Object (Table), tick the '''Join Tables (Advanced)'''.
# Enter the '''Report name'''. Ensure the report name is descriptive.
+
# Select the Object
+
 
# Select the '''Display Empty Records''' if required. This displays all entries in an object and sub-object relationship, so that all entries in the object can be viewed even if they do not have an entry in the sub-object.
 
# Select the '''Display Empty Records''' if required. This displays all entries in an object and sub-object relationship, so that all entries in the object can be viewed even if they do not have an entry in the sub-object.
# Enter a report description if required
+
# If you do not want headers for columns in your exported reports, select '''Remove Column Headers(Export Only)'''.
# Select the '''Save''' button.
+
# Enter the '''Export File Name'''. Any Exports or scheduled Exports will use this name.
# Select the Fields TAB<br>You should see a Report Object drop down. In the drop down are all the Tables that are available under the selected Object.<br>[[File:report_object.gif]]<br>On the left is a list of all Fields available from the selected Table in the Report Object drop down.<br>[[File:report_tf.gif]]<br><br>In the centre of the screen you should see 2x headings '''Fields''' and '''Groups'''<br>The fields that appear under the '''Fields''' heading are fields that you are showing on your report.<br><br>The Groups heading allows for a '''Group By''' function, where by adding a field under the Groups heading would cause all fields to show on the report and be in groups by the field that appears under the Groups heading.
+
# Enter a report '''Description''' if required.
# Add a field to the report by selecting the [[File:F.gif]] next to the desired field.<br>To group by a field select the [[File:G.gif]] next to the desired field.<br>To remove a field select the [[File:X.gif]] next to the desired field.
+
# Enable the '''Report Scheduler''' if required. <br>If Report Scheduler is selected, then you will get the following options:
# Select the '''Save''' button.
+
# Select the '''Send with Group Permission''' drop-down option. This will send the report with this groups specific permission settings to each recipient.
 +
# Select the '''Format''' you want the report delivered in.
 +
# Select the '''Frequency''' you would like to send report.
 +
# Select the '''Recipients''' by selecting the user.
 +
# Select any  permission '''Groups''' you would like to send the export to.
 +
# '''Save''' Report before Joining Tables or setting up fields.
  
===Adding a field from a related Object===
+
'''Reports created in this way, can be found in the standard reports tab, or in the "MY REPORTS" tab, in the Reporting Tool.'''
# To add a field from a related object Select the Object from the '''Report Object''' drop down. The Fields on the left of the screen will refresh.
+
# Add a field to the report by selecting the [[File:F.gif]] next to the desired field.<br>To group by a field select the [[File:G.gif]] next to the desired field.<br>To remove a field select the [[File:X.gif]] next to the desired field.
+
# Select the '''Save''' button.
+
  
====Total====
+
===Join Tables===
The '''Total''' column is populated with a check box when a numeric field is added.<br>[[File:numeric.gif]]<br>
+
# After ticking '''Join Tables (Advanced)''' & then saving the Report, this will then activate the Join Tables SubTab.
If the check box is selected this will provide a total of all numeric values at the bottom of the report, if the report is grouped by the total is placed at the bottom of each grouping.
+
# On the Join Tables SubTab, enter Table (Object) name (or part of) you wish to include in the Join. 
 +
# Click on table, then drag line to next table to join them. 
 +
# Then you will be prompted to select required '''From Field''' & '''To Field''' to join, then the '''Join Type''':  <br>'''LEFT JOIN''' shows all records from left table regardless of the existence of matching records in the right table.  <br>'''RIGHT JOIN''' means opposite of LEFT JOIN. It shows all records from the second (right) table and only matching records from first (left) table.  <br>'''INNER JOIN''' shows all records where there is at least one match in either table.
 +
# Click '''OK''' & repeat process for other Tables to include. 
 +
# To remove a Link between Object, simply click on the dot where the link connects to the Object & drag & drop it away from the Object.
 +
# '''Save''' changes, before moving onto the Fields SubTab.
 +
 
 +
===Fields===
 +
# Select the Fields SubTab.
 +
# To find the required Field (Element), start typing in the Fields section. This will show in a dropdown of all available Fields matching the search criteria.  You can reorder the Fields selected by Drag & Drop.
 +
# Optionally select the field(s) to '''Group''' the Report by. 
 +
# '''Save''' changes.
 +
 
 +
====Totals & Aggregate Functions====
 +
# Click on the '''Pencil Icon''' on the right of the Field. Select from the dropdowns, the '''Basic Function''' (Average, Count, Max, Min or Sum). 
 +
# The '''Calculate Total''' field is populated with a check box when a numeric field is added. If the check box is selected this will provide a total of all numeric values at the bottom of the report, if the report is grouped by a field, then the total is placed at the bottom of each grouping.
 +
# '''Save''' changes.
  
 
====Formatting====
 
====Formatting====
The '''Formatting''' column is populated with a drop down when a date field is added<br>[[File:date_field.gif]]<br>If formatting is selected such as Month Name this will only display the Month name in the report and not the dd/mm/yyyy
+
# Click on the '''Pencil Icon''' on the right of the Field. The '''Date Formatting''' field is populated with a drop down when a date field is added. <br>If formatting is selected such as Month Name this will only display the Month name in the report and not the dd/mm/yyyy.
 +
# '''Save''' changes.
  
 
====Sorting====
 
====Sorting====
The '''Sorting''' column is populated with a drop down for all fields.<br>[[File:sort.gif]]<br>Selecting the sort order of '''Descending''' for a field will cause the report to output the data in descending order highest to lowest.  
+
# Click on the '''Pencil Icon''' on the right of the Field. The '''Sorting Order''' field is populated with a drop down for all fields. <br>Selecting the sort order of either '''Ascending''' or '''Descending''' for a field will cause the report to output the data in either an Ascending or Descending order highest to lowest.
 +
# '''Save''' changes.
  
===Condition===
+
====Condition====
 
Conditions are used to filter your report based on a criteria.
 
Conditions are used to filter your report based on a criteria.
Example: You have created a report that lists all employees names, age and its grouped by department, but you only want to see data for 2x locations.
+
# Down the bottom of the '''Fields''' Sub option there is the '''Condition''' section.
 
+
# Select the Condition TAB.
+
# We will see '''Add condition''' drop down.
+
 
# Select the field you wish to filter by.
 
# Select the field you wish to filter by.
# Select the filter type. The filter type varies depending on what field you are filtering on.<br>The most common are Equals To, Not Equals To, Is Last, This Last, Is Next
+
# Select the filter type. The filter type varies depending on what field you are filtering on. <br>The most common are '''Equals To''', '''Not Equals To''', '''Is Last''', '''This Last''', '''Is Next'''.
 
# Select or Enter the value you are filtering on.
 
# Select or Enter the value you are filtering on.
# Select the '''Save''' button.
+
# For more than one Condition an '''AND''' or a '''OR''' operator can be selected.
 +
# You can select multiple results for some fields by clicking on '''Options''' (if available) as shown below. 
 +
# To group Condition clauses together, brackets can be used. This is done by clicking on the "Greater Than" icon to the right of the Ffeld in the condition clause. Clicking on the "Less Than" icon will remove a Bracket.  <br>The below Condition clause can be written as:  <br>:IF ('''Leaver''' = No OR '''Last Day of Work''' is Last Week) AND '''Department'''=”''???list of Department???''”
 +
# '''Save''' changes.
  
 
===View Report===
 
===View Report===
Line 58: Line 76:
 
<br>
 
<br>
 
Only reports that are '''Grouped'' by can generate a Graph, otherwise a plain table of results will be generated.
 
Only reports that are '''Grouped'' by can generate a Graph, otherwise a plain table of results will be generated.
 +
# Select the '''View Report''' SubTab. 
  
# Select the View Report TAB.
 
 
====Graph Types====
 
====Graph Types====
 
The Graph type option will not be shown if a report has not been '''Grouped''' by.
 
The Graph type option will not be shown if a report has not been '''Grouped''' by.
 
Selecting a Graph type will change the graph drawn on the report.
 
Selecting a Graph type will change the graph drawn on the report.
 +
 +
====Graph Record Count====
 +
Selecting the '''Graph Record Count''' will show the number of records being reported on.  <br>
  
 
====Export Options====
 
====Export Options====
Selecting an export option and then selecting the Export link will cause the report to be exported into the chosen format.
+
Selecting an '''Export Option''' and then selecting the '''Export''' link will cause the report to be exported into the chosen format (Excel, PDF, etc).
  
 
====Do Not Export Graph====
 
====Do Not Export Graph====
Selecting this checkbox will cause the graph to be excluded when exporting to the chosen format.
+
Selecting this checkbox will cause the graph to be excluded when exporting the report to the chosen format.
  
 +
==Scheduling Reports==
 +
 +
Reports can be scheduled to be sent to user roles or for specific users. These will be sent in an exported format via email to users. <br>
 +
If sent to a user, the exported file will only show information that the user has permissions to see within the Subscribe-HR system.<br>
 +
To set up report scheduling: <br>
 +
# After logging into the Subscribe-HR HCM Platform, select "REPORTS" which is located under "TOOLS". From the left hand navigation.
 +
# Select <b>Standard</b> or <b>MyReports</b>.
 +
# Select the desired report.
 +
# Tick the <b>Enable Scheduler</b> checkbox.
 +
# Choose which Permission group to send the report in, using the '''Send with Permission Group''' drop-down.
 +
# Choose the <b>Format</b> that the report will be output in. This can be in excel, or as a .csv.
 +
# Select the <b>Frequency</b> of the Report emails. Daily, Weekly, Fortnightly or Monthly.
 +
# Choose the <b>Recipients</b> of the report. If selecting <b>Specific Users</b>, you will need to select those users from the multiselect. You can also select <b>Groups</b> to send to, instead of or in addition to the users.. If selecting <b>FTP</b>, you will need to select which FTP from those that have been setup in the Maintenance module, [[FTP|here]].
 +
# Select the <b>Save</b> button
 +
 +
 +
<br>
 +
<br>
 
[[File:subscribehr_logo.gif]]
 
[[File:subscribehr_logo.gif]]

Revision as of 01:37, 5 December 2018

Creating Reports

The Subscribe-HR Software system is Object Orientated and this is the same for Reports. The ability to add particular fields into a report solely relies on that field being part of the object.

  1. After logging into the Subscribe-HR HCM Platform, select "REPORTS" from the left hand navigation located under "TOOLS".
  2. You will arrive on the "STANDARD" Tab.
  3. Click on a Standard Report to open this Report.
  4. You will then arrive on the "GENERAL" tab.
  5. If you want to create a "NEW" Report. You will need to select the "MY REPORTS" tab, when you arrive from the "REPORTS" option when you first click on this option from the left hand side navigation under "TOOLS".
  6. When you are creating a new report: Select the Public check box.
    By selecting the Public check box you are making all information in this report available to all users, regardless of Self Service permission settings.
    By removing the check from the Public check box you are making this report private and only available to users with permissions.
  7. Select the Report Type from the drop-down, such as ‘Human Resources’, ‘Recruitment’, etc. This selection is to assist in finding the correct type of report, but doe not mechanically affect the report.
  8. Enter the Report Name. Ensure the report name is descriptive.
  9. Select the Object this Report is to be based upon.
  10. If you want to retrieve data from more than one Object (Table), tick the Join Tables (Advanced).
  11. Select the Display Empty Records if required. This displays all entries in an object and sub-object relationship, so that all entries in the object can be viewed even if they do not have an entry in the sub-object.
  12. If you do not want headers for columns in your exported reports, select Remove Column Headers(Export Only).
  13. Enter the Export File Name. Any Exports or scheduled Exports will use this name.
  14. Enter a report Description if required.
  15. Enable the Report Scheduler if required.
    If Report Scheduler is selected, then you will get the following options:
  16. Select the Send with Group Permission drop-down option. This will send the report with this groups specific permission settings to each recipient.
  17. Select the Format you want the report delivered in.
  18. Select the Frequency you would like to send report.
  19. Select the Recipients by selecting the user.
  20. Select any permission Groups you would like to send the export to.
  21. Save Report before Joining Tables or setting up fields.

Reports created in this way, can be found in the standard reports tab, or in the "MY REPORTS" tab, in the Reporting Tool.

Join Tables

  1. After ticking Join Tables (Advanced) & then saving the Report, this will then activate the Join Tables SubTab.
  2. On the Join Tables SubTab, enter Table (Object) name (or part of) you wish to include in the Join.
  3. Click on table, then drag line to next table to join them.
  4. Then you will be prompted to select required From Field & To Field to join, then the Join Type:
    LEFT JOIN shows all records from left table regardless of the existence of matching records in the right table.
    RIGHT JOIN means opposite of LEFT JOIN. It shows all records from the second (right) table and only matching records from first (left) table.
    INNER JOIN shows all records where there is at least one match in either table.
  5. Click OK & repeat process for other Tables to include.
  6. To remove a Link between Object, simply click on the dot where the link connects to the Object & drag & drop it away from the Object.
  7. Save changes, before moving onto the Fields SubTab.

Fields

  1. Select the Fields SubTab.
  2. To find the required Field (Element), start typing in the Fields section. This will show in a dropdown of all available Fields matching the search criteria. You can reorder the Fields selected by Drag & Drop.
  3. Optionally select the field(s) to Group the Report by.
  4. Save changes.

Totals & Aggregate Functions

  1. Click on the Pencil Icon on the right of the Field. Select from the dropdowns, the Basic Function (Average, Count, Max, Min or Sum).
  2. The Calculate Total field is populated with a check box when a numeric field is added. If the check box is selected this will provide a total of all numeric values at the bottom of the report, if the report is grouped by a field, then the total is placed at the bottom of each grouping.
  3. Save changes.

Formatting

  1. Click on the Pencil Icon on the right of the Field. The Date Formatting field is populated with a drop down when a date field is added.
    If formatting is selected such as Month Name this will only display the Month name in the report and not the dd/mm/yyyy.
  2. Save changes.

Sorting

  1. Click on the Pencil Icon on the right of the Field. The Sorting Order field is populated with a drop down for all fields.
    Selecting the sort order of either Ascending or Descending for a field will cause the report to output the data in either an Ascending or Descending order highest to lowest.
  2. Save changes.

Condition

Conditions are used to filter your report based on a criteria.

  1. Down the bottom of the Fields Sub option there is the Condition section.
  2. Select the field you wish to filter by.
  3. Select the filter type. The filter type varies depending on what field you are filtering on.
    The most common are Equals To, Not Equals To, Is Last, This Last, Is Next.
  4. Select or Enter the value you are filtering on.
  5. For more than one Condition an AND or a OR operator can be selected.
  6. You can select multiple results for some fields by clicking on Options (if available) as shown below.
  7. To group Condition clauses together, brackets can be used. This is done by clicking on the "Greater Than" icon to the right of the Ffeld in the condition clause. Clicking on the "Less Than" icon will remove a Bracket.
    The below Condition clause can be written as:
    :IF (Leaver = No OR Last Day of Work is Last Week) AND Department=”???list of Department???
  8. Save changes.

View Report

The View Report TAB allows us to generate and view the report. We can export to PDF or Excel file formats.
Only reports that are 'Grouped by can generate a Graph, otherwise a plain table of results will be generated.

  1. Select the View Report SubTab.

Graph Types

The Graph type option will not be shown if a report has not been Grouped by. Selecting a Graph type will change the graph drawn on the report.

Graph Record Count

Selecting the Graph Record Count will show the number of records being reported on.

Export Options

Selecting an Export Option and then selecting the Export link will cause the report to be exported into the chosen format (Excel, PDF, etc).

Do Not Export Graph

Selecting this checkbox will cause the graph to be excluded when exporting the report to the chosen format.

Scheduling Reports

Reports can be scheduled to be sent to user roles or for specific users. These will be sent in an exported format via email to users.
If sent to a user, the exported file will only show information that the user has permissions to see within the Subscribe-HR system.
To set up report scheduling:

  1. After logging into the Subscribe-HR HCM Platform, select "REPORTS" which is located under "TOOLS". From the left hand navigation.
  2. Select Standard or MyReports.
  3. Select the desired report.
  4. Tick the Enable Scheduler checkbox.
  5. Choose which Permission group to send the report in, using the Send with Permission Group drop-down.
  6. Choose the Format that the report will be output in. This can be in excel, or as a .csv.
  7. Select the Frequency of the Report emails. Daily, Weekly, Fortnightly or Monthly.
  8. Choose the Recipients of the report. If selecting Specific Users, you will need to select those users from the multiselect. You can also select Groups to send to, instead of or in addition to the users.. If selecting FTP, you will need to select which FTP from those that have been setup in the Maintenance module, here.
  9. Select the Save button




Subscribehr logo.gif