Construct a URL Using the URL Builder to Embed Insight Dashboards

Limitation:

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

To construct a URL for embedding dashboards using the URL builder:

In Insight, go to the page that shows the dashboard(s) you want to embed: preconfigured and custom dashboards, the Business Transactions dashboard, the Business Transaction Details dashboard, or the progress tracker dashboard.
In the header area, click Embed Dashboard to open the Embed Dashboards dialog.
Click the URL in an iFrame selection to open the URL Builder.
In the URL builder, select or specify values to customize the dashboard(s) you want to embed in an external application:
Click Update Preview to preview the dashboard(s) that the URL renders.

Note:
The preview is not automatically refreshed. You must click Update Preview to see the results of changes to the URL.
When you have completed constructing the URL that represents the dashboards you want to embed, hover over the URL and click the Copy to Clipboard icon to paste it as required by the external application.

Preconfigured and Custom Dashboards

Use the URL builder to select the preconfigured and custom dashboards to be embedded in another application and filter the transactions and attributes to be shown in those dashboards.

Dashboards Pane Description Values/Syntax URL Parameter Example

Checklist of dashboards Required. Select the dashboards you want to include to generate a comma-separated list of dashboard IDs. dashboard-id1,dashboard-id2,… , dashboard-idn views views=PieChart123,Milestone_Summary_Diagram

Height Optional. Enter the desired height of the dashboards, in pixels. Minimum value (default): 350. integer height height=350

Dashboards Pane	Description	Values/Syntax	URL Parameter	Example
Checklist of dashboards	Required. Select the dashboards you want to include to generate a comma-separated list of dashboard IDs.	`dashboard-id1,dashboard-id2,`… `, dashboard-idn`	`views`	`views=PieChart123,Milestone_Summary_Diagram`
Height	Optional. Enter the desired height of the dashboards, in pixels. Minimum value (default): `350`.	`integer`	`height`	`height=350`
Layout	Optional. Enter a comma-separated list of the number of dashboards to be rendered for each row. For example: A value of `4` displays 4 dashboards in one row: A value of `2,2` displays 2 rows with 2 dashboards per row: A value of `1,3,2` displays 3 rows with 1 dashboard in the first row, 3 in the second row, and 2 in the third row: Default: vertical single-column layout.	`number-dashboards-in-1st-row,number-dashboards-in-2nd row,` …`,number-dashboards-in-nth-row`	`layout`	`layout=4` `layout=2,2` `layout=1,3,2`

Layout

Optional. Enter a comma-separated list of the number of dashboards to be rendered for each row. For example:

A value of 4 displays 4 dashboards in one row:
A value of 2,2 displays 2 rows with 2 dashboards per row:
A value of 1,3,2
displays 3 rows with 1 dashboard in the first row, 3 in the second row, and 2 in the third row:

Default: vertical single-column layout.

number-dashboards-in-1st-row,number-dashboards-in-2nd
                                        row,

…,number-dashboards-in-nth-row

layout

layout=4

layout=2,2

layout=1,3,2

Styling Pane Description Values/Syntax URL Parameter Example

Styling Pane	Description	Values/Syntax	URL Parameter	Example
Show Header	Optional. Select to include a header with each embedded dashboard showing the name of the dashboard. For example, Milestones Summary. Default: Not selected (no header).	`true` \| `false` (default)	`header`	`header=true`

Show Header

Optional. Select to include a header with each embedded dashboard showing the name of the dashboard. For example, Milestones Summary.

Default: Not selected (no header).

true | false (default)

header

header=true

