Primary Distribution Server section

Host

Required.

Host name of the primary Distribution Server.

Port

Required.

Port number of the primary Distribution Server.

Secondary Distribution Server

Displays the host name and port number of the secondary server. Select the icon next to the right of the Secondary Distribution Server field to access the following settings.

Enabled

Required for Failover.

Default is not enabled.

Enables or disables the Distribution Server failover function.

Host

Required if Failover is enabled.

Host name of the failover Distribution Server.

Port

Required if Failover is enabled.

Port number to access the failover Distribution Server.

Failover Interval

Required if Failover is enabled.

Default value is 1.

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

Default is not selected.

Selected. The Primary and Secondary servers monitor the status of each other by reading and updating a server status record in the WebFOCUS repository.

Not Selected. The Primary and Secondary servers communicate to each other through the network. If network communication between the servers is disrupted, the Secondary server may promote itself to Full Function status if does not receive a response from the Primary server even if the Primary server is in Full Function mode.

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.

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.

Host name of the worker Distribution Server.

Workload Distribution Server Port

Required if Workload Distribution is enabled.

The default value is 8200.

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:

• (FOC095)
• (FOC096)
• (FOC201)
• (FOC757)
• (FOC837)
• (FOC36359)

For an explanation regarding these FOC Message Numbers, see the bulleted list below this table.

Specifies which FOC error and warning messages (identified by their number) the Distribution Server will ignore when processing report output returned from the Reporting Server.

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.

Scan-back section

Scan-back Type

Required.

Default value is On.

On, Off, Reset Next Runtime.

Scan-back 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 restart time) that you want the Distribution Server to scan for jobs not yet run and run them.

Possible values are:

• On
• Off
• Reset Next Run Time

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

Job Status Notification Plug-in

Optional.

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, see How to Configure the Job Status Notification Plug-in.

Provide Metrics Information from Resource Analyzer

Optional.

This functionality enables the collection of RA DBMS statistics from the Reporting Server for display in the schedule log.

Note: If you do not have Resource Analyzer on the Reporting Server, this functionality will not work.

When the check box is selected, the RC log displays messages containing RA DBMS information. When the check box is not selected, messages are not displayed.

For an example of the log report, see the following image.

Hold Connection

By default, this option is selected.

Selected. The database connection is kept open throughout the execution of the schedule, including obtaining Address Book information and writing information to the log files.

Not selected. The database connection is dropped before executing the schedule. A new connection is made after the schedule is executed to obtain Address Book information and write information to the log files.

Allow Group Blackout Dates

Required.

By default, this option is selected.

Specifies whether or not schedule blackout dates can be defined at the group level, in addition to being globally defined for all users. This option must be selected to view group blackout dates that have been defined.

Allow PDF Distribution Directly to a Printer

Required.

By default, this option is selected.

When selected, PDF is a selectable format for the Printer distribution method. This enables a PDF file to be distributed directly to a printer. The printer must have the appropriate driver to print PDF files.

Schedule Tasks

Optional.

All Task Types are enabled by default.

Specifies what Task Types are available to users. For more information, see Task Options in the Basic Scheduling Tool.

Distribution Formats

Optional.

All formats are enabled by default.

Specifies what report and graph formats are available to users. For more information, see ReportCaster Formats for Scheduled Output.

Distribution Methods

Optional.

All distribution methods are enabled by default.

Specifies what distribution methods are available to users. For more information, see Creating a Distribution List.

Inline Report Distribution

Required.

The default value is Allowed.

Specifies whether or not the Schedule tool will enable the email distribution option to send a report in the body of the email (inline).

Note: If this option is deselected after a schedule using this option has been created, the schedule will fail when it is run. A message in the log will indicate how to fix the problem.

Packet Email

Required.

The default value is Yes.

Controls how task output and burst content are distributed through email.

Valid values are:

• No. Each burst value or task output is distributed in a separate email.
• Yes. People receiving multiple burst values or output from multiple tasks will receive a single email with multiple attachments.
• Burst. Each burst value in a distribution list will generate a separate email for a given email address. There may be one or more attachments in the email depending on the number of tasks in the schedule.

Allowed Email Domains

The default value is Off.

Contains the email domains that are authorized in a distribution.

Note: Files containing email addresses intended for distribution are also verified for valid domains at schedule execution time. If it contains a restricted address, then no delivery is made to that address and an error message is written to the log file.

Mail Server Defaults Section

Mail Server

Required.

