Skip Headers
Oracle® Fusion Middleware User's Guide for Oracle Business Intelligence Enterprise Edition
11g Release 1 (11.1.1)

Part Number E10544-06
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Master Index
Master Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

10 Working with Actions

This chapter describes how to work with actions in Oracle Business Intelligence Enterprise Edition. It describes how to use actions to navigate to related content and to invoke operations, functions, or processes in external systems and explains how to add actions to analyses, dashboard pages, agents, KPIs, and initiatives and objectives in scorecards.

This chapter includes the following sections:

What Are Actions?

Actions provide functionality to:

You can include actions in analyses, dashboard pages, agents, scorecard objectives, scorecard initiatives, and KPIs

Actions can be executed:

For example, a sales director wants to meet with the sales manager of any region where sales drop below a certain threshold. You might embed an action object into the sales director's dashboard to enable the sales managers to schedule such a meeting simply by clicking a link. Or, you could use an agent to schedule the meeting automatically as soon as the sales threshold is passed.

What Are Action Links and Action Link Menus?

An action link is a link to an action that you have embedded in an analysis, dashboard page, scorecard objective, scorecard initiative, or KPI that, when clicked, runs an associated action.

Figure 10-1 shows an analysis to which an action link has been added to column values. When you hover the mouse pointer over a column value (for example, Touch-Screen T5 in this figure), the column value is displayed as a link. Clicking the column link displays the associated action link, then clicking the action link executes the associated action.

Figure 10-1 Example of an Action Link Added to an Analysis

This image is described in the surrounding text.

In analyses, KPIs, scorecard objectives, and scorecard initiatives, multiple action links are displayed in a list. Figure 10-2 shows an analysis to which a list of action links (Display Graph View, Send Email to Manager, and Open Fulfillment Analysis) has been added to column values. When you hover the mouse pointer over a column value (for example, Touch-Screen T5 in this figure), the column value is displayed as a link. Clicking a column value link displays a list of actions. Clicking an action in the list executes the associated action.

Figure 10-2 Example of Multiple Action Links Added to an Analysis

This image is described in the surrounding text.

On a dashboard page, you can add action links as standalone links or you can group multiple action links together on action link menus. An action link menu lets users select, from a list of action links, the appropriate action to be executed based on the business insight that they gained from the data.

Additionally, you can conditionally show each action link, depending on the data. This powerful functionality enables you to set up context-sensitive menus that present users with the appropriate next steps based on the data that is displayed. For more information on conditionally showing action links, see "About Conditionally Enabling Actions."

Action links that you add to analyses are displayed to users in the following views:

For information about views, see Chapter 3, "Adding Views for Display in Dashboards."

Action links that you add to scorecard objectives and initiatives are displayed to users in the following scorecard views:

Action links that you add to KPIs are displayed to users in KPI analyses.

Note:

Action links are not included in exported formats, for example, Excel and PDF.

What Action Types Are Available?

The types of actions that are available are categorized into two groups: those that navigate to related content and those that invoke operations, functions, or processes in external systems.

Privileges control which types of actions you can create. You might be able to create only navigate-type actions, only invoke-type actions, or both navigate- and invoke-type actions. Or, you might be able to only execute actions (if they exist as shared objects in the catalog or in a shared object, for example in a dashboard or analysis). For more information, see "Who Can Create Actions?"

In addition, where you can an add an action depends on its type. For information, see "Where Can I Add Actions?"

For information about the Contextual Event action type, which developers can use when adding Oracle BI EE objects to Oracle ADF applications, see "Passing Business Intelligence Content with the Oracle BI EE Contextual Event Action" in Oracle Fusion Middleware Developer's Guide for Oracle Business Intelligence Enterprise Edition.

Actions that Navigate to Related Content

The following list identifies and describes the types of actions that navigate to related content:

Actions that Invoke Operations, Functions or Processes in External Systems

