9 Delivering Content

This chapter provides information on how to deliver personalized and actionable content to users in Oracle Business Intelligence Enterprise Edition. It describes how to create agents, how to subscribe to agents, and how to configure devices and delivery profiles.

What Are Agents?

Agents enable you to automate your business processes.

You can use agents to provide event-driven alerting, scheduled content publishing, and conditional event-driven action execution.

You can choose:

  • A schedule that the Agent runs on

  • A data condition that determines what the Agent does

  • An analysis that can be distributed

  • Actions that can be automatically executed depending on whether the data condition is met

Agents can dynamically detect information-based problems and opportunities, determine the appropriate individuals to notify, and deliver information to them through a wide range of devices (email, phones, and so on).

The delivery content of an agent is localized according to the preferred locale of the recipient. (Users specify their preferred locale in the Preferences tab of the My Account dialog.)

What Are Alerts?

An alert is a notification generated by an agent that delivers personalized and actionable content to specified recipients and to subscribers to the agent.

You can see the alerts that have been delivered to you throughout Oracle BI Enterprise Edition, for example:

  • In the Alerts section of the Home page.

  • On the first page of My Dashboard. (An Alerts section is automatically added to the first page of My Dashboard, if you do not manually place one there.)

  • On a dashboard page, if the content designer adds an Alerts section to the page. See Adding Content to Dashboards

  • In the Alerts dialog displayed from the Alerts! button in the global header.

  • In specified delivery devices, such as a phone. See What Are Devices and Delivery Profiles?

See Accessing and Managing Your Alerts.

How Agents Work

In the simplest format, an agent automatically performs a specified catalog analysis based on a defined schedule, and examines the results for a specific problem or opportunity.

If the specified problem or opportunity is detected in the results, then an alert is generated and delivered to specified recipients and to subscribers to the agent, using the delivery options that are specified for each person.

See What Are Alerts? and What Are Devices and Delivery Profiles?

To handle more complex requirements, agents can invoke actions that trigger other agents, scripts, Java programs, or applications. Results can be passed between agents, and to other applications or services through XML, HTML, or plain text. For example, an agent might run an analysis to identify all current product orders over a specified dollar amount that cannot be filled from a regional warehouse. The results can be passed to another agent that runs an analysis to locate alternative sources for these products. A final agent might be triggered to feed information into a corporate CRM system and to notify the appropriate account representatives of the alternative sourcing.

You might automatically be a recipient of alerts generated by some agents, and agents created by others might be available for you to subscribe to. You can also create your own agents if you have the appropriate permissions and responsibilities. Depending on the level of authority that you have, you can selectively share agents with others or make agents available for all users.

What Is the Agent Editor?

The Agent editor lets you create agents to deliver personalized and actionable content to users. It also lets you view a summary of the current settings of agents.

The Agent editor contains the following tabs:

  • General — Lets you specify the priority of the content that an agent is to deliver and how to generate the delivery content (that is, what user to run the query as).

  • Schedule — Lets you specify whether the agent is to be run based on a schedule, how often it runs, and when its running is to start and end.

  • Condition — Lets you specify whether an agent always delivers its content and executes its actions, or conditionally delivers its content and executes its actions.

  • Delivery Content — Lets you specify the content to deliver with an agent, such as a dashboard page or a saved analysis.

  • Recipients — Lets you specify who is to receive the delivery content of the agent and who is allowed to subscribe to the agent.

  • Destinations — Lets you specify where the content is to be delivered.

  • Actions — Lets you specify one or more actions to execute when an agent finishes.

You access the Agent editor when you create or edit an agent. See Creating Agents.

About Controlling Access to Agents

Access to agents is available to all Oracle BI EE users.

Granting access to specific agent functions is performed from the Manage Privileges page. If you have the appropriate authority, then you can grant or deny explicit access to a variety of agent privileges, including the ability to perform the following actions:

  • Create agents

  • Publish agents for subscription

  • Deliver agents to specified or dynamically determined users

  • Chain agents

  • Modify current subscriptions for agents

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