Name of the default mail server used to distribute an email schedule.

You can also specify a port for Mail Host using hostname:port. If you do not specify a port or the port you specify is not present, the default port is used.

This server requires a secure SSL connection

Optional.

Check this box if the specified mail server uses SSL.

This server requires a secure TLS connection

Optional.

Check this box if the specified mail server uses TLS.

This server requires authentication

Optional.

Check this box if the specified mail server requires authentication with a user ID and password.

SMTP User Id/Password

Required if the mailhost is using SMTP Authorization.

No default value.

User ID and password used to connect to the mailhost.

SMTP Security Plug-in

Optional.

Name of a custom written Java class that implements the ReportCaster SMTP security interface to dynamically retrieve the user ID and password needed to connect to an SMTP server. For more information, see How to Configure Email Settings.

Email Reply Defaults Section

Mail From

Optional.

Default value for the email From field. This can be any value.

Mail Reply Address

Optional.

Default email reply address when creating an email schedule.

Notification Defaults Section

Notify Mail Server

Optional.

Name of the mail server that distributes the notification email. If blank, ReportCaster uses the Mailhost setting as the notification mail server.

Tip: Information Builders recommends using different mail servers for notification and email distribution. This way, if there is a problem with your Mailhost, notification will still be sent. Having separate mail servers ensures that you will be informed when the default mail server falters.

You can also specify a port for the Notify Mailhost using hostname:port. If you do not specify a port or the port you specify is not present, the default port is used.

Default Notify Type

The default value is Never.

Specifies whether to send notification of the schedule status to a specified email address. Possible values are:

• Never. This is the default value. ReportCaster does not send notification of the schedule status under any circumstance.
• On Error. The specified users are notified when errors are encountered while running the schedule. Information Builders recommends using the On Error notification option.
• Always. The specified user is always notified when the schedule runs.

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

Email Retries Section

Email Retries

The default value is 1.

Number of times the Distribution server will try to connect to the email server to deliver report output.

If the Distribution server is unable to connect to the email server on the first try, it will attempt to connect again after the specified Email Retry Interval has passed. A message for each attempt is written to the log file.

Valid values are 0 through 9.

Email Retry Interval(seconds)

The default value is 60 seconds.

Amount of time that the Distribution server will wait between retries.

Valid values are 1 through 999.

Default FTP Host

Optional.

Name of the default FTP server when creating an FTP schedule.

If you want to designate a port number other than the default port number, then use the following format: hostname:port

Default FTP Location

Optional.

Name of the default FTP location (directory) when creating an FTP schedule.

Default User

Optional.

Default user ID and password to perform FTP file transfers.

To access the Default User settings, click the icon to the right of the Default User field. The User dialog box opens, where you can type the user name and password.

SFTP Security Plug-in

Optional.

Name of a custom written Java class that implements the ReportCaster SFTP security interface to dynamically retrieve the value of a public key needed to connect to a secure FTP server. For configuration information, see How to Configure FTP Settings.

Create Index File with Burst Distribution

Required.

By default, this option is selected.

For an FTP distribution of burst reports, this option determines whether or not to create an index file when the schedule runs.

This server requires a secure SSH File Transfer Protocol (SFTP)

Optional.

This option secures the configuration settings that you specify. If this check box is selected, the configuration information that you specify is secured, by default, in the schedule. This functionality enables you to select this option once in the configuration tool, eliminating the need to select the check box each time you use the scheduling tool.

If this check box is not selected, you can optionally secure the configuration information at schedule creation time through the Scheduling tool.

Add Zip Extension to Filename if Not Specified

Required.

By default, this option is selected.

Controls whether or not the .zip file extension will be automatically appended to the Zip file name entered by the user in a schedule distributed by email or FTP.

Select this option if you want to automatically append .zip to the entered file name.

Do not select this option if you want to use the file name as entered by the user and not have .zip automatically appended to the file name.

Zip Minimum with Email Distribution

Required.

The default size is in KB and set to 0.

Select either MB or KB and customize the size of your file using the up and down arrows.

Zip Encryption Password Plug-in

Required.

Default value is None.

Global setting that enables you to password protect and encrypt scheduled output distributed in a Zip file. This setting controls how passwords are obtained by the Distribution Server. The zip encryption is AES 256. For more information, see How to Configure the Default Zip Encryption Password Plug-in.

Possible values are:

• None. Do not use a plug-in to return the password for Zip protection.

  When set to None, you have the option to use the Zip encryption password feature by embedding the password in either a Dynamic Distribution List or a Distribution File rather than using a plug-in.

