Reports allow a Partner to set up, save, and retrieve Reports that contain details about People on the Customer Account.
To begin, tap or click on the Reports icon from the Customer Dashboard. Then tap/click the People icon on the Reports page.
Initially, the view for each Report will display an upper area with two tabs on the left side and potentially two buttons on the right side of the window above a lower area containing the Saved Reports and Retrieve Reports display.
People Reports
People Reports allow a User to run Reports based on details of the People entered into the Customer Account.
Adding a People Report
To create a new People Report, first tap or click the Add Report button in the People Report tab. This is located on the right side of the People Reports tab. This will pop out a sidebar where you can enter the information for the new People Report.
When creating a new People Report, there are a number of settings that must be configured.
Report Name - Enter a descriptive Name for the People Report.
Partition - If a partition is to be included as a filter in the Report, tap or click the Partition field to select the Partition.
Filters - Select from the following filter options for the Report. For some filters (First Name, Last Name, Email), a Partner can select between including the selected item(s) or excluding the selected item(s) from the Report. For more information regarding each Filter option, please refer to People Reports Filter Options. Once the filter has been configured, tap or click Save.
Output - After selecting the Filters for the People Report, a Partner can choose the details that will be output when the Report is previewed or submitted. The Output Filters for a People Report are the Details available for a Person on the Customer Account. These Output Filters can be selected by tapping or clicking the Edit Fields button.
After setting up the Filters and Output settings, tap or click the Save button in the Lower Right corner of the pop-out window.
Credentials Reports
Credential Reports allow a User to run Reports based on the Credentials entered for People on the Customer Account.
Adding a Credential Report
To create a new Credential Report, first tap or click the Add Report button in the Credential Report tab. This is located on the right side of the Credential Reports tab. This will pop out a sidebar where you can enter the information for the new Credential Report.
When creating a new Credential Report, there are a number of settings that must be configured.
Name - Assign a descriptive Name for the Credential Report.
Partition - If a Partition is to be included as a filter in the Report, select one from the Partition drop-down field.
Filters - Tap or click the Filters field to select the Credential data is included in the Credential Report. With the exception of 'Creation Date' and 'Last Scan Date', these filters can be set so the filtered results are 'One Of' or 'Not One Of' the selected filter items.
|
Credential Number or Range - Select specific Credential numbers, Credential number range, or which contain certain numbers. |
|
Credential Type - Select between Card, Bluetooth, or Mobile App credentials. |
|
Facility Code - Select between any Facility Codes entered on the Customer Account |
|
Creation Date - Select the creation timeframe for those Credentials which will be displayed in the Report. |
| Last Scan Date - Select the timeframe when a Credential was most recently used for display in the Report. |
|
Credential Status - Select the status of Credentials added to the Customer Account.
|
Output - After selecting the Filters for the Event Report, a Partner can choose the details that will be output when the Report is submitted. These Output Filters can be selected by tapping or clicking the Edit Fields button.
After setting up the Filters and Output settings, tap or click the Save button in the Lower Right corner of the pop-out window.
Event Reports
Event Reports allow a User to run Reports based on the Events that have occurred on the Customer Account.
Adding an Event Report
To create a new Event Report, first tap or click the Add Report button in the Event Report tab. This is located on the right side of the Event Reports tab. This will pop out a sidebar where you can enter the information for the new Event Report.
When creating a new Event Report, there are a number of settings that must be configured.
Name - Assign a descriptive Name for the Events Report.
Partition - If a partition is to be included as a filter in the report, select one from the Partition drop-down field.
Filters - Select from the following filter options for the Report. For all filters besides Occurred, a Partner can select between including the selected item(s) or excluding the selected item(s) from the Report.
|
Occurred - Select a date or date range for the Events Report. |
|
Events - Select the Events that will be used to filter the Event Report by tapping or clicking the name of the Events. Specific Events types can be searched and selected by tapping or clicking in the field with a magnifying glass. For more information regarding Event types, please refer to the article about Event Types. |
|
Results - Select the Results that will be used to filter the Event Report by tapping or clicking the name of the Result. Specific Results can be searched and selected by tapping or clicking in the field with a magnifying glass. For more information regarding Result types, please refer to the article about Results Types. |
|
Devices - Select the Devices that will be used to filter the Event Report by tapping or clicking the name of the Device. Specific Devices can be searched and selected by tapping or clicking in the field with a magnifying glass. |
| Persons - Select the People that will be used to filter the Event Report by tapping or clicking the name of the Person. Specific People can be searched and selected by tapping or clicking in the field with a magnifying glass. |
|
Cards - Select the Cards that will be used to filter the Event Report by tapping or clicking the Card number. Specific Cards can be searched and selected by tapping or clicking in the field with a magnifying glass. |
|
Connections - Select the Connections that will be used to filter the Event Report by tapping or clicking the name of the Connections. Specific Connections can be searched and selected by tapping or clicking in the field with a magnifying glass. |
|
Groups - Select the Groups that will be used to filter the Event Report by tapping or clicking the name of the Groups. Specific Groups can be searched and selected by tapping or clicking in the field with a magnifying glass. |
Output - After selecting the Filters for the Event Report, a Partner can select the details that will be output when the Report is submitted.
After setting up the Filters and Output selections, a Partner can Save the Event report by clicking Save in the lower right corner of the window.
Previewing/Submitting a Report
After selecting the Filters and Output details, a Partner can then Preview the selected report. This is done by tapping or clicking the Preview Report button. This Preview will display up to 50 entries based on the Output filters configured for the Report. When Filters or Output selections are changed or new events have occurred, you will need to click Preview again to update the preview of the report.
After Previewing a Report, tapping or clicking the Submit button will submit the Report so that the Report result can be opened again later in the Retrieve Reports tab. If a Report was previewed without being saved, the Report will be generated for retrieval without a descriptive name. Once a Report has been submitted, a Partner can retrieve the Report from the Retrieve Report tab. The time that the report is retrievable is subject to the Reporting Plan.
Retrieve Reports
After a Report has been Submitted, the Report can later be retrieved, within the limits of the Reporting Plan for the Customer Account. Any previously Submitted Reports will be displayed in the Retrieve Reports tab. Tapping or clicking the downward arrow icon will allow a Partner to download the Report in multiple formats (JSON, HTML, or CSV). Tapping or clicking on the magnifying glass icon next to a Submitted Report will give a Partner the ability to view the Report and the information about when the Report was submitted.
Comments
0 comments
Please sign in to leave a comment.