In this section: |
When you access the Basic Scheduling tool, the information for the Task tab options is predefined with the selected report procedure (FEX) information. You can complete the available task options, such as specifying parameter values, as well as select whether or not to burst the report.
Note:
The options available when you select the Task tab are:
Select one of the following options from the Alert Options dialog box.
Caution: Be sure that you set the schedule interval to a time period greater than the time it takes to run the scheduled procedure. When the schedule interval is less than the time it takes to run the procedure and the Delay option is selected, an alert schedule will distribute (based on the distribution option that you selected) more frequently than expected. For email distribution, this can result in unnecessary distribution of emails which can impact the business or operational goals of the alert report distribution.
Report Properties
FLEX, VISDIS, and VISDISAE report output formats are no longer supported. If you are editing a task that uses one of these formats within a schedule, you can change the output format in the dialog box that opens.
When an alert has been triggered, you can set the alert schedule to deactivate under certain conditions.
When a recurring alert schedule is configured to have a delay, the alert schedule runs repeatedly throughout the secondary run interval until the alert is triggered, and then does not run again until the next primary run interval. This delay will only happen if the alert is triggered.
The Alert Options dialog box is shown in the following image.
For example, an alert schedule is set to run daily at 9:00 AM and has a secondary run interval that occurs every five minutes, lasting for a total of 15 minutes. This alert schedule runs four times per day, at 9:00 AM, 9:05 AM, 9:10 AM, and 9:15 AM. These recurrence settings are shown in the following image.
If the alert is triggered at 9:00 AM, an alert result report distributes at 9:00 AM. Once the alert has been triggered, if you do not want to repeatedly receive the same report at 9:05 AM, 9:10 AM, and 9:15 AM, but you do not want to deactivate the alert schedule, you can use the Delay option to reschedule the alert schedule to run on the next primary interval.
This means that if the alert is triggered at 9:00 AM on Tuesday, the alert schedule will not continue to run at 9:05 AM, 9:10 AM, and 9:15 AM. All remaining scheduled runs that are planned to occur during the secondary run interval are cancelled. However, the delayed alert schedule is rescheduled to run at the next primary run interval, which is Wednesday at 9:00 AM.
For example, if we add a delay of one hour to the alert schedule before the alert is triggered at 9:00 AM on Tuesday, the next run time of the alert schedule would be 10:00 AM. However, since 10:00 AM is past the duration of the secondary run interval, which is only from 9:00 AM to 9:15 AM, the alert schedule is delayed to run the next day at 9:00 AM on Wednesday.
In this section: |
How to: |
Reference: |
You can customize a report and control its execution with parameters. When scheduling a report procedure (FEX), the schedule Task Parameters section allows you to supply a value for parameters referenced in the report procedure or add a parameter to the schedule by creating a new parameter and specifying the parameter name and value.
If your Server Procedure contains Pre/Post Procedures, see Schedule Pre-Processing and Post-Processing Procedures.
If the scheduled procedure contains parameters for which values must be supplied at run time, these parameters are displayed in the parameters section of the scheduling tool.
In the Basic Scheduling tool, click the Parameters tab to open the Task Parameters dialog box, shown in the following image.
Parameters may have default values and may have values that can be selected from a static or dynamic list. For more information about selecting parameters in the Scheduling Task Parameters dialog box, see the examples provided in this chapter.
The following are considerations when specifying parameter values for a procedure:
Note:
ReportCaster displays global variables that are used in FILTERS defined in Master Files and referenced by a procedure. For example, if a Master File contains
FILENAME=CAR,SUFFIX=FOC VARIABLE NAME=&&COUNTRY1, USAGE=A10, DEFAULT=ENGLAND,$ FILTER FILTER1=COUNTRY EQ '&&COUNTRY1'; $
and the procedure being scheduled contains
WHERE FILTER1
then ReportCaster displays COUNTRY1 in the Parameters window.
Specifying default parameter values can be done with the -DEFAULT or -DEFAULTH command or within the WHERE statement. Default values specified with the -DEFAULTH command are not prompted for.
The following procedure sets a default value of NY for the STATE (2-3 letters for US State) parameter.
-DEFAULT &STATE=NY TABLE FILE GGSALES SUM DOLLARS UNITS BY ST BY CATEGORY BY PRODUCT ON TABLE SUBHEAD "Product Sales Report" WHERE ST EQ '&STATE.2-3 letters for US State.' END
The parameters that have default values defined in the report procedure (FEX) are listed within the Parameters tab with the default value in the Value column. When parameters are stored in a schedule, ReportCaster adds a -SET for the parameter to the schedule procedure sent to the Reporting Server to be run. A -SET command overrides a value specified in a -DEFAULT command.
The following image shows the Task Parameters dialog box displaying the STATE parameter. In the Use Default column, the State parameter shows a value of Yes. In the Parameter Properties section, NY is shown in the Value and Default Value fields. This is the default parameter value.
To use a value other than the default value at schedule execution time, so that it will be used even if the procedure is changed, click the parameter and change the parameter value within the Parameter Properties section. Values for simple parameters are specified by entering a value for the parameter in the Value field. There are also static and dynamic parameter types that allow selection of a single or multiple values, which are explained in the following examples.
When parameters are stored in a schedule, ReportCaster adds a -SET for the parameter to the schedule procedure sent to the Reporting Server to be run. A -SET command overrides a default value specified in a -DEFAULT command.
The following procedure provides a list of static values that are valid for the CATEGORY (Category) parameter.
-DEFAULT &STATE=NY TABLE FILE GGSALES SUM DOLLARS UNITS BY ST BY CATEGORY BY PRODUCT ON TABLE SUBHEAD "Product Sales Report" WHERE ST EQ '&STATE.2-3 letters for US State.' WHERE CATEGORY EQ '&CATEGORY.(Coffee,Food,Gifts).Category.' END
The following image shows the Task Parameters dialog box displaying the CATEGORY parameter. In the Value column, the CATEGORY parameter has a value of Coffee. Since this CATEGORY parameter has a list of possible parameter values, there is no default value specified. Therefore, the Use Default column is blank.
To supply a value for a single select parameter, select the parameter in the Task Parameters table and enter a value in the Value field in the Parameter Properties section. From the list of the values, select a value to assign to the parameter. You can select only one value for a static single-select parameter.
The following procedure provides a single select list of values that are valid for the PRODUCT (Product Name) field. This list is dynamically populated with values from the GGSALES data source.
-DEFAULT &STATE=NY; TABLE FILE GGSALES SUM DOLLARS UNITS BY ST BY CATEGORY BY PRODUCT ON TABLE SUBHEAD "Product Sales Report" WHERE ST EQ '&STATE.2-3 letters for US State.' WHERE PRODUCT EQ '&PRODUCT.(FIND PRODUCT IN GGSALES).Product Name.' END
The following image shows the Task Parameters dialog box displaying the PRODUCT parameter. In the value column, the PRODUCT parameter has a value of Espresso. Since the PRODUCT parameter has a list of possible parameter values, there is no default value specified. Therefore, the Use Default column is blank.
To supply a different value, click the PRODUCT parameter in the table and change the parameter value within the Parameter Properties section. You can select only one value from the dynamic single-select list.
The following procedure provides a static multiselect list of values that are valid for the CATEGORY (Category) field.
-DEFAULT &STATE=NY TABLE FILE GGSALES SUM DOLLARS UNITS BY ST BY CATEGORY BY PRODUCT ON TABLE SUBHEAD "Product Sales Report" WHERE ST EQ '&STATE.2-3 letters for US State.' WHERE CATEGORY EQ '&CATEGORY.(OR(Coffee,Food,Gifts)).Category.' END
The following image shows the Task Parameters dialog box displaying the CATEGORY parameter. The CATEGORY parameter has been encoded to only use the values Coffee, Food or Gifts. The selected values will show in the Value column. Since the CATEGORY parameter has a list of possible parameter values, there is no default value specified. Therefore, the Use Default column is blank.
When the Value button is selected in the Parameter Properties section, a list of available values displays, as shown in the following image. Using the Ctrl key, you can select more than one value from the static multiselect list.
The following procedure provides a dynamic multiselect list of values that are valid for the PRODUCT field. This list is dynamically populated with values from the GGSALES data source.
-DEFAULT &STATE=NY; TABLE FILE GGSALES SUM DOLLARS UNITS BY ST BY CATEGORY BY PRODUCT ON TABLE SUBHEAD "Product Sales Report" WHERE ST EQ '&STATE.2-3 letters for US State.' WHERE PRODUCT EQ '&PRODUCT.(OR(FIND PRODUCT IN GGSALES)).Product Name.' END
The following image shows the Task Parameters dialog box displaying the CATEGORY parameter. The CATEGORY parameter has been encoded to use any value found in the GGSALES data source. The selected values will show in the Value column. Since the CATEGORY parameter has a list of possible parameter values, there is no default value specified. Therefore, the Use Default column is blank.
When the Value button is selected in the Parameter Properties section, a list of available values displays, as shown in the following image. Using the Ctrl key, you can select more than one value from the dynamic multiselect list.
In this section: |
How to: |
In addition to the ability to distribute sections of a single report to individual users using standard bursting, you can distribute sections of reports by using a filter with a static or dynamic multi-select parameter.
Analytic documents, which are compound reports that contain interactive reports, and reports that use an Excel format output, can be burst by using the parameter values saved in these reports. You can also burst Excel reports that contain a table of contents. You can burst these reports using a field other than the first BY field.
The Repeat Task for Each Selected Value check box must be selected in order to burst each parameter separately. In both the Basic and Advanced Scheduling tools, the Repeat Task for Each Selected Value check box is found in the Parameter Value for Amper Variable dialog box, as shown in the following image.
The values you choose are shown in the Task Parameters dialog box and placed between square brackets in the Value column to indicate their selection, as shown in the following image.
Once the schedule is run, the Distribution Server repeats the execution of the task for each parameter selected. For example, since the parameter values Japan, Italy, and France are selected, and the Repeat Task for Each Selected Parameter check box is selected, the schedule bursts the report information into three separate reports. Each report shows information related to one of the three selected parameters, as shown in the following image.
Selecting the Repeat Task for Each Selected Value check box allows you to select the Run Pre/Post-RPC Every Time check box, as shown in the following image.
The Run Pre/Post-RPC Every Time check box enables the Distribution Server to run pre-processing and post-processing procedures with each task repetition.
For example, if three parameter values are selected, and the Run Pre/Post-RPC Every Time check box is selected, pre-processing procedures run before each selected value, and post-processing procedures run after each selected value.
If you do not select this check box, pre-processing procedures execute only once before the first task is executed, and post-processing procedures execute only once after the last task is executed. This check box is cleared by default.
Note: The Run Pre/Post-RPC Every Time check box cannot be selected unless the Repeat Task for Each Selected Value check box is selected first.
The Task Parameters dialog box opens.
Once the parameter is chosen, the Parameter Properties section is populated with information about the selected parameter.
Note: For the Value button to be able to be selected, the chosen parameter must be a multiselect parameter.
The Parameter Value for Amper Variable dialog box opens.
The selected parameter values now appear in square brackets in the Task Parameters dialog box in the Value column, as shown in the following image.
When the schedule is run, it distributes a report for every burst parameter that you selected, as shown in the following image.
The Advanced Scheduling tool displays.
Note: The Parameters tab is available only when WebFOCUS Server Procedure or WebFOCUS Report is selected.
Once the parameter is chosen, the Parameter Properties section is populated with information about the selected parameter.
Note: For the Value button to be able to be selected, the chosen parameter must be a multiselect parameter.
The Parameter Value for Amper Variable dialog box opens.
The selected parameter values now appear in square brackets in the Task Parameters dialog box in the Value column, as shown in the following image.
When the schedule is run, it distributes a report for every burst parameter that you selected, as shown in the following image.
When you create an analytic document or Excel compound report that contains filtered and unfiltered reports, only the filtered reports can be configured for bursting.
The following image shows two reports created in InfoAssist on one dashboard. The report showing MODEL, CAR, COUNTRY, and DEALER COST data has a COUNTRY filter applied, which allows the user to filter report results by country. The report showing MODEL and RETAIL_COST data does not have a filter.
When you access Task Parameters for this compound report through the scheduling tool, any edits you make to the parameter will only apply to the filtered report. Meaning, you will only be able to assign values to a parameter in the filtered report. An example of this is shown in the following image, where you can see the values that were assigned to the COUNTRY parameter.
When you schedule a compound report to be burst, and the Repeat Task for Each Selected Value check box is selected, the reports that contain filters will burst based on the parameter values selected. In the following image, the compound report is distributed into three separate burst reports, which show filtered data about W GERMANY, FRANCE, and JAPAN, respectively.
For each burst report, the first chart shows data for the selected COUNTRY value.
The following image shows the W GERMANY burst compound report.
Because no filters have been applied to the second report, the results of the second report are the same for each burst compound report. Only the report that uses the COUNTRY filter changes.
If you attempt to burst an analytic document or Excel compound report that contains only filtered reports, all reports will be compatible with bursting.
The following images show two reports created in InfoAssist on one dashboard. Both reports use the same filter for the MODEL data.
When Task Parameters are accessed through the scheduling tool for this compound report, you can specify the MODEL values for both reports.
As shown in the following image, the MODEL parameter has the filter values 3.0 SI 4 DOOR, 100 LS 2 DOOR AUTO, XJ12L AUTO, B210 2 DOOR AUTO, and 2000 SPIDER VELOCE selected.
The selected values appear in brackets in the Task Parameters dialog box, as shown in the following image.
When you schedule a compound report to be burst, and the Repeat Task for Each Selected Value check box is selected, burst reports are created based on the parameter values selected. In the following image, the compound report is distributed and burst into five separate compound reports, which show filtered data about each selected car model.
For each burst compound report, both reports show data for the selected car model. In the following image, the burst compound report showing information about the 3.0 SI 4 DOOR car model is selected. Both reports in the burst compound report only show information about the selected model.
It is important to verify that the parameters you delete when scheduling a report procedure (FEX) will be handled, as follows, so that the scheduled job will run successfully:
To delete a parameter so that it is not stored with the schedule information, highlight the parameter in the parameter table you want to delete, and click the Delete button.
How to: |
If you need to have the schedule job send a parameter and value that is not defined in the report procedure being scheduled, you can create a new parameter in the Task Parameters dialog box. Parameters referenced during processing by the Reporting Server must be assigned a value for the scheduled job to run successfully. The schedule job log report will contain information when required parameter values were not provided.
You can create parameters for a task as follows:
The Task Parameter dialog box displays, as shown in the following image.
The Name and Value boxes are populated in the Task Parameters dialog box Parameters table.
Use the following guidelines when selecting a format:
How to: |
If you are scheduling a Server Procedure or report procedure (FEX), you can schedule a maximum of two pre-processing and post-processing procedures. The pre-processing and post-processing procedures that you schedule can reside on the Reporting Server or in the WebFOCUS Repository, as shown in the following image.
Note: All ReportCaster internal variables, which start with &DST, are passed to pre-processing and post-processing procedures so that they are available for application specific logic. For more information, see ReportCaster Internal Variables.
Note: If you do not specify an application path, the default search path for the Reporting Server is used to locate the specified procedure.
procedurename name=value, name=value
You do not need to enter the pairs in the order in which they are encountered in the procedure.
For additional information on supplying parameter values for a procedure, see the Supplying Variable Values From Another Procedure topic in the Developing Reporting Applications manual.
The Advanced Options tab provides access to the Additional FOC Errors to be Processed as Warnings dialog box, where you can specify one or more FOCUS® error message numbers, separated by a comma. If one of these FOCUS error numbers is encountered during schedule execution, ReportCaster will process it as a warning rather than an error. For example, if a FOC1517 error is generated by the procedure, add 1517 to the text box to convert this error to a warning. This means that if a report is produced, it will be distributed in spite of the FOCUS error number. It also means that this FOCUS error number will not trigger error notification if the schedule is configured to notify on error.
The Advanced Task Settings dialog box is shown in the following image.