Skip to content
CA Workload Automation DE - 12.0
Documentation powered by DocOps

Creating and Managing Forecast Reports

Last update August 15, 2015

You can create forecast reports about jobs scheduled to run during a specific period and use these reports to plan your workload. You can generate forecast reports to view the output of the report immediately or schedule forecast reports using Events to save the output on the server for viewing later.

You can view the output of forecast reports in the Services perspective and export the output in different formats including CSV and HTML.

Each report contains the following information about scheduled jobs:

  • Job name and qualifier
  • Predecessor and successor names
  • Event submission date and time
  • Estimated execution time based on historical information
  • Start time and end time

    Notes:

    • The start time and end time are calculated based on the Event schedule criteria and the following time dependencies values you specify in the job definition: ‘Do not submit before’ and ‘Delay submission when eligible by.’

    • If the jobs are not defined with these time dependency values, the start and end time are calculated only based on the Event schedule criteria.

  • Agent or advanced integration name

  • Application and subApplication name
  • Event prefix and name
  • Job type
  • Home Application name (external jobs only)

You can limit the Events, Applications, subApplications, and jobs that appear in your forecast reports. For example, your report can include Applications triggered by a specific Event or exclude Applications that run hourly.

When scheduling forecast reports, you can also specify a list of users to notify by email when the forecast report execution is complete. You can also grant permission to a list of users to view the report output.

Note: Suspended Events do not appear on forecasts. Nonscheduled Events such as File Trigger Events do not appear in forecast reports unless the Event has an expect time.

You can create and manage forecast reports as follows:

List Forecast Reports

You can list the forecast reports defined on the server. For scheduled forecast reports, you can also view the output of each scheduled forecast report.

Note: To view the output of a scheduled forecast report, you must be the execution user for the forecast report Event or be granted permission to read the report in the Event definition.

Follow these steps:

  1. Open the Services perspective.
    A list of server connections is displayed in the Services view.
  2. Right-click Forecasts under your server connection, and select Open from the pop-up menu.
    The Forecasts view opens.
  3. Enter the complete or partial forecast name in the Forecast name field to limit the forecasts displayed, and click the arrow next to the Forecast name field.

    Note: Include a wildcard for a partial name. For example, F* displays all the forecasts whose names start with F.

    A list of forecast reports appears along with the results of each forecast report.

Note: To refresh the list, right-click in the listing, and select Refresh from the pop-up menu.

Create a Forecast Report

You can create a forecast report to view the jobs scheduled to run in a specific period and use the report to plan your workload.

Follow these steps:

  1. Open the Services perspective.
    A list of server connections is displayed in the Services view.
  2. Right-click Forecasts under your server connection, and select New from the pop-up menu.
    The New Forecast view opens.
  3. Complete the following fields as required:
    • Forecast name
      Defines the report name.
    • Starting at
      Specifies the starting time and date of the report's period.

      Note: To select a date and time, you can click the button to the right of the field.

    • Continuing for
      Specifies the length of the report's period.
      Default: Events scheduled during the next 24 hours.
    • Event names
      (Optional) Specifies the Events to be included in the report. The Event name can include wildcards. For example, VER* includes all Events that begin with VER.
      Default: All Events scheduled in the report's period
    • Application names
      (Optional) Specifies the Applications to be included in the report. The Application name can include wildcards. For example, APPL* includes all Applications that begin with APPL.
    • subApplication names
      (Optional) Specifies the subApplications to be included in the report. The subApplication name can include wildcards. For example, SUB* includes all subApplications that begin with SUB.
    • Job names
      (Optional) Specifies the jobs to be included in the report. The job name can include wildcards. For example, JOB* includes all jobs that begin with JOB.
    • Threshold frequency
      (Optional) Specifies a threshold frequency in minutes to exclude frequently scheduled Events from the report. An Event execution is excluded from the forecast report if the time between its scheduled execution and its next scheduled execution is less than the threshold frequency. For example, to exclude all Events that run more frequently than two hours, enter 120.
  4. Click the Save icon.
    The forecast report is saved on the server.