About Using Customization in Agents

Using customization in agents enables you to create generic agents that you can use for more than one circumstance.

Using customizations in agents helps you to reduce the number of agents and conditions that you must create for your organization. It also lets you provide the specific alert required for a particular circumstance.

Customization in an agent is accomplished by overriding the operators and values of prompted filters associated with analyses that are used in the agent. (A prompted filter is a filter whose operator is set to Is Prompted. See Creating Column Filters.)

You use analyses in an agent when you specify that the agent is to:

  • Conditionally deliver its content and execute its actions using a condition (either named or inline) that is based on an analysis. See Working with Conditions.

  • Deliver an analysis as its content.

Prompted filters can be customized at various points, depending on how the analysis with which it is associated is used:

  • If the analysis is used as the basis for a named condition, then the chain for customization is as follows:

    1. In the analysis

    2. In the named condition

    3. In the agent customization of the condition

    4. In the subscription customization of the agent condition

  • If the analysis is used as the basis for an inline condition created in an agent, then the chain of customization is as follows:

    1. In the analysis

    2. In the agent customization of the condition

    3. In the subscription customization of the agent condition

  • If the analysis is specified as the delivery content for an agent, then the chain for customization is as follows:

    1. In the analysis

    2. In the agent customization of the delivery content

    3. In the subscription customization of the delivery content

When using customization in an agent, keep the following points in mind:

  • Once a filter is overridden, it cannot be overridden again further in the customization chain. For example, if you override a filter in the agent customization of the delivery content, then the subscriber cannot override it later in the subscription customization of the delivery content.

  • If any filters in an analysis are combined (that is, constructed using AND and OR), then this AND and OR structure is not displayed in the customization.

  • If the same filters are used more than once in an agent, then only a unique set of the filters is displayed for customization. The customized values that you specify are applied to all instances of the repeated filter.

    Exception: If the analysis is the result of combining two or more analyses based on a union operation, then unique filters from each part of the union are displayed for customization. See Combining Columns Using Set Operations.

  • Filters passed between agents participating in a chain (see the Invoke Agent action in Actions that Invoke Operations, Functions or Processes in External Systems) do not support customization. The filters passed from the parent agent are those without subscriber customizations. The filters passed to the child agent replace the respective prompted filters before subscriber customizations are applied.

Creating Agents

You can automate business processes by creating and using agents.

Bear these guidelines in mind:

  • You can also display the Agent editor by selecting Agent from the Create . . . area of the Home page.

  • You can also create an agent from an analysis. See Creating Agents from Analyses.

Use the following procedure to create an agent.

  1. In the global header, click New and select Agent.
  2. In the General tab of the Agent editor, specify the priority of the content that the agent is to deliver and how to generate the delivery content (that is, what user to run the query as).
  3. In the Schedule tab of the Agent editor, specify whether the agent is to be run based on a schedule, how often it runs, and when its running is to start and end.
    When you select the date and time, for time zones where daylight savings applies, the time zone reflects the daylight savings time. For example, if, during the summer months, you select (GMT) Greenwich Mean Time: Dublin, Edinburgh, Lisbon, London, this means BST (British Summer Time).
  4. In the Condition tab of the Agent editor, specify whether the agent always delivers its content and executes its actions, or conditionally delivers its content and executes its actions.
  5. In the Delivery Content tab of the Agent editor, specify the content to deliver with the agent, such as a dashboard page or a saved analysis.
  6. In the Recipients tab of the Agent editor, specify who is to receive the delivery content of the agent and who is allowed to subscribe to the agent.
  7. In the Destinations tab of the Agent editor, specify where the content is to be delivered.
  8. In the Actions tab of the Agent editor, specify one or more actions to execute when the agent finishes.
  9. Save the agent. See Saving Agents.

    After you have saved the agent, you can run the agent by clicking the Run Agent Now button. This is helpful, for example, to test the agent.

Viewing Summaries of Agent Settings

You can view a summary of the current settings for an agent.

