x

1. From the ReportCaster Development interface in the Schedule tab window, click New.

   The new schedule window opens.

2. Select the Task tab in new schedule window, as shown in the following image.

   

3. In the Task Type field, select WF Server Procedure.
4. In the Task Name field, type a name that describes this Task.
5. From the WF Reporting Server drop-down list, select the server from which you want to select the report.
6. From the Execution Id drop-down list, specify an Execution Id that is authorized to execute procedures on the server specified in Step 3.

   If this field is available, it means that a default Execution Id and password have been specified within the ReportCaster Server Configuration tool.

   If the Execution Id field is available, and you will be using an Execution Id that you previously used for a Task on the selected server, you can select the Execution Id (for example, osdqa1) from the drop-down list, as shown in the following image.

   

   If the Execution Id field is available and you will be using a new Execution Id, perform the following steps:

   1. Type the Execution Id and click Change Password. The Password dialog box opens.
   2. Type the password for the Execution Id.
   3. Confirm the password for the Execution Id.
   4. Click OK to return to the Tasks tab.

      Note: The Execution Id is added to the ReportCaster Repository and is viewable in the ReportCaster Console.

7. Click the Procedure Name drop-down list to select a WF Server Procedure to schedule.

   The Select WF Server Procedure folder expands, as shown in the following image.

   

   When a WebFOCUS Reporting Server is Application Enabled, you will see a node called Applications. When you open the Applications node, a query is made to the server to retrieve a list of applications found under its Application Root (APPROOT) directory. When you open an application (for example, ibinccen), a request is issued to the server to get the list of accessible files in the application, as shown in the following image.

   

   Note: When a WebFOCUS Reporting Server is configured with the traditional Cataloged Path (EDAPATH) setting, you will see Applications and Cataloged Path nodes listed under the server. For more information about these concepts, see Data Servers Feature in the WebFOCUS Managed Reporting Developer's Manual.

8. Select the WF Server Procedure.
9. Add or edit parameters in Parameter Name and Parameter Value by double-clicking the parameter.

   The Parameter Editor dialog box opens.

   Note: The check box must be selected in order to edit the parameter.

   

10. From the Report Format drop-down list, select the report format. HTML is the default value.

    Use the following guidelines when selecting a format:

    • In order to output HTML pages with images, normally you would select DHTML as the format and the output is distributed with the extension .mht. You can select HTML as the distribution format. If you select HTML ReportCaster creates the output with the extension .htm by default. If the scheduled procedure contains SET WEBARCHIVE = ON and outputs pages with images and you select HTML as the format be sure to change the extension in the Save Report As field from .htm to .mht.
    • The report format specified in this field overrides the format statement in the procedure, except for specialized formats (EXL2K FORMULA, EXL2K PIVOT, EXL2K TEMPLATE, PPT TEMPLATE, DFIX). When a report uses a specialized format, the format selection in the report schedule must match that specified in the report.
    • There are limitations on what formats are valid for certain options. For instance, not all formats are supported for bursting or printing.
      • The formats that support bursting are AHTML (except for FML reports), ALPHA, COM, COMMA, COMT, DHTML (except for FML reports), DOC, EXL2K, EXL2K FORMULA, EXL2K TEMPLATE, EXL97, GIF, HTML and HTML ODP (except for FML reports), JPEG, PDF, PNG, PPT, PS, SVG, TAB, TABT, WP, and XML.
      • The formats that support printing are DOC, PDF (when ReportCaster is configured to enable PDF to print and the printer has the appropriate driver), PS, and WP.
      • The HTML ODP format can only be distributed to the Report Library.
    • If the report is a Coordinated Compound PDF report, then you can select any supported compound format (AHTML, DHTML, EXL2K, Flash, PDF, or PPT), but keep in mind that not all of these formats support bursting.

    ReportCaster administrators can specify which report formats will appear in the Tasks tab through the Schedule Format setting in the ReportCaster Server Configuration tool.

