WebFOCUS Online Help > Managed Reporting Developer > ReportCaster Alerts > Creating an Alert

Creating an Alert

How to:

To facilitate the creation and scheduling of alerts in ReportCaster, the Alert Wizard guides you through a series of windows that complete the following tasks:

If you are logged on to Managed Reporting as a Managed Reporting Administrator or Developer, you can access the Alert Wizard through the New Standard Report option from a Standard Report folder or subfolder.

Note that when you use Report Assistant to create an alert test procedure a subset of the tabs and options are available. This is because the alert test procedure is only used to state the conditions, or rules, of the test; users do not see this report. This should be a simple report that states the selection criteria and an ON TABLE HOLD command. For sample code examples, see Alert Test Sample Code (Created With the Editor) and Alert Test Sample Code (Created With Report Assistant).

When an alert is tested and the result is true, a report (the alert event procedure, which is the second report you create when using the Alert Wizard) is sent out. This is the report users see and therefore you can add styling to this report. More options are available in Report Assistant when you are creating an alert event procedure.

Note: When you create an Alert report, it is not shown to the Managed Reporting end user by default since the report properties has the "Show on User's list" property deselected. This property is deselected by default because Alert reports are scheduled and distributed by ReportCaster, but they can also be run interactively from Managed Reporting.

Top of page
Procedure: How to Create an Alert in the Browser

The following steps provide options for creating an alert in the browser.