A summary is displayed in the Agent editor and can be expanded or collapsed. By default, the summary is expanded.

Bear this guideline in mind:

  • You can also view a summary of an agent's settings in the Preview pane of the Catalog page.

  • To the left of the Overview heading in the Agent editor, click the:
    • Plus button to expand the summary.

    • Minus button to collapse the summary.

Saving Agents

You can reuse agents by saving them.

  • If an agent is available for subscription, then you must save it in a subfolder in /Shared Folders, for example, /Shared Folders/Shared Agents/Sales/Agent1. You cannot save an agent directly in /Shared Folders, for example, /Shared Folders/Agent1.

  • If an agent is not available for subscription, then you can save it in a subfolder in /Shared Folders, in /My Folders, or in a subfolder in /My Folders, for example, /My Folders/Sales/Agent1. You cannot save an agent directly in /Shared Folders, for example, /Shared Folders/Agent1.

You can save agents in existing folders or in new folders that you create as follows.

See Subscribing to Agents.

  1. In the Agent editor toolbar, click one of the following buttons:
    • To save a new agent or to save an existing agent with the same name in the same folder, click the Save this Agent button.
    • To save an existing agent with another name or in another folder, click the Save this Agent as button.
  2. Complete the Save Agent dialog, if displayed, and click OK.

Subscribing to Agents

You can subscribe to agents that the owner has made available to you for subscription.

Subscribing to an agent ensures you receive the most recent information about the agent.

  1. In the global header, click Catalog and navigate to the agent to which you want to subscribe.
  2. Click the More link for the agent and select Subscribe.

To make an agent available for subscription, in the Recipients tab of the Agent editor, the Publish Agent for Subscription option must be selected, and users, and Catalog groups and Application roles that are allowed to subscribe must be identified.

Displaying a List of the Agents That You Subscribe to or That You Own

You can display a list of the agents that you subscribe to or that you own, that is, those that you have saved in your personal folder (My Folders).

You can access the agents that you subscribe to or own to change the behavior of them.

  1. In the global header, click Catalog.
  2. In the Catalog page menu, click Search.
  3. In the Search area, type the name or part of the name of the Agent in the Search field, select the Location , and select Agent from the Type list.
    You can use * (asterisk) as a search wildcard to return all Agent types for a given location.
  4. Click Search.

Unsubscribing from Agents

You can unsubscribe from agents to which you are currently subscribed.

Unsubscribing from an agent means you will not see the output from that agent.

  1. In the global header, click Catalog.
  2. In the Catalog page menu, click Search.
  3. In the Search area, type the name or part of the name of the Agent in the Search field, select the Location, and select Agent from the Type list.
  4. Click Search.
  5. Navigate to the agent from which you want to unsubscribe.
  6. Click the More link for the agent and select Unsubscribe.

Customizing Your Agent Subscriptions

Suppose an agent has been set up to allow users to customize the subscription and the agent uses an analysis that includes a prompted filter for either its condition, the delivery content, or both.

You can customize the filter values for the conditional analysis, the delivery content analysis, or both to suit your needs.

To allow users to customize an agent subscription, the agent must be Run As Recipient and you must select the Allow Subscribers to Customize Agents option in the Recipients tab of the Agent editor.

  1. In the global header, click Home. The Home page is displayed.
  2. In the Browse/Manage area, click My Agent Subscriptions.
    A list of the agents to which you are currently subscribed is displayed. (Agents that you have been designated a recipient of are not included in this list.)
  3. Navigate to the agent whose subscription you want to customize.
  4. Click the More link for the agent and select Customize Subscription.
  5. In the Customize Subscription to Agent dialog, customize the prompted filters or the parameters as needed. (Depending on how the agent has been set up, you can customize the prompted filters or the parameters for the condition, the delivery content, or both.)
    1. To customize a prompted filter or parameter, click the Modify the operator/value for this parameter button.
    2. In the Edit Parameter Filter dialog, edit the values as needed.
    3. Click OK.
  6. Click OK in the Customize Subscription to Agent dialog.
    The customized filter values that you set in the previous steps are not automatically displayed in agent results. See Displaying Customized Filter Values in Agent Results.