• Default. Use the provided default plug-in to return a password for the Zip encryption password feature.
• Custom. Use the provided custom plug-in named in the Zip Encryption Pwd Plug-in Name setting.

Zip Encryption Password Plug-in Name

Required when Zip Encryption Password Plug-in setting is Custom.

Type the name of a custom written plug-in that will return passwords. This plug-in must be available to the Distribution Server.

Zip Encoding

Optional.

Specifies an encoding other than the default encoding of the ReportCaster Distribution Server platform. The encoding specified must match the encoding used by WinZip or any other Zip utility installed on the Distribution Server.

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

Default Single File Compression Method for FTP

Required.

The default is Zip.

Zip settings enables you to compress a single file using Zip or Gzip.

If you prefer to use Gzip to distribute a Single File, then select Gzip from the drop-down menu for Single File Compression Method for FTP.

Use distributed filename for FTP archive filename if archive filename not specified in schedule

Optional.

If this box is checked, then when a schedule is created that uses FTP as the distribution method and the archive file name is left blank, the distribution server will use the name found in the FTP distribution list as the name of the archive file to be distributed.

Schedule End Date

Required.

Clicking the drop-down menu displays a calendar where you can select the schedule end date.

Schedule End Time

Required.

Manually, you can enter an end time for the schedule. Alternatively, use the arrows to assign a schedule end time.

Purge Log at Distribution Server Start

Optional.

By default, the check box is unchecked.

When selected, log reports are automatically purged each time the Distribution Server starts. This is in addition to the scheduled log purging that is set using the Log Purge Period and Log Purge Time options.

Log Purge Period

Optional.

Automatically purges individual log reports when they are older than a set number of days.

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

Log Purge Time

Optional.

Time at which log purging occurs.

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

Schedule Job Traces

The default value is Off.

Enables Distribution Server Traces.

• Off. Trace is disabled.
• Schedule. Schedule job processing information.
• Schedule and Report. Scheduled job processing information and report output returned to the Distribution Server to be distributed.

Distribution Server Code Page

Required.

The default code page is 65001.

Enter a valid code page for the Distribution Server.

Web Server Code Page

Required.

The default code page is 65001.

Enter a valid code page for the web server.

WFTransInOut

Optional.

Configures the WebFOCUS Servlet WFTRANSINOUT plug-in. This is a custom-written program that, when configured, is called by the Distribution Server as a last step prior to sending each request to the Reporting Server and again as the first step when receiving output from the Reporting Server. See the WebFOCUS Security and Administration manual for information on configuring this custom plug-in.

General Setting section

Active Directory

By default, this option is not selected.

Select if you are using the Active Directory technology for LDAP.

Do not select if you are using any other technology for LDAP.

Secure Connection (SSL)

By default, this option is not selected.

Indicates whether or not SSL (Secure Sockets Layer) is used to communicate with the LDAP server.

LDAP Host

There is no default value.

Host name or IP address of your LDAP directory server.

LDAP Port

Default value is 389.

Port on which the directory server listens.

LDAP Search Base

There is no default value.

Filter for LDAP searches. Only the subtree below the search base is available for LDAP queries. For example, dc=ibi, dc=com.

Search Time Out

Default value is 120.

Time, in seconds, that ReportCaster can search an LDAP data source before timing out.

Security Principal

No default value.

Service account of the user performing authentication. The user must have sufficient access rights to locate user entries in the directory.

Select the icon to the right of this option to open the User dialog box, where you can type a user name and password.

LDAP Email Setting section

Email LDAP Enabled

By default, this option is not selected.

Indicates whether ReportCaster is enabled to retrieve email address information from an LDAP data source.

Email Map

Default value is mail.

Attribute type for email entries.

Email User Filter

Default value provided is dependent on the LDAP Type selected.

Filter for email entries to be retrieved. For example:

(& (mailnickname=*)
(|(&(objectCategory=person)
(objectClass=user)(!(homeMDB=*))
(!(msExchHomeServerName=*)))
(&(objectCategory=person)
(objectClass=user)(|(homeMDB=*)
(msExchHomeServerName=*)))
(&(objectCategory=person)
(objectClass=contact))
(objectCategory=group)
(objectCategory=publicFolder)))

First Name Map

Default value is givenName.

Attribute for first name entries.

Last Name Map

Default value is sn.

Attribute for last name entries.