Lifecycle Filters Pane	Description	Values/Syntax	URL Parameter	Example
Transaction Started	Optional. Select one of the following filters: Started in last x days to enter a value (`x`) to display in the dashboards business transactions started within the last `x` days, where a day is the current time minus 24 hours. Default: `5`. Started in this range to enter a calendar range to display in the dashboards business transactions started during the specified range.	Started in last x days: `integer` Started in this range: `yyyy-MM-dd HH:mm:ss`	Started in last x days: `startTimeWindow` Started in this range: `fromStartDate` and `toStartDate`	Started in last x days: `startTimeWindow=4` Started in this range: `fromStartDate=2020-08-22 16:19:37&toStartDate=2020-08-17 16:19:37`
Transaction Ended	Optional. Select one of the following filters: Ended in last x days to enter a value (`x`) to display in the dashboards business transactions ended within the last `x` days, where a day is the current time minus 24 hours. Ended in this range to enter a calendar range to display in the dashboards business transactions ended during the specified range. None (default) to omit a transaction ended filter.	Ended in last x days: `integer` Ended in this range: `yyyy-MM-dd HH:mm:ss`	Ended in last x days: `endTimeWindow` Ended in this range: `fromEndDate`, `toEndDate`	Ended in last x days: `endTimeWindow=3` Ended in this range: `fromEndDate=2020-08-22 16:19:37&toEndDate=2020-08-17 16:19:37`
Transaction Duration	Optional. Enter From and To values and select a time unit to display in the dashboards business transactions that completed in the specified length of time.	Range values: `integer` Time Unit values: `Days \| Hours \| Minutes \| Seconds`	Range: `MinInstExecDuration`, `MaxInstExecDuration` Time Unit: `InstExecDuration`	`MinInstExecDuration=1&MaxInstExecDuration=2&InstExecDuration=Minutes,Hours` filters those transactions that completed in the range of 1 minute to 2 hours
Milestones	Optional. Select one of the following filters: Any to display in the dashboards business transactions that have passed any of the milestones you select from the list. Last to display in the dashboards business transactions that have most recently passed the milestones you select from the list. None (default) to omit a milestone filter. In this case, dashboards will display all transactions that have passed all milestones.	`milestone-id1,milestone-id2,` …`, milestone-idn`	`anyMilestones` `lastMilestones`	`anyMilestones=API_START_IthAGqTx,API_STANDAR_TbJajNFt` `lastMilestones=API_START_IthAGqTx,API_STANDAR_TbJajNFt`
Transaction Status	Optional. Select one or more status values. Dashboards show business transactions that are in the specified status(es) at the time the dashboard is rendered. Default: Display all transactions in all statuses.	`RUNNING` `COMPLETED` `RECOVERABLE` `FAILED`	`status`	`status=RUNNING,COMPLETED,RECOVERABLE`