Displaying Customized Filter Values in Agent Results

If you have customized filter values in an agent subscription and want to display the filter values in the agent results, then you must add a Filters view to the analysis.

Customized filter values allow you to present only the most important information via an agent.

  1. Edit the analysis that is being customized.
  2. Display the Results tab of the Analysis editor.
  3. Add the Filters view to the analysis.

Disabling and Enabling Agents' Schedules

You can temporarily disable (and then enable) an agent's schedule.

Disabling an agent's schedule stops the agent from running on its defined schedule. It does not stop it from being run by other means, for example, by the Run Agent Now button in the Agent editor.

Disabling an agent's schedule is useful if you have defined a schedule for an agent but find you want to stop it for a certain period of time.

In addition, an agent's schedule may be temporarily disabled by default. For example, if you copy a folder that contains one or more agents, then the schedule of each agent copy is disabled by default, and the agent does not run on its defined schedule until you enable it.

To disable and then enable an agent's schedule:

  1. In the global header, click Catalog and navigate to the agent whose schedule you want to disable or enable.
  2. Click the More link for the agent and select one of the following options:
    • Disable Schedule to disable the agent's schedule

    • Enable Schedule to cause the agent to run on schedule again

You also can disable and enable an agent's schedule by using the Enabled box in the Schedule tab of the Agent editor.

What Are Devices and Delivery Profiles?

You can receive notifications about content via devices and delivery profiles.

Devices and delivery profiles control how you will be reached when an alert is generated by an agent and which devices receive the content:

  • Device — A device is the medium used to deliver content to you. The content of an agent can be delivered to a range of devices as an email or SMS message.

  • Delivery profile — A delivery profile specifies which devices to use to deliver content to you, based on the priority of the content. You can define several delivery profiles to meet your needs, and switch among them. However, only one profile can be active at any given time.

    For example, you might have an In the Office delivery profile that delivers content to an office email, and an On the Road profile that delivers content to your cell phone, depending on the priority of the information.

