Explorer - Data Set

The Data Set area in the Explorer tab is available only for KPIs, Metrics, KPI Breakdowns, and Metric Breakdowns. It provides the ability to drill down into the details of the formula used to calculate the KPI or Metric, to see the building blocks of the calculation results, and to analyze the data used for the calculation. The page provides the formula, the filter, and the display of the data.

ClosedTo access:

Click the Explorer tab to access detailed information about all the Scorecards, Objectives, Perspectives, KPIs, KPI Breakdowns, Metric, Metric Breakdown, or Unassigned KPIs that are active in the Studio. In the EXPLORER tab, click the relevant item and click the Data Set button.

ClosedAccess Explorer to display detailed information about a selected KPI or Objective

To view more detailed information for a selected KPI or Objective:

  1. Move the cursor over the relevant item in the KPI  or Scorecard component in the Dashboard page. In the tooltip that opens, click Explore.... The EXPLORER tab opens for the selected item.

    Or click the Explorer tab to display the Active KPIs tree, and by clicking the relevant KPI, KPI Breakdown, Metric, Metric Breakdown, or Unassigned KPI in the tree, display detailed information about the selected item in the EXPLORER tab.

  2. Click the Data Set button to display the details of the formula used to calculate the KPI or Metric, to see the building blocks of the calculation results, and to analyze the data used for the calculation. The page provides the formula, the filter, and the display of the data.

ClosedView the numeric result of each aggregation function used in the formula

To view numeric result of each aggregation function used in the formula of a selected KPI or Metric:

  1. Click the Explorer tab to display the Active KPIs tree, and by clicking the relevant KPI, KPI Breakdown, Metric, Metric Breakdown, or Unassigned KPI in the tree, display detailed information about the selected item in the EXPLORER tab.

  2. Click the Data Set button.

    The formula used to calculate the KPI or Metric is displayed at the top of the page. You can click each aggregation part of the formula to activate it. It then has a colored background.

    Move the cursor above that area to display the value of that function.

ClosedView the table of raw data used for each aggregation function used in the formula

To view table of raw data used for each aggregation function used in the formula of a selected KPI or Metric:

  1. Click the Explorer tab to display the Active KPIs tree, and by clicking the relevant KPI, KPI Breakdown, Metric, Metric Breakdown, or Unassigned KPI in the tree, display detailed information about the selected item in the EXPLORER tab.

  2. Click the Data Set button.

    The formula used to calculate the KPI or Metric is displayed at the top of the page. The activated aggregation function has a colored background.

  3. Click the aggregation function for which you want to display the raw data in a table below the formula.

    The table displays a maximum of 10 rows and by default not more than 6 columns (you can customize the number of displayed columns) of raw data from the Target database. The columns correspond to the fields of the entity on which the function is built. For example: sum (defects, defect.severity = "High") gives a result set showing the field of the defects entity.

    The initial sorting of the table is by the first column.

    You can customize the number of displayed columns. You can sort the table columns to view additional information from the database.

    When you select another KPI or Metric in EXPLORER or when you leave EXPLORER and come back to the initial KPI or Metric, the configuration of the column selections and sorting order in the Data Set table is restored.

    You can also save the column settings so that if you log off and log on again, the settings you had saved are retained.

    To view the complete list of raw data, click .

ClosedView the SQL query details

To view the SQL phrase that is executed in the database and the relevant database connection details (DB server and DB schema):

  1. Move the cursor over the relevant item in the KPI, Metric, or Scorecard component in the Dashboard page. In the tooltip that opens, click Explore.... The EXPLORER tab opens for the selected item.

    Or click the Explorer tab to display the Active KPIs tree, and by clicking the relevant KPI, KPI Breakdown, Metric, Metric Breakdown, or Unassigned KPI in the tree, display detailed information about the selected item in the EXPLORER tab.

  2. Click the Data Set button.

    The formula used to calculate the KPI or Metric is displayed at the top of the page. The aggregation functions that appear in the formula have a colored background.

  3. Click the relevant aggregation function and then click . A dialog box opens and displays the name of the machine on which the database is installed followed by the port used, the name of the Target schema, and the SQL query that is run to perform the calculation corresponding to the function currently highlighted in the formula.

