| Integrator | Admin | Manager | Reporter |
Reports allow a user to Create, Save, Schedule, Retrieve, and Download Reports that contain details about the Customer Account.
To begin, select either People, Credentials, or Events depending on the type of Report you'd like to create.
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, select the + Add Report button. This is located on the right side of the People Reports tab. This will open a drawer where you can enter the information for the new 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 any additional Partitions have been created besides the Default Partition, the Partition field will be shown.
Filters - Select from the following filter options for the Report. Once the filter has been configured, select Save.
| First Name - Enter a First Name or partial name to filter the People present on the Customer Account. Select the Condition of the filter. If the filter must be case-sensitive, toggle on Case Sensitive. |
| Last Name - Enter a Last Name or partial name to filter the People present on the Customer Account. Select the Condition of the filter. If the filter must be case-sensitive, toggle on Case Sensitive. |
| Email - Enter an Email Address or partial email to filter the People present on the Customer Account. Select the Condition of the filter. If the filter must be case-sensitive, toggle on Case Sensitive. |
| Groups - Select which Groups to filter on the People present on the Customer Account. Select whether the users are a Member Of or Not Member Of for the filtered data. |
| Cards - Enter a Card Number or partial card number to filter the People present on the Customer Account. Select between Equals or Does Not Equal for the filtered data. |
| Facility Codes - Select which Facility Codes were configured for physical Credentials under a Person on the Customer Account that are displayed in the filtered data. Choose between Equals or Does Not Equal for the filtered data. |
| Partitions - Select which Partitions to filter on the People present on the Customer Account. Select whether the users are a Member Of or Not Member Of for the filtered data. |
| Mobile Credentials - Select whether the People present on the Customer Account have different Mobile Credential types (Bluetooth or Mobile App). The Credential Status can also be filtered (Accepted or Pending). |
| Enabled - Select to view the status of the People present on the Customer Account as either Enabled or Disabled. |
Output - After selecting the Filters for the People Report, the user can choose the desired details that will be displayed when the Report is previewed or submitted. The Output Filters for a People Report are the details on each Person on the Customer Account. These Filter Outputs can be selected by selecting the Edit Fields button.
Schedule - Automate the creation and delivery of a Report via email, eliminating the need to generate reports manually each time. Reports can be scheduled to run on a Daily, Weekly, or Monthly basis and sent to one or more Recipients.
- Daily - Report will be generated Daily at the specified time
- Weekly - Report will be generated Weekly on the specified day and time
- Monthly - Report will be generated Monthly on the specified date and time
- No Schedule - This Report will generate once, at the time of creation
After selecting Edit Recipients, a list of potential users will be displayed. To add a user as a Recipient, select the email, then Save.
The Report will not be available to view in the email, but the link will take you to the Retrieve Report page. The newest Report will be at the top of the page. Recipients must have a PDK.io login to access the Report. More details can be found here regarding Scheduled Reports.
After setting up the Filters, Output, and Schedule, select Save or Preview Report.
Credential Reports
Credential Reports allow a user to run Reports based on the Credentials entered on the Customer Account.
Adding a Credential Report
To create a new Credential Report, select the + Add Report button. This is located on the right side of the Credential Reports tab. This will open a drawer where you can enter the information for the new 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 any additional Partitions have been created besides the Default Partition, the Partition field will be shown.
Filters - Select the Filters field to select the Credential data to be 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.
| Credential Number or Range - Select specific Credential Number, Credential Number Range, or those that contain certain numbers. |
| Credential Type - Select between Card, Bluetooth, or Mobile credentials. |
| Facility Code - Select between any Facility Codes entered on the Customer Account. |
| Creation Date - Select the Creation Date of the credentials. |
| Last Scan Date - Select the Last Scan Date of the credentials. |
|
Credential Status - Select the Credential Status of the credentials.
|
Output - After selecting the Filters for the Credential Report, the user can choose the desired details that will be displayed when the Report is previewed or submitted. These Filter Outputs can be selected by selecting the Edit Fields button.
Schedule - Automate the creation and delivery of a Report via email, eliminating the need to generate reports manually each time. Reports can be scheduled to run on a Daily, Weekly, or Monthly basis and sent to one or more Recipients.
- Daily - Report will be generated Daily at the specified time
- Weekly - Report will be generated Weekly on the specified day and time
- Monthly - Report will be generated Monthly on the specified date and time
- No Schedule - This Report will generate once, at the time of creation
After selecting Edit Recipients, a list of potential users will be displayed. To add a user as a Recipient, select the email, then Save.
The Report will not be available to view in the email, but the link will take you to the Retrieve Report page. The newest Report will be at the top of the page. Recipients must have a PDK.io login to access the Report. More details can be found here regarding Scheduled Reports.
After setting up the Filters, Output, and Schedule, select Save or Preview Report.
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, select the + Add Report button. This is located on the right side of the Event Reports tab. This will open a drawer 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 Event Report.
Partition - If any additional Partitions have been created besides the Default Partition, the Partition field will be shown.
Filters - Select from the following filter options for the Report. For all filters besides Occurred, a user can select between including or excluding the selected item(s) (One Of, Not One Of) from the Report.
| Occurred - Select a date or date range. |
| Events - Select the Event type. For more information regarding Event types, please refer to the article about Event Types. |
| Results - Select the Result type. For more information regarding Result types, please refer to the article about Result Types. |
| Battery Charge Level Change - Select the Battery Charge Level status. |
| Devices - Select the Device's name. |
| People - Select the Person's name. |
| Cards - Select the physical credential number. |
| Connections - Select the Connection's name. |
| Groups - Select the Group's name. |
Output - After selecting the Filters for the Event Report, the user can choose the desired details that will be displayed when the Report is previewed or submitted. These Filter Outputs can be selected by selecting the Edit Fields button. When the Report is downloaded, the Details can be exported into separate columns by toggling on Export Details into Columns.
Schedule - Automate the creation and delivery of a Report via email, eliminating the need to generate reports manually each time. Reports can be scheduled to run on a Daily, Weekly, or Monthly basis and sent to one or more Recipients.
Daily - Report will be generated Daily at the specified time
Weekly - Report will be generated Weekly at the specified day and time
Monthly - Report will be generated Monthly on the specified date and time
No Schedule - This Report will generate once, at the time of creation
After selecting Edit Recipients, a list of potential users will be displayed. To add a user as a Recipient, select the email, then Save.
The Report will not be available to view in the email, but the link will take you to the Retrieve Report page. The newest Report will be at the top of the page. Recipients must have a PDK.io login to access the Report. More details can be found here regarding Scheduled Reports.
After setting up the Filters, Output, and Schedule, select Save or Preview Report.
Previewing or Submitting a Report
After selecting the desired Filters and Output details, a user can then Preview the selected report. This is done by selecting the Preview Report button. This Preview will display up to 50 entries based on the selected Output filters. When Filters or Output selections are changed, or new events have occurred, you will need to select Preview again to update the preview of the report.
After Previewing a Report, select the Submit button so the Report result can be opened again later or downloaded in the Retrieve Reports tab. If a Report was previewed and submitted without being saved, the Report will be generated without a descriptive name. The time that the report is retrievable is subject to the Reporting Plan.
NOTE: Each Saved Report will display the Name, Schedule, Last Run, and Next Run.
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. Selecting the downward arrow icon will allow a user to download the Report (JSON, HTML, or CSV). Selecting the magnifying glass icon next to a Submitted Report will allow a user to view the Report and information about when it was submitted.
Comments
0 comments
Please sign in to leave a comment.