Listen ![audio icon](bin/images/audio.png)
Translate
Audit Log (Audit Trail)
This section covers the display, filter, and export of data in Product via Audit Logs.
Archive audit logs
- Audience & purpose
-
As an Automation Administrator you want to archive old Audit log entries. This will:
- Free up database space.
- Deliver faster performance in the Audit log landing page sorting and filtering, as the operation will be performed on a lesser number of records.
Archiving
You will be able to archive selected Audit log records. Archived data will be removed from the Audit log table and be stored separately.
- You will be able to:
- Filter with a date range and archive.
- Filter with a search criteria and archive.
- Save and restore archived data in the directory structure or the database.
- You will be able to restore the archived data on a need basis.
- You will also be able to set automatic archival for data older than a particular time period (3 months, 6 months, or 1 year).
Security
Note:
- Only those users who have the "Archive audit log actions" permission will be able to archive the Audit log and restore an archived log.
- Others will not be able to archive an Audit log, even from the API.
Audit
An Audit entry will occur every time you attempt an archive action (a "Successful" or "Unsuccessful" action).
- Landing page entries will be as follows:
- Source: Product
- Action: Archive audit log
- Item Name: xxxxxxxxx
- The detailed page will list the number of records archived and the information on records archived.
- For every automatic archival, there will be an audit log entry.
Display Audit Log landing page data on the Audit Log details page
- Audience & purpose
-
As an Automation Administrator, you want to see the details (First name, Last name and Email address) of a user who was deleted from the system one year ago. This will:
- Record "point-in-time" data of a user object from its creation to its deletion.
- Help in understanding all that has changed in the user object.
- Show details of objects which have been deleted from the System.
Audit Logs/Trails
Use the following guidelines regarding Audit Logs/Trails.
- The upper-half of the Details page will show the data displayed on the Landing page (successful, as shown in the following screenshot).
- In case of errors, the System will show the errors in the upper half of the page as shown in the following screenshot.
- The breadcrumb trail will show Audit log ⋺ View action.
- Clicking the Back button will return you to the page that you came from.
- The System will show Successful / Unsuccessful types of detail pages, as shown in the preceding screenshots.
- The entire Audit log entry will be Read-Only.
- Users can only act on the page level toolbar.
Security
This page will not be accessible to any user except those with the Create/Edit/Delete permissions.
Display information
- Audience & purpose
-
As an Automation Product Administrator, you want to see all automation activities happening in your organization's Automation Landscape for a particular Product. This includes:
- Regulatory Compliance
- Internal Governance and Control
Audit Log Landing Page
Use the following guidelines to establish the Audit Log Landing Page data.
- The Audit Log Landing Page table data and ordering will be as shown in the following screenshot: Audit Logs Landing Page
- Table data will be sorted on the "Time" column by default. You will also be able to sort data on the other columns.
- For TaskRobot runs, the "Time" column will show when the TaskRobot execution started.
- Users will be able to see the item count visible on the current page.
- Time will display the Date and Time, as per the logged-in user's local timezone per his/her machine.
- The name of the "object" on which the action was performed will be shown in the "Item name" field, for example the: Username, Role name, and Robot name.
- You will be able to view details of the audited entry for Product objects such as User, Role, Schedule etc.
- For example, if an Audit Record is about a Product object, it will be easy to switch to viewing that object.
Access Control
- For "Run TaskRobot", you will be able to see all TaskRobot related data for the TaskRobots to which you have access (upload/download/delete).
- Users who have the "View everyone's Audit Log actions" permission will be able to see the entire Audit Logs data.
- Note: Unauthorized Users will not be able to access this page even if they get access to the page URL.
Task Run
Authorized users who have the "Upload", "Download", or "Delete" permission will be able to re-run the TaskRobot from the Audit Logs page.
- The System will not allow a TaskRobot re-run:
- If the device is not "Connected".
- If a user is deleted/deactivated or their "user type" is not "Robot Runner".
- Users who do not have either of the upload, download, or delete access on the TaskRobot will not be shown an action to run the TaskRobot.
- If the TaskRobot deployment was successful, the system will show a toast message:
Successfully deployed TaskRobot <TaskRobot Name> on <devicename>
- If the TaskRobot deployment was not successful, the following error message will be shown:
Could not deploy <TaskRobot> to <devicename>. <Show the reason and corrective action too>
Export information
- Audience & purpose
-
As an Product Administrator you want to export all the data of the instances when a user is "Connected to Credential Vault". This enables you to:
- Save a copy of "point in time" data for future reference.
- Share the desired information with other users.
Audit Logs/Trails
Use the following guidelines regarding the Audit Logs/Trail.
- You will be able to export:
- Monthly data from Audit Log.
- Filtered data from the Audit Log.
- Selected data from the Audit Log.
- Hidden column(s), if any, will not be exported.
- Columns in an exported CSV file will be in the same order as that of the user's screen (consider column reordering by the user).
- Data will be exported in a CSV file.
- The name of the exported CSV file will be "Audit Log.<YYYY>.<MM>.<DD>.HHMMSS".
Filter information
- Audience & purpose
- As an Product Administrator you want to find out all instances when a user "Connected to Credential Vault". This facilitates a faster search/navigation to the desired information.
Column Filter
Use the following guidelines for column filters.
- You will be able to:
- Filter information shown in the Audit Log.
- Perform a free text search on all the fields of the Audit Log table.
- Filter the Audit Trail information on the Status, Action, Source, User, and Device columns.
- For Status, Source and Action, you will be able to select the value of a column from a pre-defined list available.
- If you want to filter on Status, you will be shown "Failed" or "Successful" values to choose from.
- For filtering on Column names, the system will provide dynamic suggestions.
- When you are searching for usernames and when you type "Robe", suggestions will keep narrowing down with every additional character typed.
- Note: Only existing values will be considered for suggestions.
- You will be able to select the value of a column from a pre-defined list of available, auto-populated search terms.
- The search term count will also be displayed and updated as and when the search term updates.
- For example, if you want to filter on Status, you will be shown "Connected", "Disconnected", and "Offline" values to choose from.
- The result set will be shown as X of Y, where:
- X = the search result.
- Y = the total number of records in the table.
- You will be able to reset the search query.
- The system will remember the last filter applied by you per session.
Searching with AND vs OR
When you have performed a search on one column, you will be able to further augment the search results.
- If a second search is performed on a different column, it should be treated as "AND".
- For example, Action taken by = Mike AND Source = Device.
- If a second search is performed on the same column, it should be treated as "OR".
- For example, Action taken by = Mike OR Action taken by = John.
Time Filter
By default, you will be shown the Audit data for the past 7 days.
- You will be able to filter the result on the basis of time.
Purge data older than 6 months from historical activities
- Audience & purpose
-
As an Automation Admin you want to see Automation and ALM export historical data for the past 6 months.
- Purging old data will save database space due to the accumulation of all the historical data.
- This will result in better performance in page loading, etc.
Purging
The system will automatically purge all the historical data from the "Activity" → "Historical" page which is older than 6 months.
RBAC on archival of audit logs
- Audience & purpose
-
As an Automation Administrator you only want authorized users to be able to archive Audit logs.
- Note: Archival of Audit logs is a sensitive action and will not be allowed to everyone who has the "View audit log" permission.
Using RBAC archiving
The system will allow RBAC on archival of an Audit log.
- The "Archive" permission can only be assigned if the user has "View audit log" permission. See the following screenshots.
- If you have the "Archive" permission, the system will show the "Archive icon" on the Audit Log landing page. See the red bordered icon in the preceding screenshot.
- The permission description on the right-hand side will be:
- This allows the user to view everyone's actions in the Audit log, and the archiving of selected Audit log records.
- The archived Audit log will be removed from the Audit log table and stored separately.
Security
If a user does not have the "Archive" permission they will not be able to archive Audit logs under any circumstances, including via the API.
Show ALM Export history to user
- Audience & purpose
-
As an Automation Expert you want to see the details of an automation package which you exported last week, and you want to re-export the same set of Robots and Dependencies. This will:
- Help you to show your historical activities.
- Save you time by re-exporting historical actions using pre-filled data.
Using re-export
You will be able to see the list of exported ALM packages in the Activity > Historical page.
- You will be able to re-export an ALM package from the "Landing" page or from the "Details" page.
- When you re-export an ALM package, the system will take you to the ALM export final page where you can either export directly or modify the content of the export package.
- The following information will be shown on the Landing page:
- Status
- Device name
- Package Name
- Date
- In-context help will list the ALM Export history over the past six months.
Table level actions
You will not be able to perform a re-trigger ALM export on more than one package at a time (i.e., no table level ALM export).
Security
You will only be able to see those ALM export actions which were triggered by yourself.
Show historical activities to every user
- Audience & purpose
-
As an Automation Expert you want to see the details of an automation that you ran last week, and you want to re-run that automation. This will:
- Help you to show your historical activities.
- Save your time by re-triggering historical actions using pre-filled data.
Description
This tab will be visible to all users.
- This will show the list of actions of "Run Task" and "ALM Export".
- A user will be able to re-trigger the action (rerun or export).
- The following information will be shown on the landing page:
- Status
- Device name
- Automation name
- Robot name
- User
- Started on
- Ended On
- Rerun Automation
- ▸ When users rerun an automation, they will be taken to the "Robot run" page.
- ▸ They will be able to make changes to the automation before finally running the Robot.
- Re-trigger export
- ▸ When users re-trigger an automation, the system will take them to the ALM export final page where they can either directly export or modify the content of the export package.
- Time Period
- ▸ Historical activities will not be stored for more than 6 months.
- In-context help
- ▸ Gives a list of automation and ALM Export history over the past 6 months.
- Table level actions
- ▸ Users will not be able to perform re-run operations on multiple Robots at once (i.e., no table-level Robot run).
- Security
- ▸ Under no condition will any user (including Admins) be able to see the Robots who do not have either the "upload", "download", or "delete" permission.
- ▸ By default, all users will be able to only see those automations which were either triggered by the user or which ran because of the schedule created by the user.
- ▸ If a user has the "View others in-progress activity" permission, they will be able to see all the Robots on which the user has either of the "upload", "download" or "delete" permission.
- ▸ A user will be able to only see those ALM export actions which were triggered by that user.