1. Using Integration Insight in Oracle Integration Generation 2
  2. Embed Insight Dashboards in Other Applications
  3. Construct a URL Manually to Embed Insight Dashboards

Construct a URL Manually to Embed Insight Dashboards

You can embed Insight dashboards in other applications in an iFrame using a specially constructed URL.

Limitation:

The external application and the Oracle Integration instance must use the same Single Sign-On (SSO).

Refer to the following sections for the URL parameters specific to each dashboard:

Preconfigured and Custom Dashboards

The following parameters can be used to build the URL that describes the preconfigured and custom dashboards to be embedded in another application and the transactions to be shown in those dashboards.

Example URL: https://oic-host/ic/home/lite.html?root=console&console=InsightAPIM_giqndguH&views=Milestone_Summary_Diagram

Parameter Description Values/Syntax Example
root Required. The page ID of the Consoles page. console root=console
console Required. The ID of the associated console for the dashboards, as specified in the console manifest. console-id console=InsightAPIM_giqndguH
views Required. A comma-separated list of dashboard IDs, as specified in the console manifest. dashboard-id1,dashboard-id2,… , dashboard-idn views=PieChart123,Milestone_Summary_Diagram
header

Optional. When set to true, each embedded dashboard includes a header showing the name of the dashboard. For example, Milestones Summary.

Default: false

 true | false header=true
height Optional. The desired height of the dashboards, in pixels. Minimum value (default): 350 integer height=350
layout

Optional. A comma-separated list of the number of dashboards to be rendered for each row.

Default: 1 (vertical single-column layout).

number-dashboards-in-1st-row,number-dashboards-in-2nd row, …,number-dashboards-in-nth-row layout=4 displays 4 dashboards in one row:
Embedded dashboards with layout=4

layout=2,2 displays 2 rows with 2 dashboards per row:
Embedded dashboards with layout=2,2

layout=1,3,2 displays 3 rows with 1 dashboard in the first row, 3 in the second row, and 2 in the third row:


Embedded dashboards with layout=1,3,2
timezone

Optional. Time zone offset from Greenwich Mean Time (GMT) to be shown with the dashboards.

Default: Host computer time zone.

GMT+|-xx:xx timezone=GMT+05:30
drilldown

Optional. When set to true, enables the capability to click on embedded preconfigured or custom dashboards to drill down to associated business transactions.

Default: false

 true | false drilldown=true
Filter Parameter Description Values/Syntax Example
fromStartDate

toStartDate

Optional. Dashboards show business transactions started during the specified date range.

Valid only if startTimeWindow is not specified.

yyyy-MM-dd HH:mm:ss

fromStartDate=2020-08-22 16:19:37&toStartDate=2020-08-17 16:19:37

startTimeWindow

Optional. Dashboards show business transactions started within the last x days, where a day is the current time minus 24 hours.

Default: 5

Valid only if fromStartDate and toStartDate are not specified.

integer startTimeWindow=4
fromEndDate

toEndDate

 Optional. Dashboards show business transactions completed during the range between fromEndDate and toEndDate. Specify the start and end dates of the range.

Valid only if endTimeWindow is not specified.

yyyy-MM-dd HH:mm:ss fromEndDate=2020-08-22 16:19:37&toEndDate=2020-08-17 16:19:37
endTimeWindow

Optional. Dashboards show business transactions completed within the last x days, where a day is the current time minus 24 hours.

Valid only if fromEndDate and toEndDate are not specified.

integer endTimeWindow=6
Duration:

MinInstExecDuration

MaxInstExecDuration

Time Unit:

InstExecDuration

Optional. Dashboards show business transactions that completed in the specified length of time.

Specify MinInstExecDuration and MaxInstExecDuration duration values as integers, and specify time unit values as a comma-separated list of two values where the first value is the time unit of the MinInstExecDuration (start) value and the second value is the time unit of the MaxInstExecDuration (end) value.

Duration values:

integer

Time Unit values:

Seconds | Minutes | Hours | Days

MinInstExecDuration=1&MaxInstExecDuration=2&InstExecDuration=Minutes,Hours

filters those transactions that completed within the duration of 1 minute to 2 hours
status

Optional. Dashboards show business transactions that are in the specified status(es) at the time the dashboard is rendered.

Specify statuses as a comma-separated list of values.

Default: ALL

status1,status2, …, statusn | ALL

where valid status values are:

RUNNING

COMPLETED

RECOVERABLE

FAILED

 status=RUNNING,COMPLETED,RECOVERABLE
anyMilestones

lastMilestones

Optional. Dashboards show business transactions that have passed any of the milestones specified by anyMilestones, or have most recently passed the milestones specified by lastMilestones.

Specify milestones as a comma-separated list of milestone IDs, as specified in the console manifest.

Default: ALL

 milestone-id1,milestone-id2, …, milestone-idn | ALL

anyMilestones=API_START_IthAGqTx,API_STANDAR_TbJajNFt

lastMilestones=API_START_IthAGqTx,API_STANDAR_TbJajNFt
For indicators of type string:

indicator-id

 Applies only to custom dashboards.

Optional. Dashboards show business transactions where the specified indicator has the specifed value.

Any valid string value | ALL City=Bangalore

In this example, the indicator is a dimension with ID City of string data type.

For indicators of type decimal, integer, or float:

minindicator-id

maxindicator-id

 Applies only to custom dashboards.

Optional. Dashboards show business transactions where the specified indicator is in the specified range.

Any valid decimal, integer, or float value | ALL minOrderAmount=11&maxOrderAmount=11.4

In this example, the indicator is a measure with ID OrderAmount of float data type.

For indicators of type date:

fromindicator-id

toindicator-id

 Applies only to custom dashboards.

Optional. Dashboards show business transactions where the value of the specified indicator is in the specified date range.

yyyy-MM-dd HH:mm:ss fromOrderDate=2020-08-22 16:19:37&toOrderDate=2020-08-17 16:19:37

In this example, the indicator is a measure with ID OrderDate of date data type.

Business Transactions Dashboard

The following parameters can be used to build the URL that describes the business transactions to include in the dashboard to be embedded in another application.

Example URL: https://oic-host/ic/home/lite.html?root=bTxns&console=InsightAPIM_giqndguH

Parameter Description Values/Syntax Example
root Required. The page ID of the Business Transactions dashboard. bTxns root=bTxns
console Required. The ID of the associated console for the business transactions, as specified in the console manifest. console-id console=InsightAPIM_giqndguH
header

Optional. When set to true, the embedded dashboard includes a header showing the number of business transactions, followed by the term defined as the Business Transactions Label when the model was created. For example, 523 Orders.

Default: false

 true | false header=true
Filter parameters See filter parameters for Preconfigured and Custom Dashboards.

Business Transaction Details Dashboard

The following parameters can be used to build the URL that describes the business transaction details to be embedded in another application.

Example URL: https://oic-host/ic/home/lite.html?root=bTxnDetails&console=InsightAPIM_giqndguH&bTxnId=1224

Parameter Description Values/Syntax Example
root Required. The page ID of the Business Transaction Details page. bTxnDetails root=bTxnDetails
console Required. The ID of the associated console for the business transaction, as specified in the console manifest. console-id console=InsightAPIM_giqndguH
bTxnId Required. The ID of the business transaction.

You can find this ID in the row for the business transaction in the Business Transactions Dashboard.

transaction-id bTxnId=1224
header

Optional. When set to true, the embedded dashboard includes a header showing the model identifier name and value for the business transaction. For example, Order ID 4566.

Default: false

 true | false header=true

Progress Tracker Dashboard

The following parameters can be used to build the URL that describes the progress tracker to be embedded in another application.

Example URL: https://oic-host/ic/home/lite.html?root=bTxnProgress&console=InsightAPIM_giqndguH&bTxnId=1224

Parameter Description Values/Syntax Example
root Required. The page ID of the progress tracker for a business transactions. This page displays when you click the Click to change to progress view icon in the Business Transaction Details page. bTxnProgress root=bTxnProgress
console Required. The ID of the associated console for the business transaction, as specified in the console manifest. console-id console=InsightAPIM_giqndguH
bTxnId Required. The ID of the business transaction.

You can find this ID in the row for the business transaction in the Business Transactions Dashboard.

transaction-id bTxnId=1224
ignoreMilestones Optional. A comma-separated list of one or more milestones to exclude from the progress tracker. milestone-id ignoreMilestones=test_RdaKTHMz
showSkippedMilestones Optional. When set to true, the embedded dashboard shows all milestones that have not been passed (including Error and Terminal Error milestones). When skipped milestones are shown, the milestone sequence in the progress tracker dashboard is the order in which the milestones are defined in the model. For a description of the default milestones shown in the dashboard, see Progress Tracker Dashboard.

Example

By default, the dashboard for a Completed business transaction with Successful status shows only passed milestones, in the order in which they are passed at runtime. With showSkippedMilestones=true, the embedded dashboard shows both passed and not passed (skipped) milestones in the order in which the milestones are defined in the model.


Progress tracker dashboard for a Completed (Successful) business transaction showing skipped milestones
 true | false showSkippedMilestones=true
header

Optional. When set to true, the progress tracker dashboard includes a header showing the name of the console and the ID of the business transaction. To replace the ID with the value of a specific indicator, set the showid parameter to the indicator ID.

Example

With header=true, the header shows the name of the console and the transaction ID:


Progress tracker dashboard for a Completed (Successful) business transaction showing default header

Default: false

 true | false header=true
showid Optional. The ID of an indicator to replace the default business transaction ID in the header with the indicator value. Exposed only if header=true.

Example

With showId=ShippingState, the header shows the indicator value:


Progress tracker dashboard for a Completed (Successful) business transaction showing custom header
 indicator-id showId=ShippingState
animate

Optional. Displays the progress tracker as a live animation that overlays each blue segment with a green segment to visualize passed milestones. Specify a value to set the speed of the overlay animation in milliseconds.

Default: 0 (no animation).

integer animate=500