Example: Show the Hourly Events in a Weekly Report

Suppose that you need to run a report that shows all jobs, including hourly jobs, scheduled to run during one week starting at noon today.

To show hourly Events in a weekly report

  1. Open the Services perspective.
    A list of server connections is displayed in the Services view.
  2. Create a forecast report as follows:
    1. Right-click Forecasts under your server connection, and select New from the pop-up menu.
      The New Forecasts view opens.
    2. Enter WEEKLY in the Forecast name field, select 12:00:00 PM in the Starting at field, and select weeks in the Continuing for field.
    3. Enter * in the Event names field to include all Events scheduled in the report period.
    4. Enter 0 in the Threshold frequency field.
    5. Click the Save icon.
    The forecast report is saved on the server.

Example: Show All the Jobs Scheduled in a 24-hour Period

Suppose that you need to run a report that shows all the jobs scheduled to run between 5:00 a.m. today and 4:59 a.m. tomorrow.

To show all jobs scheduled in a 24-hour period

  1. Open the Services perspective.
    A list of server connections is displayed in the Services view.
  2. Create a forecast report as follows:
    1. Right-click Forecasts under your server connection, and select New from the pop-up menu.
      The New Forecasts view opens.
    2. Enter DAILY in the Forecast name field, select 5:00:00 AM in the Starting at field, and leave the default of 1 day in the Continuing for field.
    3. Enter * in the Job names field to include all jobs scheduled to run in the report period.
    4. Click the Save icon.
    The forecast report is saved on the server.

Generate a Forecast Report

You can generate a forecast report to view the output of the report immediately.

Note: You can generate a default report of the workload scheduled in the next 24 hours or 7 days using the default forecasts FORECAST24HOUR and FORECAST7DAY respectively.

Follow these steps:

  1. List forecast reports.
  2. Right-click the forecast you want to run, and select Generate Forecast Report from the pop-up menu.
    A dialog appears to indicate that the report is being generated.

    Notes:
    • To run this dialog in the background so that it does not block your GUI, click Run in Background. To always run the progress dialogs in the background, from the main menu select Windows, Preferences, Workbench, General, and select the Always run in Background check box. To see the report execution status of all running forecasts, in the status bar double-click the icon beside the progress bar; the progress view opens.
    • Generating a forecast report can take several minutes, depending on the number of jobs included in the report. If you select the Always run in Background check box, a temporary warning message appears to indicate that the forecast report can take several minutes to generate. To deactivate this warning message, from the main menu select Windows, Preferences, Desktop Client, Server Response and clear the Show warning message check box.
    The output of the forecast report appears in a view.

View the Output of a Scheduled Forecast Report

You can view the output of a scheduled forecast report saved on the server.

Note: To view the output of a scheduled forecast report, you must be the execution user for the forecast report Event or be granted permission to read the report in the Event definition.

Follow these steps:

  1. List forecast reports.
    A list of forecast reports appears along with the results for each report.
  2. Right-click the output of a forecast report, and select View Report from the pop-up menu.
    The output of the scheduled forecast report appears in a view.

Export a Forecast Report

You can export the output of a forecast report to your local computer and save it in the following formats:

  • Word
  • PowerPoint
  • PDF
  • PostScript
  • Excel

Follow these steps:

  1. Generate a forecast report or view the output of a scheduled forecast report.
    The output of the forecast report appears in a view.
  2. Click the Export report icon from the toolbar of the report.
    The Export Report dialog opens.
  3. Select the output format in the Export Format drop-down list.
  4. Modify the other fields as appropriate, and click OK.
    The File Download dialog opens.
  5. Click Save to save the file to the local computer.

    Note: To open the file immediately, click Open.

    The Save As dialog opens.

  6. Select a folder in the Save in drop-down list, specify a file name in the File name field, and click Save.
    The file is saved to your local computer.

Export Data from a Forecast Report

You can export the raw data of a forecast report to your local computer as a .csv file.

Follow these steps:

  1. Generate a forecast report or view the output of a scheduled forecast report.
    The output of the forecast report appears in a view.
  2. Click the Export data icon from the toolbar of the report.
    The Export Data dialog opens.
  3. Select a result set from the Available result sets drop-down list.
  4. Select columns from the Available Columns section and click > to move them to the Selected Columns section.
  5. Modify the other fields as appropriate, and click OK.
    The File Download dialog opens.
  6. Click Save to save the file to the local computer.

    Note: To open the file immediately, click Open.

    The Save As dialog opens.

  7. Select a folder in the Save in drop-down list, specify a file name in the File name field, and click Save.
    The .csv file is saved to your local computer.

View a Forecast Report Gantt Chart

You can view a Gantt chart of all the jobs in the forecast report relative to the start of the report period.

Follow these steps:

  1. Generate a forecast report or view the output of a scheduled forecast report.
    The output of the forecast report appears in a view.
  2. Click the Open Gantt chart for all jobs from report icon from the toolbar of the view.
    The Gantt chart opens in a graphical view. On the left side of the view, a table displays the expected start time, end time, and duration of each job in the report. On the right side of the view, bars representing each of the jobs in the report show when each job is expected to start and end relative to the start of the report period. Arrows between the bars indicate predecessor dependencies.
  3. (Optional) Enter a filter in the Filter chart by Name field to limit the jobs displayed.

    Note: You can use the asterisk (*) as a wildcard for zero or more characters and the question mark (?) as a wildcard for a single character. For example, to limit the Gantt chart to jobs that start with Linux, enter Linux*. The filter is not case-sensitive.

    The Gantt chart displays the jobs that match your filter.

Hide the Output of a Forecast Report

You can hide the output of a forecast report if you no longer need to view the results. Hiding the output of a forecast report does not delete the report output from the server, so other users can still the view the forecast results.

Note: The execution user of the Forecast Event cannot hide the output of the forecast report.

Follow these steps:

  1. List forecast reports.
    A list of forecast reports appears along with the results for each report.
  2. Right-click the output of a forecast report, and select Hide Report from the pop-up menu.

    Note: To hide the output of multiple forecast reports at once, hold the Ctrl key and select the forecast results you want to hide, right-click one of the selected forecast results, and select Hide Report from the pop-up menu.

    The output of the forecast report is removed from the view.

Delete the Output of a Forecast Report

If you no longer want users to view the output of a forecast report, you can delete the forecast results from the server.

Note: To delete the output of a forecast report, you must be the execution user for the Forecast Event or have Allow access to the FORECAST_RESULT_DELETE permission.

Follow these steps:

  1. List forecast reports.
    A list of forecast reports appears along with the results for each report.
  2. Right-click the output of a forecast report, and select Delete from the pop-up menu.

    Note: To delete the output of multiple forecast reports at once, hold the Ctrl key and select the forecast results you want to delete, right-click one of the selected forecast results, and select Delete from the pop-up menu.

    A confirmation dialog opens.

  3. Click Yes.
    The forecast results are deleted from the server.

Delete a Forecast Report Definition

You can delete a forecast report definition from the server if you no longer need to schedule or generate the forecast report.

Follow these steps:

  1. List forecast reports.
    A list of forecast reports appears along with the results for each report.
  2. Right-click the definition of a forecast report, and select Delete from the pop-up menu.
    If the forecast report being deleted is associated with any Events, the Affected Artifacts dialog opens and lists the Events that are affected by the deletion. Otherwise, a confirmation dialog appears, and you can skip the next step.
  3. Selection one of the following, if applicable:
    • Yes—Proceeds with the deletion.
      The forecast report definition is deleted from the server.
    • No—Cancels the deletion request.

      Note: To avoid the warning, you can update the forecast report specified in the Event definition.
  4. Click Yes in the confirmation dialog, if applicable.
    The forecast report definition is deleted from the server.

    Note: The results of the forecast report are not deleted. When you refresh the view, the forecast results reappear under the forecast report. However, you can no longer open, schedule, or generate the forecast report as the definition no longer exists.
Was this helpful?

Please log in to post comments.