PDK io - Reports

Building Reports Overview 

Table of Contents 

Filters

Details

Results

Sort by

Audit Log Entries

REFRESH

EXPORT

Delete Reports

People Reports

Reports can be created for any single or combination of events, results, or details that occur in the system. 

All Permission roles have access to the Reports features.

Click the Reports icon  in the Cloud Node Appliances home screen to create a custom report. Any previously created reports are listed in alpha order in this screen. Existing reports may be clicked on and edited if desired.

Click the + icon in the lower right to create a custom report. The Report screen is displayed.

Building reports is done by selecting options from the many filters programmed in the software. By choosing specific filters, just about any type of custom report can be generated.

Name 

Assign a unique descriptive name for the report.

Partition

If partitions have been created, the Partition field is shown. Click inside the Partition field or on the down arrow to select a partition from the drop-down menu. A Default partition exists but the Partition field does not appear unless and until an initial partition is created. 

See Partitions for additional information. 

Filters

Create report filters using the following features: Date, Events, Details, Results, and Sort by. Clicking anywhere to the right of the Filters heading or on the down arrow alternately toggles the Filters features off and on. 

Date - Date Range

A date range is necessary when building a report. Choose a preprogrammed timeframe from the drop-down list:

• Today
• Yesterday
• This Week
• Last Week
• This Month
• Last Month
• Custom Period

Or select a custom date range. Enter a date or a date range using the Date Range drop-down menu or the Start Date and End Date fields. A specific time range filter may be chosen from the menu.

Any of the pre-programmed timeframes generate recurring reports. For example, if Last Month is selected, the report will show the log information from the last calendar month. At the beginning of each month, this report will then regenerate.

Date - Start Date / End Date

Click on the respective Start Date and End Date down arrows to select a Start and End date from each of the calendars, or enter a date in each field using the MM/DD/YYYY format (Month, Day, Year). 

Events

Events can be filtered based on specific actions that have occurred in the system, such as doors Open, Credentials Input, Door Propped Alarm, and Access Allowed.

Click the + icon next to Events to select from the list of Events. Check the various type(s) of events to be included in the report, or specific events from a long list can be searched using the Filter field. 

• AutoOpen Enabled - Auto open became active on the device.
• AutoOpen Disabled - Auto open became deactivated on the device.
• Credentials Input - If any keypad input credentials occur with the # (pound) key
• Open (DPS) - The door position sensor detected the door open (unlocked)
• Close (DPS) - The door position sensor detected the door closed (locked)
• Request to Exit Open - The request to exit was triggered on the door (unlocked)
• Request to Exit Closed - The request to exit was cleared on the door (locked)
• Door Propped Alarm - The door propped alarm has triggered for the door. 
• Door Propped Alarm Clear - The door propped alarm has been cleared for the device.
• All Prop Clear - All door propped alarms have been cleared.
• Door Forced Alarm - The door forced alarm has triggered for the device.
• Communication Loss - Communication to the connection has been lost. 
• Communication Loss Clear - Communication to the connection has been re-established.
• Known Person - Reports individuals who are in the system and accessed a device
• No Person Associated with Credentials - An unknown credential was scanned and access was implicitly denied.
• Access Denied - A known credential was scanned and access was denied.
• Access Allowed on Multiswipe - A known credential was scanned and access was allowed with multiple swipes.
• Access Allowed - A known credential was scanned and access was allowed. 
• Duress PIN Entered - A duress PIN was used to authenticate at the reader.
• Any Duress PIN Entered - When any duress PIN is used to authenticate at the reader.
• Entity Added - Addition of an entity
• Entity Modified - When an entity is modified 
• Entity Removed - When an entity is removed
• Open (Lock) - When a door is opened (unlocked)
• Close (Lock) - When a door is closed (locked)
• Try to Open - Open attempt made
• Try to Open for Some Time - Open attempt made for an extended time
• Do Not Disturb - Toggles the “Do Not Disturb” status of the door/relay. On DND status, the door is locked and unresponsive to regular access attempts until the DND status is removed.
• Force Toggle - Toggles the current state of the door/relay to open/closed. If a door is closed (locked), toggles to open (unlocked). If a door is open (unlocked), toggles to closed (locked). 
• Door Forced Alarm Clear - The door forced alarm for the device has cleared.
• Card Scan Error - Bad data was received from the card reader connected to the door.
• Virtual Credentials Input - Upon input of virtual credentials
• Delay Open (Lock) - Delayed open (unlock) on a door/relay
• Delay Close (Lock) - Delayed close (lock) on a door/relay
• Open/Close (Lock) - Device toggled open (unlocked) or closed (locked)

