Work with the Console and Dashboards for a Business Process

The console page for a business process shows information about the performance of the business process using dashboards, which help a business person to identify bottlenecks in the process and track key metrics immediately and in real time.

Work with Preconfigured and Custom Dashboards

A business user can evaluate the state of a business process using the preconfigured and custom dashboards to track metrics, ratios, and trends that are important to the business.

See Preconfigured Dashboards and Custom Dashboards.

To work with the console and dashboards for a business process:

  1. In the Oracle Integration navigation pane, click Insight.
  2. In the Insight navigation pane, click Consoles.
  3. On the Consoles page, click the business process of interest to display its console page, which includes the following elements:
    • Title area showing the business process name and a Favorites Favorites icon toggle icon to mark the business process as a favorite.

    • Close button to return to the Consoles page.

    • Import Dashboards button to import dashboards that were previously exported with this particular business process. See Import Dashboards.

    • Add Dashboard button to create custom dashboards. See Create Custom Dashboards.

    • Details icon to display the Console Details. This area displays the model's icon, model description, and the descriptions for Single and Multiple Instances, which were defined when the model was created.
      Dashboard Actions and Details icon
    • Status indicator that indicates the status of the business process.

    • Timestamp at which the business process was activated.

    • Purge Purge icon icon for users with the ServiceAdministrator role to maintain database capacity and application performance by purging Integration Insight metrics and events data for the current console using the Purge Console Data dialog.


      Purge Console Data dialog
      In the Purge Console Data dialog, select the amount of Integration Insight data to purge:
      • Retain no data to delete all data for the current console.

      • Retain recent data, then select from the dropdown lists to specify a number of days or weeks from which to retain data for the current console.

      Click Purge to immediately delete Integration Insight data according to your selection.

    • Expand Filters Expand Filters icon icon to control the data shown on the dashboards. See Filter Dashboards.

    • Dashboard Type list to display dashboards of the selected type:

      • All

      • Preconfigured

      • Custom


      Dashboard Type list
    • Re-arrange dashboards Re-arrange dashboards icon icon to change the order that dashboards appear on the console:

      • Click and drag the bar next to a dashboard’s name to move it to a different position. The console page on which a dashboard appears is indicated by the large number to the right of the dashboard list. A horizontal line separates each console page in the list.


        A milestone is highlighted on the Re-arrange dashboards dialog.

        Click Done to save any ordering changes you make.

      • You can also search for dashboards displayed in the Re-arrange dashboards dialog by entering search criteria (dashboard name) into the Jump to a dashboard field, and then click the Search Search icon icon. Dashboards matching your search criteria are highlighted.

    • Search field to locate metrics on business transactions with a unique identifier, such as an order number. Matching business transactions display on the Business Transaction Details page. See Search Dashboards.


      Dashboards actions: Search, View All, Refresh, List/Card View icon
    • View All link to view all business transactions on the Business Transaction Details page, and drill down to more details. Business transactions from the last 5 days are displayed by default. See  Work with the Business Transactions Dashboard and Business Transaction Details.

    • Refresh button to update the dashboards with the most recent business process data.

    • List View List View icon icon to view only a single dashboard at a time. When in list view, click the Card View Card View icon icon to view multiple dashboards on the page.

    • Page Navigation controls to scroll to other console pages to view more dashboards.
      Page Navigation Controls on the Console Dashboards page.

    • Preconfigured and custom dashboards, which you can hover over to view more details about the data.
      Milestone and execution time details.

The following dashboards support drilling down into the dashboard details:

  • Passed Milestones: Double-click any milestone bar to open the Business Transaction Details page showing the business transactions (instances) that have passed that milestone.

  • Milestones Summary: Double-click any milestone bubble to open the Business Transaction Details page, showing the business transactions (instances) associated with the milestone.

  • Active Transactions: Double-click any business transaction bar to open the Business Transaction Details page, showing the active business transactions. Because a business transaction state may have changed between the time the dashboard was displayed and the time you clicked a bar, you may not see the same business transactions on the Business Transaction Details page.

  • Transaction Errors: Double-click any slice on the pie chart to open the Business Transaction Details page, showing the business transactions in Error state.

  • Avg. Transaction Completion Time: Double-click any bubble on the bubble chart to open the Business Transaction Details page, showing the business transactions in Successful or Failed state, depending on the bubble you clicked.

  • Custom dashboards: Double-click any element that represents business transactions (such as a pie slice in a pie chart) to open the Business Transaction Details page, showing the associated business transactions.

