Distribution Servers Settings

In this section:

The Distribution Servers folder, shown in the following image, contains the settings that define and configure the ReportCaster Distribution Server. You can also define a failover Distribution Server to act as a backup, and configure two or more Distribution Servers to share the workload.

distribution server

The Distribution Servers folder contains the following configuration settings.

Setting

Optional or Required/Default Value

Descriptions and Possible Values

Primary Distribution Server section

Host

Required.

The host name of the primary Distribution Server.

Port

Required.

The port number of the primary Distribution Server

Failover Distribution Server.

Displays the host and port of the failover server. Select the icon next to the right of the Failover Distribution Server field to access the following settings. For more information, see Configuring a Failover Distribution Server.

Enabled

Required for Failover.

Default is not enabled.

Enables or disables the Distribution Server failover function.

Host

Required if Failover is enabled.

The host name of the failover Distribution Server.

Port

Required if Failover is enabled.

The port number to access the failover Distribution Server.

Failover Interval

Required if Failover is enabled.

Default value is 1.

The frequency (in minutes) at which the failover Distribution Server checks the primary Distribution Server to verify it is running.

Workload Distribution

Displays whether or not Workload Distribution is in effect (ON or OFF). Select the icon next to the right of the Workload Distribution field to access the following failover settings. For more information, see Configuring Workload Distribution Servers.

Enabled

Required for Workload Distribution.

Default is not enabled.

Enables or disables the distribution of ReportCaster jobs among Distribution Servers.

Worker Name

Required if Workload Distribution is enabled.

Name to identify the worker Distribution Server.

Workload Distribution Server Host

Required if Workload Distribution is enabled.

The host name of the worker Distribution Server.

Workload Distribution Server Port

Required if Workload Distribution is enabled.

The default value is 8200.

The port number of the worker Distribution Server.

Maximum Threads

Default value is 3.

Controls how many simultaneous connections (threads) the ReportCaster Distribution Server can utilize to process scheduled jobs.

Note: This setting is also available in the WebFOCUS Administration Console.

Reader Interval

Required.

Default value is 1 minute.

Polling interval (in minutes) for the ReportCaster Distribution Server to check for scheduled jobs.

An acceptable value is any positive integer from 1 to 999999. Negative numbers and zero are not allowed.

Note: This setting is also available in the WebFOCUS Administration Console.

Recovery

Default value is OFF.

On. During startup, the ReportCaster Distribution Server recovers scheduled jobs that were processed but not completed.

Off (Default). During startup, the ReportCaster Distribution Server does not recover any scheduled jobs.

Note: This setting is also available in the WebFOCUS Administration Console.

Processing for No Report to Distribute

Required.

Default value is Error.

Specifies whether the No Report to Distribute message from the WebFOCUS Reporting Server is categorized as an error or a warning. This is a global setting, relevant to all schedules. Possible values are:

  • Error. The No Report to Distribute message is categorized as an error and the message is written to the ReportCaster log report in red. When the schedule has the Notification option set to Error, the Notification is sent.
  • Warning. The No Report to Distribute message is categorized as a warning, and the message is written to the log report (in orange) as an informational message. When the schedule has the Notification option set to Warning, no error notification is sent.

These settings also apply to burst reports when there is a No Report to Distribute message for an individual burst value.

If a schedule contains multiple tasks, the No Report to Distribute processing only applies if all tasks that are part of the schedule produce the No Report to Distribute message. If one task in the schedule produces a report, then the value of this setting does not affect log messaging or notification.

FOC Message Numbers to be Processed as Warnings

Optional.

Default FOC Message Numbers are:

  • 95
  • 96
  • 201
  • 757
  • 837
  • 36359

Enables you to specify which FOC error and warning messages (identified by their number) that you want the WebFOCUS Server to ignore when processing report requests.

For descriptions of the default message numbers and for instructions on adding and removing FOC message numbers from the list of default FOC messages, see Configuring FOC Message Numbers to be Processed as Warnings.

Max Messages per Task from Data Server

Required.

Default value is 1000

Controls the number of messages for each task from the Data Server written to the ReportCaster log file.

Scanback section

Scanback Type

Required.

Default value is On.

On, Off, Reset Next Runtime.

Scanback Interval

Default value is 15, 24 hour periods.

If the Distribution Server is unavailable for a period of time, this is the number of 24 hour periods (beginning with the Distribution Server re-start time) that you want the Distribution Server to scan for jobs not yet run and run them.

Possible values are:

  • An integer value greater than zero. 365 is the maximum integer value.
  • Reset Next Run Time
  • Off