Click SELECT.

Details 

Details is selected to filter logs based on Users, Card numbers, Group access, Specific doors, and Connection types. Click the + icon next to Details to select from the list of Details. By default, the PERSONS tab is shown. Click on the various tabs in the Add Details screen to add report details. 

PERSONS Tab 

Users who have been added are listed in this PERSONS tab screen. Check the desired people to be included in the report, or for a long list of people, search for a person using the Filter field. Click SELECT. 

CARDS Tab 

Cards that have been added are listed in this CARDS tab screen. Check the desired cards to be included in the report, or for a long list of card numbers, search for a card using the Filter field. Click SELECT.

GROUPS Tab 

Groups that have been added are listed in this GROUPS tab screen. Check the desired groups to be included in the report, or for a long list of groups, search using the Filter field. Click SELECT.

DOORS Tab 

Doors that have been added are listed in this DOORS tab screen. Check the desired doors to be included in the report, or for a long list of doors, search using the Filter field. Click SELECT.

CONNECTIONS Tab

Connections/controllers that have been added are listed in this CONNECTIONS tab screen. Check the desired connections to be included in the report, or for a long list of connection types, search using the Filter field. Click SELECT. 

Results 

Click the + icon next to Results to select from the list of Results options. These are the Action events that occur. Check the listed result types to be included in the report. Specific result options can be searched using the Filter field. 

To fine tune the report, filter the event results. Results can be filtered by making specific selections. A few example results are Known Person, Access Denied, Send Email, and Lockdown On.

• Known Person - Reports those individuals who are in the system and who accessed a device
• No Person Associated with Credentials - An unknown credential was scanned and access was implicitly denied.
• Access Denied - A known credential was scanned and access was denied.
• Access Allowed on Multiswipe - A known credential was scanned and access was allowed with multiple swipes.
• Access Allowed - A known credential was scanned and access was allowed.
• Send Email - When an email is sent
• Do Not Disturb - Toggles the “Do Not Disturb” status of the door/relay. On DND status, the door is locked and unresponsive to regular access attempts until the DND status is removed.
• Force Toggle - Toggles the current state of the door/relay to open/closed. If a door is closed (locked), toggles to open (unlocked). If the door is open (unlocked), toggles to closed (locked). 
• Force Open - Holds the door/relay (that the event is created on) in the Open (unlocked) position and will not close (lock) unless Force Closed. 
• Force Close - Clears the Force Open (unlocked) status and locks the door.
• Open - Opens (unlocks) the door/relay
• Close - Closes (locks) the door/relay 
• Lockdown On - Lockdown (doors locked) of selected devices is set to On. All doors are locked.
• Lockdown Off - Lockdown (doors locked) of selected devices is set to Off. All doors are unlocked. 
• Delay Open - A time delay for opening (unlocking) the door/relay
• Delay Close - A time delay for closing (locking) the door/relay
• Open/Close - Opens (unlocks) the door/relay and sends a close (lock) after a delayed time period 

Click SELECT.

Sort by 

Sort by Occurred Time options are:

• ASC - Ascending (Sort in ascending order – A to Z.)
• DESC - Descending (Sort in descending order – Z to A.)

Audit Log Entries

Based on the selections made in the above Filters fields, the desired report information is displayed beneath the Audit Log Entries field. Click REFRESH to update the report information after any Filters changes are made. 

REFRESH 

To generate the report, simply select REFRESH. All logs will be pulled based on the information selected. When Report selections or changes have been made in any of the Filters fields, click REFRESH to update and generate the most recent audit log additions / changes / updates to the report. A list of the additions and changes that have been made are shown. A report is pulled showing their activity, such as doors that have been accessed.  

By clicking on each of the column headings (Occurred, Info Text, Event, and Result), an edit field opens that enables entering search text to filter and refine the contents of the listed column topic. This can be useful when there is a list of audit log items to refine to a particular date and time, specific text content, a particular event, or result. To the far right of each of the log entries is the DETAILS link. Clicking this link displays the Log Entry Details window.

Occurred

Date and time when the event occurred in the form: YYYY-MM-DD HH:MM:SS (Year, Month, Day, Hour, Minutes, Seconds)

Info Text

Information on the person / device / input that was affected by the addition / modification. 

Event

A brief description of the added or modified event that occurred. 

Result

The result of the event.

DETAILS

To the far right of each log entry is the DETAILS link. Clicking this link displays the Log Entry Details window showing the Person Name and the Door Name.

EXPORT 

Click EXPORT to export the report as an HTML or CSV file. By default, the report file is saved to the Downloads folder as YourReportName.html or YourReportName.csv, depending on the format selected and the assigned file name. 

Click SAVE. The requested report information is saved and listed by the report name in the Reports screen. Multiple reports are listed in alpha order. 

NOTE: As is the case with most of these screens in this application, the SAVE button does not appear unless and until additions/changes have been made to the information in that screen. 

Example: Recurring Report

1. To build a recurring report that shows all users who have been granted access at the front door within the last week, give the report a name, such as Access Allowed at Front Door.

2. Choose a date range such as Last Week.

3. To filter the results, choose Events, then select Credentials Input.

4. Under Results, select Access Allowed.

5. From Details, navigate to the DOORS tab, and choose the front door.

6. Hit REFRESH to view the logs.

The logs can be exported as HTML or a CSV file. By saving the report (hit SAVE), the logs can be accessed at any time from the main Reports screen.

Delete Reports

In the Reports screen, hover the cursor over the report to be deleted and click the trash icon. 

People Reports

Select Reports  from the Cloud Node Appliances home screen.

Select the People  option in the Reports screen.

In the People Reports screen, select the + icon in the lower right.  

 

Assign a descriptive Name for the People Report you want to create.

Partitions

If a partition is to be included in the report, select one from the Partition drop-down field. 

Filters

To select filter options for the report, select the + icon next to Filters. 

Click in the Filter field to select from First Name, Last Name, Email, Groups, Cards, Partitions, Mobile Credentials, and Enabled. 

Content for the third field in the Add Filter screen is based on the selection made in the Filter field. 

First Name - Select the first name of the person to be filtered. In the Options field, select from Contains, Does Not Contain, Equals, Does Not Equal. If required, check Case-Sensitive. When completed, click ADD. 

Last Name - Select the last name of the person to be filtered. In the Options field, select from Contains, Does Not Contain, Equals, Does Not Equal. If required, check Case-Sensitive. When completed, click ADD. 

Email - Select the email address to be filtered. In the Options field, select from Contains, Does Not Contain, Equals, Does Not Equal. If required, check Case-Sensitive. When completed, click ADD. 

Groups - Select a filter based on whether the selected group(s) are a Member Of or Not Member Of the selected group(s) and check the name of the group(s) to be filtered. When completed, click ADD. 

Cards - Select a filter based on whether the selected card number(s) Equals or Does Not Equal the selected card number(s) and check the card number(s) to be filtered. When completed, click ADD. 

Partitions - Select a filter based on whether the selected partition(s) is a Member Of or Not Member Of the selected partition(s) and check the partition(s) to be filtered. When completed, click ADD. 

Mobile Credentials - Select a filter based on whether the selected mobile Credential Type is Bluetooth or touch Mobile App and whether the Credential Status is Accepted or Pending. Check the appropriate box(es). When completed, click ADD. 

Enabled - Select from Enabled or Disabled. When completed, click ADD. 

To delete any of the listed filter options, scroll over or select the desired option and select the trash icon. 

Output

To define the fields that will be displayed in the People Report, select the + icon next to Output.

Check the desired Output Fields for the report information you want to be displayed. 

When completed, click ADD.  The selected Output options are listed and displayed similar to the following example.

To save the report format you have created, select SAVE at the top right. 

Audit Log Entries

Click REFRESH to display the People Report containing the selected options. Your report will look similar to the following example People Report. 

To export the report as an HTML or a CSV file, select EXPORT.