Work with the Business Transactions Dashboard and Business Transaction Details

The Business Transactions dashboard provides a list of all business transactions, each of which is associated with an activated business process. A business person can view this dashboard to see the start date, end date, last milestone passed, values of various business process indicators, and drill down into details about a specific transaction.

See Business Transactions Dashboard and Business Transaction Details.

You can navigate to the Business Transactions dashboard in any of the following ways:

  • Click the View All link on the console page for a business process.

  • Drill down from preconfigured or custom dashboards.

  • Search for business transactions. See Search Dashboards.


Description of instance-list-june-2018.png follows
Description of the illustration instance-list-june-2018.png

To work with the Business Transactions dashboard:

  • Click any of the row headers to sort the list by that header.

  • Enter values in the Search field to search for case-sensitive partial matches of unique identifiers. See Search Dashboards.

  • Filter by various lifecycle filters or by filterable indicators to narrow or expand your results. See Filter Dashboards.

  • Scroll down to the end of the page to use the navigational arrows to navigate to subsequent pages.

  • Double-click anywhere in the row for a single business transaction (instance) to open the Business Transaction Details page for that business transaction.

    Note:

    If your business process includes milestones that can be passed more than once, and indicator values are extracted for that milestone, only the indicator values extracted from the most recent time the milestone was passed are displayed in the list.

    Drill down into the Business Transaction Details page to see indicator values extracted each time a milestone was passed.



In the Business Transaction Details page:

  • Click any milestone in the timeline to display a popup showing the milestone details, including indicators.

  • Click the breadcrumb links at the top of the page to navigate back to the Business Transactions dashboard and console page for the business process.

Create Custom Dashboards

Custom dashboards use visualization charts, such as pie charts or bar charts, to represent dimensions and measures for Integration Insight models that have indicators defined.

See Custom Dashboards.

Users with the ServiceAdministrator, ServiceDeveloper, or ServiceUser roles can create custom dashboards.

