Adding or Editing an Audit History Data Insight

{"URL":["/*.*/EditDataInsight_BasicInfo","/*.*/AddEditDataInsight_AuditHistory_Columns","/*.*/AddEditDataInsight_AuditHistory_Filters"],"heroDescriptionIdentifier":"ice_insight_audit_history_defining_intro","customCards":[{"id":"ice_insight_all_defining_basic","title":"Defining the Basic Information","type":"customize","languages":["en-us"],"contextURL":["https://docs.automic.com/documentation/webhelp/english/ALL/components/TERMA_DOCU/*.*/AAI%20Guides/Content/Data_Insights/Insights_Type_Audit_History_Defining.htm"]},{"id":"ice_insight_audit_history_defining_columns","title":"Defining Columns Settings","type":"customize","languages":["en-us"],"contextURL":["https://docs.automic.com/documentation/webhelp/english/ALL/components/TERMA_DOCU/*.*/AAI%20Guides/Content/Data_Insights/Insights_Type_Audit_History_Defining.htm"]},{"id":"ice_insight_audit_history_defining_filters","title":"Defining Filters Settings","type":"customize","languages":["en-us"],"contextURL":["https://docs.automic.com/documentation/webhelp/english/ALL/components/TERMA_DOCU/*.*/AAI%20Guides/Content/Data_Insights/Insights_Type_Audit_History_Defining.htm"]}]}

The Audit History data insight gathers all events that are tracked in the AAI database for each active scheduler. These can be events related to job and jobstream executions, or job or jobstream definitions, or system events. You define the default content and presentation of an Audit History data insight in the Basic Information, Columns, and Filters tabs of its data insight definition.

Important!

This data insight can be used for AutoSys schedulers only.

In addition, for the Audit History data insight to be able to show data, make sure that the AutoSys workload automation engine has the Autotrack Level set to either 1 or 2 (not 0). Otherwise, AutoSys does not track and store details about the changes to the AutoSys database, therefore, AutoSys has no audit data for AAI to collect and present in the data insight. For information about autotrack in AutoSys, see the topic "autotrack Command -- Tracks Changes to the Database" in the AutoSys documentation on https://techdocs.broadcom.com/us/en/ca-enterprise-software/intelligent-automation.html.

This page includes the following:

Basic Information for Audit History

On the Basic Information tab of a data insight, you specify the data insight type, name, and time zone for the data insight, and optionally provide a description for yourself and editors in the following fields:

data insight type, cannot change data insight type
  • Type: Select a data insight type from the drop-down list. The type determines the base filter and column configuration settings for the data insight.

    The type is the only setting in a data insight definition that you cannot change after initially saving the data insight.

    Each data insight type is a template with predefined data fields and filters to extract and present data for a specific purpose. These specifications are built into the internal type definition and cannot be changed. The predefined configuration is a starting point for your own data insights. When you define or edit a data insight, you can further filter the data and change the sorting order and column configurations. When you view the data insight, you can temporarily and dynamically change these configurations.

  • Name: This is the name of the data insight that will appear on the Data Insights list, in the title of the data insight view, and in output file names. It must be unique within this AAI installation.

    Tips:

    The name should communicate the purpose or the scope of the data insight. This is particularly important when the data insight is shared with other people, who will see it on their Data Insights list or dashboards, or for the name of the output files that can be produced from the data insight.

    Also, be sure to follow any naming conventions that are established within your AAI user group or across your company.

  • Time Zone: The time zone that you want the dates and times in the output to be presented in. Your user-preferred time zone is selected by default. If data is coming from various time zones, the time data is converted as needed so that you have comparative values.  

  • Description (optional): This is a good place for notes to yourself or to anyone you share editor access to the data insight with. For example, explain the purpose, the intended consumers or stakeholders of the data. This can also be a place where the owner and editors can communicate their changes to the settings.

Note:

At this point, you can save the data insight. All other values will keep the default values. The default Columns and Filters settings are based on the data insight type, Schedule and Sharing are not defined, and the Report Settings are defined for the default PDF output.

Column Settings for Audit History