Note: As you use the Alert Wizard, when you create reports, you may see messages that state "Report Saved". Your changes for the report have been saved but not written to the Managed Reporting Repository until the Alert is saved. To save the Alert, click Finish in the Alert Wizard. If you exit the Alert Wizard before you click Finish, the Alert is not saved.

  1. Right-click a Standard Reports folder or subfolder. Select New Standard Report and then Alert Wizard from the context menus.

    In the browser, the Alert Wizard Welcome window opens, as shown in the following image, and lists the steps to create an alert to set up one or more tests. (The alert report is distributed only if the entire test evaluates as true.)

  2. Click Next.

    The Alert Wizard, Alert Test window opens, as shown in the following image.

  3. Select the alert test.
    • If you want to check for a file, click the Test for File Existence option button.

      Type in the full path to the file on the WebFOCUS Reporting Server that you want to check. Do not use a file name or a file path that includes spaces.

      Click Next.

      If the file is located, the alert report is sent. Proceed to Step 12 to create the alert report (event procedure).

    • If you select WebFOCUS Test (the default), click Next.

    The Alert Wizard, New or Existing Test window opens, as shown in the following image, containing two buttons, Report Assistant and Editor.

  4. Select a tool to create an alert test.

    Select either Report Assistant or Editor to create an alert test.

    If you choose Report Assistant (recommended), proceed to Step 5.

    If you choose Editor, proceed to Step 9.

    Note: If you neglect to specify an alert condition, cancel the alert and reenter the information. Clicking the Back button causes Managed Reporting to abend.

  5. Choose a Master File.

    The WebFOCUS Masters List window opens in the browser. Select a data source description and click OK. HTML Report Assistant opens to assist you in creating selection criteria for your alert test. For more information on HTML Report Assistant, see the WebFOCUS Managed Reporting End User's Manual.

  6. Select your options in HTML Report Assistant. When you have finished click Quit.

    Note: When creating an alert test, amper variables in a WHERE condition must have a value specified in the schedule. This is because alerts run unattended and are not able to collect a value from a user. For more information see the ReportCaster Development and Administration manual.

  7. You are prompted to save your changes. Click Yes.

    You return to the Alert Wizard, New or Existing Test window.

  8. Click Next. Proceed to Step 12.
  9. If you chose Editor in Step 4, the Editor window opens. Type your alert test procedure in the editor window.

    Note: You must include an ON TABLE HOLD command in your alert test.

  10. When you have completed the procedure, select Exit from the File menu in the browser. The Editor Save Changes window opens.

    Caution:

    • If you use the Editor to create an alert test, you can no longer use Report Assistant to edit the alert test. Information Builders recommends using Report Assistant to create the alert test and the alert event.
    • If you are creating an alert test with the Editor and you specify a parameter (&variable), you must create the alert event with the Editor.
  11. Click Yes to save your alert test. You return to the Alert Wizard, New or Existing Test window. Click Next.
  12. The Alert Wizard, Alert Event window opens, as shown in the following image. You can indicate which report to distribute when the alert test is true. It can be a report you create or one that already exists.

    • If you choose New WebFOCUS Report, click Next and proceed to Step 13.
    • If you choose Select WebFOCUS Report, click Next and proceed to Step 16.

    For information on which option to select, see the Considerations note in Components of an Alert.

  13. The Alert Wizard, Create the Report window opens, as shown in the following image. Create a new report with the Report Assistant or Editor.

  14. Click Next when you have completed the report for the alert event.

    The Alert Wizard, Two-Way window opens. To attach a Two-Way Email template, proceed to Step 17. Otherwise, continue to Step 15.

  15. Click Save and proceed to Step 19.
  16. Select your report from the Standard Reports folder and click Next, as shown in the following image. The Alert Wizard, Two-Way Email window opens.

  17. You can now optionally attach a Two-Way Email to the alert if your server is licensed for Two-Way Email and has Two-Way Email templates. You select Attach a Two-Way Email to this alert for an optional Two-Way Email to be attached to the alert. (The check box is unchecked by default.)

    When you select the Attach a Two-Way Email to this Alert check box, a tree of reports available to Two-Way Email opens. This tree consists of only Standard Reports that have Two-Way Email templates. If a Standard Report does not have any Two-Way Email templates attached, it is not listed.

    Note: If a Two-Way Email template is attached to an alert, the schedule distribution option is limited to e-mail only. If the Two-Way Email template is subsequently detached, the distribution option is not refreshed and is still limited to e-mail only. To access the additional distribution options, recreate the alert.

    For more information on Two-Way Email, see the WebFOCUS Managed Reporting Administrator's Manual.

  18. Click Save after you have selected the Two-Way Email template.

    The Save New Alert Report window opens, as shown in the following image.

  19. Type the name for the alert and, if applicable, check the Prompt for Parameters or Show on User's list check boxes.
  20. Click OK.

    The Alert Wizard, Schedule window opens.

    The following image shows the Alert Wizard, Schedule window which contains the Schedule the Alert button.

  21. Click Schedule the Alert to invoke ReportCaster to schedule the alert. The ReportCaster Development and Administration Interface is invoked, as shown in the following image. Click Schedule Management to open the scheduling management interface, then click Create a New Schedule to schedule the alert.

    Note: If you prefer to schedule the alert at a later date, click Finish instead of Schedule the Alert. Your alert report appears in the folder (or subfolder) with a special icon denoting an alert (as distinguished from a Standard Report).

  22. When the Development and Administration User Interface is invoked, click the Create a New Schedule link. The New Schedule-ReportCaster window opens, as shown in the following image, where you select the frequency, start time, and date to create the schedule alert.

    Tip: To schedule an alert, you must create a Task. Since an alert is a Standard Report, you must select the Standard Report Task Type when creating an alert schedule. For more information, see the ReportCaster Development and Administration manual.

  23. Exit ReportCaster and click Finish.

    The alert report displays in the Domain Builder of the Managed Reporting browser.

Top of page
Procedure: How to Create an Alert in Developer Studio

The following steps provide options for creating an alert in Developer Studio.

