Develop > Customize KPIs, Metrics, Pages, and More > Prepare the Dashboard Display > Customized Static or Dynamic URL Component

Customized Static or Dynamic URL Component

You can use a static URL, where the component simply opens the URL that you enter. You can also create a dynamic URL, where the component URL responds to other components on the page.

ClosedTo access:

In the Component Gallery, click the Add External Component button or select a component and click the Edit Component Properties button.

Note The URL for an external component must begin with one of the following: https://, http://, or ftp://.

Main task: Dashboard Display

ClosedCreate a simple URL component

  1. In the Dashboard, click the Component Gallery button in the Dashboard toolbar, or in an empty component of the Dashboard, click the Add Component button.
  2. In the Component Gallery dialog box that opens, click the Add External Component button.
  3. In the New Component dialog box that opens, enter the name, URL, and description, and click OK.
  4. Optionally. In the Categorize Component area, select one or more categories to which you want the component assigned.

    5. The new component is added to the Component Gallery, and can then be added to any page.

ClosedCreate a dynamic URL

  1. In the Dashboard, click the Component Gallery button in the Dashboard toolbar, or in an empty component of the Dashboard, click the Add Component button.
  2. In the Component Gallery dialog box that opens, click the Add External Component button.
  3. In the New Component dialog box that opens, enter a name for the component and the static portion of the URL.
  4. Optionally. In the Categorize Component area, select one or more categories to which you want the component assigned.
  5. In the Wiring Context area, select one or more contexts whose attributes can be used to define the URL pattern.
  6. In the URL Parameters and Values area, click the New Parameter button.
  7. In the New Parameter dialog box that opens select the URL Part (the area of the URL where you want to add the parameter), and the name of the parameter, and click OK. The parameter is added to the URL Parameter and Value table.
  8. Drag the relevant attribute from the Attributes list. The attributes displayed in the list are based on the contexts you selected in the Wiring Context area.

    The URL Pattern area shows the dynamic URL you have built, using the static URL in the upper area of the dialog box, and the URL parameters that you defined.

  9. Click OK to save the component.

    10. The new component is added to the Component Gallery, and can then be added to any page.

ClosedNew/Edit Component Dialog Box

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

UI Element

Description
<Upper Pane>

Refresh. If you have edited the static part of the URL, click refresh to update the URL pattern below.
Name Enter the name you want to assign to the component.
URL

Enter the URL of the component.

If you are creating a dynamic URL using parameters, enter the static part of the URL here.

Example The URL to search for the string hp in Google.com uses the following format: http://www.google.com/search?q=hp. The static part of this URL is the section before the question mark: http://www.google.com/search.

If you are creating a static URL, and you are using HTTP, your browser might block the link as it might consider it an unsafe script because ITBA runs on HTTPS, which is secure. If you are using Chrome there will be a little shield to the right of the URL bar. If you are using IE, go to Internet Options > Security > Internet > Custom level..., and make sure that the Enable box under Display mixed content is checked. If, in addition, you get a certificate error (e.g. self signed), some browsers will not load the page within frames. In this case, ensure that you can load the page without any errors (e.g. importing the certificate into trusted store) and try again.
Description

The description of the component.
Categorize Component

Click on the drop down element to display a list of the existing categories. You can select one or more categories. You can also create new categories. For details, see the Left Pane section of user interface in the Component Gallery and Component Categories.
Configure Wiring

This area enables you to select one or more contexts whose attributes are used to define the URL pattern.

Wiring Context

Lists the wiring contexts you have already configured. Each line represents a context whose attributes can be used to create the URL pattern.

Add Context. Click to add a context whose attributes can be used to define the URL pattern.

 You must enter a URL in the URL box before you click the Add Context button.

The Select Contexts dialog box enables you to select which context to add.


You can select:

  • KPI List Selection. The context is sent to the target component, when you select a KPI in the source component.
  • Objective Selection.The context is sent to the target component, when you select an Objective in the source component.
Remove. Select a wiring context and click the button to remove it from the list.
URL Parameters and Values Area for KPI List Selection or Objective Selection

This area enables you to add URL parameters and values to build the URL pattern, using wiring context attributes.

UI Element

Description

New Parameters. Click to add a URL parameter. Select the area of the URL where you want to add the parameter in the URL Part:

Path. The parameter is used in the path part of the URL.

Query String. The parameter is used in the query string of the URL.

Fragment. The parameter is used in the rest of the URL.

Type the parameter name in the Name box in the URL Parameters dialog box that appears.

Example To create a dynamic URL based on http://www.google.com/search?q=hp, add a URL parameter named q.
Remove. Select a URL parameter and click this button to remove it from the list.
URL Parameter and Value

Lists the URL parameters you have already configured.

Each line represents the name of a URL parameter which is used to create the URL pattern, and its value. After defining a parameter name, drag an attribute from the Attributes area to the Value area of the URL parameter.

To edit a parameter value, click the value itself and edit its contents.
Attributes

This contains a list of the attributes that can be used to build the URL pattern. This list is dependent on the contexts you select in the Wiring Context area.

  • If you select KPIChange in the Wiring Context area, the attribute <<kpiId>>is available to build your URL pattern. The parameter represents the ID of the KPI on which you click in the source component to run the external URL with the ID of the KPI as a parameter.
  • If you select ObjectiveChanges in the Wiring Context area, the attributes <<id>> and <<type>> are available to build your URL pattern. The <<id>> parameter represents the ID of the Objective and the <<type>> parameter represents the type of the Objective on which you click in the source component to run the external URL with the ID of the KPI as a parameter.

To use an attribute as the value of a URL parameter, drag the attribute from this area to the Value area of the parameter.
URL Pattern

This shows the URL pattern that was built using the static URL that you entered in the URL field, and the URL parameters that you defined in the URL Parameters area.

Example The result of the creation of a dynamic URL based on http://www.google.com/search?q=. 

Send Help Center feedback