OBJECTIVE: This article provides an overview of Ad Hoc Reports in HHAeXchange.
Table of Contents:
- Data Source Section
- Fields Section
- Filters/Parameters Section
- Misc Section
- Preview Section
- User Rights Section
Data Source Section
The Data Source section is used to assign the report to a new or existing Report Category, and to specify from which Module in the system the report is retrieving information. Refer to table under the image for field descriptions.
The Data Source Tab
Sorting tool allowing to file similar reports in a single location. Select an existing Report Category from this field or create a new category by selecting the New value. Every Report Category appears as a folder in the left navigation panel under the New Report link.
When creating a new Report Category, the Add New Category window opens, prompting for a Category Name, as seen in the image on the right.
Adding a New Category
|Report Sub Category
Create a sub-level within a Report Category. As with Report Category, new values for this field can be created by selecting New from the dropdown. Values for this field are tied to the selected Report Category.
NOTE: The Report Category and Report Sub Category fields are not required. If no values are selected for these fields, the report automatically is filed under a Default folder.
|The name of the report as it appears within the Reporting Tool.
|Data Source Category
|Specify the Module within HHAX from where the report collects information.
|Specify what information within the selected Data Source Category, or system Module, the report is collecting information from. These values correlate to the selected Data Source Category.
Data Sources tied to the Caregiver Data Source Category
The Fields section is used to specify what information from the selected Data Source is collected for the report. This section is also used to define how the Field information is formatted, sorted, and grouped.
The Fields Tab
Define the following to set up a new Field.
|Select a Field for the report.
|The name of the selected Field as displayed in the report. By default, the Display Name reflects the selected field. This value can be edited as needed.
Specify how information in the related field is formatted. For example, fields containing date information can be customized to display in one of several ways.
NOTE: The Format option is not available for every Field.
|Select this checkbox to sort the results of the field in ascending order. Selecting this checkbox for multiple Fields prompts the system to sort based on the Sr. No, located in the left-most column of this section.
|Select this checkbox to group report information based on the associated Field. For example, to run a report to review Caregivers based on the Office they work for, then select the Group checkbox for the Office field, ensuring that Caregivers are grouped together based on this criterion.
Select the icon to define additional formatting requirements to include italicizing or bolding the field text, adjusting alignment or cell width, and specifying a Subtotal Function as well as adding a count to the field.
Fields defined as a Group contain additional Setting options to also add colors.
Group Field Setting
|Add Row (Button)
|Click the Add Row button to add more fields.
|Click on the delete () icon to remove unwanted fields from the report.
|Field Arrangement (Arrow buttons)
|Use the up/down arrow buttons to rearrange fields. Click the up arrow to move the field one place right in the report.
Add, Delete, or Move Field
The Filters / Parameters section is used to set parameters for the set report Fields. Setting up filters and parameters ensures that only relevant information is collected in the report.
The Filters / Parameters Section
Define the following to set up a new Filter / Parameter.
|Select a Field from the dropdown. This dropdown allows the selection of any field associated with the Data Source, even if not used by the report.
|Define the relation between the selected Field and the set Value.
Enter the Value of the selected Field. Depending on the selected Field, enter a date, select a predefined value, or manually enter.
Once the Value is set, the new parameter can be saved. The following image illustrated the selected Value for a report that provides all Caregiver In-Services dating back to 06/01/2016:
|Select this checkbox to return “empty” results for the Field when there is no value. For example, to run a report to review Alt. Caregiver Codes and see Caregivers who are missing a value for this field.
|Select this checkbox to hide the parameter; does not appear under the Preview Tab. Refer to the Preview Section below.
|AND / OR
|Link multiple parameters using the AND / OR values. Linking two or more parameters with the AND value means all the parameters must be satisfied to return results. If the parameters are linked with an OR, then the report yields either one parameter OR the other.
|Click the Add Row button to add more Fields.
|Click on the delete icon to remove unwanted Fields from the report.
The Misc section is used to customize the look and organization of the report. This section is divided into three sub-sections: Page Settings, Show/Hide Items, and Color Settings.
The Misc Section
The Preview section is used to review and export reports and to review existing filters set up in the Filters / Parameters section.
The Preview Section
|All Filters / Parameters created for the report are listed in this section for review purposes only.
|Create additional filters in this section before previewing or exporting the report. The filters created in this section are cleared once the report is closed.
Generates a copy of the report within the tool allowing assessment of the report before exporting it. Use the toolbar within the report to navigate between result pages, export, and refresh the data.
|Add to Report Scheduler
|Use this button to add the ad hoc report to the Report Scheduler, a function which allows Agencies to define automated scheduling logic for reports.
|Export to CSV
Click this button to export the report as a CSV file.
NOTE: Exporting the report in this format may remove any customized formatting/color options applied in the Misc Section.
|Click to exit the report.
User Section Rights
The User Rights section permits Agencies to set the level of user access/permissions for the report. From here, Agencies can select the user permissions to View/Run, Edit, and/or Delete the report. Rights are granted on a Role basis or by individual user.
User Rights Section
To grant report rights on a Role basis, select the View, Edit, and/or Delete checkboxes at the Role level, as seen in the following image. Selecting at a Role level assigns rights to the entire Role group.
Assign User Rights to Role
To grant report rights to an individual user, click on the plus to expand the Role category and locate the individual(s). Select the View, Edit, and/or Delete checkboxes, as seen in the following image.
Assign Rights to Individual Users
Source: HHAeXchange Support Center