Settings for the Data Servers folder:

Graph Agents

The default value is 1.

Optimizes the processing of graphs. Due to performance considerations, Information Builders generally recommends configuring this setting to 1 Graph Agent for each concurrent graph report. However, your own internal testing should determine the Graph Agent value that best suits the business needs of your organization.

Graph Servlet URL

Optional.

There is no default.

Overrides the default graph server setting and configures graph image files to be created on the Application Server.

Type the following value

http://hostname/context_root/IBIGraphServlet

where:

hostname

Is the host name of the Application Server where the WebFOCUS Client is installed.

context_root

Is the site-customized context root for the WebFOCUS web application deployed on your Application Server. ibi_apps is the default value.

This setting is available for WebFOCUS procedures and Managed Reporting procedures.

This setting should not be used when web server security is enabled. This includes Basic authentication, IWA, SSL, and third-party security products (such as SiteMinder). In these cases, the web server security settings can prevent WebFOCUS from creating the graph.

Excel Servlet URL

Default value is http://localhost: 8080/ibi_apps

Specifies the application server to be used to zip the file components that comprise an EXCEL® 2007 file (.xlsx) as follows:

&URL_PROTOCOL://servername/alias/IBIEXCELSERVURL

where:

URL_Protocol

Is HTTP.

servername

Is the name of the application server where the WebFOCUS Client is installed.

alias

Is the context root of the WebFOCUS application. The default is ibi_apps.

For more information, see Technical Memo 4690: Saving Report Output in Excel 2007/2010 Format 7.7.03.

This setting is available for WebFOCUS procedures and Managed Reporting procedures. This setting should not be used when web server security is enabled. This includes Basic authentication, IWA, SSL, and third-party security products (such as SiteMinder). In these cases, the web server security settings can prevent WebFOCUS from creating the Excel 2007/2010 file.

Settings for an individual Data Server:

Name

Required.

Name of the selected Data Server.

Note: Data Server names are case-sensitive. Data Servers are defined in the WebFOCUS Client as uppercase so you should also define Data Servers as uppercase in ReportCaster.

Security Type

By default, this option is set to User.

Static. A valid Execution Id and password is supplied in the User setting. When creating a schedule, you cannot specify an Execution Id and password.

User. A valid Execution Id and password must be specified when creating a schedule.

Shared. When creating a schedule, the WebFOCUS user ID and password is internally assigned as the Execution Id and password.

Note: Since the actual password is not stored in the WebFOCUS repository, the Shared configuration can only be used when a password is not required to connect to the Reporting Server.

Trusted. The Execution Id is the schedule owner and no password is sent to the WebFOCUS Reporting Server when schedules run. For more information, see the WebFOCUS Security and Administration manual.

Note: The Reporting Server must be a configured to accept a Trusted connection when the Trusted option is selected.

User

Required if Security Type is set to Static.

Default Execution Id and password.

To access the ID and password, select the icon to the right of the User field. The User dialog box opens, where you can type the user name and password.

Graph Section

Graph Engine

Required. The value is GRAPH53.

Controls which graph engine to use for server-side graphics. By default, this specifies the GRAPH53 setting.

Headless

By default, this option is not selected.

Determines whether a graphics card exists on the WebFOCUS Reporting Server. When not selected (the default), a graphics card exists on the server. When selected, no graphics card exists on the server.

Cluster

By default, this option is not selected.

Indicates that this node consists of one or more Reporting Servers available to ReportCaster. ReportCaster will pick a server from the list each time it receives a task for that server node.

Note: ReportCaster does not check to see if a server is running before sending a job to the server. The Reporting Server Cluster Manager feature will route jobs to a running server. You can use this feature by defining the node using odin.cfg. For more information, see the following definition for URL.

URL

Required.

The default is

jdbc:eda
{host}:{port};
server=;

Used internally to establish the JDBC connection to the Reporting Server for the execution of report procedures (FEX).

The default URL value enables ReportCaster to use the default service. If you want to use a service other than the default, then:

• Create a service using the Reporting Server Web Console.
• Append CLASS=CLIENT(servicename) to control the URL value, where servicename is the non-default service name. For example, for ReportCaster to use a service named rcaster, set the URL value to:

  jdbc:eda:\\{host}:{port};server=;
  CLASS=CLIENT(rcaster)

  Optionally, you can set ENCRYPTION=1 to encrypt the communications link between the Distribution Server and the Reporting Server using the Data Encryption Standard (DES). For example,

  jdbc:eda:\\localhost:12470;server=;
  ENCRYPTION=1

  To connect to a CLM node, specify an odin.cfg file instead of the host and port on the JDBC URL. For example:

  jdbc:eda:\\cfg=c:\ibi\
  WebFOCUS8\client\wf\
  etc\odin.cfg;server=nodename

