The Reporting Tool. An Overview of HHAeXchange s Reporting Tool

Transcription

1 HHAeXchange The Reprting Tl An Overview f HHAeXchange s Reprting Tl Cpyright 2017 Hmecare Sftware Slutins, LLC One Curt Square 44th Flr Lng Island City, NY Phne: (718) Fax: (718)

2 Table f Cntents Overview... 1 The Reprting Tl... 2 Reprting Tl User Interface... 2 Creating an Ad Hc Reprt... 4 The Data Surce Sectin... 4 The Fields Sectin... 6 The Filters / Parameters Sectin... 8 The Misc. Sectin The Preview Sectin The User Rights Sectin Cpyright 2017 Hmecare Sftware Slutins, LLC One Curt Square 44th Flr Lng Island City, NY Phne: (718) Fax: (718)

3 Overview The Reprting Tl is an intuitive custmizatin functin which allws Agencies t quickly create ad hc reprts. The tl cntains its wn set f permissins that may be used t determine which users have access t run specific a reprt, edit it, r delete it. This user guide will walk thrugh the prcess f generating a new ad hc reprt and discuss the Reprting Tl s user interface. Further inquiry r supprt cncerning either functin shuld be directed t HHAeXchange Custmer Supprt. The Reprting Tl Page 1 An Overview f HHAeXchange s Reprting Tl Overview Prprietary & Cnfidential

4 The Reprting Tl The fllwing sectin will discuss the Reprting Tls user interface. It will als prvide a high-level descriptin f the infrmatin required t create a new reprt. Reprting Tl User Interface T pen the Reprting Tl, navigate t Reprt > Reprting Tl (ML). The Reprting Tl will pen in a new windw, pictured belw: The Reprting Tl T begin, users will either chse t create a New Reprt using the link in the left-hand clumn, r select an existing reprt t run, edit, r delete, by expanding ne f the Reprt Categries, r the flders cntaining the created ad hc reprts. Create New Reprt Select an Existing Reprt The Reprting Tl Page 2 An Overview f HHAeXchange s Reprting Tl The Reprting Tl Prprietary & Cnfidential

5 The first time this functin is pened, the nly ptin available is New Reprt. This is because new Reprt Categries are created when generating reprts. The prcess f creating new Reprt Categries will be cvered in the Data Surce sectin belw. Reprting Tl, n Reprt Categries Reprts are divided int six sectins, accessible using the tabs circled in the image belw. Fur f these sectins are used t setup the reprt, ne is used t run it, and the last is used t assign users rights t the reprt: Starting frm the left, the reprt tabs include: Reprt Tabs Data Surce: This sectin cntains fields which allws users t created/assign the reprt t a Reprt Categry (ne f the flders in the left-hand clumn f the Reprting Tl). It is als where users will specify which Mdule in the system the reprt shuld gather infrmatin frm. Fields: This sectin is used t define categries int which infrmatin in the reprt will be srted. Filters/Parameters: The Filters/Parameters sectin is used t augment the reprts search results by defining limits r criteria fr the infrmatin cmpiled frm the selected Data Surce. Misc: This sectin allws users t custmize hw the reprt is displayed when run. Preview: The Preview sectin is used t run and exprt the reprt. User Rights: This sectin allws Agencies t permit r restrict access t reprts n a case-bycase basis. When creating, r editing a reprt, users may navigate t any f these sectins by selecting the crrespnding tab, s lng as the required infrmatin n the current tab is cmplete. T prceed thrugh the reprt creatin prcess in a linear manner, use the buttn. The Reprting Tl Page 3 An Overview f HHAeXchange s Reprting Tl The Reprting Tl Prprietary & Cnfidential

6 Creating an Ad Hc Reprt The Data Surce Sectin The Data Surce sectin is used t assign the reprt t an existing, r new, Reprt Categry, and t specify which Mdule in the system the reprt will be retrieving infrmatin. The fields fund under this tab are as fllws: The Data Surce Tab Reprt Categry: The Reprt Categry is a srting tl which allws users t file reprts f a similar nature in a single lcatin. Users may select an existing Reprt Categry frm this field, r create a new ne by selecting the New value. Every Reprt Categry will appear as a flder in the left-hand clumn under the New Reprt link. Reprt Sub Categry: The Reprt Sub Categry is used t create a sub-level within a Reprt Categry. Similar t the Reprt Categry, new values fr this filed may be created by selecting New frm the drpdwn. Values fr this field are tied t the selected Reprt Categry. When entering either a new Reprt Categry r Reprt Sub Categry, the fllwing windw will pen, prmpting users t enter the Categry value: Add New Reprt Categry r Reprt Sub Categry. Nte: The Reprt Categry and Reprt Sub Categry fields are nt required. If n values are selected fr these fields, the reprt will autmatically be filled under a Default flder. Reprt Name: The name f the reprt as it appears within the Reprting Tl. The Reprting Tl Page 4 An Overview f HHAeXchange s Reprting Tl The Reprting Tl Prprietary & Cnfidential