Custom Filters Pane (applies only to custom dashboards)	Description	Values/Syntax	URL Parameter	Example
Indicators of type `decimal`, `integer`, or `float`	Optional. Enter valid values to display in the dashboards business transactions that fall within the specified minimum and maximum range.	Any valid `decimal`, `integer`, or `float` values.	`minindicator-id` `maxindicator-id`	`minOrderAmount=11&maxOrderAmount=11.4` In this example, the indicator is a measure with ID `OrderAmount` of `float` data type.
Indicators of type `string`	Optional. Enter a valid string value. Dashboards show business transactions where the `string` indicator has the specifed value.	Any valid `string` value	`indicator-id`	`City=Bangalore` In this example, the indicator is a dimension with ID `City` of `string` data type.
Indicators of type `date`	Optional. Select either Last x Days or Custom Range. Dashboards show business transactions where the `date` indicator value is within the specified last number of days or date range.	`yyyy-MM-dd HH:mm:ss`	`fromindicator-id` `toindicator-id`	`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.

Advanced Properties Description Values/Syntax URL Parameter Example

Advanced Properties	Description	Values/Syntax	URL Parameter	Example
Time Zone	Optional. Select the time zone to be shown with the dashboards as an offset from Greenwich Mean Time (GMT). Default: Host computer time zone.	`GMT+\|-xx:xx`	`timezone`	`timezone=GMT+05:30`
Enable Navigation to Business Transactions	Optional. Select to enable the capability to click on embedded preconfigured or custom dashboards to drill down to associated business transactions. Default: Not selected (no drill down).	`true` \| `false` (default)	`drilldown`	`drilldown=true`

Time Zone

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

Default: Host computer time zone.

GMT+|-xx:xx

timezone

timezone=GMT+05:30

Enable Navigation to Business Transactions

Optional. Select to enable the capability to click on embedded preconfigured or custom dashboards to drill down to associated business transactions.

Default: Not selected (no drill down).

true | false (default)

drilldown

drilldown=true

Business Transactions Dashboard

Use the URL builder to filter the business transactions to include in the dashboard to be embedded in another application.

Styling Pane Description Values/Syntax URL Parameter Example

Styling Pane	Description	Values/Syntax	URL Parameter	Example
Show Header	Optional. Select to include a header with the embedded dashboard 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: Not selected (no header).	`true` \| `false` (default)	`header`	`header=true`

Show Header

Optional. Select to include a header with the embedded dashboard 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: Not selected (no header).

true | false (default)

header

header=true

Lifecycle Filters Pane	Description	Values/Syntax	URL Parameter	Example
Transaction Started	Optional. Select one of the following filters: Started in last x days to enter a value (`x`) to display in the dashboard business transactions started within the last `x` days, where a day is the current time minus 24 hours. Default: `5`. Started in this range to enter a calendar range to display in the dashboard business transactions started during the specified range.	Started in last x days: `integer` Started in this range: `yyyy-MM-dd HH:mm:ss`	Started in last x days: `startTimeWindow` Started in this range: `fromStartDate`, `toStartDate`	Started in last x days: `startTimeWindow=4` Started in this range: `fromStartDate=2020-08-22 16:19:37&toStartDate=2020-08-17 16:19:37`
Transaction Ended	Optional. Select one of the following filters: Ended in last x days to enter a value (`x`) to display in the dashboard business transactions ended within the last `x` days, where a day is the current time minus 24 hours. Ended in this range to enter a calendar range to display in the dashboard business transactions ended during the specified range. None (default) to omit a transaction ended filter.	Ended in last x days: `integer` Ended in this range: `yyyy-MM-dd HH:mm:ss`	Ended in last x days: `endTimeWindow` Ended in this range: `fromEndDate`, `toEndDate`	Ended in last x days: `endTimeWindow=3` Ended in this range: `fromEndDate=2020-08-22 16:19:37&toEndDate=2020-08-17 16:19:37`
Transaction Duration	Optional. Enter From and To values and select a time unit to display in the dashboard business transactions that completed within the specified length of time.	Duration values: `integer` Time Unit values: `Days \| Hours \| Minutes \| Seconds`	Duration: `MinInstExecDuration`, `MaxInstExecDuration` Time Unit: `InstExecDuration`	`MinInstExecDuration=1&MaxInstExecDuration=2&InstExecDuration=Minutes,Hours` filters those transactions that completed within the duration of 1 minute to 2 hours
Milestones	Optional. Select one of the following filters: Any to display in the dashboard business transactions that have passed any of the milestones you select in the field below. Last to display in the dashboard business transactions that have most recently passed the milestones you select in the field below. None (default) to omit a milestone filter.	`milestone-id1,milestone-id2,` …`, milestone-idn`	`anyMilestones` `lastMilestones`	`anyMilestones=API_START_IthAGqTx,API_STANDAR_TbJajNFt` `lastMilestones=API_START_IthAGqTx,API_STANDAR_TbJajNFt`
Transaction Status	Optional. Select one of more status values to display in the dashboard business transactions that were in the specified status(es) at the time the data was loaded. Default: Display all transactions in all statuses.	`RUNNING` `COMPLETED` `RECOVERABLE` `FAILED`	`status`	`status=RUNNING,COMPLETED,RECOVERABLE`

Custom Filters Pane	Description	Values/Syntax	URL Parameter	Example
Indicators of type `string`	Optional. Enter a valid string value to display in the dashboards business transactions with that value for the indicator.	Any valid `string` value	`indicator-id`	`City=Bangalore` In this example, the indicator is a dimension with ID `City` of `string` data type.
Indicators of type `decimal`, `integer`, or `float`	Optional. Enter valid values to display in the dashboards business transactions that fall within the specified minimum and maximum range.	Any valid `decimal`, `integer`, or `float` values.	`minindicator-id` `maxindicator-id`	`minOrderAmount=11&maxOrderAmount=11.4` In this example, the indicator is a measure with ID `OrderAmount` of `float` data type.
Indicators of type `date`	Optional. Select Last x days and value, or select Custom Range and a From/To date range. Dashboards show business transactions where the indicator value matches the dates specified.	`yyyy-MM-dd HH:mm:ss`	`fromindicator-id` `toindicator-id`	`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 Transaction Details Dashboard

Use the URL builder to identify the business transaction to include in the dashboard to be embedded in another application.

