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 Default: |
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: |
number-dashboards-in-1st-row,number-dashboards-in-2nd
row,
…,number-dashboards-in-nth-row |
layout=4 displays 4 dashboards in
one row:
|
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 Default: |
true |
false |
drilldown=true |
Filter Parameter | Description | Values/Syntax | Example |
---|---|---|---|
fromStartDate
|
Optional. Dashboards show business transactions started during the specified date range. Valid only if |
yyyy-MM-dd
HH:mm:ss |
|
startTimeWindow |
Optional. Dashboards show business transactions
started within the last Default: Valid only if |
integer |
startTimeWindow=4 |
fromEndDate
|
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
|
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 Valid only if |
integer |
endTimeWindow=6 |
Duration:
Time Unit: InstExecDuration |
Optional. Dashboards show business transactions that completed in the specified length of time. Specify |
Duration values:
Time Unit values: Seconds | Minutes | Hours |
Days |
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: |
where valid status values are:
|
status=RUNNING,COMPLETED,RECOVERABLE |
anyMilestones
|
Optional. Dashboards show business transactions that
have passed any of the milestones specified by
Specify milestones as a comma-separated list of milestone IDs, as specified in the console manifest. Default: |
milestone-id1,milestone-id2,
…, milestone-idn | ALL |
|
For indicators of type
string :
|
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
|
For indicators of type decimal ,
integer , or float :
|
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
|
For indicators of type
date :
|
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
|
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 Default: |
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
Default: |
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 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
|
true |
false |
showSkippedMilestones=true |
header |
Optional. When set to Example With Default: |
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
|
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: |
integer |
animate=500 |