11. If you want to burst the report, select the Burst Report check box. The burst feature enables you to break a report into sections and distribute the sections separately. Burst values may be specified in a Distribution List, distribution file, or by creating a dynamic distribution list.
12. Optionally, if your report has parameters or you want to schedule pre-processing or post-processing procedures, click Advanced Procedure.
13. In the Save Report As field, type a name for the report to be distributed. By default, this value is populated as application_procedurename.ext, where application is the name of the application if WebFOCUS is Application Enabled, procedurename is the file name of the WF Server Procedure, and ext is the extension of the format you selected. For example: ibinccen_salerank.htm. If the report is burst, it is distributed as ibinccen_salerank_burstvalue.htm. If you change the default value, and you specify an extension, be sure to specify the extension of the format you selected. If you do not specify an extension, ReportCaster automatically uses the extension of the format you selected.

    Note: In order to output HTML pages with images, normally you would select DHTML as the format and the output is distributed with the extension .mht. You can select HTML as the distribution format. If you select HTML ReportCaster creates the output with the extension .htm by default. If the scheduled procedure contains SET WEBARCHIVE = ON and outputs pages with images and you select HTML as the format be sure to change the extension in the Save Report As field from .htm to .mht.

14. Click Save.
15. If you are creating a schedule with multiple tasks and want to use an existing task as a template, select the task you want to clone from the list and click Clone.

    A duplicate of the selected task appears in the list with the name Clone Of taskname.

    Open the cloned task and modify as needed.

16. Click the Distribution tab to specify distribution options (see Distribution Options), or optionally select one of the following options:
    • New. Schedule another Task within your schedule. Follow the steps outlined in the appropriate procedure for the Task type you want to schedule. You can only create multiple Tasks when using the e-mail or printer distribution methods.
    • Edit. Edit a selected Task within your current schedule.
    • Delete. Delete a selected Task within your current schedule.

    Note: If you have multiple Tasks, you can move the position of a Task within the window by clicking the following up or down arrows.

Note: You cannot create a WF Server Procedure schedule when a server within a cluster configuration is unavailable.

x

1. Select and click the checked empty row at the bottom of the parameter list.

   

   The Parameter Editor window opens.

2. In the Parameter Properties Name field, type a valid name for the new parameter.
3. In the Parameter Properties Value field, type a value for the new parameter.

   

4. Click OK. The new parameter is created and the Advanced Task Options window closes.

   

x

Uncheck the box next to the parameter you want to delete. When the schedule is saved, the unchecked parameter is deleted and no longer stored with the schedule.

x

The following are considerations when specifying parameter values for a procedure:

• Ability to create a new parameter for WebFOCUS Server procedures.
• The maximum number of characters for each individual parameter value is 3200. You can store multiple values for a single parameter. Multiple values for a parameter are stored as one entry, which must not exceed the 3200 maximum character limit.
• Dynamic parameter prompting for WebFOCUS (WF) Server procedures is available.
• ReportCaster displays the description for the parameter when it is specified in the procedure. Otherwise, ReportCaster displays the parameter name.
• ReportCaster performs field validation for numeric and alpha formats, and range value validation.
• ReportCaster displays default variable values, as well as static or dynamic single-select and multi-select lists.

  Note:

  • The No Selection option is displayed for dynamic multi-select lists. When selected, this option does not perform any data selection test on that field.
  • ReportCaster does not support using the -HTMLFORM command to create a dynamic selectable list of parameter values.

    As an alternate method of creating a dynamic selectable list of parameter values, you can use the schedule technique in the HTML Composer. For details, see Technical Memo 4626: Adding Schedule Capability to the HTML Layout Painter.