The Audit History data insight offers configuration settings that support tracking and reporting for activity history. These include relevant data columns, on which you can filter the event data, and group-by options for the aggregations on the graphic. What you need to know specifically for the Audit History data insight is covered here in the following:

Defining Column Settings for the Audit History

On the Columns tab, you can define the default columns for the data insight and the default sort order.

  1. Select the columns to include in the data table. Columns with key data are required and are therefore already selected and grayed out. For more information, see Available Columns on the Audit History.

  2. Under Select the sort option in order below, define the sort columns in the order of the sort hierarchy. The rows will be sorted by the data in the column in position 1 of this list, and within those values, they can be further sorted by the data in the column in position 2, and so on. Also select the radio button to specify the direction of the sort (Ascending or Descending).

    To remove a sort level, click the X at the end of the row.

    Note:

    In the headers on the data table, up or down arrows indicate an ascending or descending sort order, and a superscript number 1, 2, 3, and so on, shows the sort hierarchy.

Available Columns on the Audit History

columns on audit history data insight, columns on audit history report

The following are the data columns that are available in an Audit History data insight. You can define filters based on the data in these columns and you can choose to show or hide them in the table. The ones marked with an asterisk (*) are required columns and cannot be hidden. They contain key data or data that is essential to the purpose of an Audit History data insight.

  • Type*: The event type that occurred. The following are the filter options for event types that can be collected for the audit history:

    • Calendar Definition: Any changes related to a calendar definition

    • Connection Profile Definition: Any changes related to the connection profile

    • Job Definition: Any changes related to a job definition

    • Machine Definition: Any changes related to the machine definition

    • Monitor/Browser Definition: Any changes related to monitoring or browser definition

    • Override Definition: Any changes related to a one-time override

    • autosys_secure command: Occurrences of this kind of event

    • autotrack command: Occurrences of this kind of event

    • sendevent command: Occurrences of this kind of event

  • ID: The internal ID of the event. The sequential ID number tells you precisely the order of events.

  • Time*: The time that the event occurred, in the time zone that is defined for this data insight.

  • User*: The user whose actions triggered the event.

  • Name: The name of the object that was touched, if applicable.

  • Scheduler*: The AAI scheduler name for the workload scheduler on which the event occurred

  • Value: Details about the type of event, such as the full command for a sendEvent or autoTrack command event

Note:

You can sort the table on any of the columns except the Value column. This is due to the complexity of the data that the column can contain. To surface events related to a specific action, command type, or other value, add a filter on the Value column that will select them.

Filter Settings for Audit History

On the Filters tab, you can define two settings that control which data is included in the data table of the data insight by default:

  • Simple filters: Define these by clicking the filter icon and then selecting columns and specifying the filter criteria, as you do with all simple filters in AAI. For more information, see Using Filters.

    You can filter the data insight by values in any of the available columns. For information, see Available Columns on the Audit History.

    Note:

    The Date Range filter must be defined to prevent too massive a data pull that would clog up your processing resources. By default, it is set to the Last 30 Days.

  • The Group by field for the graphic that is rendered in the data insight. The following are the columns that you can choose for the Group By setting on the Audit History data insight:

    group-by options for audit history
    • Scheduler (default)

    • Type

    With the Group By setting of the Audit History data insight, you can choose what is summarized to make up the slices in the pie chart. Whereas the whole pie chart represents the total of all events that match the filter criteria, each slice shows the proportion of those events that belong to the each value in the Group By column value.

Note:

The settings you define here are the defaults that anyone viewing the data insight can temporarily override, but will be reset when closing the data insight or logging out. For more information, see Using a Data Insight.

Next Steps

After you define the settings on the Basic Information, Columns, and Filters tabs, you have defined all the settings that affect what appears on the data insight and how it is presented. You can continue in one of the following ways: 

  • Save the data insight now by clicking one of the following:

    • Save: This saves all settings, closes the definition, and returns to the Data Insights list.

    • Save & Run: This saves all the settings, opens the data insight based on the specified filters and column configurations, and produces and downloads an output file as defined on the Report Settings tab.

  • Define additional optional settings on any or all of the remaining tabs of the data insight before saving it. The additional tabs define how the data insight is managed and distributed. For information see: