Reference: |
The WebFOCUS Administration Console is used to invoke the ReportCaster API to configure ReportCaster, create the ReportCaster repository, restart the Distribution Server, configure ReportCaster environment parameters, and turn ReportCaster traces on and off. The WebFOCUS Administration Console authenticates to ReportCaster with the value of the user ID IBIMR_RC_SVCUSER. If authentication fails, users are prompted for their credentials.
ReportCaster functionality is grouped into the Repository, Configuration, Utilities, and Traces categories in the ReportCaster menu of the WebFOCUS Administration Console and is described in the following topics.
The WebFOCUS Administration Console settings available in the Repository area of the ReportCaster menu are described in this topic. For more information, see the ReportCaster Administration manual.
Selecting Connection in the Repository area of the ReportCaster menu provides access to a panel with the following settings:
Path and name of the Java class to connect to the relational database.
Used internally to establish the JDBC connection to the database server.
Database user ID used by the JDBC driver to connect to the ReportCaster Repository.
Password for the database user ID used by the JDBC driver to connect to the ReportCaster Repository.
Selecting Test Repository in the Repository area of the ReportCaster menu provides access to a panel with the following information:
Tests the connection between the Distribution Server and the ReportCaster Repository using the Repository connection values (Class Name, URL, Server User, Server Password) and indicates the status of this test.
Selecting Create All Tables in the Repository area of the ReportCaster menu generates a confirmation dialog box.
Note: Before creating all tables, make sure you have defined the Repository connection settings in the Connection area and tested the connection in the Test Repository area.
Selecting Drop/Create All Tables in the Repository area of the ReportCaster menu generates a confirmation dialog box.
Note: Before dropping and creating all tables, make sure you have defined the Repository connection settings in the Connection area and tested the connection in the Test Repository area.
The WebFOCUS Administration Console settings available in the Configuration area of the ReportCaster menu are described in this topic. For more information, see Configuring ReportCaster in the ReportCaster Administration manual.
The following settings are accessed by selecting Configuration in the ReportCaster menu.
The default value for the From field in a schedule using e-mail distribution. This can be any value.
The default value for the Reply Address field in a schedule using e-mail distribution.
Specifies whether to send notification of the schedule status to a specified e-mail address. Possible values are:
Never - This is the default value. ReportCaster does not send notification of the schedule status under any circumstance.
Always - The specified user is always notified when the schedule runs.
On Error - The specified users are notified when errors are encountered while running the schedule. We recommend using the On Error notification option.
The name of the default mail server used for a schedule using e-mail distribution.
You can also specify a port for the 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.
The name of the mail server that handles notification e-mail. If left blank, the mail server specified in the Mail Host setting is used as the notification mail server.
You can also specify a port for the Notify 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.
Tip: We recommend using different mail servers for notification and e-mail distribution in case there is a problem with the default mail server (notification e-mails are still sent). Having separate mail servers ensures you are informed if the default mail server falters.
The user ID for Simple Mail Transfer Protocol (SMTP) authentication.
The password associated with the SMTP user ID for SMTP authentication.
Specifies the application server and WebFOCUS context root used to zip the file components that comprise an EXCEL® 2007 file (.xlsx) file.
The code page of the platform, where the ReportCaster Distribution Server is running, is passed to the WebFOCUS Reporting Server to enable its communication back to the ReportCaster Distribution Server. Used for National Language Support (NLS).
Configures the WebFOCUS Servlet WFTRANSINOUT plug-in. This is a custom-written program that, when configured, is called by the ReportCaster Distribution Server as the last step prior to sending each request to the Reporting Server and again as the first step when receiving output from the Reporting Server.
In the WFTransInOut field, type the fully qualified name of the package and class that implements the WFTransInOut interface.
To configure the exit jar file and classpath:
Note: For more information about WFTRANSINOUT, see Developing Your Own WebFOCUS Plug-in.
Code page of the platform where the Web server is installed.
Automatically purges individual log reports when they are older than a set number of days. The default value is 30.
Time at which log purging occurs. The default value is 1:00 A.M.
Controls how many simultaneous connections (threads) the ReportCaster Distribution Server can utilize to process scheduled jobs.
Polling interval (in minutes) for the ReportCaster Distribution Server to check for scheduled jobs. The default value is 1 minute.
Recovers scheduled jobs. Possible values are:
ON - During startup, the ReportCaster Distribution Server recovers scheduled jobs that were processed but not completed.
OFF - This is the default value. During startup, the ReportCaster Distribution Server does not recover any scheduled jobs.
If the Distribution Server is unavailable for a period of time, any jobs scheduled during that period are not run. By default, when the Distribution Server is restarted, it searches for and runs all jobs with a next run time that is less than the current time, then resets the next run time according to the next scheduled run time of the job. The Scan Back value and Scan Back Type settings allow you to control the period of time the Distribution Server will look for jobs and whether or not it will run them.
The Scan Back value is an integer value that represents the number of 24 hour periods, beginning when the Distribution Server is restarted, that the Distribution Server scans back to look for, and run, jobs that have not yet run. The maximum integer value for Scan Back is 365. The default value is 15 (periods of 24 hours).
Possible Scan Back Type values are:
ON - This is the default value. Turns on Scan Back functionality. The Distribution Server searches for all jobs with a next run time that is less than the current time, runs only those jobs found within the time period set in the Scan Back setting, and resets the next run time of all of the jobs initially found.
OFF - Turns off Scan Back functionality, which results in the Distribution Server following its default behavior to locate, run, and reset all jobs with a next run time that is less than the current time.
RESET_NEXTRUNTIME - Searches for all jobs with a next run time less than the current time and resets the next run time to the next scheduled run time of the job. A Scan Back value of zero defaults to this Scan Back Type.
Enables ReportCaster administrators to specify an encoding other than the default encoding of the ReportCaster Distribution Server platform. It must match the encoding used by WinZip or any other Zip utility installed on the ReportCaster Distribution Server.
The WebFOCUS Administration Console settings available in the Utilities area of the ReportCaster menu are described in this topic. For more information, see the ReportCaster Administration manual.
Selecting ReportCaster Status in the Utilities area of the ReportCaster menu provides access to a panel with the following information:
Indicates the status of the ReportCaster Distribution Server. Possible status modes include:
Not Started - Distribution Server has not been started.
Started in Console Mode - Distribution Server requires additional configuration.
Full Function Mode - Distribution Server is up and ready for use.
Selecting Restart ReportCaster in the Utilities area of the ReportCaster menu provides access to a panel with the following information:
Restarts the Distribution Server and the ReportCaster application, and indicates the status of this restart. Use this to implement changes made to the ReportCaster configuration settings.
Administrators can configure the type of ReportCaster user interface and scheduling tool interface that displays for all users.
The selections are:
Displays the new HTML version of the ReportCaster End User Interface.
Displays the Java Applet version of the ReportCaster End User Interface.
The selections are:
Displays the standard version of the new HTML ReportCaster Scheduling tool interface.
Displays a version of the ReportCasterScheduling tool interface based on a template that you customize for your specific scheduling options.
The WebFOCUS Administration Console settings available in the Traces area of the ReportCaster menu are described in this topic. For more information, see ReportCaster Tracing in the ReportCaster Administration manual.
The following settings are accessed by selecting Traces in the ReportCaster menu.
Determines whether servlet tracing statements are being written or not. Possible values are:
ON - Enables tracing for all servlets executed by ReportCaster, including the ReportCaster API. Servlet tracing provides information about queries to, and maintenance of, the ReportCaster Repository. This includes events that occur during the scheduling of a job.
OFF - This is the default value. Disables servlet tracing and ignores the Servlet Trace File value.
When servlet tracing is enabled, you can specify the path and file name on the Web server where the servlet tracing statements will be written. You must type the fully qualified path of a location accessible on the Application Server/Servlet Engine. There is no default value, and a specified value is ignored if the Servlet Trace Flag setting is OFF.
Enables schedule tracing. Possible values are:
OFF - This is the default value. Disables schedule tracing. When set to OFF, the files and folders in the ReportCaster Distribution Server /temp directory, and the Schedule trace files J*.* in the /trc directory, are deleted when the ReportCaster Distribution Server is started up. Therefore, if you want to keep any of these files you must either back them up or make sure that Schedule Trace is set to either SCHEDULE or SCHEDULE_REPORT.
SCHEDULE - Enables schedule tracing.
SCHEDULE_REPORT - Enables schedule tracing and report tracing.
When Schedule Trace is set to SCHEDULE or SCHEDULE_REPORT, ReportCaster produces trace files containing ReportCaster Distribution Server information related to the specific jobs being run. Each job creates the following trace files in the /ibi/WebFOCUS/ReportCaster/trc/ directory, each with a unique Job Process ID (Jobid):
Additionally, when schedule tracing is enabled, the following core ReportCaster Distribution Server trace files are created in the /ibi/WebFOCUS/ReportCaster/trc/ directory. When a new instance of the ReportCaster Distribution Server starts, these trace files replace the previous trace files:
| WebFOCUS |