ClosedExport raw data to a .csv file

To export the raw data to a .csv file:

  1. Click the Explorer tab to display the Active KPIs tree, and by clicking the relevant Objective, KPI, KPI Breakdown, Metric, Metric Breakdown, or Unassigned KPI in the tree, display detailed information about the selected item in the EXPLORER tab.

  2. Click the Data Set button.

    The formula used to calculate the KPI or Metric is displayed at the top of the page. The aggregation functions that appear in the formula have a colored background.

  3. Click (or link) to export all the data included in the Target database table (not just the data displayed in the GUI table) that is used to calculate the function that is currently highlighted in the formula to a file in .csv format. It opens your list of directories where you can select where to save the .csv file you are creating.

    Depending on the settings of your browser, the file may be automatically saved to a predetermined download directory.

ClosedView the key elements of the percentage formula

To view a detailed description of the percentage formula:

  1. Move the cursor over the relevant item in the KPI, Metric, or Scorecard component in the Dashboard page. In the tooltip that opens, click Explore.... The EXPLORER tab opens for the selected item.

    Or click the Explorer tab to display the Active KPIs tree, and by clicking the relevant Objective, KPI, KPI Breakdown, Metric, Metric Breakdown, or Unassigned KPI in the tree, display detailed information about the selected item in the EXPLORER tab.

  2. Click the Data Set button.

    The formula used to calculate the KPI or Metric is displayed at the top of the page. The aggregation functions that appear in the formula have a colored background. The pie shows the information corresponding to the general section of the percentage formula and to all other data.

    The filter describes the filter formula. For details, see Data Set.

ClosedSend the contents of the Data Set page by Email

  1. In the EXPLORER tab, click the relevant item in the Active KPIs tree and click Data Set.
  2. To send an email to the Owner of the entity, click the Send Mail icon.

    If you send an email right after adding an annotation, the content of the annotation is automatically added to the email.

For additional details, see Explorer Tab - Data Set.

Movie: To display the relevant movie, open the ITBA application, click Help in the top right corner of the application main page and select the Movies option. Select the relevant movie. For details, see .

ClosedExport the contents of the Data Set page to a PDF file

  1. In the EXPLORER tab, click the relevant item in the Active KPIs tree and click Data Set.
  2. To export the contents of the Data Set page to a PDF file, click the Save snapshot icon.

For additional details, see Explorer Tab - Data Set.

Movie: To display the relevant movie, open the ITBA application, click Help in the top right corner of the application main page and select the Movies option. Select the relevant movie. For details, see .

ClosedPrint the contents of the Data Set page

  1. In the EXPLORER tab, click the relevant item in the Active KPIs tree and click Data Set.
  2. To print the contents of the Data Set page, click the Print icon.

For additional details, see Explorer Tab - Data Set.

Movie: To display the relevant movie, open the ITBA application, click Help in the top right corner of the application main page and select the Movies option. Select the relevant movie. For details, see .

ClosedExplorer Tab - Data Set

Note When in IT Business Analytics, you navigate to another tab and then return to the Explorer tab, the details of the item that was previously in focus are displayed again. However, its properties might be refreshed.

The EXPLORER tab includes the following areas:

ClosedActive KPIs

User interface elements are described below (when relevant, unlabeled elements are shown in angle brackets):

UI Element

Description

<Search>

Enter the relevant string to display, in the tree, the nodes whose name includes the string.

In addition, the child nodes of the filtered nodes are also listed even when the child node names do not include the string.

If the display is filtered (in case you accessed the Explorer from one of the components in the Dashboard), the <Search> box displays information about the filter. For example:

Advanced Search. Opens additional fields to help you refine the component's filter:

  • Status: Select one of the All, Good, Warning, Critical, or No Data values to display only the elements with the selected status, in the Active KPIs area. When you select No Data, the search returns only the elements with no data.

  • Type: Select:

    • All. To display all the elements in the tree with the selected status.
    • KPI. To display only the KPIs with the selected status.
    • Metric. To display a list of all the Metrics (the Status is changed to All). If you had selected a value in Status, and then you select Metric, then the Status field displays All, and becomes inaccessible.
    • Objective.To display only the Objectives with the selected status, and their KPIs.