Note: This setting is also available in the WebFOCUS Administration Console.

Job Status Notification Plug-in

Optional.

The name of a custom written Java class that implements the ReportCaster Job Status Notification interface and instructs the Distribution Server to perform some action (such as notifying a Web Service or other listener) that a scheduled job has started and ended.

For more information on the Job Status Notification Plug-in, see Customizing ReportCaster Plug-ins.



x
Configuring a Failover Distribution Server

The Distribution Failover Server feature enables you to configure a backup Distribution Server that can resume ReportCaster operations when there is an interruption (planned or unplanned) in the primary Distribution Server service. This section explains how to define the server you want to use as the Failover Distribution Server. For details on configuring a Failover Distribution Server with ReportCaster, see the Post-Installation Verification and Configuration chapter in the WebFOCUS and ReportCaster Installation and Configuration manual for your platform.

To access the Failover Distribution Server settings, click the icon to the right of the Failover Distribution Server setting field. The Failover Distribution Server dialog box opens, as shown in the following image.

failover

These settings are detailed in the Distribution Servers table. When you have entered the host name, port number, and Failover Interval for the backup Distribution Server, be sure that the Enabled option is selected, then click OK.

To implement these settings in ReportCaster, in the Configuration tab toolbar, click Save, then Restart.


Top of page

x
Configuring Workload Distribution Servers

You can configure one or more Distribution Servers to share in executing ReportCaster jobs. This section explains how to define those servers you want to use in Workload Distribution. For details on configuring ReportCaster to use Workload Distribution, see the Post-Installation Verification and Configuration chapter in the WebFOCUS and ReportCaster Installation and Configuration manual for your platform.

To define Workload Distribution Servers, perform the following steps.

  1. Click the icon to the right of the Workload Distribution field. The Workload Distribution dialog box opens, as shown in the following image.

    workload

  2. Select the Enabled setting. The settings in the Workload Distribution dialog box are now available to configure.
  3. Click Add.

    A template for a worker is added to the display pane, as shown in the following image.

    workload

  4. Double-click the Worker Name field and type a descriptive name for the Worker Distribution Server.
  5. Double-click the Worker Distribution Server Host field and type the host name.
  6. Double-click the Worker Distribution Server Port field, type the port number of the host (or use the spin box to set the port number). The default value is 8200.
  7. Repeat Steps 3 through 6 for each additional Worker that you want to participate in Distribution Workload.

To delete a Worker, select the specific worker in the list of workers and click Delete.

Note: If you have the ReportCaster Server Configuration Recovery option set to ON, and there is a service interruption, the Distribution Server recovers scheduled jobs that were processed but not completed.

For information on monitoring Workers and Workload Distribution, see Viewing the Distribution Server Status.


Top of page

x
Configuring FOC Message Numbers to be Processed as Warnings

How to:

The ReportCaster Distribution Server will not distribute report output returned by the WebFOCUS Reporting Server if a FOC message is received. Not all FOC messages are errors and you may want to enable distribution for a non-error FOC message. The FOC Message Numbers to be Processed as Warnings parameter enables you to control which messages the Distribution Server will ignore when processing report requests.

By default, ReportCaster ignores the following FOC messages when distributing reports. You can add or delete FOC messages from this default list using the procedure found in this section.



x
Procedure: How to Configure FOC Message Numbers to be Processed as Warnings
  1. In the Distribution Servers folder, click the icon to the right of the FOC Messages Numbers to be Processed as Warnings setting.

    The FOC Message Numbers to be Processed as Warnings dialog box opens displaying a list of the default FOC message numbers and other FOC message numbers that you previously added. The following image shows this dialog box with the default FOC message numbers.

    FOC message

  2. Add to or remove from the list of FOC message numbers, as follows:
    • To add a FOC message, type the FOC message number in the Add this number to the list of FOC message numbers field and click Add. To add multiple FOC message numbers, separate the number items with a comma. For example, type 20, 500, 77 to add the three numbers to the list.

      The new FOC message number(s) appears in the FOC message numbers list.

    • To remove one or more FOC messages, select the FOC number or numbers in the list that you want to remove and click Remove. (Use the Shift key to select contiguous items and the Ctrl key to select disjointed items.)

      The selected FOC message number no longer appears in the FOC message numbers list.

    • To restore the FOC message numbers list to the original default numbers, click Default.
  3. To save your FOC message selections, click OK. The values are saved and the FOC Messages Numbers to be Processed as Warnings dialog box closes.

WebFOCUS