7 Data Surce Categry: This field is used t specify the Mdule within HHAeXchange that the reprt will be gathering infrmatin frm. Data Surce: The Data Surce specifies what infrmatin within the selected Data Surce Categry, r system Mdule, the reprt will gather infrmatin frm. The values in this drpdwn crrelate t the selected Data Surce Categry. Data Surces tied t the Caregiver Data Surce Categry Nte: Further infrmatin cncerning the Data Surce Categries and Data Surces may be fund in the Appendix. The Reprting Tl Page 5 An Overview f HHAeXchange s Reprting Tl The Reprting Tl Prprietary & Cnfidential

8 The Fields Sectin The Fields sectin allws users t specify what infrmatin frm the selected Data Surce is cllected fr the reprt. It als allws users t define hw the Field infrmatin is frmatted, srted, and gruped. The Fields Tab T setup a new Field, users need t define the fllwing: Field: Select a Field fr the reprt frm this drpdwn. Display Name: The name f the selected Field as displayed in the reprt. By default, the Display Name will reflect the selected field. Users may edit this value t suit their needs. Frmat: This drpdwn allws users t specify hw infrmatin in the related field is frmatted. Fr example, fields that cntain date infrmatin may be custmized t display it in ne f several ways. Please nte that the Frmat ptin is nt available fr every Field. Srt: Select this checkbx t srt the results f the field in ascending rder. Selecting this checkbx fr multiple Fields prmpts the system t srt them based n the Sr. N, fund in the leftmst clumn f this sectin. Grup: Select this checkbx t grup reprt infrmatin based n the assciated Field. Fr example, if a user wanted t run a reprt t review Caregivers based n the Office they wrk fr, they culd select the Grup checkbx fr the Office field, ensuring that Caregivers are gruped tgether based n this criterin. Setting: Users may define additinal frmatting requirements by selecting the Settings icn. This includes Italicizing r Blding the field text, adjusting the text alignment r width f the cell, and specifying a Subttal Functin, r adding a cunt t the field. Field Settings The Reprting Tl Page 6 An Overview f HHAeXchange s Reprting Tl The Reprting Tl Prprietary & Cnfidential

9 Fields designated as a Grup cntain additinal Setting ptins, allwing users t als add clrs t the field: Grup Field Settings Add Field: T add mre Fields, click the buttn. Remve Field: T remve unwanted Fields frm the reprt, click the delete icn. Field Arrangement: T rearrange Fields, click the apprpriate arrw buttn. Each psitin up will mve the Field ne place right in the reprt. Add, Delete, r Mve Field The Reprting Tl Page 7 An Overview f HHAeXchange s Reprting Tl The Reprting Tl Prprietary & Cnfidential

10 The Filters / Parameters Sectin The Filters / Parameters sectin is used t set parameters fr the set reprt Fields. Setting up filters and parameters ensures that nly the infrmatin relevant t the user s needs is cllected in the reprt. The Filters / Parameters Sectin T setup a new Filter / Parameter, users need t define the fllwing: Field: Select a Field being used in the reprt frm this drpdwn. Please nte that this drpdwn will allw users t select any field assciated with the Data Surce, even if it is nt being utilized by the reprt. Operatr: Use this field t define the relatin between the selected Field and the set Value. Value(s): Enter the Value f the selected Field here. Depending n the Field, users may have t enter a date, select a predefined value, r enter it manually. Once the Value is set, the new parameter may be saved. If, fr example, a user wanted t create a reprt that reviewed all Caregiver In-Services dating back t June 1 st f 2016, they culd create the fllwing parameter: Is Empty: Select this checkbx t return empty results fr the Field when there is n value. Fr example, if a user wanted t run a reprt t review Alt. Caregiver Cdes, and wants t see thse Caregivers that are missing a value fr this field, they wuld select this checkbx. Hide: Select this checkbx t hide the parameter. This means it will nt appear under the Preview Tab. This will be cvered further in the Preview Sectin belw. The Reprting Tl Page 8 An Overview f HHAeXchange s Reprting Tl The Reprting Tl Prprietary & Cnfidential