To create a custom dashboard:

  1. In the Oracle Integration navigation pane, click Insight.
  2. In the Insight navigation pane, click Models.
  3. On the Models page, click the model for which you want to create a custom dashboard and ensure that the model has indicators (dimensions and measures) defined. If not, follow the steps in Create Indicators.

    Note:

    You can only create and define indicators for models that are in a Draft state. If you have to create a draft of your model to add indicators, you must also reactivate the model. Metrics may be lost while the model is being reactivated.

  4. Close the Models page.
  5. In the Insight navigation pane, click Consoles.
  6. On the Consoles page, click the model for which you want to create a custom dashboard.
  7. Click Add Dashboard to open the Add New Dashboard dialog.

    The Add New Dashboard dialog.
  8. Enter a suitable Title for the dashboard.
  9. Click the dashboard icon to show the icon picker. Choose an appropriate icon for your dashboard.

    Dashboard icon picker
  10. Click the chart icon to show the chart picker. Select a chart appropriate for the data visualization.

    Chart picker
  11. Based on the type of the chart you choose, select appropriate values for each of the fields in Create Dashboard dialog:
    Chart Type and Values User Interface

    Pie chart

    • Slice Size - select the values to be represented by the slice size. This is a mandatory field.

      • Measure - select the measure for the slice size. This is a mandatory field.

      • Aggregation - select the aggregating function for the slice size. This is a mandatory field.

    • Grouping - select the dimension used to group data. This is a mandatory field.

    • Ignore empty values - select to display data only for valid values, and ignore null values, of the selected dimension.


    Pie chart selections

    Bar chart

    • Y Axis - select the values to be represented on the Y Axis.

      • Measure - select the appropriate measure. This is a mandatory field.

      • Aggregation - select the appropriate aggregating function. This is a mandatory field.

    • X Axis - select the values to be represented on the X Axis. These values can be the instance start date or a dimension.

    • Grouping - select the dimension used to group data. This cannot be the same dimension used for the X-Axis. This is an optional field.

    • Ignore empty values - select to display data only for valid values, and ignore null values, of the selected dimension.


    Bar chart selections.

    Bubble chart

    • X Axis - select the values to be represented on the X Axis.

      • Measure - select the appropriate measure. This is a mandatory field.

      • Aggregation - select the appropriate aggregating function. This is a mandatory field.

    • Y Axis - select the values to be represented on the Y Axis.

      • Measure - select the appropriate measure. This is a mandatory field.

      • Aggregation - select the appropriate aggregating function. This is a mandatory field.

    • Bubble Size - select the values to be used to determine the bubble size.

      • Measure - select the appropriate measure. This is a mandatory field.

      • Aggregation - select the appropriate aggregating function. This is a mandatory field.

    • Grouping - select the dimension used to group data. This is a mandatory field.

    • Ignore empty values - select to display data only for valid values, and ignore null values, of the selected dimension.


    Bubble chart selections.

    Area chart

    • Y Axis - select the values to be represented on the Y Axis.

      • Measure - select the appropriate measure. This is a mandatory field.

      • Aggregation - select the appropriate aggregating function. This is a mandatory field.

    • X Axis - select the values to be represented on the X Axis. These values can be the instance start date or a dimension. This is a mandatory field.

    • Ignore empty values - select to display data only for valid values, and ignore null values, of the selected dimension.


    Area chart selections.

    Line chart

    • Y Axis - select the values to be represented on the Y Axis.

      • Measure - select the appropriate measure. This is a mandatory field.

      • Aggregation - select the appropriate aggregating function. This is a mandatory field.

    • X Axis - select the values to be represented on the X Axis. These values can be the instance start date or a dimension. This is a mandatory field.

    • Ignore empty values - select to display data only for valid values, and ignore null values, of the selected dimension.


    Line chart selections.

    Scatter chart

    • X Axis - select the values to be represented on the X Axis.

      • Measure - select the appropriate measure. This is a mandatory field.

      • Aggregation - select the appropriate aggregating function. This is a mandatory field.

    • Y Axis - select the values to be represented on the Y Axis.

      • Measure - select the appropriate measure. This is a mandatory field.

      • Aggregation - select the appropriate aggregating function. This is a mandatory field.

    • Grouping - select the dimension used to group data. This is a mandatory field.

    • Ignore empty values - select to display data only for valid values, and ignore null values, of the selected dimension.


    Scatter chart selections.

Display Dashboards Using a URL

Integration Insight supports URL access to dashboards, which allows you to display both preconfigured and custom dashboards in a browser or embedded in other applications.

To display one or more dashboards using a URL:

  1. In the Oracle Integration navigation pane, click Insight.
  2. In the Insight navigation pane, click Consoles.
  3. On the Consoles page, click the menu icon in the top right corner of the dashboard for which you want the URL, and select Copy URL.
    Copy URL on custom dashboard menu
  4. Paste the URL where you want to display the dashboard, such as a browser or an application that allows embedded URLs.

    Dashboard in a web browser

    Note:

    • If the source dashboard has filters applied, those filters will be preserved in the URL that displays the embedded dashboard. Click Apply Filters to change the filters applied to the embedded dashboard.
    • If you drill down into the dashboard, the Business Transaction Details page is displayed. Just as within Integration Insight, you can double-click anywhere in the row for a single business transaction (instance) to open the Business Transaction Details page for that business transaction.
  5. To embed multiple dashboards, use Copy URL to retrieve the dashboard IDs from the end of the URL, then append each dashboard ID to the views parameter, separated by commas. For example:
    http://my.company:8003/ic/insight/index.html?pageid=console&console=InsightAPI&startLastXdays=17&display=4&views=Milestone_Summary_Diagram,Milestone_History_Bar

Search Dashboards

You can search for specific business transactions (instances) associated with a business process using case-sensitive partial match search strings.

You can search for business transactions from the console and dashboards page or the Business Transaction Details page. The search results are displayed in a list on the Business Transaction Details page. For example, you can search for business transactions such as a particular sales opportunity or help ticket. You can also filter by various lifecycle filters or by filterable indicators to narrow or expand your results.