You configure your devices and your delivery profiles from the Delivery Options tab of the My Account dialog. See Configuring Your Devices and Delivery Profiles. (The administrator manages the types of devices that are available to you. See Managing Device Types for Agents in System Administrator's Guide for Oracle Business Intelligence Enterprise Edition.)

Your organization might automatically generate system delivery devices and delivery profiles as follows:

  • Using the SA System subject area, your organization can generate system delivery devices based on each user's email address and other device information (such as cell phone numbers) from the SA System subject area, and then generate a system delivery profile for each user using the user's system delivery devices.

  • Using the LDAP server (but only if delivery devices and profiles have not been generated from the SA System subject area), your organization can generate system delivery devices based on each user's email address from the LDAP server and then generate a system delivery profile for each user using the user's system delivery device.

If you do not configure any devices or profiles, then the system delivery profile that is generated for you is used as the default. Even if you define other profiles, you can configure the system profile as your default profile. If you define a delivery profile, then you can include system devices in this profile and set the priority levels for which this delivery device is used. See Setting Up the SA System Subject Area in Scheduling Jobs Guide for Oracle Business Intelligence Enterprise Edition.

Depending on the destinations that are specified for an agent, content can be delivered to the:

  • Home page and dashboard. See What Are Alerts?

  • Active delivery profile or specific devices.

    When the destinations are specific devices, content is delivered to the devices that you have configured rather than to the devices in your active delivery profile. For example, if an Agent is defined to be delivered to Email devices, then the default Email device that you configured is used rather than any Email devices that you configured in your active delivery profile.

Delivery content is assigned a specific priority. The default priority is normal. When you select devices for your active profile, you can indicate what priority content should be sent to that device. For example, if you have added a cell phone to your delivery profile, then you might associate it with high priority content only. When you know that you will be away from the office frequently and out of email range, you can select to receive only low priority content through your office email.

Configuring Your Devices and Delivery Profiles

You use the Delivery Options tab of the My Account dialog to configure the devices and delivery profiles to be used to reach you when an alert is generated by an agent.

  1. In the global header, click Signed In As username, (where username is the name that you use to log in to Oracle BI Enterprise Edition) and then select My Account to display the My Account dialog.
  2. Click the Delivery Options tab.
  3. In the Devices area, add or edit the appropriate devices.
    1. Select the device category button (for example, Email) for the device to add.
    2. Click the Create Device button to display the Create Device dialog.
      When the destinations specified for agents are specific devices, the default devices you specify here override the devices in your active delivery profile. For example, if an agent is defined to be delivered to email devices, then default email device that you specify here is used rather than any email devices that you specify in your active delivery profile. (The destinations for agents are specified on the Destinations tab on the Agent editor.)
    3. In the Name field, enter the name of the device, for example, Work Email.
    4. In the Category box, select the device category.
    5. In the Device Type box, select the type of device.
    6. In the Address/Number field, enter the address for the device, for example, an email address for email. When typing a phone number for a device, do not use punctuation such as spaces, dashes, or parentheses.
    7. Click OK to return to the Deliver Options tab of the My Account dialog.
      The device is displayed in the Devices list for the appropriate category (for example, Email).
    8. If you want this device to be the default device, then select the Default option to the right of the device name.
  4. To edit a device, perform the following steps:
    1. Select the device in the list.
    2. Click the Edit Device button to display the Edit Device dialog.
    3. Make your edits and click OK to return to the Deliver Options tab of the My Account dialog.
  5. Add or edit the appropriate delivery profiles:
    1. Click the Create Delivery Profile button to display the Create Delivery Profile dialog.
    2. In the Name field, enter a delivery profile name.
    3. To the right of each delivery device to use when this profile is the active profile, select one or more of the priority options — High, Normal, or Low. These priorities are used together with the priority of the delivery content to determine the destination for delivery content. For more information on the priority of the delivery content, see the General tab on the Agent editor.
      Do not set the priority for devices that you do not want to use. Devices that do not have a priority selected are not used by the profile.
    4. Click OK to return to the Deliver Options tab on the My Account dialog.
      The profile is displayed in the Delivery Profiles list.
    5. If you want the delivery profile to be your active profile, then select the Active option to the right of the profile name.
  6. To edit a delivery profile, perform the following steps:
    1. Select the delivery profile in the list.
    2. Click the Edit Profile button to display the Edit Delivery Profile dialog.
    3. Make your edits and click OK to return to the Deliver Options tab on the My Account dialog.
  7. Click OK.

Accessing and Managing Your Alerts

You can access a list of your alerts.

The list shows the name of each alert along with its delivery date and time, and number of occurrences. Using this list, you can:

  • View the content for an alert.

  • Clear an alert and all its occurrences.

  • Edit the agent that generated the alert, if you have permission to modify the agent.

  • Run the agent that generated the alert, if you have permission to execute the agent.

  • Subscribe to the Oracle BI Alerts feed. See Subscribing to an RSS Feed for Alerts.

  • Clear all your alerts and all their occurrences.

See What Are Alerts?

  1. In the global header, click Alerts!
  2. In the Alerts dialog, view and manage your alerts as needed.

You can also access and manage your alerts from the Alerts section on the Home page.

Subscribing to an RSS Feed for Alerts

You can receive alerts by way of an RSS 2.0 compatible reader that supports HTTP basic authentication.

If Oracle BI Presentation Services uses the HTTPS protocol, then the RSS reader that you use must also support the HTTPS protocol.

To subscribe to an RSS Feed for alerts, you must have been granted the Access to RSS Feeds privilege by the administrator.

  1. Click the Alerts! link to display the Alerts dialog.
  2. Click the Subscribe to RSS feed button (located to the left of the Clear All button).
    The browser's page to subscribe to an RSS feed is displayed.
  3. Subscribe to the Oracle BI Alerts following the instructions on the browser's page.