11 AND / OR: Users may link multiple parameters using the AND / OR values. Linking tw r mre parameters with the AND value means all the parameters must be satisfied t return results. Fr example, if a user wanted t create a reprt that reviewed all Caregiver In-Services with a tpic f CPR Training AND dating back t June 1 st f 2016 they culd create the fllwing parameters: Date and Tpic Parameter Linking these tw parameters with AND means nly In-Services meeting bth rules will be included in the reprt. If the parameters were linked with an OR, hwever, the reprt wuld find either In-Services dating back t June 1 st, 2016 OR had a tpic f CPR Training. Add Field: T add mre Fields, click the buttn. Remve Field: T remve unwanted Fields frm the reprt, click the delete icn. The Reprting Tl Page 9 An Overview f HHAeXchange s Reprting Tl The Reprting Tl Prprietary & Cnfidential

12 The Misc. Sectin The Misc. sectin is used t custmize the lk and rganizatin f the reprt. It is split int three sectins: Page Settings, Shw/Hide Items, and Clr Settings. The Misc Sectin Custmizable rganizatin and display features include: Page Settings Page Header: Set the text fr the header f the reprt. By default, the Reprt Name will be applied t the field. Fnt size f the header can als be entered here. Please nte that this is a required field, as indicated by the red asterisk *. Page Fter: Set the text fr the fter f the reprt. Fnt size f the fter can als be entered here. Height: Set the height f the Header/Fter. Width: Set the width f the Header/Fter. Shw/Hide Items Shw Page Number: Select this checkbx t include the page numbers in reprts. Page Break After Grups: Select this checkbx t separate Grup by page. Shw Date And Time: Select this checkbx t include the date / time the reprt was run. Display Grup In Different Clumn: Select this checkbx t srt multi-level grupings int different clumns. Display Only Summary: Select this checkbx t review a summary f each fields Subttal Functin. T utilize this functin, ne field must be designated as a Grup and all fields must have a Subttal Functin value. The Reprting Tl Page 10 An Overview f HHAeXchange s Reprting Tl The Reprting Tl Prprietary & Cnfidential

13 Clr Settings Brder Clr: Select the Brder clr arund the reprt. Page Header Clr: Select the Page Header clr. Page Header Fregrund Clr: Select the Page Header Fregrund clr. Page Fter Clr: Select the Page Fter clr. Page Fter Fregrund Clr: Select the Page Fter Fregrund clr. Item Clr: Add a clr t every ther Rw values. Item Fregrund Clr: Select a clr fr the Fregrund. Alternate Item Clr: Add a clr t every ther Rw values. Wrks in tandem with Item Clr field. The Reprting Tl Page 11 An Overview f HHAeXchange s Reprting Tl The Reprting Tl Prprietary & Cnfidential

14 The Preview Sectin The Preview sectin is used t review and exprt reprts. Users may review existing filters setup in the Filters / Parameters sectin. The Preview Sectin The fllwing fields and functins are available in this sectin: Existing Filters: Any Filters / Parameters created fr the reprt will als be listed in this sectin fr review purpses nly. Additinal Filters: Users may create additinal filters in this sectin befre previewing r exprting the reprt. The filters created in this sectin will be cleared nce the user clses the reprt. View: The View functin generates a cpy f the reprt within the tl itself. This allws users t assess the reprt befre exprting it. View Reprt The Reprting Tl Page 12 An Overview f HHAeXchange s Reprting Tl The Reprting Tl Prprietary & Cnfidential

15 Similar t existing HHAeXchange reprts, users can navigate between result pages, exprt, and refresh the data using the tlbar at the tp f the reprt. Reprt Tlbar Add t Reprt Scheduler: This buttn allws users t add the ad hc reprt t the Reprt Scheduler, a sn t be released functin which allws Agencies t define autmated scheduling lgic fr reprts. Exprt t CSV: Click this buttn t exprt the reprt as a CSV file. Please nte that exprting the reprt in this frmat may remve any custmized frmatting/clr ptins applied in the Misc. sectin. Cancel: Click this buttn t exit the reprt. The Reprting Tl Page 13 An Overview f HHAeXchange s Reprting Tl The Reprting Tl Prprietary & Cnfidential

16 The User Rights Sectin The User Rights sectin permits Agencies t set the level f access users have t the reprt. Mre specifically, Agencies may chse which users have permissin t View (r run) the reprt, Edit the reprt details, r Delete the reprt. User Rights Sectin T assign rights t the reprt, users may either: Grant them a user Rle basis, meaning all users under that Rle will receive the permissin: Assign User Rights t Rle Grant them t individual users by expanding each Rle and flagging rights n a case-by-case basis: Assign Rights t individual Users The Reprting Tl Page 14 An Overview f HHAeXchange s Reprting Tl The Reprting Tl Prprietary & Cnfidential