Adding or Editing a Job Status Data Insight

{"URL":["/*.*/EditDataInsight_BasicInfo","/*.*/AddEditDataInsight_JobStatus_Columns","/*.*/AddEditDataInsight_JobStatus_Filters"],"heroDescriptionIdentifier":"ice_insight_job_status_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_job_status_defining_columns","title":"Defining Columns Settings","type":"configure","languages":["en-us"],"contextURL":["https://docs.automic.com/documentation/webhelp/english/ALL/components/TERMA_DOCU/*.*/AAI%20Guides/Content/Data_Insights/Insights_Type_Job_Status_Defining.htm"]},{"id":"ice_insight_job_status_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_Job_Status_Defining.htm"]}]}

The Job Status data insight is a tool to monitor the current job execution status of all jobs in the AAI. It gives you a snapshot of overall status by showing you the total number of jobs in every possible execution status. By defining advanced filters based on any combination of job definition and run properties, you can get a view of the jobs that have a recent run status that interest you.

You define the default content and presentation of a Job Status data insight in the Basic Information, Columns, and Filters tabs of its data insight definition.

This topic describes how to define those settings and the available options for each. For information about what you see on the Job Status data insight and how to work with that, see The Job Status Data Insight.

This page includes the following:

Basic Information for a Job Status Data Insight

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 Printing is defined for PDF output.

Column and Filter Options

The Job Status data insight offers advanced filter options as well as extensive column options, both based on scheduler-specific job properties. Define column and filter options that work together to select and present the completion status data that you want to include in the data insight.

Defining Columns for a Job Status Data Insight

job status columns, job status available columns, job status data insight columns

The Job Status data insight gives you a lot of freedom to choose any job property to want to include as a data column in your data insight. You can also specify the initial sort order of those columns. You do this in the data insight definition. Later, when you or other users view the data insight, you can configure the available columns as you want by rearranging them, changing the width, hiding optional columns, and changing the sort order.

Tip:

In the data insight definition, you do not have to include all the columns that you might filter the data insight on. For example, you can filter for a specific scheduler type and not include it in your selection of available columns for the data insight because all rows would have the same scheduler value. In this case, it would be helpful to use a data insight name that reflects the hidden filter value, for example, Job Status: AutoSys.

If you are going to share the data insight, consider adding all the columns that other users might want to see, even if you might prefer not to show them.

To define columns for a Job Status data insight, use the following steps:

  1. Open the Columns tab on the data insight in one of the following ways:

    • If you creating a new data insight, click the Columns tab and continue

    • If you want to change the filters on Job Status data insight, select Edit from the actions menu, the vertical ellipses button on either the Data Insights list or at the far right of the toolbar of the open data insight. Then click the Columns tab.

    The tab is made up of two equal halves: On the left are all the possible job attributes and on the right under Selected Job Attributes, is a list of required data columns for all Job Status data insights. They are selected and grayed out. The following are the job attributes for the default columns that are required on all Job Status data insights: 

    • Job Name

    • Parent

    • Status: the final status of the job run

    • Scheduler Name: the scheduler that the job ran on

    • Machine Name: the machine (agent) that the job ran on

    • Last Start Time

    • Last End Time

  2. To add more columns, do the following:

    1. Under Available Job Attributes, choose the tab with the list of attributes By Category or the one By Name.

    2. For each attribute, navigate to the attribute or use the Search field to locate it.

    3. When you find it, click the checkbox to mark it.

    4. Click the right arrow in the middle of the tab to move your selection to the list of Selected Job Attributes.

    5. To remove an attribute from the list, select in from the list of Selected Job Attributes, and click the left arrow.

    6. Continue until you have added all the attributes you want to be available on the table.

  3. Optionally, define the default sort order.

    1. Under Selected Job Attributes, mouse over the attribute you want as your primary sort.

    2. When up and down arrows appear to the right, click up for ascending sort or down for descending.

    3. Do the same for the secondary sort column, and so on. The numbers 1, 2 ,3, and so on, appear with each column you select to sort to show you the order of the sort hierarchy.

  4. When you are finished building your filter criteria, define or edit the Filters tab, and then click Save.

Defining Filters for a Job Status Data Insight

job status filters, job status data insight filters

You can define filters for the Job Status data insight only on the Filters tab of the data insight definition. Filtering is based on any combination of job definition and run properties for the scheduler types that AAI supports.

Tip:

In the data insight definition, you do not have to include all the columns that you might filter the data insight on. For example, you can filter for a specific scheduler type and not include it in your selection of available columns for the data insight because all rows would have the same scheduler value. In this case, it would be helpful to use a data insight name that reflects the hidden filter value, for example, Job Status: AutoSys.

To filter a Job Status data insight, use the following steps:

  1. Open the Filters tab on the data insight in one of the following ways:

    • If you creating a new data insight, click the Filters tab and continue

    • If you want to change the filters on Job Status data insight, select Edit from the actions menu, the vertical ellipses button on either the Data Insights list or at the far right of the toolbar of the open data insight. Then click the Filters tab.

  2. Add a search criterion .

  3. Select an Attribute and a Criteria value and then enter the Value to describe a selection rule for your filter.

    For example, to include all jobs of the "command" type, your filter would be as follows:

    • Attribute: Job Type

    • Criteria: Matches

    • Value: command

    The search is not case sensitive, so it does not matter whether you enter upper- or lower-case or a combination. AAI will ignore the cases when filtering.

  4. Optionally, add other values for the same attribute.

    1. Click the plus (+) at the far right of the current line.

    2. Select a Criteria value and then enter a new Value.

    3. Continue to add more values in the same way.

    These values have an OR relationship. Any of them can be true for the job to be included. For example, you might continue the previous example to say that you want to include any job of the "command" or of the "CMD" type, knowing that your different schedulers use different names for jobs that have the same function, your second value would be as follow:

    • OR

    • Criteria: Contains

    • Value: CMD

  5. Optionally, add values for another attribute that you want to be considered in the filter.

    1. Click + Add Criteria

    2. Select another Attribute and a Criteria value and then enter the Value to describe the next selection rule.

    3. Again, if you want to another value for the attribute, click the plus (+) at the far right of the line, and define the additional value to be included.

  6. When you are finished building your filter criteria, define or edit the Columns tab, and then click Save.

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 and then produces and downloads an output file as defined on the Printing tab. The default is a PDF file.

  • 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: