In this section: |
|
The Configuration tool enables administrators to view and manage the configuration of the Distribution Server, Servlet (deployed in WebFOCUS web application) interfaces and tools. Options that administrators can modify include Distribution Servers, Repository Settings, General Preferences, Email Settings, and other options, as shown in the following image.
Along the top of the Configuration tab, a series of toolbar icons enable you to perform the following tasks.
Note: The icons that are available for selection vary depending on the configuration folder you are using.
The Configuration tab provides access to configuration settings through the following folders:
To implement changes to the ReportCaster server configuration settings, you must save the changes, and then restart the Distribution Server and the ReportCaster web application. Use the following steps to save any configuration changes.
A window opens, asking you to confirm the save.
A window opens, explaining that you must restart the Distribution Server and the ReportCaster web application in order for the changes that you saved to take effect, and that a Restart button is available in the Configuration toolbar.
A window opens, asking you to confirm that you want to stop all running jobs and restart.
A window opens with a message that the server has been restarted.
Note: If failover or workload distribution is configured, all Distribution Servers are started.
Several of the Configuration tab folders provide the option to change the default user ID or password. To change default user ID settings, click the icon that appears to the right of the setting field. This opens the User dialog box, where you can type a new user ID and password. When your changes are complete, click OK to exit the User dialog box. Remember to save your changes and restart the Distribution Server to implement any changes.
In this section: How to: |
The Distribution Servers folder, shown in the following image, contains the settings that define and configure the 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. The Server Status option, located on the ribbon, provides the ability to restart the Distribution Server, suspend distribution, stop distribution, switch servers, and refresh data. For more information, see Server Status and Configuring ReportCaster Failover and Workload Distribution.
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. |
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. |
Use repository to synchronize Primary and Failover servers |
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:
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:
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. |
Setting |
Optional or Required/Default Value |
Descriptions and Possible Values |
---|---|---|
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:
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. |
Your program will be called at the start and end of each schedule to perform the customized actions it has been designed to do. For more information, refer to the ibi.broker.scheduler.plugin package found in the Java documentation.
The Distribution Server Failover feature allows you to configure a secondary Distribution Server that can resume ReportCaster operations when there is an interruption (planned or unplanned) in the primary Distribution Server service. The primary Distribution Server is monitored to verify it is operational. If there is an interruption in service, the failover Distribution Server is triggered to take over the role of the primary server.
The Workload Distribution feature allows ReportCaster to distribute scheduled jobs across multiple Distribution Servers, providing an efficient and fast way to process large numbers of schedules. Multiple Distribution Servers can be installed on one or more hosts. One instance is designated as the Workload Manager, while the other are designated as Workers. The WebFOCUS Repository will be shared by the Workload Manager and the Workers. Workload Distribution is set up through the ReportCaster Configuration tool. All servers will share one set of configuration information, and the Workload Manager will push any configuration changes to the Workers.
For your application of ReportCaster, you can configure either or both Failover and Workload Distribution. The following procedure includes instructions to configure both, but notes when to skip to the appropriate steps if you are only configuring one or the other.
To configure distribution server failover:
The Secondary Distribution Server dialog box opens, as shown in the following image.
The Workload Distribution dialog box opens, as shown in the following image.
Repeat this step for each Worker Distribution Server instance that you want to add.
The Repository Settings folder in the Configuration tab, as shown in the following image, contains the settings that specify how ReportCaster should maintain the database connection during the processing of a scheduled job.
The Repository Settings folder contains the following configuration settings.
Setting |
Optional or Required/Default Value |
Descriptions and Possible Values |
---|---|---|
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. |
In this section: |
The General Preferences folder in the Configuration tab, as shown in the following image, contains settings that determine which schedule tasks, distribution formats, and methods will be available to a user.
The General Preferences folder contains the following configuration settings.
Setting |
Optional or Required/Default Value |
Descriptions and Possible Values |
---|---|---|
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. |
The Schedule Tasks setting in the General Preferences folder enables authorized users to specify what Task Types are available to users and groups.
By default, all Task Types are enabled (selected). The WebFOCUS Report option only appears if the WebFOCUS Portal (Managed Reporting) optional product has been installed. A minimum of one Task Type must be selected.
Note:
The ReportCaster - Schedule Tasks dialog box opens, as shown in the following image.
The changes are saved and the Schedule Tasks dialog box closes.
The Distribution Formats setting in the General Preferences folder enables users to specify what report and graph formats are available to users and groups.
These settings only apply to WF Server Procedures and WebFOCUS (Managed Reporting) procedures. By default, all report and graph formats are enabled (selected). A minimum of one report or graph format must be selected.
Note: If a Format is deselected after a schedule using that Format has been created, the schedule will fail when it is run. A message in the log will indicate how to fix the problem.
The ReportCaster - Report/Graph Formats dialog box opens, as shown in the following image.
By default, Styled Formats are displayed with each format type selected.
Select or clear the check box for the following specialized formats.
Select or clear the check box for the following unstyled formats.
Select or clear the check box for the following graph image formats.
The changes are saved and the Report/Graph Formats dialog box closes.
The Distribution Methods setting in the General Preferences folder enables authorized users to specify what distribution methods are available to users and groups. If a Method is deselected after a schedule using that Method has been created and the Only run schedules for selected Distribution Method is selected, the schedule processing will not run the schedules tasks. A message in the log will indicate the distribution method is not configured for use.
By default, all distribution methods are enabled (selected).
Note: A minimum of one distribution method must be selected.
The Managed Reporting and Library options only appear if these products are enabled. Managed Reporting is an optional product component that is installed with the WebFOCUS Client.
The ReportCaster - Schedule Distribution Methods dialog box opens, as shown in the following image.
Note: At least one schedule distribution method must be selected.
The changes are saved and the Schedule Distribution Methods dialog box closes.
How to: |
The Email Settings folder in the Configuration tab contains default email settings, default notification settings, email retry options, and email security. The Email Settings window is shown in the following image.
The Email Settings folder contains the following configuration settings.
Setting |
Optional or Required/Default Value |
Descriptions and Possible Values |
---|---|---|
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:
|
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:
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. |
Note: In WebFOCUS 8, the functionality provided by the default implementation of the SMTP Security Plug-in can be accomplished within a schedule using the Email Server options in the scheduling tool.
ibi.broker.scheduler.plugin.DefaultSMTPSecurityExit
HOSTNAME, AUTHORIZATION REQUIRED(Y,N),USERNAME,PASSWORD,SSL(Y,N),TLS(Y,N)
If the mail server (hostname) is found in the smtp_security_exit.txt file and the authorization required flag is Y, the user and password in the file will be used to authenticate the mail server. If the SSL flag is Y, then SSL will be used. If the TLS flag is Y, TLS will be used.
How to: |
The FTP Settings folder in the Configuration tab, shown in the following image, contains the settings that define the default FTP server that ReportCaster will use for FTP distributions.
The following table lists and describes the configuration settings that are available in the FTP Settings folder.
Setting |
Optional or Required/Default Value |
Descriptions and Possible Values |
---|---|---|
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. |
You can optionally supply values for the Default FTP Host, Default FTP Location, and Default User fields. These values are defaults for the schedule, as they are used at schedule creation time.
Note: Once stored, these values are used when you create a schedule. They are constant, unless you override them at the time you create a schedule.
ibi.broker.scheduler.plugin.DefaultSFTPSecurityExit
If the default SFTP Plug-in is in use, then for any schedule distributing by SFTP, the Distribution Server will attempt to authenticate to the SFTP Server using the private key found in the sftp_private_key.txt file.
In this section: How to: |
The Zip Settings folder in the Configuration tab, as shown in the following image, contains settings for adding an extension to a distributed Zip file, the Zip encryption to use for distribution, and defining a Zip encryption password plug-in.
The Zip Settings folder contains the following configuration settings.
Setting |
Optional or Required/Default Value |
Descriptions and Possible Values |
---|---|---|
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:
|
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. |
The default plug-in provided with ReportCaster enables the encryption password to be associated with the Managed Reporting Domain where the scheduled procedure (FEX) resides. Therefore, the default plug-in can only be used to password protect reports created by a procedure (FEX) stored in the WebFOCUS repository Content folder path. For information on customizing a Zip Encryption Protection Plug-in, see How to Configure the Default Zip Encryption Password Plug-in.
The plug-in delivers the password to the Distribution Server at schedule execution time, where the output is then encrypted and zipped. To use the default plug-in, choose Default for the Zip Encryption Password Plug-in setting. The default plug-in references the password file, zipencrypt.txt, for the domain and password. During installation, an empty version of this file is included in the ibi/ReportCaster/cfg directory.
The password statement in this file must be in the following format:
Domain, IBFSpath, password, $
where:
Is the full path (for example, IBFS:/WFC/Repository/mthsales) to the location of the domain within the WebFOCUS Repository.
Is the password to open content from the associated domain.
Note: The ReportCaster log will indicate that encryption was used.
The guidelines for using the default plug-in are:
Note: Since a Managed Reporting Domain is required to use the Zip Encryption Password Plug-in, attempting to enter a task other than a Managed Reporting report will result in a failure to distribute the output of that task. If the zipencrypt.txt file contains an entry with the Managed Reporting Domain, but no password, then the output is not encrypted and will be zipped or not zipped according to the Zip option selected in the schedule when it was created. If both the Managed Reporting Domain and a password are in the password file, then the output is zipped regardless of the Zip option.
To edit the zipencrypt.txt password file:
The default implementation requires that Inline Email be disabled. You will receive the following prompt when attempting to configure the default Zip Encryption Password Plug-in.
If you click OK, Inline Email is automatically disabled.
This file has the following structure:
Domain, domainhref, Password, $
where the first column is the word Domain, the second column identifies the folder containing the report to be scheduled, and the third column is the password.
Note: Only WebFOCUS procedures can be scheduled when this plug-in is configured. If a password is found, the output is encrypted. If a password is not found, the output is zipped but not encrypted.
The Other Schedule Defaults folder in the Configuration tab, as shown in the following image, contains settings for Schedule End Date and Schedule End Time.
Note: Depending on your time zone, the default Schedule End Date may be set to Jan 1, 2100.
The following table lists and describes the configuration settings available in the Other Schedule Defaults folder.
Setting |
Optional or Required/Default Value |
Descriptions and Possible Values |
---|---|---|
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. |
The Log Settings folder in the Configuration tab, as shown in the following image, contains settings for purging log files, log purge periods, and log purge times.
The Log Settings folder contains the following configuration settings.
Setting |
Optional or Required/Default Value |
Descriptions and Possible Values |
---|---|---|
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. |
The Traces folder in the Configuration tab, shown in the following image, contains settings for the Distribution Server traces.
The Traces folder contains the following configuration settings.
Setting |
Optional or Required/Default Value |
Descriptions and Possible Values |
---|---|---|
Schedule Job Traces |
The default value is Off. |
Enables Distribution Server Traces.
|
The Code Page folder in the Configuration tab, as shown in the following image, contains settings for code pages.
The Code Page folder contains the following configuration settings.
Setting |
Optional or Required/Default Value |
Descriptions and Possible Values |
---|---|---|
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. |
ReportCaster can be configured to retrieve email address information from an LDAP data source. The leading mail server software vendors use LDAP for storage of email information. This includes Active Directory on Windows platforms.
The LDAP folder in the Configuration tab, as shown in the following image, contains settings to define LDAP server connection and security, as well as LDAP email settings.
The LDAP Settings folder contains the following configuration settings.
Setting |
Optional or Required/Default Value |
Descriptions and Possible Values |
---|---|---|
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. |
In this section: |
The Data Servers folder in the Configuration tab, as shown in the following image, contains settings to configure the Reporting Server(s) associated with ReportCaster. Using the configuration settings in this folder, you can also configure multiple Reporting Servers with ReportCaster and set up a cluster environment. Instructions for multiple and cluster servers appear later in this section.
The following image shows the display in the right panel when the Data Servers folder is selected. Initially, the default data server appears in this panel with information, such as the data server name, URL (used to connect to the Reporting Server), the type of server, whether or not it is the default server, and what security type it is using. When you add a data server that ReportCaster can access, it will appear in this list.
The following image shows the configuration settings when you select a specific data server under the Data Servers folder, in this example, EDASERVE.
The Data Servers folder contains the following configuration settings.
Setting |
Optional or Required/Default Value |
Descriptions and Possible Values |
---|---|---|
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:
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:
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:
|
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. |
You can configure multiple Reporting Servers with ReportCaster through the Data Server folder in the ReportCaster Configuration tab. Although the installation program automatically populates values for the default EDASERVE server, all additional Reporting Servers must be added to the configuration manually.
Note: If the default Reporting Server is changed on the Client, then the change will not be effective until the period specified by the IBFS Cache Cleaner service or until the Distribution Server is restarted. If the Distribution Server is installed on another machine with a separate copy of the Client, then a change to the default Reporting Server will not be effective until the same change is made on the Client installed on the same machine as the Distribution Server.
Note: The default Data Server names are SERVER, SERVER 2, SERVER 3, and so on.
The right panel displays the default properties for the selected server, as shown in the following image.
In the Name field, specify the name of the server you want to add to the ReportCaster configuration file. This name must match the NODE setting for that server specified in the WebFOCUS Client configuration file. For more information, see the WebFOCUS Security and Administration manual.
To set the Data Server URL, Maximum Connection, and Weight, double-click the template in the appropriate field and either type a value or select a value from the spin box.
Caution: Information Builders recommends that you avoid changing the name of a Reporting Server, since all existing jobs on that server will no longer run.
In this section: |
The Report Library folder in the Configuration tab, shown in the following image, contains settings for Library distribution and Watch List options.
The Report Library folder contains the following configuration settings. In addition, the Report Library version expiration processing occurs one hour after the time specified by the Log Purge Time setting located in the settings folder.
Setting |
Optional or Required/Default Value |
Descriptions and Possible Values |
---|---|---|
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 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:
|
The Library Distribution Options enable you to select the Library Access options and Email for Library options available to users in the Basic Scheduling tool and Advanced Scheduling tool when distributing scheduled output to the Report Library.
The following image shows the default settings for the ReportCaster Library Distribution Options.
The Library Distribution Options dialog box opens, as shown in the following image. By default, all options are selected.
Library Access. Designates the options that appear in the Access Type drop-down menu in the Basic Scheduling tool. Available options are:
Note: An authorized user can change the Shared or Published status of a Library item from the right-click menu of the item in the repository tree. If a Library item is originally created with a status of Private and is subsequently changed to Shared or Published from the repository tree, the Access Option Private in the schedule will not be applied at schedule execution time. This only occurs in cases where the schedule that creates subsequent versions of the Library report is not changed to reflect this updated status. The Library item will retain the updated Shared or Published status and a warning message will be displayed in the schedule log indicating this fact.
Library Email. Designates who has access to the email notification option, Send an Email after report procedure (FEX) saved to Library, in the Basic Scheduling tool. Available options are:
Note: The Library Email option is available only when the corresponding Library Access option is selected.
Library Search is not available in WebFOCUS Release 8.0 Version 01 or earlier WebFOCUS 8 releases. It will be available in a future WebFOCUS 8 release. The Library Search folder in the Configuration tab, shown in the following image, contains settings for defining the search engine and properties to search the Report Library content.
The Library Search folder contains the following configuration settings.
Setting |
Optional or Required/Default Value |
Descriptions and Possible Values |
---|---|---|
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 |
WebFOCUS |