Oracle report server configuration file 10g




















Input requests to your system varies from 6 reports per minute to 12 reports per minute. In this scenario, the calculations are as follows:. This ensures that whenever a job arrives, it gets an idle engine immediately. In scalability and performance tests, maximum throughput is seen when maxEngine is configured using the guideline of engines multiplied by the number of CPUs.

For more information, refer to Section 8. Given that, maxQueueSize should be set to accommodate all the jobs for 4 hours. Thus, at a rate of 10 jobs per minute:. The value of cacheSize also should be set sufficiently high to accommodate jobs. Suppose the average size of each report is K:. You can use similar logic to calculate the value of the cache element's maxCacheFileNumber property.

The cache key is used by Reports Server to determine if an incoming job request matches existing output in the cache.

You must have at least one engine element in your configuration file, and you can have more than one. The engine element identifies the fully qualified Java class that starts an engine and provides a number of attributes that set operational controls on the engine.

As an example of a custom engine, you may have developed an engine to execute an operating system command should an event occur in your database. A keyword, unique within a given configuration XML file that identifies a particular engine element.

This can be a text string or a number, for example:. A fully qualified Java class that implements two interfaces: oracle. Engine and oracle. The directory path to the Java class specified in the class attribute.

To specify the directory, use the conventions required by the server platform, for example:. The number of jobs the engine can run before the engine is terminated, and, if necessary, a new engine is started. This feature is available to thwart memory leaks.

The number of minutes of allowable idle time before the engine is shut down However, the current number of engines should be higher than minEngine.

For example, if minEngine is 0, maxIdle is 30, and one engine has been running but unused for 30 minutes, that engine will shut down. If, under the same conditions, minEngine is 1, the active engine will not shut down, even if it has been idle for 30 minutes.

The number of milliseconds of allowable waiting time between when the server launches an engine and the engine calls the server back. If the machine that hosts the server is very fast, you can reduce this number for faster performance. Optional attribute The default environment within which Reports Server starts an engine. The attribute takes an id associated with an environment element in the server configuration file.

If you specify defaultEnvId , Reports Server starts an engine with the environment variables specified in the referenced environment element plus whatever environment variables that Reports Server is running under. If you do not specify defaultEnvId , Reports Server spawns engines with the environment settings in force at startup time. For more information, refer to Section 3. The maximum amount of time in minutes for an engine to update the status of the job while running a report in your environment.

If it takes longer than this amount of time to update the job status for some reason for example, due to the engine hanging or a long blocking SQL query , Reports Server terminates the job. For example, you can use this attribute to specify the starting heap size and maximum heap size for the JVM, additional classpath entries, and so on. For more information, see Section B. The keepConnection property is used by the default runtime engine implementation; that is, oracle.

YES The default runtime engine retains the existing database connection information. NO The default runtime engine discards the existing database connection information and reconnects with the userid specified for the job. The keepConnection property does not affect reports deployed using either rwbuilder or rwrun. You can also optionally enter multiple properties under the engine element.

The sourceDir property identifies the default directory you will use for report definition files. The tempDir property identifies the name and location of the temporary directory OracleAS Reports Services will use for its temporary files. The classPath attribute is not specified because this configuration uses the default engine class. Including this property in your engine configuration element enables you to diagnose whether or not a specific function in a report run completed successfully. The diagnostic log provides information on important checkpoints or tasks in the engine during a report run.

This information is useful in cases where the engine stops responding, resulting in "hanging" jobs.

To turn on the engine diagnosis option, your engine configuration element might look like this:. When the diagnosis property is set to yes , the engine creates separate diagnostic files from the Reports Server and engine trace files. Diagnostic files are in the same location as the trace files see Section Every rwEng engine creates two diagnostic files per instance that is, per engine lifetime.

Each diagnostic log is a new file, with the timestamp included in the file name. Diagnostic files are not appended to or replaced for different instances of the same engine. The engine diagnosis option provides more detailed information than report tracing, which is typically used to debug the execution of a report to provide information such as the file currently formatting, or report trigger currently running.

If you do not enter a security element in the configuration file, Reports Server is not secure. You can have from zero to multiple security elements in your configuration file. The security element identifies the fully qualified Java class that controls server access. A keyword, unique within a given configuration XML file that identifies a particular security element. You can associate multiple properties with the security element. For example, if you use the default security Java class that is provided with OracleAS Reports Services, your security configuration entry might look like the example provided above.

The value of oidEntity is set by the Installer upon installation. Reports Server uses this entity to connect to the Oracle Internet Directory. Components of the Oracle Application Server can all connect to the Oracle Internet Directory, but each component may have different privileges in the directory.

Hence, each component needs to identify itself through its own entity name to the Oracle Internet Directory when it connects. The commented out property, securityUserid , illustrates the old method of specifying security. The property attributes confidential and encrypted are available for encrypting the information within the property. When you next open the configuration file, the password information will be scrambled, and encrypted will be set to yes.

If you forget the password you entered in the configuration file, you can delete the property and reenter it with new values, making sure to set encrypted to no. The oidconnection element attributes are described in Table If you do not enter a destination element in the server configuration file, the provided destination classes will be used printer, e-mail, file, cache, and OracleAS Portal—which is an exception in that it requires an entry in the server configuration file so that you may specify the userid and password the server will use to log in to the portal.

You can have from zero to multiple destination elements in your server configuration file. Use the destination element to register destination types with the server. There is no need to register default destinations. OracleAS Portal: The entry for this destination is created by default in the server configuration file, but it is commented out. To start using this destination, you must uncomment the destination entry, and also provide appropriate property values for example, the value for the portalUserid property.

Thus, they are configured and available by default. The destination element attributes are described in Table Allowable values include:. You also have the option of entering multiple properties under the destination element. The confidential and encrypted attributes are included to automatically invoke encryption on the portalUserid value the next time Reports Server is started. Should your destination implementation require additional information, specify the information in the pluginParam element.

Oracle Reports will use the Reports Server discovery mechanism specified in this file. By default, Oracle Reports uses the rwnetwork. Uncomment this element to specify a custom network configuration file.

This element specifies the network configuration file that will be used for Reports Server discovery. If naming service is enabled, then the Reports Server will register itself to the naming service.

Oracle Reports clients will then contact the naming service to get the Reports Server reference. The namingService element attribute is described in Section 3. The job element works in collaboration with the engine and security elements. Use job to identify a job type and specify which engine and which security implementation should be used with that type of job.

For example, you may have developed an engine to execute an operating system command should an event occur in your database. When the event occurs, the job type information is sent to Reports Server, which looks up the job type under the job element in its configuration file, and follows the direction provided in the element's attributes to the engine and, if applicable, security implementation specified for that type of job.

Describes the type of job to be processed by the server. You can enter any type of job, as long as Reports Server has an engine to process it. References the ID entered for the engine that will process this job type. Available IDs are specified under the engine element in the server configuration file using the id attribute. The id is a unique keyword that you devise within a given configuration XML file that identifies a particular engine. References the ID entered for the security mechanism that will be applied to this job type.

Available IDs are specified under the security element in the server configuration file. If you do not enter a notification element in the configuration file, the notification function is disabled. You can have from zero to multiple notification elements in your configuration file. Use the notification element to specify a Java class that defines the type of notification that should be sent when a job succeeds or fails.

You can use the default notification class, which provides for notification through e-mail, or design your own with the Oracle Reports Notification API. The notification element attributes are described in Table A keyword, unique within a given configuration XML file, that identifies a particular notification element.

If you use the default email notification implementation, use the pluginParam element to specify the outgoing SMTP mail server to be used to send the mail. Use the runtime commands notifysuccess and notifyfailure to specify the email address where notification should be sent for more information, see Appendix A, "Command Line Keywords". For example, you can include these commands in your runtime URL:. With the default e-mail implementation, you can specify only one address for each type of notification.

You can specify one or both types of notification. You can send notification each to the same address or each to a different addresses. Some mail servers may validate the sender's domain name.

If the notification fails because of this domain name validation, then you must add the following property as part of the notification element:. Otherwise, enter the directory path along with the filenames according to the requirements of the platform that hosts the server. You can have a maximum of one log element in your server configuration file.

The log element is available for backward compatibility. It invokes the generation and population of a reports log file. The log file is automatically generated and stored in the following path the path is the same for Windows and UNIX :. Describes the type of jobs that need to be logged. This is in addition to the default server activities that are logged.

Choose from the following options:. You can have a maximum of one jobStatusRepository element in your server configuration file. The jobStatusRepository element specifies the Java class that implements a job status repository.

It provides an additional means over the persistFile element of storing job status information. The persistFile is a binary file and, therefore, cannot be used to publish job status information within your application. The jobStatusRepository provides a means of including status information in your application by providing additional ways of storing it. The default class, oracle. JobRepositoryDB , stores information in a database.

JobRepository that stores information wherever you wish. The jobStatusRepository element attribute is described in Table The jobStatusRepository element allows for zero or multiple properties for passing options into the repository.

The jobStatusRepository element might look like this in your server configuration file:. In this example, the value for the repositoryConn property is the login for access to the database that stores the repository. The confidential and encrypted attributes are used to invoke encryption on the login information once Reports Server is restarted. You can have a maximum of one trace element in your server configuration file. Use the trace element to create a file for tracing your report's execution and to specify the objects and activities you want to trace.

The trace element controls tracing only for the server and the engine. Reports Server uses the rwlpr executable for submitting a print job. This log file will contain information regarding the messages that can be used to diagnose any printing issues, such as spooler problems. The filename of the trace file. If no path is specified, the trace file will be in the following directory on both Windows and UNIX:. This attribute defines the activities that will be traced.

You can have one or more traceOpts values. Separate values with a vertical bar. Valid values are listed and described in Table By default, tracing tracks both server and engine events. Tracing engine events can cause performance problems in some cases. Use traceModule to track only server events server , only engine events engine , or both all. The traceOpts element attributes are described in Table If you have specified a log element in your server configuration file, in addition to using the trace element, this value will cause information that is sent to the log file to also be sent to the trace file.

This is a catch-all option that dumps any information not covered by the other options into the trace file. Disables tracing, and generates only log files not trace files in the directory specified by traceFile. If you do not specify a connection element in your server configuration file, default values will be used see Table You can have a maximum of one connection element in your server configuration file.

The connection element defines the rules of engagement between the server and the clients connected to it. The connection element attributes are described in Table The maximum number of requests that the server can service simultaneously.

Requests in excess of the maxConnect value return a Java exception. In addition to its attributes, connection has a sub-element: orbClient. For information about Application Server-level techniques for high availability, refer to Section 1. Use orbClient to provide the name of the public key file that the client will use to connect to Reports Server. Reports Server uses the public key to verify the signature sent by the client when it tries to connect to Reports Server. Reports Server only accepts clients whose signature can be verified through this public key.

You can have from zero to multiple orbClient sub-elements in your server configuration file. The orbClient sub-element attributes are described in Table Identifies the public key file that the client will use to connect to Reports Server.

The default file is stored in the rwrun. OracleAS Reports Services provides default client public and private key files, clientpub. These key files are in place for all components of OracleAS Reports Services You can regenerate public and private key files to replace the default key pair.

To do this, at the command prompt use the following command:. To do this, you must unjar the file, place the regenerated private key into it, and rejar the file. If you want Reports Server to use predefined ports instead of random ports, you must include the ORBPorts element in the server configuration file. One port is needed for Reports Server and one for each engine. You cannot specify port numbers for individual engines. Each engine picks up the next port number in the list.

You can have a maximum of one queue element in your server configuration file. If you have no queue element, the default, , will remain in effect. Use the queue element to specify the maximum number of jobs that can be held in each of the reports queues.

OracleAS Reports Services has three queue components:. You may want to define the number of users who can connect and submit job requests simultaneously to rwservlet. For example, set this value to if you expect around concurrent active users. OracleAS Reports Services provides a template for server error messages.

These messages are generated automatically, according to cause. The template provides the visual setting within which the error message is displayed. You may wish to customize the appearance of error messages, for example with your company logo, or with an icon you plan to associate with errors. You may wish to add buttons that link your users to a help system, your company home page, or back to the last browser window.

You can do this by providing your own HTML framework for automatically generated error messages. It is not necessary to enter the path to the error message template when it is stored in the default template directory:. The character set of the error message template rwerror. In earlier releases, it was windows , which is a character set specific to the Windows platform. If you choose to run Reports Server within the same process as Reports Servlet rwservlet , you specify the following in rwservlet.

For troubleshooting printing and font issues when using the in-process server, see Section D. If a Reports Server name is not specified, for example, in the runtime URL, rwservlet starts the in-process server if not started already with the name specified by the SERVER parameter, and submits the job to it.

To specify Oracle Internet Directory connections for Reports Servlet, specify Oracle Internet Directory connection pooling parameters in the rwservlet. For Reports Server, you can specify Oracle Internet Directory connection pooling parameters using the oidconnection element in the server configuration file, as described in Section 3. It ensures that dynamically generated images, such as charts, will be viewable only by the person who runs the report.

JSPs, and other report types, that run through Reports Servlet have this protection automatically. Cookies save encrypted user names and passwords on the client-side when users first authenticate themselves. When the server receives a cookie from the client, the server compares the time saved in the cookie with the current system time.

Users must re-authenticate to run the report. The encryption key can be any character string. You can use these to include formatting options to make diagnostic and debugging output easier to read.

A HELP keyword is available with the rwservlet command for bringing up a servlet-related help topic. The help file is invoked when you specify the following URL:. You may want to supply a help file of your own. For more information, refer to Section By default, Reports Servlet uses the rwnetwork. In Oracle Reports 10 g Release 2 To resolve this issue, Oracle Reports 10 g Release 2 Using WEB.

In this case, the request is submitted to rwservlet. By default, Reports Servlet uses the rwservlet. If you are running multiple OC4J instances with reports installed on the same Oracle Application Server and wish to use different configuration files, you can do so by adding the following start parameter to opmn. Alternatively, you can edit the web.

Since Reports Server's destinations are pluggable, you can also add your own custom destinations for the URL content. For example, suppose you have created a JSP report for high fidelity Web publishing of data stored in a table containing employee expense data. Add an engine element for the URL engine to the server configuration file. For example, your engine element might be as follows:. Add a job element that associates the appropriate job types with the URL engine to the server configuration file.

For example, your job element might be as follows:. Some features of OracleAS Reports Services support retrieving or sending information through a firewall. For example, the URL engine, the XML data source, the Text data source, and the mail destination features all retrieve or send information through the firewall. For these features to function properly, Reports Server requires certain proxy information. In the interests of simplicity, you store the necessary proxy information in a single location and point to it from the Reports Server configuration file.

To configure your Reports Server with proxy information, you do the following:. Add the pluginParam element to the server configuration file and have it point to the proxy information file for example, proxyinfo.

For example, your pluginParam element might be as follows:. Update the proxy information file with the necessary proxy values for your configuration. For example, proxyinfo. OPMN provides a centralized mechanism for initializing, maintaining, and shutting down your Oracle Application Server components, including Reports Server. If you add any Reports Servers after installing Oracle Application Server, you should register the new server s in two places:.

To register a new Reports Server in both opmn. Components are configured with OPMN in the opmn. This section describes how to configure the following components through OPMN:. Oracle Application Server Administrator's Guide. The module tag is included by default in opmn. This module is loaded with the following information, by default, in opmn. In the case of the standalone Reports Server, the Reports Server is running in its own component. This tag specifies the name of Reports Server.

It must match the Reports Server internal name from targets. This tag defines the process characteristics for the named Reports Server. It indicates whether Reports Server should be restarted when it fails. It also specifies the number of Reports Servers started for this process set, which has to be 1 because the process-set id identifies a single Reports Server name.

The first tag specifies the value for the PATH environment variable for the process. This variable must be set for the start script to find uname. This environment element is not needed on the Microsoft Windows platform. This group of tags gathers together all of the data parameters common to the process.

If it is not configured, this option is not passed in to Reports Server. This group of tags indicates the restart parameters category, which defines parameters to be used in detecting whether the process has failed and needs to be restarted.

If a notification is not received within the specified reverseping-timeout period, then the process is considered failed and will be restarted. This tag delimits the list of components upon which Reports Server depends. OPMN uses dependencies to determine whether to start a process. Like module-data and environment blocks, dependencies blocks can be defined for multiple elements within opmn. OPMN creates an aggregate dependency list at the process set level that contains all of the dependencies defined at or above it.