Note: As you use the Alert Wizard, when you create reports, you may see messages that state "Report Saved". Your changes for the report have been saved but not written to the Managed Reporting Repository until the Alert is saved. To save the Alert, click Finish in the Alert Wizard. If you exit the Alert Wizard before you click Finish, the Alert is not saved.

  1. Right-click a Standard Reports folder or subfolder. Select New Standard Report and then Alert Wizard from the context menus.

    In Developer Studio, the New Alert Wizard Procedure window opens, as shown in the following image, and contains File Name and Files of type text fields, check boxes for Prompt for Parameters, Show on User's List, Server, and Application Path.

    Enter the name for the alert, check any necessary options and click Create. The Alert Wizard, Welcome window opens.

  2. Click Next.

    The Alert Wizard, Alert Test window opens, as shown in the following image.

  3. Select the alert test.
    • If you want to check for a file, click the Test for File Existence option button.

      Type in the full path to the file on the WebFOCUS Reporting Server that you want to check. Do not use a file name or a file path that includes spaces.

      Click Next.

      If the file is located, the alert report is sent. Proceed to Step 12 to create the alert report (event procedure).

    • If you select WebFOCUS Test (the default), click Next.

    The Alert Wizard New or Existing Test window opens, as shown in the following image, containing two buttons, Procedure Viewer and Editor. Choose one to create the WebFOCUS test.

  4. Select a tool to create an alert test.

    Select either the Procedure Viewer or Editor to create an alert test.

    If you choose Procedure Viewer (recommended), proceed to Step 5.

    If you choose Editor, proceed to Step 9.

    Note: If you neglect to specify an alert condition, cancel the alert and reenter the information. Clicking the Back button causes Managed Reporting to abend.

  5. Choose a Master File.

    The WebFOCUS Table List window opens. Select a data source description and click OK.

    The Procedure Viewer opens and launches Report Assistant where you can create selection criteria for your alert test. If you don't see the Report Assistant, double-click the Report icon in the Procedure Viewer. For details on using Report Assistant, see the Creating Reports With Graphical Tools manual.

  6. Choose your options.

    Select your options in Report Assistant. When you have finished click Exit.

    Note: When creating an alert test, amper variables in a WHERE condition must have a value specified in the schedule. This is because alerts run unattended and are not able to collect a value from a user. For more information see the ReportCaster Development and Administration manual.

  7. You are prompted to save your changes. Click Yes and close the Procedure Viewer.

    You return to the Alert Wizard, New or Existing Test window.

  8. Click Next. Proceed to Step 12.
  9. If you chose Editor in Step 4 the Editor window opens. Type your alert test procedure in the editor window.

    Note:

  10. When you have completed the procedure, close the Text Editor. The Save Current Changes? window opens.
  11. Click Yes to save your alert test. You return to the Alert Wizard, New or Existing Test window. Click Next.
  12. The Alert Wizard, Alert Event window opens, as shown in the following image. You can indicate which report to distribute when the alert test is true. It can be a report you create or one that already exists.

    • If you choose New WebFOCUS Report, click Next and proceed to Step 13.
    • If you choose Select WebFOCUS Report, click Next and proceed to Step 16.

    For information on which option to select, see the Considerations note in Components of an Alert.

  13. The Alert Wizard, Create the Report window opens, as shown in the following image. Create a new report with the Procedure Viewer or Editor.

    Note: From the Procedure Viewer Alert Event window you can also access Report Painter to create a more complex request. For details, see the Creating Reports With Graphical Tools manual.

  14. When you have completed the report for the alert event, click Next.

    The Alert Wizard, Two-Way window opens. To attach a Two-Way Email template, proceed to Step 17. Otherwise, continue to Step 15.

  15. Click Save and proceed to Step 18.
  16. Select your report from the Standard Reports folder and click Next, as shown in the following image. The Alert Wizard, Two-Way Email window opens.

  17. You can now optionally attach a Two-Way Email to the alert if your server is licensed for Two-Way Email and has Two-Way Email templates. You select Attach a Two-Way Email to this alert for an optional Two-Way Email to be attached to the alert. (The check box is unchecked by default.)

    When you select the Attach a Two-Way Email to this Alert check box, a tree of reports available to Two-Way Email opens. This tree consists of only Standard Reports that have Two-Way Email templates. If a Standard Report does not have any Two-Way Email templates attached, it is not listed.

    For more information on Two-Way Email, see the WebFOCUS Managed Reporting Administrator's Manual.

  18. Click Save after you have selected the Two-Way Email template.

    The Save New Alert Report window opens, as shown in the following image.

  19. Click Schedule the Alert to invoke ReportCaster to schedule the alert. The ReportCaster Development and Administration Interface is invoked, as shown in the following image. Click Schedule Management to open the scheduling management interface, then click Create a New Schedule to schedule the alert.

    Note: If you prefer to schedule the alert at a later date, click Finish instead of Schedule the Alert. Your alert report appears in the folder (or subfolder) with a special icon denoting an alert (as distinguished from a Standard Report).

  20. When the Development and Administration User Interface is invoked, click the Create a New Schedule link. The New Schedule -ReportCaster window opens, as shown in the following image, where you select the frequency, start time, and date to create the schedule alert.

    Tip: To schedule an alert, you must create a Task. Since an alert is a Standard Report, you must select the Standard Report Task Type when creating an alert schedule. For more information, see the ReportCaster Development and Administration manual.

  21. Exit ReportCaster and click Finish.

    The alert report displays in the Explorer in Developer Studio.

WebFOCUS