Using Exceptions

Exceptions are conditions or results (such as a threshold being reached) requiring intervention. Exceptions cause corresponding indicators on a subscribing users Exceptions Dashboard to change, or a notification to be sent to users who have subscribed.

The exceptions dashboard is an optional content window used to monitor exceptions, it displays on Personal Pages. Each indicator represents one exception-capable job or items manually flagged as an exception.

Use exceptions with jobs or items:

You have only one Exceptions Dashboard, even if you put it on multiple Personal Pages. If you modify the Exceptions Dashboard on one Personal Page, it changes on all of your Personal Pages that include it.

Configuring Exceptions

Configure exceptions for jobs and items with version properties. There are two ways to configure exceptions:

  • Programmatically set-up a job to generate exceptions if certain conditions are met. When you run the job if an exception occurs, the exception status of the job is set.

  • Manually set exceptions on an item by setting the property to Flag as an Exception.

  To programmatically enable a job with monitored exceptions capability:

  To set exception status for items manually, from Explore, set the property Flag as an Exception for the latest version of the item. See Version Properties.

Using the Exceptions Dashboard

The exceptions dashboard shows a traffic light indicator for each job or item you place on it. The traffic light indicator changes to indicate if an exception occurred (red) or did not occur (green).

Note:

Items have version properties to use exceptions and the exceptions dashboard.

  To use the Exceptions Dashboard with jobs:

  1. Select Explore, navigate to the job whose exception you want to monitor, right-click the job, and click Properties.

  2. From Advanced, select If exceptions are generated, allow users to add to their Exceptions Dashboard, and click OK.

  3. Select Explore, navigate to the job, right-click the job, and click Subscribe.

  4. On Personal Pages tab, select Add to Exceptions Dashboard.

    If this option is not on the Subscribe Settings page, the file cannot be monitored for exceptions.

  5. Click OK.

A traffic light is added to the exceptions dashboard. The traffic light indicator is green. If the job is run and generates an exception, then the traffic light indicator changes to red.

  To use Exceptions Dashboard with items:

  1. Select Explore, and navigate to the item that has an exception you want to monitor.

  2. Right-click the item, and click Properties.

  3. From Advanced, select If exceptions are generated, allow users to add to their Exceptions Dashboard.

  4. From Versions, set the property Flag as an Exception for the latest version of the item and click OK.

  5. Select Explore, navigate to the item.

  6. Right-click the item, and from the shortcut menu, select Subscribe.

  7. On Subscribe Settings, select Add to Exceptions Dashboard.

    If this option is not on the Subscribe Settings page, this file cannot be monitored for exceptions.

  8. Click OK.

A red traffic light is added to the exceptions dashboard, to indicate that an exception is set for this item.

Adding the Exceptions Dashboard to a Personal Page

  To add the Exceptions Dashboard to a Personal Page:

  1. Select a Personal Page and click Personal Page content icon.

  2. Click Exceptions Dashboard and click Personal Page add icon.

  3. Click Save Settings.

Customizing the Exceptions Dashboard

  To customize Exceptions Dashboard:

  1. Select Favorites, and select a Personal Page.

  2. On Exceptions Dashboard, select Personal Page edit icon.

  3. To not show green lights, and have red lights displayed when an exception occurs, enable the Only display links to artifacts that have exceptions.

    Note:

    This option is applicable for monitored exceptions used with jobs. Traffic lights display when the exception status is set. You cannot show a green traffic light for items.

  4. When exceptions occur and you want to see its exception text explanatory message next to its red light, select Display exception messages next to graphic indicators.

    Note:

    There is a smartcut tag called getException() that displays exception messages on a Interactive Reporting dashboard. For more information, see the Oracle Hyperion Interactive Reporting User's Guide

  5. Click Change Properties.