This chapter describes how to configure Oracle BI Publisher.
In Oracle Identity and Access Management 11g Release 2 (11.1.2.3.0), Oracle Identity Manager comes with a bundled version of Business Intelligence to allow the production of governance reports. The bundled version is a subset of the Business Intelligence product.
BI Publisher is deployed and configured as a separate managed server within the same Oracle Identity Manager domain. You have the choice of either leveraging the embedded BI Publisher or a standalone BI Publisher. It is recommended that you use the embedded BI Publisher if there are no other reporting requirements, and you only need reporting for Oracle Identity Manager.
After you configure BI Publisher, you can use the following standard features of BI Publisher:
Highly formatted and professional quality reports with pagination and headers/footers.
PDF, Word, and HTML output of reports.
Capability to develop your own custom reports against the Oracle Identity Manager repository (read-only repository access).
BI Publisher's scheduling capabilities and delivery mechanisms, such as e-mail and FTP.
Format (report) can be edited separately from the data definition (data model).
Standardized Oracle Identity sub-template for headers.
National Language Support (NLS) for BI Publisher report output.
This chapter describes how to configure BI Publisher to facilitate the creation of Identity Governance reports.
The Oracle Business Intelligence (BI) configuration is located in the Domain configuration directory. Perform the steps below to configure BI managed servers to use the BI configuration located under the IGD_ASERVER_HOME.
The WebLogic Administration Server automatically copies configuration changes applied to the primary domain configuration location to all the managed server domain configuration directories that have been registered to be part of the domain.
Table 20-1 lists the Domain URLs and their corresponding components and SSO Users.
| Component | URL | SSO User |
|---|---|---|
|
Self-service Console |
|
xelsysadm |
|
OIM Administration Console |
|
xelsysadm |
Verifying the Integration of BI Publisher with Oracle Identity Manager
Enabling Cluster-Level Session Replication Enhancements for Oracle BI Publisher
The BI Publisher configuration folder stores the files that contain your server configuration settings, for example, your data source connections, delivery server definitions, and scheduler settings.
The path to the configuration folder is stored in the xmlp-server-config.xml configuration file. When you install BI Publisher, this is automatically configured to:
${xdo.server.config.dir}/repository
The environment variable ${xdo.server.config.dir} is used to store the path to the location of the xmlp-server-config.xml configuration file. By default, both the BI Publisher configuration folder and the xmlp-server-config.xml file are installed to DOMAIN_HOME/config/bipublisher. The resource section in the xmlp-server-config.xml defines the location of your repository.
By Default, the reports repository path in xmlp-server-config.xml is set to file system absolute path IGD_ASERVER_HOME/config/bipublisher/repository.
By default, Oracle BI Publisher stores reports on the local file system. In an highly available solution, this directory should be moved to a shared storage, so that all BI Publisher instances have access to the same report repository.
To set the server configuration options for Oracle BI Publisher, complete the following steps:
Shutdown BI managed servers wls_bi1 and wls_bi2 through the WebLogic Administration Console.
Edit the file xmlp-server-config.xml.
IGD_ASERVER_HOME/config/bipublisher/xmlp-server-config.xml
Update the parameter 'path' in xmlp-server-config.xml file to reflect the shared configuration folder location.
<?xml version = '1.0' encoding = 'UTF-8'?>
<xmlpConfig xmlns="http://xmlns.oracle.com/oxp/xmlp">
<resource>
<file path="IGD_ASERVER_HOME/config/bipublisher/repository"/>
</resource>
<config>
<file path="IGD_ASERVER_HOME/config/bipublisher/repository"/>
</config>
</xmlpConfig>
Save the xmlp-server-config.xml file.
Note:
Since the repository is in the file system, the case sensitivity of folder and report names is determined by the platform on which you run BI Publisher. For UNIX-based environments, the repository object names are case-sensitive.Start the BI Publisher Managed Servers wls_bi1 and wls_bi2 on both OIMHOST1 and OIMHOST2.
For more information about starting the servers, see Section 31.1.6.4.1, "Starting Oracle BI Publisher WebLogic Managed Servers".
Validate BI Publisher at the following URLs:
http://OIMHOST1VHN3.example.com:9704/xmlpserver http://OIMHOST2VHN3.example.com:9704/xmlpserver
Log in as the xelsysadm user.
To validate the BI server configuration:
On OIMHOST1 log in to BI Publisher with xelsysadm credentials and select the Administration tab.
Under System Maintenance, select Server Configuration.
In the Path field under Configuration Folder, verify the shared location for the Configuration Folder. It must be the location provided in the xmlp-server-config.xml file.
In the BI Publisher Repository field under Catalog, verify the shared location for the BI Publisher Repository. It must be the location provided in the xmlp-server-config.xml file.
Repeat steps 1-4 on OIMHOST2.
The architecture of the BI Publisher Scheduler uses JMS queues and topics to provide a highly scalable, highly performing, and robust report scheduling and delivery system. BI uses the Quartz scheduling engine for scheduling the reports.
BI Publisher clustering support enables you to add server instances on demand to handle processing and delivery load. In a clustered implementation, the report repository and the scheduler database are shared across the multiple instances. Also, the JMS queues for scheduling and JMS topic for publishing diagnostic information are shared across the server by registering JMS queues and topics via JNDI services.
This section describes how to configure the scheduler options and JMS configuration.
This section contains the following topics:
Section 20.2.3, "Configuring Default Persistence Store for Transaction Recovery"
Section 20.2.4, "Using JDBC Persistent Stores for TLOGs and JMS"
Section 20.2.5, "Updating the JMS Configuration of BIP Scheduler"
Follow the below steps to configure the scheduler options:
On OIMHOST1, access the BI Publisher URL and log in as xelsysadmin.
http://OIMHOST1VHN3.example.com:9704/xmlpserver
Select the Administration tab.
Under System Maintenance, select Scheduler Configuration.
Select Quartz Clustering under the Scheduler Selection, then click Apply.
Repeat these steps on OIMHOST2.
Because of a known issue, when BI is configured only one persistence store is created. The workaround is to create a new persistent store using the following steps.In this procedure; you create a JMS store for BI for each managed server. One JMS store configuration is already created during WebLogic domain creation. The location for all persistence stores should be set to a directory that is visible from all BI nodes.
Shutdown all the BI Publisher Managed Servers. For more information, see Section 31.1.6.4.2, "Stopping Oracle BI Publisher WebLogic Managed Servers".
Create the following directory:
RT_HOME/domains/IAMGovernanceDomain/jms/BipJmsStore1
Log into the WebLogic Administration Console.
In the Domain Structure window, expand the Services node and click the Persistent Stores node.
Click Lock & Edit in the Change Center.
In the Domain Structure window, expand the Services node and click the Persistent Stores node.
Click on existing File Store (for example, BipJmsStore), and verify the target. If it is WLS_BI2, the new File Store must target WLS_BI1.
Click New and Create File Store.
Enter a name, such as BipJmsStore1 and target WLS_BI1. Note that the targets WLS_BI1 and WLS_BI1 (migratable) are displayed. Select WLS_BI1
Enter a directory located in shared storage so that OIMHOST1 and OIMHOST2 can access it. For example:
RT_HOME/domains/IAMGovernanceDomain/jms/BipJmsStore1
Click Save.
In the Domain Structure window, expand the Services node, expand Messaging and click JMS Servers.
Click New.
Enter a name, such as BipJmsServer1.
In the Persistence Store drop-down list, select BipJmsStore1 and click Next.
Select WLS_BI1 as the target and click Finish.
In the Domain Structure window, expand the Services node, expand Messaging and click JMS Modules node.
Click BipJmsResource and click the Subdeployments tab.
Click BipJmsSubDeployment under the Name section of the subdeployments table.
On the Settings for BipJmsSubDeployment page, under JMS Servers category, select the new JMS server that you created in the earlier steps. For example: BipJmsServer1.
Click Save, and then click Activate Changes.
Start the BI Publisher Managed Servers - wls_bi1 and wls_bi2. For information about starting the BI Publisher Managed Servers, see Section 31.1.6.4.1, "Starting Oracle BI Publisher WebLogic Managed Servers".
The WLS_BI Managed Servers have a transaction log that stores information about committed transactions that are coordinated by the server that might not have been completed. The WebLogic Server uses this transaction log for recovery from system crashes or network failures. To leverage the migration capability of the Transaction Recovery Service for the servers within a cluster, store the transaction log in a location accessible to a server and its backup servers. Preferably, this location should be on a dual-ported SCSI disk or on a Storage Area Network (SAN).
Perform the following steps to set the location for the default persistence stores for the BI Servers:
Create the following directory on the shared storage:
RT_HOME/domains/IAMGovernanceDomain/tlogs/cluster_bi
Log in to the Oracle WebLogic Server Administration Console.
Click Lock and Edit.
Under Domain Structure, expand Environment, and then click Servers.
The Summary of Servers page appears.
Click the name of the BI server (wls_bin) represented as a hyperlink in the Name column of the table.
The Settings page for the selected server appears, and defaults to the Configuration tab.
Go to the Services sub tab.
Under the Default Store section of the page, provide the path to the default persistent store on shared storage.
The directory structure of the path is as follows:
RT_HOME/domains/IAMGovernanceDomain/tlogs/cluster_bi
Note:
To enable migration of the Transaction Recovery Service, specify a location on a persistent storage solution that is available to other servers in the cluster. All the servers that are a part of the cluster must be able to access this directory.Click Save.
For information about when to use JDBC persistent stores for transaction logs (TLOGs) and JMS, and for instructions on how to configure the persistent stores for TLOGs and JMS for the BI Managed Servers, see Section 15.4.10, "Using JDBC Persistent Stores for TLOGs and JMS in an Enterprise Deployment".
The architecture of the BI Publisher Scheduler uses JMS queues and topics to provide a highly scalable, highly performing, and robust report scheduling and delivery system. BI Publisher clustering support enables you to add server instances on demand to handle processing and delivery load. The JMS queues for scheduling and JMS topic for publishing diagnostic information are shared across the server by registering JMS queues and topics through JNDI services. A shared Directory is used to temporarily store data and files used by the scheduler while jobs are executing. After a job is completed, the temporary data for the job is deleted. The directory is used to exchange data and document information among all the BI Publisher nodes and therefore, must be accessible by all BI Publisher nodes. The size of the directory depends on the total size of the job data, output documents, and the number of concurrent jobs. The directory should be big enough to hold all the XML data and documents for all the parallel running jobs. If BI Publisher runs on different machines while this directory is not configured, the scheduler may fail.
If BI Publisher runs on a single machine, defining a shared directory is optional. BI Publisher uses the application server's temporary directory to store this data.
Complete the following steps to configure the BI scheduler JMS configuration. Run this procedure on both OIMHOSTs: OIMHOST1 and OIMHOST2.
Log in to BI Publisher at the one of the following URLs:
http://OIMHOST1VHN3:9704/xmlpserver http://OIMHOST2VHN3:9704/xmlpserver
Click Administration in the top right corner, then click Scheduler Configuration under System Maintenance to open the Scheduler Configuration page.
In the JMS Configuration section, update the Shared Directory by entering a directory that is located in the shared storage.
RT_HOME/domains/IAMGovernanceDomain/jms/sharedtemp
Note:
Ensure that the directory location (RT_HOME/domains/IAMGovernanceDomain/jms/sharedtemp) specified for the BI JMS Shared directory, exists.Update the JNDI URL as:
cluster:t3://cluster_bi
Click Apply.
Check the scheduler status in the Scheduler Diagnostics tab. The scheduler status must be Passed.
Click Test JMS.
Verify the above configurations on all the BI managed servers.
Restart all BI managed servers.
Validate the BI instance by accessing the following URL:
http://igdadmin.example.com/xmlpserver
Use the xelsysadm username and password to log in.
To verify the integration of BI Publisher with Oracle Identity Manager in fresh configuration mode, do the following:
log in to the BI Publisher using your Oracle Identity Manager system administrator credentials by navigating to the following URL:
http://HOST_NAME:PORT/xmlpserver
The default port for BI Publisher server is 9704.
Note:
Make sure that BI Publisher server is running when accessing the BI Publisher URL.Click Catalog. The Oracle Identity Manager directory with reports is displayed under the Shared Folders directory.
You can now use the full capabilities of BI Publisher, such as PDF report generation and e-mail delivery.
Note:
In addition to the Oracle Identity Manager System administrator credentials, you can also access BI Publisher using the WebLogic credentials and the BISystemUser credentials.By default, BISystemUser password is same as that of the Oracle Identity Manager system administrator password.
It is recommended that you create a backup after successfully completing the installation and configuration of each tier, or at another logical point. Create a backup after verifying that the installation so far is successful. This is a quick backup for the express purpose of immediate restoration in case of problems in later steps. The backup destination is the local disk. You can discard this backup when the enterprise deployment setup is complete. After the enterprise deployment setup is complete, you can initiate the regular deployment-specific Backup and Recovery process.
For information about database backups, see Oracle Database Backup and Recovery User's Guide.
To back up the installation to this point, back up the following:
The Web tier
The Access Manager database
The Administration Server domain directory
The Managed Server domain directory
The LDAP Directory
The Keystores created
You can enable session replication enhancements for Managed Servers in a WebLogic cluster to which you deploy a Web application at a later time.
To enable session replication enhancements for bi_cluster in the domain IAMGovernanceDomain, use the values in Table 20-2.
Table 20-2 Network Channel Properties
| Managed Server | Name | Protocol | Listen Address | Listen Port | Additional Channel Ports |
|---|---|---|---|---|---|
|
WLS_BI1 |
|
t3 |
OIMHOST1VHN3.example.com |
7005 |
7006 to 7014 |
|
WLS_BI2 |
|
t3 |
OIMHOST2VHN3.example.com |
7005 |
7006 to 7014 |
Proceed as follows:
Log in to the WebLogic Administration console at: http://IGDADMIN.example.com/console
Ensure that Managed Servers in the oim_cluster cluster are up and running, as described in Section 31.1, "Starting and Stopping Enterprise Deployment Components."
To set replication ports for a Managed Server, use the values in Table 20-2.
To set the values for WLS_BI1, for example, complete the following steps:
Under Domain Structure, click Environment and Servers. The Summary of Servers page is displayed.
Click Lock & Edit.
Click WLS_BI1 on the list of servers. The Settings for WLS_BI1 are displayed.
Click the Cluster tab.
In the Replication Ports field, enter a range of ports for configuring multiple replication channels. For example, replication channels for Managed Servers in bi_cluster can listen on ports starting from 7005 to 7015. To specify this range of ports, enter 7005-7015.
Repeat Steps a through e for each of the other managed servers in Table 20-2.
The following steps show how to create a network channel for the managed server WLS_BI1.
Log in to the Oracle WebLogic Server Administration Console.
If you have not already done so, click Lock & Edit in the Change Center.
In the left pane of the Console, expand Environment and select Servers.
The Summary of Servers page is displayed.
In the Servers table, click WLS_BI1 Managed Server instance.
Select Protocols, and then Channels.
Click New.
Enter ReplicationChannel as the name of the new network channel and select t3 as the protocol, then click Next.
Enter the following information:
Listen address: OIMHOST1VHN1
Note:
This is the WLS_OIM1 floating IP assigned to WebLogic Server.Listen port: 7005
Click Next, and in the Network Channel Properties page, select Enabled and Outbound Enabled.
Click Finish.
Click Save.
Under the Network Channels table, select ReplicationChannel, the network channel you created for the WLS_BI1 Managed Server.
Expand Advanced, select Enable SDP Protocol, and click Save.
To activate these changes, in the Change Center of the Administration Console, click Activate Changes.
You must repeat the above steps to create a network channel each for the remaining Managed Servers in the cluster. Enter the required properties, as described in Table 20-2.
After creating the network channel for each of the Managed Servers in your cluster, click Environment > Clusters. The Summary of Clusters page is displayed.
Click bi_cluster. The Settings for bi_cluster page is displayed.
Click the Replication tab.
In the Replication Channel field, ensure that ReplicationChannel is set as the name of the channel to be used for replication traffic.
In the Advanced section, select the Enable One Way RMI for Replication option.
Click Save.
To activate these changes, in the Change Center of the Administration Console, click Activate Changes.
Complete this procedure for each domain.