Configuring the Workspace Alert Component

*  To configure the Workspace Alert component:

  1. Merge the component. (See Merging Components.)

  2. Optional: Create a summary table (see Creating Summary Tables), or use an existing table as a summary table.

  3. Optional: Use the Workspace Alert component with the Conditional Sub-Queries component. (See Using the Workspace Alert Component with the Conditional Sub-Queries Component.)

*  To use the EPM Workspace Alert Properties configuration frame:

  1. In Interactive Reporting Studio or EPM Workspace, open a dashboard that contains anWorkspace Alert component.

    To access the configuration frame, use Sections or the Configuration drop-down list found in Dashboard Studio.

  2. From Tables Sections, select an option:

    • All Tables—All tables are available.

    • Configured Tables—Only tables with applied exception or alert configurations are available.

    • Unconfigured Tables—Only tables without applied exception or alert configurations are available.

  3. From the drop-down list, directly under the options, select a table to be monitored.

    Available tables vary depending on the selected option.

  4. Optional: To view the selected table, click View button.

  5. Optional: Select Used Conditional Sub-Queries (CSQ) to employ the Conditional Sub-Queries component to configure an alert.

    If selected, you are not required to provide alert details for column, operator, or threshold values. The option is only available when the Conditional Sub-Queries component is used.

  6. From Alert Details, select the Query that the exception table is dependent upon.

    The code follows the ParentSection dependency and displays the associated query.

    The onPostProcess() method is activated for the selected query. See Using the OnPostProcess() Method Call.

  7. Select the Column of the selected table, the data of which is compared to the use- specified Threshold Limit.

  8. Optional: If the selected Column contains date values, Threshold Limit is unavailable and a calendar control is displayed. Perform these actions:

    • Select a date

    • Click Set

    The date value is added to Threshold Limit.

  9. From Operator, select the comparison operator for the evaluation of the threshold value.

    If the BETWEEN operator is selected, Threshold Max is available, which defines the maximum value that you want to add.

  10. Enter a Threshold Limit that is used in the evaluation.

    The limit value causes the exception, and is used to create a filter. If rows remain after the limit is applied, an output.properties text file is created and exported.

    • If you are using Interactive Reporting Studio , the output.properties file is exported to same directory as the Interactive Reporting document.

    • If you are using EPM Workspace, the output.properties file is collected by the event service that generates alerts when a job is executed.

  11. From Exception String Format, select an option:

    • Alert=True—String displayed when an exception occurs

    • Alert=False—String displayed when no exception occurs

    These options determine the editable exception text in Alert String Format.

  12. From Keywords, select the values that dynamically create an exception string.

    • Row Count—Number of rows after the filter is applied

    • Threshold Value—Use the specified value

    • Column Name—Column selected for an alert

    • Table Name—Table selected for an alert

    • Time Stamp—Time and date of the exception

  13. In Alert String Format, the exception string is created and displayed.

    If an alert is reported, the exception string reads; for example: As there are _:_1_:_ rows that are within a range, in table _:_4_:_, this raises an alert as of _:_5_:_. If no alert is reported, the exception string reads; for example: No alert has occurred.

  14. Optional: Edit the exception string text.

  15. Optional: Enter the string format without selecting Keywords.

  16. Perform an action:

    • To discard in-memory settings and revert to original settings, click Restore.

    • To remove all in-memory table configuration settings, click Clear All.

    • To remove the selected table configuration, click Clear.

    • To commit current settings and call configuration methods to prepare tables for the onPostProcess() method, click Apply.

      When Apply is clicked, the orcl_Exception.txt table is created, and a limit is added to the specified table that is used to look for the exception.

    Note:

    Clicking Apply, confirms that the orcl_Exception.txt table exists, and if it does not, the table is created. The Exception Info column in orcl_Exception.txt is hidden. If a false exception alert is returned, you must select the appropriate table and populate EPM Workspace Alert Properties. Users are alerted and process is stopped. Clicking Apply, also verifies that the computed column called Exception Text exists in orcl_Exception.txt. If does not, the computed column is added, and Exception Info is populated with default syntax.