The Search field has the same label as the business transaction identifier.


Search field

Notes:

  • Search is performed based on only the search string you provide. Any filters you have applied are ignored.

  • Search is performed on only identifier values of business transactions (instances). For example, if the identifier is Order Number, you can only search for business transactions by order number.

  • Retrieving a large number of business transactions in a search may adversely affect performance.

  • When you enter a search, if the business transaction identifier is of type integer, double, or date, you must enter a search string that exactly matches the identifier. If the identifier is of type string, you can enter a partial string that can include the following SQL wildcards:

    • % (percentage): A substitute for zero or more characters.

    • _ (underscore): A substitute for a single character.

Filter Dashboards

Integration Insight supports a sophisticated set of filter criteria that allows business owners to focus on the business data that matters most to them. The filter criteria that is selected determines which business transactions are included in the dashboards.

Filter criteria can be specified for:

  • preconfigured dashboards

  • custom dashboards

  • the Business Transaction Details page


Description of bt-dash-filter.png follows
Description of the illustration bt-dash-filter.png

For all dashboards, you can specify milestone-related filter criteria, such as business transaction start date, end date, duration, passed milestones, and so on. These are called lifecycle filters, and are the same across all business processes.

For custom dashboards and the Business Transaction Details page, you can also specify criteria based on indicators in the business process that have been marked as filterable. These are called indicator filters, and vary between business processes.

Note:

Dashboards do not update automatically. You must click Apply to apply the filters and to update the dashboards based on your filter criteria or Clear All to clear all the selected filters. Click Refresh to see the latest data without changing the filters.

Lifecycle Filters

To filter dashboards by lifecycle filters:

The available lifecycle filters are:
  • Transaction Started: Filters for business transactions started in your chosen time range of either one of the preset ranges or a custom range. The default value is Last 5 Days.

    • Last x Days - displays all transactions started within the last x days, where a day is the current time minus 24 hours.

    • Use as Default for all Consoles - when selected, all consoles will use the specified filter value.

    • Custom Start Value - displays all transactions started during a time range you specify.

    • Clear - clears the filter you have set, and returns to the default value.

  • Transaction Ended: Filters for business transactions ended in your chosen time range of either one of the preset ranges or a custom range. The default value is Last 1 Days.

    • Last x Days - displays all business transactions completed within the last x days, where a day is the current time minus 24 hours.

    • Custom End Value - displays all transactions completed during a time range you specify.

    • Clear - clears the filter you have set, and returns to the default value.

  • Transaction Duration: Filters for the length of time a business transaction took to complete. Enter a numerical value in the text box and select the appropriate unit of time. The possible units are: Days, Hours, Minutes, and Seconds.

  • Any Milestones/Last Milestones: Filters for business transactions that have passed selected milestones. This includes active and completed transactions.

    • Any Status - displays data for transactions that have passed the milestone(s) you select.

    • Last - displays data for transactions that have most recently passed the milestone(s) you select.

  • Transaction Status: Filters for business transactions that were in the selected status(es) at the time the data was loaded. The possible values are:

    • Healthy - displays data for transactions that are running.

    • Successful - displays data for transactions that have completed successfully.

    • Recoverable Errors - displays data for transactions that are in a faulted state.

    • Failed - displays data for transactions that have failed.

Note:

When you change filter criteria, click Apply to refresh the business transaction data and apply the changed filters. Clicking Refresh Data only refreshes the data, without applying the changed filters.

Note:

Integration Insight does not support filtering by NULL string values.

Indicator Filters

To filter dashboards by indicators that have been marked as filterable (applies only to custom dashboards and the Business Transaction Details page):

  • Click the Expand Filters Filters icon icon to expose the filter criteria for selection. For example, the following screen shows two indicators have been marked as filterable in the business process.


    Indicator filters for custom dashboards and Business Transaction Dashboard

Note:

When filtering by numeric indicators, you specify a numeric range of values to return. Filtering by text strings requires a case-sensitive exact match that can include the following SQL wildcards:

  • % (percentage): A substitute for zero or more characters.

  • _ (underscore): A substitute for a single character.