General Properties Pane	Description	Values/Syntax	URL Parameter	Example
View	Click to embed the progress tracker dashboard for the business transaction, and click to embed the Business Transaction Details dashboard for the business transaction. You must click Update Preview to refresh the dashboard with the new view. The `header` setting is preserved between views, but other settings are set to their default values when you switch views.	N/A	N/A	N/A
Business Transaction ID	Required. The ID of the business transaction. This field is automatically filled by the ID of the business transaction that you selected in the Business Transactions dashboard.	`transaction-id`	`bTxnId`	`bTxnId=1224`

Styling Pane Description Values/Syntax URL Parameter Example

Styling Pane	Description	Values/Syntax	URL Parameter	Example
Show Header	Optional. Select to include a header showing the unique instance identifier name and value for the business transaction. For example, Order Number 4566. Default: Not selected (no header). Example With Show Header selected, the header shows the unique instance identifier name and value for the current business transaction:	`true` \| `false` (default)	`header`	`header=true`

Show Header

Optional. Select to include a header showing the unique instance identifier name and value for the business transaction. For example, Order Number 4566.

Default: Not selected (no header).

Example

With Show Header selected, the header shows the unique instance identifier name and value for the current business transaction:
Business Transaction Details view for a Completed (Successful) business transaction showing the default header

true | false (default)

header

header=true

Progress Tracker Dashboard

Use the URL builder to customize the progress tracker dashboard to be embedded in another application.

General Properties Pane	Description	Values/Syntax	URL Parameter	Example
View	Click to embed the progress tracker dashboard for the business transaction, and click to embed the Business Transaction Details dashboard. You must click Update Preview to refresh the dashboard with the new view. For URL parameters that the two views have in common, such as `header`, the settings you specify in one view are inherited in the other view.	N/A	N/A	N/A
Identifier	Required. The ID of the business transaction (the value of the unique instance identifier for this transaction). This field is automatically filled by the ID of the business transaction that you selected in the Business Transactions dashboard.	`transaction-id`	`bTxnId`	`bTxnId=1224`
Exclude Milestones	Optional. Select one or more milestones to exclude from the progress tracker dashboard from the list of all milestones defined in the associated model. For example, if business executives do not want to see a particular Error milestone when it is passed, select that milestone from the list and click Update Preview to hide the milestone from the dashboard.	`milestone-id`	`ignoreMilestones`	`ignoreMilestones=test_RdaKTHMz`
Custom Settings	Optional. Select Show skipped milestones to show 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 Show skipped milestones selected, the embedded dashboard shows both passed and not passed (skipped) milestones in the order in which the milestones are defined in the model.	`true` \| `false`	`showSkippedMilestones`	`showSkippedMilestones=true`

Styling Pane Description Values/Syntax URL Parameter Example

Styling Pane	Description	Values/Syntax	URL Parameter	Example
Show Header	Optional. Select to include a header showing the name of the console and the ID of the business transaction. Default: Not selected (no header). Example With Show Header selected, the header shows the name of the console and the transaction ID:	`true` \| `false` (default)	`header`	`header=true`
Custom Header	Optional. Exposed only if Show Header is selected. Select an indicator to replace the default business transaction ID in the header with the indicator value. Example With Custom Header set to indicator `Shipping State`, the header shows the indicator value:	`indicator-id`	`showid`	`showId=ShippingState`
Animation	Optional. Enter a value to display the progress tracker as a live animation that overlays grey segments with green segments to visualize passed milestones, where the value you enter specifies the speed of the overlay animation in milliseconds. Default: No animation.	`integer`	`animate`	`animate=500`

Show Header

Optional. Select to include a header showing the name of the console and the ID of the business transaction.

Default: Not selected (no header).

Example

With Show Header selected, the header shows the name of the console and the transaction ID:

true | false (default)

header

header=true

Custom Header

Optional. Exposed only if Show Header is selected. Select an indicator to replace the default business transaction ID in the header with the indicator value.

Example

With Custom Header set to indicator Shipping State, the header shows the indicator value:

indicator-id

showid

showId=ShippingState

Animation

Optional. Enter a value to display the progress tracker as a live animation that overlays grey segments with green segments to visualize passed milestones, where the value you enter specifies the speed of the overlay animation in milliseconds.

Default: No animation.

integer

animate

animate=500