If duplicate dependencies are defined at different levels, then duplicate checks on that dependency are made before starting a process. OPMN has two primary types of dependencies: external and internal. For external resources, an external program performs the check on the resource. Internal dependencies are indicated in the list by the managed-process tag.

OPMN maintains a cache of dependency states that contains the last known state of each dependency and the time it was last checked. A single cache entry exists for each dependency with identical attributes, even if that dependency is specified in multiple locations that is, for different process sets.

A cache timeout parameter for each dependency allows users to specify how long to use its state in the cache. Likewise, a general timeout parameter for each dependency determines how long OPMN should wait for a status update before aborting the dependency check and the process start.

Dependencies are checked in the order in which you declare them. The traversal of this list of dependencies concludes either when the full sequence of checks completes successfully the resource is available or when one of the checks fails the resource is not available or the check timed out. If you are using the in-process server, then within the OC4J component you must specify the Reports Server data. The protocol used for pinging is AJPv1.

The Oracle Reports bridge runs within its own component. Therefore, you must specify a separate ias-component tag for the Oracle Reports bridge to control the bridge through OPMN. The following are examples for a minimum bridge configuration as well as a full bridge configuration.

By default, Oracle Reports uses the built-in broadcast mechanism for Reports Server discovery. Alternatively, Oracle Reports clients can use the Common Object Service COS naming service for Reports Server discovery to submit report requests when the built-in broadcast mechanism is not suitable for your environment, as in the following scenarios:.

This port must be specified in your rwnetwork. If OPMN is up and running, to reload the changes made to the opmn. Modify the rwnetwork. To resolve this error, check whether the naming service process orbd is running. If not, start it. If the orbd process is running, check the port specified for namingService in the rwnetwork. It should be same as the port on which orbd is started. This is because OPMN does not check the dependency while stopping the process.

This is harmless, and can be ignored. Oracle Workflow delivers a complete business process management system that supports business process definition, business process automation, and business process integration.

The Oracle Workflow engine is part of the Oracle database. By integrating Oracle Workflow with Oracle Reports, you can include Oracle Reports execution as one of the activities in your business process. For example, as soon as a manager approves an expense report, Oracle Workflow generates a report.

Additionally, the report notifies the Oracle Workflow engine when the report execution is complete, triggering the next activity in the business process. This white paper explains how to install and configure Oracle Workflow and Oracle Reports to communicate with each other, and also provides the steps to include report-specific functions in your business process.

Specifically, it covers installing and configuring Oracle Reports and Oracle Workflow, defining an Oracle Workflow process for running a report, running a report from the Oracle Workflow process, and troubleshooting assistance. Before you deploy a report on a machine that is either slow or is running on a load, you may want to configure the following:.

The default timeout period is This period is calculated from: ping timeout , ping interval , and number of retries. The default values for these are:. Based on these values, there will be three ping attempts with a timeout of 30 seconds each at 20 second intervals. The first ping is done after the specified ping interval. You can configure the ping timeout by adding a ping entry with sufficient timeout configured to the machine's load in following element in opmn. You can also switch off the URL ping by removing or commenting out the following element in opmn.

When running on a loaded machine, an attempt to start all Reports Servers by OPMN may result in a start timeout for some Reports Servers as some of them were not able to finish the start up activities completely. Starting up these engine processes might take some time in loaded machines. Callback timeout Reports Server-side : Callback timeout is the measure that Reports Server uses to determine the time that it must wait for a response from the engine before timing out.

This time out period is in milliseconds. Prior to Oracle Reports 10 g Release 1 9. This dependency is removed with Oracle Reports 10 g. Additionally, earlier releases required a valid printer on UNIX for fonts. Now, OracleAS Reports Services includes a default screen printer surface, ScreenPrinter, that emulates a screen or printer for fonts in the absence of an available printer. The PostScript printer driver screenprinter. This driver is the first entry in uiscreenprint.

The file locations UNIX only are:. You can modify the Fonts section of screenprinter. The quality of images contributes considerably to the overall appearance of a report, particularly for a Web report.

You may prefer different image formats in your report output depending on the needs of your project. On the other hand, if you are building a Web portal, you might prefer GIF images because of their smaller size and faster download.

Similarly, you may wish to import images of these various formats into your report. Depending on the format of your output, you may choose from a variety of formats for your images. Enabling advanced imaging also enables you to import images of these same formats into your report. This limitation does not apply on the Windows platform. This conversion increases the file size. This is consistent with the RTF specification and is expected behavior.

Skip Headers. For more information, see Section 3. All rights reserved. Description The server element opens and closes the content area of the server configuration file.

When the compatible element is set, Oracle Reports 6 i client requests will still be forwarded to the Reports Server in 10 g Release 2 However, this is not a supported configuration, and Oracle will not fix bugs that result from this configuration. Note: The tnsnames. Description The cache element is available for specifying the Java class that defines the server's cache implementation. RWCache A fully qualified Java class that implements the oracle.

Description The engine element identifies the fully qualified Java class that starts an engine and provides a number of attributes that set operational controls on the engine. Table Attributes of the engine Element Attribute Valid Values Description id string A keyword, unique within a given configuration XML file that identifies a particular engine element.

EngineImpl A fully qualified Java class that implements two interfaces: oracle. In Oracle Reports 10 g Release 1 9. You only need to use securityUserid if you want to connect to an OracleAS Portal instance other than the default instance, which is installed with the Oracle Application Server infrastructure.

Table Attributes of the security Element Attribute Valid Values Description id string A keyword, unique within a given configuration XML file that identifies a particular security element. Note: For securityUserid database connection strings, both the thin testhost. Description The oidconnection element specifies Oracle Internet Directory connection pooling parameters for Reports Server.

In a production environment, you can use this parameter to provide granular control over Oracle Internet Directory connection pooling of Reports Server, namely: The number of connections to keep open in the pool when Reports Server is initialized. Note: Setting much lower or higher values than the default values for these attributes can have a performance impact on OracleAS Reports Services.

In a typical production environment, the default values are recommended. Description Use the destination element to register destination types with the server. Allowable values include: oracle. DesMail oracle. DesFile oracle. DesPrinter oracle. Note: For portalUserid database connection strings, both the thin testhost. Note: If you change the network configuration file for Reports Server, then any client that connects to that server must use the same configuration settings. You must have at least one job element and can have more than one.

Description The job element works in collaboration with the engine and security elements. The job element attributes are described in Table Description Use the notification element to specify a Java class that defines the type of notification that should be sent when a job succeeds or fails. Table Attributes of the notification Element Attribute Valid Values Description id string Default: mailNotify A keyword, unique within a given configuration XML file, that identifies a particular notification element.

Description The log element is available for backward compatibility. Choose from the following options: allJobs : All jobs will be logged succeededJobs : Only jobs that ran successfully will be logged failedJobs : Only jobs that failed will be logged noJob : No jobs will be logged. Description The jobStatusRepository element specifies the Java class that implements a job status repository. Note: For repositoryConn database connection strings, both the thin testhost. Description Use the trace element to create a file for tracing your report's execution and to specify the objects and activities you want to trace.

Note: For information about the various ways to trace report execution, see Section Use this value to determine which report section was sent to which destination.

Description The connection element defines the rules of engagement between the server and the clients connected to it. Table Attributes of the connection Element Attribute Valid Values Description maxConnect Number Default: 20 The maximum number of requests that the server can service simultaneously. Note: In Oracle Reports 10 g Release 2 To do so, at the command prompt enter:. For batch , the default is no. Enter yes if you do not want to be prompted for confirmation during installation.

For autostart , the default is no. Enter yes if you want the service to start automatically at reboot without requiring a user to manually start the Reports Server. To learn more about clustering servers together, see Chapter 12, " Clustering Reports Servers".

In the Services dialog window, select This Account in the Log On As section, and select an operating system user name and password. This specifies the user account under which the server process is run. For that matter, the user running the Reports Server service must have access to anything the server may need. For example, the server may need write access to another drive. Set the Startup Type of the service to Automatic when the system is started.



0コメント

  • 1000 / 1000