• The Specify All Parameter Values check box is checked if there are any parameters available for the report (Standard Report, My Report, or WF Server Procedure) and default values are not supplied. You can check or uncheck this option to quickly enable or disable the check boxes for each individual parameter that does not have default values. If the check box for an individual parameter is unchecked, the input field for the parameter value is disabled, the default parameter value(s) are displayed (but cannot be changed), and no parameter data is saved to the ReportCaster Repository for that parameter. Check the box to change and save the values for that parameter.
• ReportCaster will not prompt for variables with defaults set by the -DEFAULTH command. The purpose of the -DEFAULTH command is to be able to assign amper variables a default value and not be dynamically prompted for that variable.
• ReportCaster does not prompt for the value of its internal variables that are set by the Distribution Server at schedule execution time. For example, &DSTOWNER is the user ID of the schedule owner. If this parameter is referenced in a scheduled procedure the value will be available because the Distribution Server sets the value to the owner of the schedule at schedule execution time. However, the scheduling tool will not prompt for this value at schedule creation time.
• When specifying parameters with special characters (for example, %, &, | ):

  If you are specifying the entire WHERE condition as the parameter value, you must enclose the value within two single quotation marks rather than a double quotation mark. For example: ''WHERE CAR NOT LIKE MOTO%''

  If you are only specifying a value as the parameter value, you do not need to enclose the parameter value within quotation marks. For example: O&DINFO

• If you want to specify parameter values in a pre-processing or post-processing procedure, these must be typed in the Procedures tab.
• Once a parameter has been added to the Schedule table, ReportCaster will continue to show that parameter even if it is removed from the underlying report. You must manually remove the parameter by unchecking it in the Parameter tab of the Advanced Task Options window.

Note: You can only schedule saved procedures using ReportCaster; HTML forms cannot be scheduled using ReportCaster. Parameter prompting is not available in pre-processing or post-processing procedures. For more information about WebFOCUS auto prompting, see Coding a User Interface in the Developing Reporting Applications manual.

The following are examples of how ReportCaster displays default variable values, as well as static and dynamic single-select and multi-select lists.

Top of page

Example: Setting a Default Variable Parameter Value

Since ReportCaster requires considerations for special characters, Information Builders recommends using the syntax specified in the following examples.

The following procedure sets a default value of NY for the STATE (2-3 letters for US State) field, and a default value of Web Sales for the SNAME (Store Name) field. Note that there must be an ampersand in front of the field name in the -DEFAULT command for the amper variable(s) to contain a default attribute in ReportCaster.

-DEFAULT &STATE=NY
-DEFAULT &SNAME=Web SalesTABLE FILE CENTORD
SUM QTY_IN_STOCK BY STATE BY SNAME BY PRODNAME
ON TABLE SUBHEAD
"Inventory Report"
WHERE STATE EQ '&STATE.2-3 letters for US State.'
WHERE SNAME EQ '&SNAME.Store Name.'
END

The parameters that have a default value set in the procedure are not checked in the scheduler. Since they are not checked they will not be stored with schedule. At schedule execution time, the default value set in the procedure will be used.

To use a value other that the default value at schedule execution time or to store the default value with the schedule so that it will be used even if the procedure is changed check the parameter and click the parameter to open the Parameter Editor. Type the value to be used in the value field and click OK.

The parameter will now be checked and the displayed value will be stored with the schedule and used at schedule execution time.

Top of page

Example: Adding a Static Single-Select List of Parameter Values

The following procedure provides a list of static values that are valid for the SNAME (Store Name) field.

-DEFAULT &STATE=NY
TABLE FILE CENTORD
SUM QTY_IN_STOCK BY STATE BY SNAME BY PRODNAME
ON TABLE SUBHEAD
"Inventory Report"
WHERE STATE EQ '&STATE.2-3 letters for US State.'
WHERE SNAME EQ '&SNAME.(eMart,TV City,Web Sales).Store Name.'
END

The Store Name parameter appears as follows in the ReportCaster Scheduler. Initially, no value has been set for the parameter so the value is blank.

Since no default value for Store Name is supplied in the procedure, the parameter is checked in the scheduler. To supply a value for Store Name, click the parameter to open the Parameter Editor. The values for the Store Name parameter appear as follows in the ReportCaster Scheduler. You can select only one value from the list.

Select the value to be used from the list and click OK. The selected value appears in the scheduler.

Top of page

Example: Adding a Dynamic Single-Select List of Parameter Values

The following procedure provides a list of values that are valid for the PRODNAME (Product Name) field. This list is dynamically populated with values from the CENTORD data source.

-DEFAULT &STATE=NY
TABLE FILE CENTORD
SUM QTY_IN_STOCK BY STATE BY SNAME BY PRODNAME
ON TABLE SUBHEAD
"Inventory Report"
WHERE STATE EQ '&STATE.2-3 letters for US State.'
WHERE SNAME EQ '&SNAME.(eMart,TV City,Web Sales).Store Name.'
WHERE PRODNAME EQ '&PRODNAME.(FIND PRODNAME IN CENTORD).Product Name.'
END

The Product Name parameter appears as follows in the ReportCaster Scheduler. Initially, no value has been set for the parameter so the value is blank.

To supply a value for Product Name, click the parameter to open the Parameter Editor. The values for the Product Name parameter appear as follows in the ReportCaster Scheduler. You can select only one value from the list.

Select the value to be used and click OK. The selected value appears in the scheduler.

Top of page

Example: Adding a Static Multi-Select List of Parameter Values

The following procedure provides a list of static values that are valid for the SNAME (Store Name) field.

-DEFAULT &STATE=NY
TABLE FILE CENTORD
SUM QTY_IN_STOCK BY STATE BY SNAME BY PRODNAME
ON TABLE SUBHEAD
"Inventory Report"
WHERE STATE EQ '&STATE.2-3 letters for US State.'
WHERE SNAME EQ &SNAME.(OR(eMart,TV City,Web Sales)).Store Name.
END

The Store Name parameter appears as follows in the ReportCaster Scheduler.

To supply values for Store Name, click the parameter to open the Parameter Editor. The values for the Store Name parameter appear as follows in the ReportCaster Scheduler. You can select more than one value from the list, as shown in the following image.

Select the values to be used from the list and click OK. The selected values appear in the scheduler.

Top of page

Example: Adding a Dynamic Multi-Select List of Parameter Values

The following procedure provides a list of values that are valid for the PRODNAME (Product Name) field. This list is dynamically populated with values from the CENTORD data source.

-DEFAULT &STATE=NY
-DEFAULT &SNAME='TV City' 
-DEFAULT &PRODNAME='''120 VHS-C Camcorder 40 X'''TABLE FILE CENTORD
SUM QTY_IN_STOCK BY STATE BY SNAME BY PRODNAME
ON TABLE SUBHEAD
"Inventory Report"
WHERE STATE EQ '&STATE.2-3 letters for US State.'
WHERE SNAME EQ &SNAME.(OR(eMart,TV City,Web Sales)).Store Name.
WHERE PRODNAME EQ &PRODNAME.(OR(FIND PRODNAME IN CENTORD)).Product Name.
END

The Product Name parameter appears as follows in the ReportCaster Scheduler.

To supply values for Product Name, click the parameter to open the Parameter Editor. The values for the Product Name parameter appear as follows in the ReportCaster Scheduler. You can select more than one value from the list. You can also select No Selection if you do not want to perform any data selection test on that field.

Select the values to be used and click OK. The selected values appear in the scheduler.

Important: When coding a multi-select list of parameter values using -DEFAULT syntax without storing parameter values in the ReportCaster Repository, the -DEFAULT value is used, as specified in the procedure, and the scheduled request will fail if you do not specify three single quotation marks before and after the parameter value string.

x

If you are scheduling a report Task that is a WF Server Procedure, Standard Report, or My Report, you can schedule a maximum of two pre-processing and post-processing procedures. The pre-processing and post-processing procedures that you schedule must reside on the WebFOCUS Reporting Server.

To schedule pre-processing and post-processing procedures for a Task:

1. Click Advanced Procedure. The Advanced Procedures window opens, as shown in the following image.

   

2. Select the following information:
   1. Pre-processing Procedures:

      First. From the drop-down list, select the first pre-processing procedure. ReportCaster will run this procedure immediately preceding the scheduled Task.

      Second. From the drop-down list, select the second pre-processing procedure. ReportCaster will run this procedure immediately after the first pre-processing procedure, but before the scheduled Task.

   2. Post-processing Procedures:

      First. From the drop-down list, select the first post-processing procedure. ReportCaster will run this procedure immediately following the scheduled Task.

      Second. From the drop-down list, select the second post-processing procedure. ReportCaster will run this procedure immediately after the first post-processing procedure.

3. Click OK to return to the Task tab.