The following list identifies and describes the types of actions that invoke operations, functions, or processes in external systems:

  • Invoke a Web Service — Invokes a Web Service operation or any SOA service that is exposed as a Web Service (for example, a Business Process Execution Language (BPEL) process in the Oracle SOA Suite that is exposed as a Web Service).

    This action type requires some configuration before you can use it. For information on the required configuration, see Oracle Fusion Middleware Integrator's Guide for Oracle Business Intelligence Enterprise Edition.

  • Invoke a Java Method — Invokes a Java method in an Enterprise Java Bean (EJB).

    This action type requires some configuration before you can use it. For information on the required configuration, see Oracle Fusion Middleware Integrator's Guide for Oracle Business Intelligence Enterprise Edition.

  • Invoke a Browser Script — Invokes a JavaScript function from the client web browser.

    This action type requires some configuration before you can use it. For information on the required configuration, see Oracle Fusion Middleware Integrator's Guide for Oracle Business Intelligence Enterprise Edition.

  • Invoke Server Script — Executes a custom script when the current agent completes. The custom script type can be either Javascript or VBScript.

    Note:

    This action supports custom script actions when the server is running on Microsoft Windows. For other platforms (including Windows), consider using the Invoke Java Method (EJB) or Invoke Web Services action.

  • Invoke an HTTP Request — Sends an HTTP request through the server to a target URL. This action type is used to invoke external systems that are exposed by URL APIs.

  • Invoke Agent — Invokes another agent. This action type lets you chain agents. For example, you can have Agent A invoke Agent B, which invokes Agent C and so on.

  • Invoke Java Jobs — Executes a custom Java program action that was created in a previous release (prior to 11g) and upgraded in this release. You cannot create this type of action. (See "How Will Actions Created in Previous Releases Be Upgraded?") This action type is read-only.

Who Can Create Actions?

The ability to create actions is controlled by the following action privileges, which are managed by the administrator:

By default, these action privileges are granted to the administrator.

For information about privileges, see "Managing Presentation Services Privileges" in Oracle Fusion Middleware Security Guide for Oracle Business Intelligence Enterprise Edition.

For information about permissions, see Chapter 13, "Managing Objects in the Oracle BI Presentation Catalog."

Where Can I Add Actions?

Where you can add an action depends on its type. You can add some types to analyses, dashboard pages, agents, scorecard objectives, scorecard initiatives, and KPIs, while others you can add only to agents or only to analyses, dashboard pages, scorecard objectives, scorecard initiatives, and KPIs. Table 10-1 lists the types of actions and identifies where you can add each type.

Table 10-1 Action Types and Where You Can Add Them

Action Type Add to Analyses, Dashboard Pages, Scorecard Objectives, Scorecard initiatives, and KPIs Add to Agents

Navigate to EPM Content

Yes

No

Navigate to BI Content

Yes

No

Navigate to a Web Page

Yes

No

Navigate to E-Business Suite

Yes

No

Navigate to Siebel CRM

Yes

No

Invoke a Web Service

Yes

Yes

Invoke a Java Method

Yes

Yes

Invoke a Browser Script

Yes

No

Invoke an HTTP Request

Yes

Yes

Invoke Agent

No

Yes

Invoke Server Script

No

Yes

Note: For this action type, the server must be running on Microsoft Windows.

Invoke Java Jobs

No

Yes


For more information on adding actions to objects, see:

What Are Named Actions?

A named action is an action that you define and then save by name in the Oracle BI Presentation Catalog so that you can reuse it. You can also reuse a named action as a template to create another named action.

You can save all types of actions to the catalog except the following types:

For example, suppose that you frequently want to include navigation to your organization's web site in analyses and dashboard pages that you are designing. You can create an action that navigates to the URL and save it to the catalog. Then as you create analyses and dashboard pages, you can add this named action to them.

You create a named action when you create an action from the:

You can also create a named action from a dashboard, an analysis, or a KPI. You do so by creating an inline action and then, to keep it, saving it to the catalog. For information on inline actions, see "What Are Inline Actions?"

What Are Inline Actions?

An inline action is an action that you define at the point of use and do not save by name in the catalog. Instead, it is saved as part of the analysis, dashboard page, agent, scorecard objective, scorecard initiative, or KPI.

An inline action is automatically deleted when the analysis, dashboard page, agent, scorecard objective, scorecard initiative, or KPI that contains it is deleted. This simplifies catalog management for actions that make sense only within particular BI content.

For example, suppose that you are designing a dashboard page and want to invoke an EJB that you plan to use only once. You can create an action that invokes the EJB at that point and then add it to the page. When you save the dashboard, the action is saved with it.

You create an inline action when you:

How Will Actions Created in Previous Releases Be Upgraded?

In previous releases (prior to 11g) of Oracle BI EE, you could use the Advanced tab to specify one or more actions to execute when an iBot completed or create action links that allowed end users to navigate from their dashboards to a record in a Siebel operational application.

If you upgrade from a previous release (prior to 11g), then these actions are upgraded as described in "Upgrading Actions" in Oracle Fusion Middleware Upgrade Guide for Oracle Business Intelligence.