Maximum Connection

Required.

The default connection is 3.

Maximum number of connections available to the Reporting Server. You can specify a maximum of 20 connections.

This setting works in conjunction with the optional Weight setting, enabling you to prioritize the alternate servers in a cluster queue.

Weight

Optional.

This setting may be from 10 (the highest) to 0 (the lowest). Default value is 4.

This setting is only available when you create alternate server(s) within a cluster. Used with the Maximum Connection setting.

This setting works in conjunction with the Maximum Connections setting, enabling you to prioritize the alternate servers in a cluster queue.

For example, if you have three servers (A, B, and C), you might want to use server A as the primary server. You would specify a higher weight (10 is the highest) and Maximum Connection (20 is the highest) setting for server A. If you want to use server B the least, you would specify the lowest weight of 1 and a Maximum Connection of 3.

Enabled

By default, this option is selected.

Selected. Indicates that the Report Library is configured for use with ReportCaster.

Not selected. Indicates that the Report Library is not configured for use with ReportCaster.

Library Distribution Options

Required.

Provide the ability to restrict the Access Options and/or Email for Library option that appear in ReportCaster when distributing scheduled output to the Report Library.

Default Library URL for Email Notification

Required.

Configured during the Distribution Server installation.

Default value is http://hostname: port/ibi_apps/ library/libreport.jsp (where hostname is the host name of the WebFOCUS web application. Specify the port only if it is not the default value of 8080).

URL included in the email notification that enables you to access specific content in the Report Library.

This is the Library URL value in the Distribution tab of the Basic Scheduling Tool and the Advanced Scheduling Tool when the distribution method is Library and the Send an Email after Report saved to Library option is selected.

Note: If this field is blank, then no report ID or burst values are sent with the e‑mail notification.

Use Default Library URL for Email Notification

Required.

Selected. The Distribution Server will always use the URL in the ReportCaster configuration file when sending notifications.

Not selected. The Distribution Server will not automatically use the URL in the ReportCaster configuration file when sending notifications. The URL value that is specified in the schedule is used.

Note: Javascript in the output of a URL task distributed to the Report Library may cause a script error when the report is opened from a Library notification email.

Send Report Id And Version With Notification Email

Required.

Selected. Report ID and burst values are sent with the email notification of the distribution.

Not selected. Report ID and burst values are not sent with the email notification of the distribution.

Compression

By default, this option is not selected.

Selected. ReportCaster will compress files stored in the Report Library.

Not selected. ReportCaster will not compress files stored in the Report Library.

Watch List section

Email From

Optional.

Name of either the person, department, group, and so on, that is sending the Watch List email notification. This notification informs the recipient that a new version of a report procedure (FEX) on the Watch List has been sent to the library. The notification includes the report job description and a link to the report procedure (FEX).

Email Message

Optional.

Message in the body of the Watch List notification email.

Email Reply Address

Optional.

Email address that will receive any reply responses from the Watch List notification email.

Email Subject

Optional.

Text that will appear in the Watch List notification email subject line.

Notify Mode

Optional.

The default value is Watch email only.

If the report schedule is set to send an email notification when the report procedure (FEX) is saved to the library and the report procedure (FEX) is subscribed to the Watch List, then:

• Watch List Notification Only. You will only receive the Watch List notification email.
• Watch List and Schedule Notification. You will receive both the schedule library notification email and the Watch List notification email.

Enabled

By default, this option is not selected.

Enables and disables the repository connection to the search engine.

Collection Name

Default value is report_library.

The search collection to be associated with Report Library content. This setting must match a Collection Name in the search engine.

Feed Data Source Name

Default value is ReportLibrary.

Source name for Report Library feed for the search engine.

Feeder Gate Server URL

Default value is http://{host}:{port}/ {context}/xmlfeed.

URL to feed the search engine.

The URL format is:

http://{host}:{port}/{context}/xmlfeed

Front-end Style sheet Name

Default value is reportlibrary_frontend.

Stylesheet used by the search engine.

Search URL

Default value is http://{host}:{port}/ {context}/search.

URL of search engine.

The URL format is:

http://{host}:{port}/{context}/search