Active KPIs

Depending on how you accessed the Explorer tab, the pane lists all the Scorecards, Perspectives, Objectives, KPIs, KPI Breakdowns, Metrics, Metric Breakdowns, and Unassigned KPIs, active in the IT Business Analytics or a subset of these items.

The list of Scorecards that is displayed corresponds to the Scorecards that are permitted for your user. For details about permissions, see User Management

Note A Scorecard Administrator who wants to see a newly created Scorecard in Explorer (and who has the correct permissions to see the Scorecard), needs to refresh the Explorer using the Refresh button to display the Scorecard.

Click one of the Scorecards, Perspectives, Objectives, KPIs, KPI Breakdowns, Metrics, Metric Breakdowns, or Unassigned KPIs to display their detailed information in the other pane.

The area also displays on the right side of the Active KPIs pane, a subset of the following items depending on the type of item you selected:

  • The name of the item.
  • The value of the item.
  • The trend icon indicates the trend of the value calculated over the current period.
  • The status of the item, during the current period. It can be:
    • indicates that the status is Good.
    • indicates that the status is Warning.
    • indicates that the status is Critical.
    • indicates that the status is Pending and that the calculations have not yet been performed or completed.

ClosedData Set

  • <Analysis area>

    User interface elements are described below (when relevant, unlabeled elements are shown in angle brackets):

    UI Element

    Description

    <Name> in period <Selection> <Value> <Trend> <Status>

    The title lists:

    • <Name>. The name of the selected item (KPI, KPI Breakdown, Unassigned KPI, or,  Metric, or Metric Breakdown).
    • in period <Selection>. Select the period you want to display. You can select:

      • Current. The title of the page displays the current value, trend, and status of the selected item.
      • Last Closed. The title of the page displays the value, trend, and status of the selected item for the last completed calculation period.
      • A list of periods when the value of the selected item was calculated.
    • Value. The value of the selected item.
    • Trend. The trend icon indicates the trend of the value of the selected item in the selected period compared to its value in the previous period.
    • Status. The status of the KPI, KPI Breakdown (Metrics, and Metric Breakdowns do not have a status), during the current period. It can be:

      • indicates that the status is Good.
      • indicates that the status is Warning.
      • indicates that the status is Critical.
      • indicates that the status is Pending or No data, meaning that the calculation of the status was not yet completed or the status was not calculated or that there was en error in the calculation.
    <Formula>

    The formula used to calculate the KPI or Metric is displayed at the top of the page. The aggregation functions that appear in the formula have a colored background.

    Move the cursor above that area to display the value of that function.

    When the formula uses a PERCENTAGE aggregative function, the display shows a pie char:

    Limitations:

    • KPI or Metric formulas that use the PERCENTAGE_MATH mathematical function have a display similar to the other mathematical functions (see above for a picture of the typical display) and do not display a pie.
    • Percentages where the dividend is a subset of the divisor can be represented as a pie.
      PERCENTAGE(Defect, Defect.Severity='Urgent', Defect.Severity='Urgent' or Defect.Severity='Warning', 0)
      If the dividend is not a subset of the divisor it cannot be represented as a pie.
      PERCENTAGE(Defect, Defect.Severity='Urgent', Defect.Severity='Warning', 0)
    • It is also recommended to change the PERCENTAGE function into a RATIO function. For example, the following PERCENTAGE formula cannot be represented by a pie.

    The formula used to calculate the KPI or Metric is displayed at the top of the page. The aggregation functions that appear in the formula have a colored background.The pie has two sections: the top section (<KPI_or_Metric_name>) represents the value of the KPI or Metric; the bottom section (other) represents: 100% - <KPI_or_Metric_value>.

    The section that represents the value of the KPI is:

    • Red for a KPI when the KPI threshold definition has a minimize configuration (meaning that the status is good when the KPI value is low).
    • Colored for a KPI when the KPI threshold definition has a maximize configuration (meaning that the status is good wen the KPI value is high), or for a Metric.

    Expand Formula to display the formula.

    Complete formula/
    Abbreviated formula

    Click Complete formula to display the whole formula.

    Click Abbreviated formula to display the truncated formula.

    <Filter formula>

    The filter configured for the KPI or Metric. The contents of the filter are not shown by default. Click Filter to expand and display the filter contents.

    This icon displayed in the filter indicates that the filter is for a KPI or a Metric.

    This icon displayed in the filter indicates that the filter is for a KPI Breakdown or a Metric Breakdown.

    When the filter includes both global and partial filter structures, you can filter a KPI or Metric both globally and partially by clicking on each section of the filter:
    <global_filter> and <partial_filter>.

    <Analysis area>

    Click the relevant function in the formula.

    The analysis area displays:

    • The formula with the function you have selected.
    • The table displays a maximum of 10 rows and by default not more than 6 columns (you can customize the number of displayed columns) of raw data from the Target database. The columns correspond to the fields of the entity on which the function is built. For example: sum (defects, defect.severity = "High") gives a result set showing the field of the defects entity.

      The initial sorting of the table is by the first column.

      You can customize the number of displayed columns. You can sort the table columns to view additional information from the database.

      When you select another KPI or Metric in EXPLORER or when you leave EXPLORER and come back to the initial KPI or Metric, the configuration of the column selections and sorting order in the Data Set table is restored.

      You can also save the column settings so that if you log off and log on again, the settings you had saved are retained.

    The table of raw data has the following capabilities:

    • Sort the table. To sort the table by column to view additional information, click the relevant column title.

    • Display or hide columns. Right-click one of the column headers to display a list of all the available columns. Click the relevant column name in the list to display it or remove it from the display:

      • Copy and paste part of the table.

        1. Click and drag the cursor over the relevant cells of the table. The cells are highlighted.

        2. Click Ctrl + C.
        3. Go to the location where you want to paste the data and click Ctrl + V.
    • Reorder columns. You can change the location of columns, by clicking the relevant column header and dragging it to the relevant location.
  • Toolbar

    User interface elements are described below (when relevant, unlabeled elements are shown in angle brackets):

    UI Element

    Description

    Send mail. Opens an Outlook email, with the name of the selected entity in the Subject box.

    Save snapshot. Captures the current view in Explorer (all of it) in a new window. A dialog box opens to ask you where you want to save the image.

    Print. Displays the Print dialog box where you can select the printer and how to print the content of the corresponding Explorer tab.

    The printout includes:

    • The contents of the area that was selected while you clicked the button.
    • The Annotations Area.

    Show/Hide Annotations. The button is enabled only for Objectives, KPIs, KPI Breakdowns, Metrics, Metric Breakdowns, or Unassigned KPI. It opens a box where you can add your annotation or hide them after viewing. For details, see Annotations.

    Click the button again to close the Annotation area.

    Note The Show/Hide Annotations icon with a little + sign in the bottom toolbar indicates that a new annotation was added to the selected item during the past week.
    The number of days during which the annotations are considered to be new is a setting that is configurable by your administrator in Admin > Scorecard > Dashboard Settings > Number of days annotations are considered new. For example, if the administrator gives the setting the value 14, then the + sign will indicate that the annotation was added in the last 2 weeks. The default is a week.

  • Additional Buttons in Toolbar

    User interface elements are described below (when relevant, unlabeled elements are shown in angle brackets):

    UI Element

    Description

    Export to .csv. Click to export all the data included in the Target database table (not just the data displayed in the GUI table) that is used to calculate the function that is currently highlighted in the formula to a file in .csv format.

    It opens your list of directories where you can select the location of the .CSV file you are creating. Depending on the settings of your browser, the file may be automatically saved to a predetermined download directory.

    Display SQL. Click to show the SQL query that runs to calculate the function that is currently highlighted in the formula. It also displays the name of the database server and the name of the schema used by the SQL query.

    Copy query to Clipboard. Click to copy the contents of Retrieval query to the clipboard.