What Are Action Parameters?

Action parameters are used to pass data from Oracle BI EE to the operations or processes that are represented by actions:

When creating a named action or when associating an action with an object (such as a column on an analysis), you can specify whether a parameter is:

Note:

An action link or conditional action link that is on a displayed total or grand total will not pass a parameter outside of related BI content.

About Conditionally Enabling Actions

You can conditionally enable actions that are added to:

Actions that are added to KPIs are associated with KPI ranges so they are enabled conditionally because of their definitions. Likewise for actions that are added to scorcecards, because they are associated with states of initiatives and objectives.

About Conditionally Enabling Actions Added to Analyses

When you add an action to an analysis, you can specify that its associated action link is to be displayed only when one or more conditions are met. You do this by selecting one or more columns in the analysis to use and specifying the condition to meet. (The steps to specify a condition are very similar to those used for conditional formatting.)

For example, in an analysis that shows sales figures by regions, you can specify that an action link Send E-mail to Regional Manager is to be displayed only if sales figures drop below a certain amount.

About Conditionally Enabling Actions Added to Dashboard Pages

When you add an action to a dashboard page, you can specify that its associated action link is to be displayed only when a certain condition is satisfied. You do this by specifying a condition (either a named or inline) that is to be satisfied.

For example, in a dashboard page that displays stock levels for products, you can specify that an action link Order Stock is to be displayed only if stock levels are low for a given product.

Using conditional action links on an action link menu lets you display different sets of actions to users, depending on the data in dashboard pages. For example, in a dashboard page that displays stock levels for products, you can add an action link menu that contains the following action links:

  • Order Stock and Stop Advertising, if stock levels are zero for a given product

  • Order Stock, if stock levels are low for a given product

  • No actions, if the stock levels are adequate for a given product

For more information on action links, see "What Are Action Links and Action Link Menus?" For more information on conditions, see Chapter 9, "Working with Conditions."

About Conditionally Enabling Actions Added to Agents

While you primarily use an agent's condition to determine whether the agent delivers its content or not, you can also use it to determine if the agent executes its actions.

When you add an action to an agent, you can specify that the action is to be executed only when a certain condition is satisfied. You do this by adding a condition (either inline or named) to the agent, and then specifying whether you want the action to be executed:

  • Only if the agent condition evaluates to true

  • Only if the agent condition evaluates to false

For some actions, you can also specify whether to execute the action for each row that is returned by the condition. (Note that Invoke Server Script actions and Invoke Agent actions cannot be executed per row of the result set. In addition, if one of the action parameters is a result set mapping, then it cannot be executed per row.)

For example, you could add an action to an agent that automatically kicks off a new marketing campaign and specify that it is to be executed only if a condition that evaluates whether sales for a region drop below $2,000,000 is true.

For more information on conditions, see Chapter 9, "Working with Conditions."

About Customizing Information Displayed to Users on Action Execution

You can customize information to display to users when they run actions. Specifically, you can:

You use the "Action Options dialog" to customize this information when you create or edit an action. See "Specifying the Settings for New Actions."

Creating Named Actions

You can create named actions (if you have the appropriate privileges), which content designers can add to analyses, dashboard pages, agents, scorecard objectives, scorecard initiatives, and KPIs.

For more information about named actions, see "What Are Named Actions?"

To create a named action:

  1. In the global header, click New, select Action under Actionable Intelligence, and then select the type of action to create.

    The "Create New Action dialog" is displayed.

  2. Complete the New Action dialog. For information, see "Specifying the Settings for New Actions."

Specifying the Settings for New Actions

You specify the settings for a new action in the "Create New Action dialog" (displayed as the New Action dialog for agents and dashboards, and Add New Action dialog for scorecards), when you do any of the following tasks:

To specify the settings for a new action:

  1. Click the Create New Action button (displayed as the Add New Action button in an agent or New Action button in a dashboard) and then select the type of action to create. If you selected:

  2. Depending on the type of action that you are creating or editing, do one of the following, as described in Table 10-2.

    Table 10-2 First Step by Action Type

    Action Type What You Do

    Navigate to a Web Page

    or

    Invoke an HTTP Request

    In the URL field, enter the URL of the web page.

    Tip: You can highlight the URL in the browser and copy and paste it into the URL field.

    Invoke a Browser Script

    In the Function Name field, enter the name of the function to be executed or click Browse and complete the "Select Script Function dialog."

    If the script has parameters defined for it and you selected the function in the Select Script Function dialog, then the parameters are displayed in the Define Parameters list. If you manually entered the function name, then you must manually add the parameters.

    Invoke Server Script

    In the Language box, select JavaScript or VB Script, and then in the Script Path field, enter the path of the script to be executed.

    By default, the scripts are stored in the following directory: ORACLE_INSTANCE\bifoundation\OracleBISchedulerComponent\coreapplication_obischn\scripts\common. For example D:\OBI11g\instances\instance1\bifoundation\OracleBISchedulerComponent\coreapplication_obisch1\scripts\common.

    Note that the Administrator can change the default directory where the scripts are stored.

    Invoke Agent

    Click Browse and complete the "Select Existing Agent dialog."

    Navigate to E-Business Suite

    In the Define Parameters list, define these mandatory parameters:

    • FunctionCode — The name of the function that relates to the target E-Business Suite form, for example, GLXIQJRN

    • ConnectionPool — The name of the connection pool for the Oracle E-Business Suite database in the Oracle BI repository, for example, EBS12

    You can also define optional parameters for passing the context from Oracle Business Intelligence to EBS forms.

    For information on defining parameters, see the steps for defining parameters in this procedure.

    For information on integrating with Oracle E-Business Suite security, see Oracle Fusion Middleware Integrator's Guide for Oracle Business Intelligence Enterprise Edition.

    Navigate to Siebel CRM

    In the Define Parameters list, define these mandatory parameters:

    • View — The name of the view that contains the record to which to navigate, for example, Opportunity List View.

    • Applet — The name of the parent applet in the view that contains the record to which to navigate, for example, Opportunity List Applet.

    • Pass Value — The row number of the record to which to navigate, for example, 3SIA-2O5VU.

      Generally, if you are adding this type of action to an analysis as an inline action, you use a column in the analysis criteria to set the value of Pass Value. To do so, click the Change type of value button, select Column Value, and then click the Column Value button and select the column.

    For how to determine the name of the view, applet, and record row number, see your Siebel CRM application documentation.

    For information on defining parameters, see the steps for defining parameters in this procedure.


  3. (for an Invoke an HTTP Request only) In the Request box, select one of the following options:

    • Get — Invokes the URL as an HTTP GET request.

    • Post — Invokes the URL as an HTTP POST request.

  4. (for an Invoke Agent action only) In the Execute for Recipients box, select the scope of recipients. For example, if you want the recipients to be the same as the recipients of the selected agent, then select Of Specified Agent.

  5. (optional for a Navigate to Web Page or an Invoke an HTTP Request action) To define parameters for the action, click Define Parameters to display the Define Parameters list.

  6. Define the parameters as appropriate:

    • To add a parameter, click the Add Parameter button. A new parameter row is added to the Define Parameters list. (Note that the Add Parameter button is not available for all action types.)

    • (for an Invoke Server Script action only) To pass the delivery content or the results of the analysis on which the agent condition is based to the script, click the Add Document Parameter button. A new document parameter row is added to the Define Parameters list.

    • Specify the column values for each parameter:

      • In the Name column, if you are creating a new parameter, then enter the name of the parameter. Use a name that is unique within the action.

        This column is not available for all action types.

      • In the Prompt column, if you want the user to provide the parameter value, then enter the prompt to display to the user.

      • In the Value column, to provide a parameter value, enter or select the value. If you want the user to specify the value, then leave this field as is.

      • In the Fixed column, specify whether to allow users to see but not set the parameter.

        This column is not available for all action types.

      • In the Hidden column, specify whether to hide the parameter from users.

        This column is not available for all action types.

      • In the Optional column, specify whether the parameter requires a value before the action can be executed.

  7. (optional) Customize information displayed to the user when the action runs:

    1. Click Options to display the "Action Options dialog."

    2. Specify the customization that you want.

    3. Click OK.

    This functionality is available only for actions where it is appropriate to display information to users.

  8. Click OK.

    If you are creating a named action, then a dialog is displayed where you specify the information for saving the action.

Adding Actions to Analyses

You can add one or more actions to a column heading, column value, or hierarchy level value in an analysis. When you add an action to a column heading, column value, or hierarchy level value, you add the action by using an action link.

When an analysis that contains one or more action links is presented to users in a pivot table, table, map, graph, trellis, or gauge, users can click a link to run the associated action.

For more information on action links, see "What Are Action Links and Action Link Menus?"

To add one or more actions to an analysis:

  1. Edit the analysis to which you want to add one or more actions.

  2. Move the mouse pointer over the Options button for the column or hierarchy level to which you want to add one or more actions and select Column Properties or Hierarchy Level Properties.

    The "Column Properties dialog" is displayed.

    Note:

    You can also access the Column Properties dialog from the "Analysis editor: Results tab." Select the relevant view and click the Edit View button. Locate the appropriate column in the "Layout pane," click the More Options button, and then select Column Properties.

  3. Click the "Column Properties dialog: Interaction tab."

  4. In the Primary Interaction box in the Column Heading area (to add one or more actions to a column heading) or the Value area (to add one or more actions to a column value or hierarchy level value), select Action Links to display the Action Links area.

  5. To add an action that has been saved as a systemwide default for the column or level, click the Add Action Link button and select the action.

    (For more information on saving systemwide defaults for a column or level, see "Column Properties dialog.")

  6. To add a new action:

    • If one or more actions have been saved as systemwide defaults for the column or level, then click the Add Action Link button and select New Action Link.

    • If no actions have been saved as systemwide defaults for the column or level, then click the Add Action Link button.

    The "New Action Link dialog" is displayed.

  7. In the Link Text field, enter the text to display as the link to execute the associated action.

  8. To create an action (that is, an inline action), click the Create New Action button and specify the settings for the new action. For information, see "Specifying the Settings for New Actions."

  9. To add an existing action (that is, a named action):

    1. Click the Select existing action button.

      The "Open dialog" is displayed.

    2. Complete the Select Action dialog.

      If there are parameters associated with the action, then the "Edit Parameter Mapping dialog" is displayed.

    3. Complete the Edit Parameter Mapping dialog (if displayed).

  10. If you are adding the action link to a value, then in the Show Link component in the New Action Link dialog, select one of the following options:

    • Always — Specifies that the action link is always to be enabled.

    • Conditionally — Specifies that the action link is to be enabled only under certain conditions.

      Selecting this option displays the Conditions area.

      For more information, see "About Conditionally Enabling Actions."

    If you are adding the action link to a column heading, then the Conditionally option is not available.

  11. If you selected Conditionally, then add one or more conditions to be used to enable the action link. For each condition to add:

    1. Click the New Condition button and select the column to use. The "New Condition dialog" is displayed.

    2. Complete the New Condition dialog.

  12. In the New Action Link dialog, click OK to add the action link to the Action Links area on the Interaction tab.

  13. For each additional action link to add, repeat steps 5 -12.

  14. To specify that, when only one action link is available at runtime, the action link is to be executed immediately rather than be displayed in a menu for selection, select the Do not display in a popup if only one action link is available at runtime box.

  15. Select the Enable on Totals check box when your analysis contains a total or grand total, and the associated attribute or measure column contains an action link or a conditional action link and you want the action link (or conditional action link) to be applied to both the column and the total or grand total. This does not apply to column heading action links and by default, this behavior is turned off.

  16. Click OK to close the Column Properties dialog.

  17. Click the Save Analysis toolbar button on the Analysis editor to save the analysis.

About Adding Actions to Dashboard Pages

You can add actions to dashboard pages in one of two ways:

For more information on action links and action link menus, see "What Are Action Links and Action Link Menus?"

Adding Actions to Dashboard Pages Using Action Links

To add an action to a dashboard page using an action link:

  1. Edit the dashboard page to which you want to add an action.

  2. From the Dashboard Object pane, drag and drop an Action Link object on the dashboard page.

  3. Click the Properties button for the Action Link object to display the "Action Link Properties dialog."

  4. Complete the Action Link Properties dialog. For information, see "Completing the Action Link Properties Dialog."

  5. Click the Save toolbar button on the Dashboard builder to save the dashboard page.

Completing the Action Link Properties Dialog

When you add actions to dashboard pages either by using action links or action link menus, you create action links by completing the "Action Link Properties dialog."

To complete the Action Link Properties dialog:

  1. To create an action (that is, an inline action), click the New Action button and specify the settings for the new action. For information, see "Specifying the Settings for New Actions."

  2. To add an existing action (that is, a named action):

    1. Click the Select existing action button.

      The "Open dialog" is displayed.

    2. Complete the Open dialog.

      If there are parameters associated with the action, then the "Edit Parameter Mapping dialog" is displayed.

    3. Complete the Edit Parameter Mapping dialog (if displayed).

  3. In the Link Text box, enter the text to display as the link to execute the associated action.

    Note:

    If you enter information into the Link Text box prior to adding an existing action or creating an action, the information that you entered is overwritten with the name of the action link.

  4. If you are creating an action link that will not be displayed on an action link menu, then in the Caption box, enter a caption to display above the link text.

  5. (for an action link that navigates to a URL or to other BI content only) Use the Open Link in New Window box in the Action Link Properties dialog to specify whether to open the link in a new browser window or tab.

  6. (for Navigate to BI Content actions only) Use the Add to Briefing Book box to specify whether the action that is associated with the action link can be executed in a briefing book, but only if the number of briefing book navigation links to be followed is greater than 0.

    For information about briefing books, see "Working with Briefing Books."

  7. In the Show Link component, select one of the following options:

    • Always — Specifies that the action link is always to be enabled.

    • Conditionally — Specifies that the action link is to be enabled only if the associated condition is satisfied.

      The Condition area is displayed.

  8. If you selected Conditionally, then specify the condition as follows:

    1. To create a condition, click the New Condition button to display the "New Condition dialog" and then complete the dialog.

      For information on completing the dialog, see "Specifying the Settings for Conditions."

    2. To select an existing condition, click Select Condition to display the "Select Condition dialog" and then complete the dialog.

  9. Click OK in the Action Link Properties dialog.

Adding Actions to Dashboard Pages Using Action Link Menus

To add one or more actions to a dashboard page using an action link menu:

  1. Edit the dashboard page to which you want to add one or more actions.

  2. From the Dashboard Object pane, drag and drop an Action Link Menu object on the dashboard page.

  3. Click the Properties button for the Action Link Menu object to display the "Action Link Menu Properties dialog."

  4. In the Menu Label box, enter the name to display for the menu.

  5. In the Caption box, enter a caption to display above the action link menu text.

  6. Add the action links to the menu as follows:

    Note:

    You also can drag an Action Link object from an Action Link Menu object to create a standalone action link.

  7. Click OK in the Action Link Menu Properties dialog.

  8. Click the Save toolbar button on the Dashboard builder to save the dashboard page.

Adding Actions to Agents

You can add one or more actions to an agent.

To add an action to an agent:

  1. Edit the agent to which you want to add an action.

  2. Click the "Agent editor: Actions tab."

  3. Determine whether to add the action to the Agent Condition True or No Condition Exists area or the Agent Condition is False area as follows:

    • If there is no condition associated with the agent, or if there is a condition associated with the agent and you want the action to execute only if the condition evaluates to true, then use the Agent Condition True or No Condition Exists area

    • If there is a condition associated with the agent and you want the action to execute only if the condition evaluates to false, then use the Agent Condition is False area.

  4. To create an action (that is, an inline action), click the Add New Action button and specify the settings for the new action. For information, see "Specifying the Settings for New Actions."

  5. To add an existing action (that is, a named action):

    1. Click the Add Existing Action button.

      The "Select Existing Action dialog" is displayed.

    2. Complete the Select Existing Action dialog.

      Note:

      You cannot add an existing action that navigates to related content (such as Navigate to BI Content) or an existing Invoke a Browser Script action to an agent.

      If there are parameters associated with the action, then the "Add Existing Action dialog" is displayed.

    3. Specify any required parameter values in the Add Existing Action dialog.

    4. Click OK.

  6. (not available for Invoke Server Script actions, Invoke Agent actions, or actions for which one of the parameters is a result set mapping) Select the Invoke per Row option if you have specified a condition for the agent and want to execute the action for each row returned by the condition.

  7. Click the Save this Agent toolbar button in the Agent editor to save the agent.

Adding Actions to KPIs

You can add one or more actions to a KPI. When you add an action to a KPI, you add the action by using an action link.

When a KPI that contains one or more action links is presented to end users (generally in a scorecard or a KPI watchlist), users can click a link to run the associated action.

To add one or more actions to a KPI:

  1. Edit the KPI to which you want to add one or more actions.

  2. Click the "KPI editor: States page."

  3. Click the Define action links for this status button to display the "Action Links dialog."

  4. To add an action that has been added to another range of the KPI, click the Add Action Link button and select the action.

  5. To add a new action:

    • If one or more actions have been added to another range of the KPI, click the Add Action Link button and select New Action Link.

    • If no actions have been added to other ranges of the KPI, then click the Add Action Link button.

    The "New Action Link dialog" is displayed.

  6. In the Link Text field, enter the text to display as the link to execute the associated action.

  7. To create an action (that is, an inline action), click the Create New Action button and specify the settings for the new action. For information, see "Specifying the Settings for New Actions."

  8. To add an existing action (that is, a named action):

    1. Click the Select existing action button.

      The "Open dialog" is displayed.

    2. Complete the Open dialog.

      If there are parameters associated with the action, then the "Edit Parameter Mapping dialog" is displayed.

    3. Complete the Edit Parameter Mapping dialog (if displayed).

  9. Click OK in the New Action Link dialog.

  10. For each additional action link to add, repeat steps 5-9.

  11. Click OK to close the Action Links dialog.

  12. Click the Save KPI As toolbar button on the KPI editor to save the KPI.

Adding Actions to Initiatives and Objectives in Scorecards

You can add one or more actions to an initiative or objective in a scorecard. When you add an action to an initiative or objective, you add the action by using an action link.

To add one or more actions to an initiative or objective:

  1. Edit the scorecard that contains the initiative or objective.

  2. Navigate to the initiative or objective to which you want to add an action as follows:

    • If you are adding the action to an initiative, then in the "Initiatives pane," double-click the initiative.

    • If you are adding the action to an objective, then in the "Strategy pane," double-click the objective.

  3. In the Action Link area in the "Analytics pane," click the New Row button.

    The "Action Link dialog" is displayed.

  4. In the State Equals box, select the state of the initiative or objective under which the action link is to be enabled.

  5. To create an action (that is, an inline action), click the Create New Action button and specify the settings for the new action. For information, see "Specifying the Settings for New Actions."

  6. To add an existing action (that is, a named action):

    1. Click the Select Existing Action button.

      The "Open dialog" is displayed.

    2. Click OK.

  7. In the Link Text field, enter the text to display as the link to execute the associated action.

  8. Click OK in the Action Link dialog.

    The action link is added to the Action Link area.

  9. Save the objective or initiative.

Creating a New Action Based on an Existing Named Action

You can create an action based on an existing named action.

For example, suppose that your organization has an existing named action Send Message that sends an email message. Its parameters include a recipient, subject, message, and priority. You can create an action that is based on this Send Message action that sends a high priority message. To do so, you provide a high priority value for the priority parameter and save the new action with a new name, such as Send High Priority Message.

To create an action based on an existing named action:

  1. Edit the existing named action on which you want to base a new action. The "Edit Action dialog" is displayed.

  2. Specify any changes that you want.

  3. Click Save As and specify the save as criteria in the dialog.

Editing Named Actions

To edit a named action:

  1. Navigate to the action in the catalog.

  2. Click the Edit link to display the "Edit Action dialog."

  3. Edit the action and click OK.

  4. Click Save Action.

Editing Actions and Action Links Added to Analyses

To edit an action and action link that have been added to an analysis:

  1. Edit the analysis to which the action and action link has been added.

  2. Move the mouse pointer over the Options menu for the column or hierarchy level to which the action has been added and select Column Properties or Hierarchy Level Properties.

    The "Column Properties dialog" is displayed.

    Note:

    You can also access the Column Properties dialog from the "Analysis editor: Results tab." Select the relevant view and click the Edit View button. Locate the appropriate column in the "Layout pane," click the More Options button, and then select Column Properties.

  3. Click the "Column Properties dialog: Interaction tab."

  4. In the Action Links area, select the action to edit and click the Edit Action Link button to display the "Edit Action Link dialog."

  5. Make the appropriate changes to the action link.

  6. Click the More button and select Edit Action. The "Edit Action dialog" is displayed.

  7. Edit the action and click OK.

  8. Click OK in the Edit Action Link dialog.

  9. Click OK in the Column Properties dialog.

  10. Click Save Analysis.

Editing Actions, Action Links, and Action Link Menus Added to Dashboard Pages

To edit an action, action link, or action link menu that has been added to a dashboard page:

  1. Edit the dashboard page.

  2. If the action and action link are associated with an action link menu:

    1. Click the Properties button for the Action Link Menu object. The "Action Link Menu Properties dialog" is displayed.

    2. Make the appropriate changes to the menu label and caption.

    3. In the Action Links area, select the action to edit and click the Edit button.

      The "Action Link Properties dialog" is displayed.

  3. If the action and action link are standalone, click the Properties button for the Action Link object to which the action is associated. The "Action Link Properties dialog" is displayed.

  4. Make the appropriate changes to the action link.

  5. Click the More button and select Edit Action. The "Edit Action dialog" is displayed.

  6. Edit the action and click OK.

  7. Click OK in the Action Link Properties dialog, and then in the Action Link Menu Properties dialog (if displayed).

  8. Click Save to save the dashboard.

Editing Actions Added to Agents

You can edit an action that you have added to an agent. If the action is an inline action, then you can edit the entire action. If the action is a named action, then you can edit only the parameter values.

To edit an action that has been added to an agent:

  1. Open the agent.

  2. Click the "Agent editor: Actions tab."

  3. Select the action and click the Edit Parameters button. The "Edit Action dialog" is displayed.

  4. Edit the action and click OK.

Editing Actions and Action Links Added to KPIs

To edit an action and action link that have been added to a KPI:

  1. Edit the KPI to which the action and action link has been added.

  2. Click the "KPI editor: States page."

  3. Click the Define action links for this status button to display the "Action Links dialog."

  4. In the Action Links area, select the action to edit and click the Edit Action Link button to display the "Edit Action Link dialog."

  5. Make the appropriate changes to the action link.

  6. Click the More button and select Edit Action. The "Edit Action dialog" is displayed.

  7. Edit the action and click OK.

  8. Click OK in the Edit Action Link dialog.

  9. Click OK in the Action Links dialog.

  10. Click Save KPI As.

Editing Actions and Actions Links Added to Initiatives and Objectives in Scorecards

To edit an action and action link added to an initiative or objective:

  1. Edit the scorecard that contains the initiative or objective.

  2. Navigate to the initiative or objective as follows:

  3. In the Action Link area in the "Analytics pane," click the Edit Row button.

    The "Action Link dialog" is displayed.

  4. Make the changes that you want and click OK in the Action Link dialog.

  5. Save the objective or initiative.

Saving Inline Actions in Analyses to the Catalog

To save an inline action in an analysis:

  1. Edit the analysis to which the action has been added.

  2. Move the mouse pointer over the Options menu for the column or hierarchy level to which the action has been added and select Column Properties or Hierarchy Level Properties.

    The "Column Properties dialog" is displayed.

    Note:

    You can also access the Column Properties dialog from the "Analysis editor: Results tab." Select the relevant view and click the Edit View button. Locate the appropriate column in the "Layout pane," click the More Options button, and then select Column Properties.

  3. Click the "Column Properties dialog: Interaction tab."

  4. In the Action Links area, select the action to save and click the Edit Action Link button. The "Edit Action Link dialog" is displayed.

  5. Click the More button and select Save Action As to display the "Save As dialog" to specify the save criteria.

  6. Specify the save criteria and click OK.

    Tip:

    To replace the reference to the current action with the saved action, select the Replace current action with a reference to the saved action box.

  7. Click OK in the Edit Action Link dialog.

  8. Click OK in the Column Properties dialog.

Saving Inline Actions in Dashboards to the Catalog

To save an inline action in a dashboard to the catalog:

  1. Edit the dashboard page.

  2. If the action and action link are associated with and action link menu:

    1. Click the Properties button for the Action Link Menu object. The "Action Link Menu Properties dialog" is displayed.

    2. Make the appropriate changes to the menu label and caption.

    3. In the Action Links area, select the action to edit and click the Edit button.

      The "Action Link Properties dialog" is displayed.

  3. If the action and action link are standalone, then click the Properties button for the Action Link object to which the action is associated. The "Action Link Properties dialog" is displayed.

  4. Click the More button and select Save Action As. The "Save As dialog" is displayed.

  5. Edit the action and click OK.

  6. Click OK in the Action Link Properties dialog, and then in the Action Link Menu Properties dialog (if displayed).

  7. Click Save to save the dashboard.

  8. Click the More button and select Save Action As to display the dialog to specify the save criteria.

  9. Specify the save criteria and click OK.

    Tip:

    To replace the reference to the current action with the saved action, select the Replace current action with a reference to the saved action box.

  10. Click OK in the Action Link Properties dialog, and then in the Action Link Menu Properties dialog (if displayed).

  11. Click Save to save the dashboard.

Testing a Named Action by Executing It

After creating a named action, you can test it to ensure that it executes properly.

To test a named action by executing it:

  1. Navigate to the named action in the catalog.

  2. Click the Execute link.

  3. Respond to any request for more information or any confirmation prompt that is displayed.

    Note:

    A successful invocation message indicates only that the action itself ran successfully. It does not indicate that the process or operation that the action represents ran successfully.