The purpose of this document is to provide a comprehensive guide on how to use the Audit Log feature on the Genea Platform. It aims to help users understand the benefits of using the Audit Log feature and how it can help them track and monitor activity. This document will also provide step-by-step instructions on how to access and interpret the information in the Audit Log.
This document is intended for users of the Genea platform who are interested in learning more about the Audit Log feature. It will cover the basic concepts of the Audit Log, including what it is, how it works, and its benefits.
Benefits
The Audit Log feature on the Genea platform provides numerous benefits for users, including:
Enhanced security: The Audit Log feature allows users to track and monitor all activity in their account, including login attempts, changes to account settings, and any suspicious activity. This helps users identify potential security threats and take action to prevent unauthorized access to their accounts.
Improved accountability: The Audit Log feature helps users keep track of who has accessed their accounts and what changes have been made. This can help improve accountability among team members and prevent mistakes or intentional misuse of user's account.
Better decision-making: The information provided by the Audit Log feature can help users make better decisions about how to manage their accounts. By reviewing the activity log, users can identify areas of improvement and take action to optimize their account usage.
Time-saving: Instead of manually tracking activity in their account, users can rely on the Audit Log feature to automatically record and store all activity. This saves time and reduces the risk of missing important information.
Troubleshooting: The Audit Log feature can be a valuable tool for troubleshooting issues in your account. If a problem arises, you can use the Audit Log to trace the source of the issue and take appropriate action to resolve it.
Prerequisite:
Please note that the Audit Log feature is only available for customers who are fully on Mercury hardware.
This feature is not supported for VertX or any other hardware than Mercury or Mix hardware customers.
If you are unsure whether you are fully on Mercury hardware, please check with your account administrator or contact Genea support team for further assistance.
What is Audit Log on the Genea platform?
The Audit Log is a powerful feature on the Genea platform that tracks all activity performed on the platform. This feature provides a comprehensive list of all changes made on the platform, including user activity and system events.
To access the Audit Log feature on the Genea platform, log in to your account and navigate to any location on the platform. From there, click on "Activity" and select the "Audit Log" tab in the platform's dashboard.
This will take you to a page where you can view a list of all events and filter the results based on specific criteria. You can also export the Audit Log data to a CSV file for further analysis or archiving purposes.
Another way to access the Audit Log feature on the Genea platform is by navigating to the User Page for a specific user. To do this, go to the "All Users" page and select the user you want to view. Then, check the bottom container of the user details page, where you will see the "Audit Log" tab.
From here, you can view a list of all events related to that user and filter the results based on specific criteria. This feature can be helpful for monitoring and analyzing the activity of individual users on the platform. The Audit Log displays the actions performed on a specific user as well as the actions performed by that user on the Genea platform.
In summary, the Audit Log is a powerful feature that can help you track and monitor activity on the Genea platform, providing valuable insights and enhancing security.
Audit Log Versions:
There are two versions of the Audit Log feature in the Genea platform:
Current version
Beta version.
The Beta version includes additional features and enhancements.
To access the Beta version, navigate to the Audit Log page and look for the "Try the Beta" toggle button.
Note that this button is only visible to customers who are using full Mercury hardware with their Genea platform.
If you choose to try the Beta version, you can toggle between the current and Beta versions at any time by using the same button. By using the Beta version, you can get early access to new features and provide feedback to help improve the overall quality of the Genea platform.
Current Version:
Beta Version:
Understanding the Audit Log Columns
The Audit Log on the Genea platform consists of 7 columns that provide detailed information about each event. Here is an overview of each column and its explanation:
No | Column Name | Description |
1 | Performed By | This column displays the name of the person or system that performed the action or triggered the event. (Available on Current Version) We can see Performed By Type and that will show the role of the person who performed the action. |
2 | Location | This column displays the name of the location that was accessed or modified in the event. |
3 | Category | This column displays the category of the event that occurred, such as User, Location Access, Card etc. |
4 | Performed On | This column displays the object or resource that was acted upon in the event. |
5 | Category Action | This column displays the specific action that was taken or event that occurred on the Category such as Card Created, Card Deleted etc. |
6 | Event Description | This column provides a detailed description of the event that occurred on the platform. (Available on Current Version) |
7 | Time | This column displays the date and time when each event occurred. (Available on Current Version) |
Reference Screen:
Audit Log Details
The View Details button is a feature available on the Audit Log that allows you to see more information about a specific log entry.
This button appears when you hover over a log entry, giving you the option to view the details of the event, such as who performed the action and what changes were made.
Clicking on the View Detail button will display a side screen with all the information related to that specific event. This feature helps you to get a better understanding of the actions performed on your Genea platform. Side panel will appear with three sections: Basic, Summary and Snapshot.
The Basic section shows information about the event, such as who performed it (Performed By), when it occurred (Time), and a description of the event (Event Description).
The Summary section provides a brief explanation of the event, for example, "Added Genea Atlanta location" or "Deleted Access Group".
The Snapshot section displays the changes that were made during the event. It has two parts, Old and New.
The Old section shows the data that was present before the change was made, and the New section displays the updated data.
If something was removed from the old data, it will be displayed in red, while new additions to the data will be displayed in green.
By using the View Detail button and examining the Basic, Summary, and Snapshot sections, you can gain a deeper understanding of the events recorded in the audit log.
More Examples:
Granted Location Access to Adrian Johnson
Added access to the User Adrian Johnson
Updated Location Access for Adrian Johnson
Updated Avatar
Audit Log Additional Options
The Audit Log feature on the Genea platform provides several options that allow you to customize and manage your view of the log. These options are:
No | Options | Description |
1 | Start/Stop Live Activity Recording | This button allows you to enable or disable live activity recording in the Audit Log. |
2 | Sync Latest Activities | This button allows you to refresh the Audit Log with the latest activities from the platform. |
3 | Column Selector | This button allows you to select which columns to display in the Audit Log. |
4 | Export | This button allows you to export the Audit Log data to a CSV (comma-separated values) file. |
Reference Screenshot:
Audit Log Filters
The Audit Log feature on the Genea platform offers various filters to help you narrow down and refine your log view. You can apply multiple filters at a time, and clear them all by simply clicking the "Clear Filters" button. Here are the different types of filters available on the Audit Log:
Date Filters:
Last 90 Days (Default): This filter displays events that occurred in the last 90 days.
Custom Date Range: This filter allows you to select a specific start and end date for the log. However, please note that the maximum range for a custom date selection is 90 days. This means that the start and end dates cannot be more than 90 days apart.
Category Filter:
All: This filter displays all events that have been recorded in the Audit Log.
Access Group: This filter displays events related to access groups.
Users: This filter displays events related to users, such as when a user was added or removed from the system.
Cards: This filter displays events related to access cards, such as when a card was activated or deactivated.
Here is the list of all categories along with their respective category actions available in the Audit Log.
No | Category | Category Action |
1 | Access Group | Access Group Created |
|
| Access Group Deleted |
|
| Access Group Updated |
2 | API Key | API Key Created |
|
| API Key Updated |
|
| API Key Deleted |
|
| API Key Regenerated |
3 | Card | Card Anti Passback Cleared |
|
| Card Created |
|
| Card Deleted |
|
| Card Found |
|
| Card Lost |
|
| Card Updated |
4 | Custom Attribute | Custom Attribute Created |
|
| Custom Attribute Updated |
|
| Custom Attribute Deleted |
|
| Custom Attribute Option Created |
|
| Custom Attribute Option Updated |
|
| Custom Attribute Option Deleted |
5 | Custom Role | Custom Role Created |
|
| Custom Role Updated |
|
| Custom Role Deleted |
|
| Custom Role Policy Created |
|
| Custom Role Policy Updated |
6 | Location | Location Updated |
|
| Location Logo Updated |
7 | Location Access | Location Access Activated |
|
| Location Access Granted |
|
| Location Access Revoked |
|
| Location Access Suspended |
|
| Location Access Updated |
8 | Location Settings | Location Settings Updated |
|
| Location Alert Settings Updated |
9 | PIN | PIN Created |
|
| PIN Deleted |
|
| PIN Updated |
10 | Schedule | Schedule Created |
|
| Schedule Deleted |
|
| Schedule Updated |
11 | Temporary Access | Temporary Access Granted |
|
| Temporary Access Revoked |
|
| Temporary Access Updated |
12 | User | User Avatar Deleted |
|
| User Avatar Updated |
|
| User Created |
|
| User Custom Attribute Updated |
|
| User Deleted |
|
| User Insufficient Licenses |
|
| User Updated |
Category Action Filter:
Access Group Created: This filter displays events when an access group is created.
Access Group Deleted: This filter displays events when an access group is deleted.
Card Created: This filter displays events when an access card is created.
Card Deleted: This filter displays events when an access card is deleted.
Card Found: This filter displays events when a lost access card is found.
User Created: This filter displays events when a user is created.
User Deleted: This filter displays events when a user is deleted.
Description:
This filter allows you to search for specific events that match a particular text string in the event description.
Location:
This filter allows you to filter events based on the location where they occurred.
Performed By:
This filter allows you to filter events based on the user who performed the action. It allows you to search for specific users that match a particular text string.
Performed By Type:
This filter allows you to view events based on the type of Performed By. You can filter by four types: All, User, System & API Keys.
Performed On:
This filter allows you to filter events based on the resource or entity that the action was performed on. It allows you to search for specific users that match a particular text string.
If you have any questions about this feature or have any feature requests, please reach out to acsupport@getgenea.com.