Installation and Upgrade Guides › Policy Server Installation Guide › Installing Reports

Installing Reports

Installation Road Map

The following diagram illustrates a sample CA SiteMinder® installation and lists the order in which you install and configure each component.

Solid lines surround the components that are required before installing and configuring reports. They include the following components:
- A Policy Server
- A policy store
- An Administrative UI registered with a Policy Server.
Dotted lines surround the components that you install and configure now. They include the following components:
- The Report Server
- A report database
- A CA SiteMinder® audit database.

More information:

Policy Server

CA SiteMinder® Audit Database

Reporting Installation Checklists

Review the Report Server and report database checklists to help ensure the following:

Your environment meets the minimum operating system and database requirements
You complete the required prerequisite configuration

Report Server

Be sure that the Report Server host system meets the minimum operating system requirements:
- Windows
- UNIX
(Solaris) Install the required operating system patches to the Report Server host system.
Note: For more information, see the Policy Server Release Notes.
Be sure that the Report Server host meets the connectivity requirements.
Be sure that the Report Server host name does not include any of the following characters:
- An underscore (_)
- A period (.)
- A slash (/) (\)
If you are reinstalling the Report Server, uninstall the current instance. The installation fails if you attempt to install over an existing instance.
Windows installations:
- Be sure that you have access to a user account that is a member of the local Administrators group. The user account that runs the installer must be a member of the local Administrators group.
  Important! Installing to a system where the default Windows security settings have been modified for the local Administrator group is not supported.
- Be sure that the system to which you are installing is not a domain controller. Installing to a domain controller is not supported.
UNIX installations:
- Be sure that the Report Server host IP is configured properly in the /etc/hosts file to avoid an IP resolution problem.
- Be sure that you have access to a root user account and a non–root user account. You require a root-user account to start the installation and a non–root user account to complete the installation. Be sure that the non–root user account:
  - Is the owner of a valid home directory.
  - Has write permissions to the home directory.
- Be sure that the following commands and utilities are installed on the operating system and available on the PATH environment variable for the root user account:
  - /bin/sh
  - uname
  - awk
  - tar
  - stty
  - pwd
  - expr
  - chown
  - id
  - ulimt
  - read
  - hostname
  - grep
  - dirname
  - which
  - touch
  - sed
  - tail
  - gzip
- Be sure that the PATH environment variable of the root–user account does not inlcude GNU or third–party replacements for core system command–line tools or an individually downloaded and compiled version of the tool.
- Set at least one of the following variables to a valid utf8/UTF-8 locale:
  - LC_ALL
    Example: export LC_ALL=en_US.UTF-8
  - LANG
    Example: export LANG=en_US.UTF-8
  - LC_CTYPE
    Example: export LC_CTYPE=en_US.UTF-8

Report Database and Audit Database

If you are not using the embedded version of MySQL:
- Be sure that the database server host system has a fixed host name.
- Be sure that you are using a supported database to function as the report database.
- Be sure that a new, empty database is available.
- Be sure that the database client and server are configured to use UTF8 character encoding. For more information about the required settings for a Unicode configuration, see your vendor-specific documentation.
(SQL Server) If you are using SQL Server as a report database, an audit database, or both, complete the following items on the Report Server host system:
- Be sure that a CA SiteMinder® supported SQL Server driver is installed on the Report Server host system.
- Create a data source name (DSN) that identifies each database. The Report Server uses the DSN to communicate with each database.
(Oracle) If you are using Oracle as a report database, an audit database, or both:
- Do the following items on the Report Server host system:
  - Be sure that a supported Oracle Net client is installed.
  - Use an Oracle Net Service Name to identify each database in the tnsnames.ora file. The Report Sever uses the service name to communicate with each database.
  - Set the NLS_LANG variable to one of the following UTF–8 settings:
    – AMERICAN_AMERICA.WE8MSWIN1252
    
    – AMERICAN_AMERICA.AL32UTF8
  - Set the ORACLE_HOME variable to Oracle_Net_client.
    Oracle_Net_client
    
    Specifies the Oracle Net client installation path.
    
    Windows Example: C:\oracle\product\10.2.0\client
    
    UNIX Example: export ORACLE_HOME=/opt/oracle/product/10.2.0/client1
  - (Windows) Add the ORACLE_HOME variable to the system environment variables.
    Example: %Oracle_Home%\bin
  - (UNIX) Set the LD_LIBRARY_PATH variable to $ORACLE_HOME/lib32:$ORACLE_HOME/lib.
    Example: LD_LIBRARY_PATH=$ORACLE_HOME/lib32:$ORACLE_HOME/lib:$LD_LIBRARY_PATH
  - (UNIX) Set the PATH variable to $ORACLE_HOME/bin:$PATH.
    Example: export PATH=$ORACLE_HOME/bin:$PATH
- Do the following items on the database server host system: Set the NLS_LANG variable to one of the following UTF–8 settings:
  - AMERICAN_AMERICA.WE8MSWIN1252
  - AMERICAN_AMERICA.AL32UTF8

Report Database and Audit Database

If you are not using the embedded version of MySQL:
- Verify that the database server host system has a fixed host name.
- Verify that you are using a supported database to function as the report database.
- Verify that a new, empty database is available.
- Verify that the database client and server are configured to use UTF-8 character encoding. For more information about the required settings for a Unicode configuration, see your vendor-specific documentation.
(SQL Server) If you are using SQL Server as a report database, an audit database, or both, complete the following items on the Report Server host system:
- Verify that a CA SiteMinder® supported SQL Server driver is installed on the Report Server host system.
- Create a data source name (DSN) that identifies each database. The Report Server uses the DSN to communicate with each database.
- Verify that the database is enabled for UTF-8 character encoding. For more information about the required settings for a Unicode configuration, see your SQL Server documentation.
(Oracle) If you are using Oracle as a report database, an audit database, or both:
- Do the following items on the Report Server host system:
  - Verify that a supported Oracle Net client is installed.
  - Verify that the database client and server are configured to use UTF-8 character encoding. For more information about the required settings for a Unicode configuration, see your vendor-specific documentation.
  - Use an Oracle Net Service Name to identify each database in the tnsnames.ora file. The Report Server uses the service name to communicate with each database.
  - Set the NLS_LANG variable to one of the following UTF–8 settings:
    – AMERICAN_AMERICA.WE8MSWIN1252
    
    – AMERICAN_AMERICA.AL32UTF8
  - Set the ORACLE_HOME variable to Oracle_Net_client.
    Oracle_Net_client
    
    Specifies the Oracle Net client installation path.
    
    Windows Example: C:\oracle\product\10.2.0\client
    
    UNIX Example: export ORACLE_HOME=/opt/oracle/product/10.2.0/client1
  - (Windows) Add the ORACLE_HOME variable to the system environment variables.
    Example: %Oracle_Home%\bin
  - (UNIX) Set the LD_LIBRARY_PATH variable to $ORACLE_HOME/lib32:$ORACLE_HOME/lib.
    Example: LD_LIBRARY_PATH=$ORACLE_HOME/lib32:$ORACLE_HOME/lib:$LD_LIBRARY_PATH
  - (UNIX) Set the PATH variable to $ORACLE_HOME/bin:$PATH.
    Example: export PATH=$ORACLE_HOME/bin:$PATH
- Do the following items on the database server host system: Set the NLS_LANG variable to one of the following UTF–8 settings:
  - AMERICAN_AMERICA.WE8MSWIN1252
  - AMERICAN_AMERICA.AL32UTF8

Reporting Considerations

Consider the following items before installing the Report Server:

Installing the Report Server on a host system with any other CA SiteMinder® component is not supported. Be sure to install the Report Server on a separate host system.
A UNIX installation can take several hours. Before you install, increase the page size to 4 GB or equal to RAM size. If the installation takes longer than four hours, stop the installation and increase the page size.
If JBoss is installed on the Report Server host system, port conflicts can occur. If you experience port conflicts after installing the Report Server, you can locate JBoss port information in the following files:
- jboss-service.xml
  Default location: jboss_home\server\server_configuration\conf
- server.xml
  Default location: jboss_home\server\server_configuration\deploy\jbossweb-tomcat55.sar
  
  jboss_home
  
  Specifies the JBoss installation path.
  
  server_configuration
  
  Specifies the name of your server configuration.
  
  Default value: default
  
  Note: If you change either of these files, restart JBoss. For more information, see the Red Hat documentation.
- service-bindings.xml
  This file is only present if the Administrative UI was installed to the Report Server host system using the stand-alone option.
  
  Default location: administrative_ui_install\webadmin\conf
  
  administrative_ui_installation
  
  Specifies the Administrative UI installation path.
  
  Note: If you change this file, restart the Administrative UI application server.

More information:

Administrative UI Installation Options

Start the Application Server

Stop the Application Server

How the Reports Installation Works

The CA SiteMinder® reporting feature requires that you install and configure a Report Server, a report database, and a CA SiteMinder® audit database to manage CA SiteMinder® policy analysis and audit-based reports. The following diagram details a sample CA SiteMinder® environment and lists the order in which each component is installed or configured:

Graphic showing the components required for the Report Server

The following list explains each of the illustrated steps:

Install the Report Server—Installing the Report Sever is the first step in the process. You configure a report database during the installation.
Install the CA SiteMinder® report templates—Installing the CA SiteMinder® report templates is the second step in the process. The CA SiteMinder® Report Server Configuration Wizard configures the Report Server to use a set of CA SiteMinder® policy analysis and auditing report templates.
Register the Report Server—Registering the Report Server is the third step in the process. Registration requires that you configure a connection between:
- The Report Server and a Policy Server
- The Report Server and the Administrative UI
Configure a CA SiteMinder® audit database—Configuring a CA SiteMinder® audit database is the fourth step in the process. A separate CA SiteMinder® audit database, which is registered with the Administrative UI, is required to run audit-based reports.

How to Install the Report Server

Complete the following procedures to install the Report Server:

Review the installation checklists.
Gather information for the installer.
Install the Report Server.

Gather Information for the Installer

Review the following sections to identify the information required by the Report Server installer.

Installation Credentials

Depending on the operating system to which you are installing, the installer requires one or more sets of credentials:

(Windows and UNIX) BusinessObjects Administrator password
The installer creates a default SAP BusinessObjects Enterprise administrator account (administrator). You use this account to import CA SiteMinder® report templates and to access the BusinessObjects Content Management Console. Determine the password for this account.

The password must meet the following composition criteria:
- The password must include at least six characters.
- The password cannot contain the word "administrator" in any form.
- The password must include at least two of the following character types:
  - Uppercase characters
  - Lowercase characters
  - Numerals
  - Punctuation
(UNIX) Non–root user account—You require a root–user account to start the installation and a non–root user account to complete the installation. Identify the non–root user account:
- User name
- Group name

MySQL Report Database

If you are using the embedded version of MySQL to function as the report database, the installer requires specific information. Use the report database installation worksheet to gather the following information before starting the installation:

MySQL root password
The password for the MySQL root user account.

Note: You cannot change the name of the root user account. The installer defaults the name to root.
User
The name of the report database administrator account.

Installer default: sa
Password
The password of the report database administrator account.

SQLAnywhere Report Database

From CA SiteMinder® 12.51, CA SiteMinder® supports CA Business Intelligence 3.3 that lets you use SQLAnywhere as a report database on only the RHEL 6 platform.

If you want to use the embedded version of SQLAnywhere to function as the report database, the installer requires specific information. Use the report database installation worksheet to gather the following information before starting the installation:

SQLAnywhere root password
The password for the SQLAnywhere root user account.

Note: You cannot change the name of the root user account. The installer defaults the name to root.
User
The name of the report database administrator account.

Installer default: sa
Password
The password of the report database administrator account.

Microsoft SQL Server Report Database

If you are using Microsoft SQL Server to function as the report database, the installer requires specific information. Use the report database installation worksheet to gather the following information before starting the installation:

Data Source Name (DSN)
The DSN that Report Server is to use to communicate with the report database.

Note: The Report Server is compiled as 32–bit native binary and is designed to use 32–bit data source middleware connectivity. If you are installing to a Windows 64–bit operating system, be sure to create the DSN using odbcad32.exe. This executable is located in the following location:
```
install_home\Windows\SysWOW64.
```
install_home

Specifies the installation path of the Windows operating system.
Login ID
The name of the report database administrator account. This account must have the default (DBO) account permissions.
Password
The password of the report database administrator account.

Oracle Report Database

If you are using Oracle to function as the report database, the installer requires specific information. Use the report database installation worksheet to gather the following information before starting the installation:

Oracle Net Client Service name
The service name that the Report Server is to use to communicate with the report database.
- (Windows) The installer refers to the Oracle Net Client Service name as Server.
- (UNIX) The installer refers to the Oracle Net Client Service name as TNSNAME.
User name
The name of the report database administrator account. This account must have the following privileges:
- create session
- create table
- create procedure
Note: You can also use an administrator account with the CONNECT and RESOURCE roles enabled. Be sure to disable the Admin Option setting for both roles.
Password
The password of the report database administrator account.

Apache Tomcat Installation

CA SiteMinder® only supports the version of Apache Tomcat that is embedded with the Report Server installation. Use the web application installation worksheet to gather the following information before starting the installation:

Connection port
The port to which Apache Tomcat is to connect and wait for requests.

Installer default: 8080
Redirect port
Identify the port to which Apache Tomcat must redirect requests.

Installer default: 8443
Shutdown port
The port to which the Apache Tomcat SHUTDOWN command must be issued.

Installer default: 8005

Install the Report Server

The following sections detail how to install the Report Server on Windows and UNIX.

Before You Install

Consider the following items before you install the Report Server:

Installing the Report Server on a host system with any other CA SiteMinder® component is not supported. Be sure to install the Report Server on a separate host system.
You install the Report Server using the installation media on the Technical Support site.
Note: For a list of installation media names, see the Policy Server Release Notes.
The Report Server is compiled as 32–bit native binary and is designed to use 32–bit data source middleware connectivity. If you are installing to a Windows 64–bit operating system, be sure to create the DSN using odbcad32.exe. This executable is located in the following location:
```
install_home\Windows\SysWOW64.
```
install_home

Specifies the installation path of the Windows operating system.
A UNIX console installation is not supported.
The Report Server installation includes the following components that run as processes:
- The Content Management Server
- The Server Intelligence Agent
These components require TCP/IP ports to communicate. The installer lets you modify the default settings to prevent port conflicts on the Report Server host system.
Important! The installation zip contains multiple folders. The installer executable requires this folder structure. If you moved the Report Server installer after extracting the zip, copy the entire folder structure to the same location. Execute the installation media from this folder structure.
Important! (UNIX) The user account installing the Report Server must have executable permissions on the directory that contains the installation media. If the user account does not have these permissions, run the following command:
```
chmod -R+x directory
```
directory

Specifies the directory that contains the installation media.
(UNIX) If you execute the Report Server installer across different subnets, it can crash. Install the Report Server directly on the host system.
(UNIX) Before you install the Report Server on an RHEL 6 machine, ensure that you complete the following tasks on the RHEL 6 machine:
- Install the following RPMs:
  - ncurses-libs.i686
  - Compat-libstdc++-33.3.3-69.el6.i686
  - libXext-1.1-3.el6.i686
  - libXext-devel-1.1-3.el6.i686
  - ncurses-base
  - ncurses-libs 5.9-7.20121017
  - xorg-x11-libX11-7.6-23.1.2.i586
  - xorg-x11-libXau-7.6_1.0.6-9.1.1.i586
  - xorg-x11-libxcb-7.6_1.7-8.1.i586
- Set the LD_LIBRARY_PATH environment variable to the location of the 32-bit libncurses.so.5 library.

More information:

Locate the Installation Media

Windows

Follow these steps:

Be sure that you have reviewed the installation checklists.
Be sure that you have gathered the required information for the installer.
Exit all applications that are running.
Double–click installation_media.

installation_media

Specifies the Report Server installation executable.

The CA Business Intelligence installation wizard appears and prompts you for a locale.

Note: For a list of installation media names, see the Policy Server Release Notes.
Select English and click OK.
The installer introduction appears.
Click Next.
The CA license agreement appears.
Accept the license agreement and click Next.
The installer prompts you to install CA sample templates.
Select No and click Next.
Note: CA sample templates are not related to the CA SiteMinder® reporting templates. The CA SiteMinder® Report Server Configuration wizard installs the required reporting templates. You run the wizard after installing the Report Server.

The installer prompts you to save a response file for a silent installation.
Select Yes and click Next.
An installation summary appears.
Review the summary and click Install.
The installer installs the components. The CA Business Intelligence Setup wizard appears.
Click Next.
The installer introduction appears.
Click Next.
The SAP BusinessObjects Enterprise license agreement appears.
Accept the license agreement and click Next.
The installer prompts you to select language packs. English is selected by default.
Leave the default English setting and click next.
The installer prompts you for an installation type.
Select New and do one of the following steps to configure the report (CMS) database:
- (Recommended) To install the embedded version of MySQL, select Install MySQL Database Server and click Next.
- To configure an existing Microsoft SQL Server or Oracle database, select Use an existing database server and click Next.
  The installer prompts you for the Content Management Server port and the password for the SAP BusinessObjects Enterprise administrator account.
Complete the following steps:
1. Specify the port on which the Content Management Server must listen.
2. Specify a password for the default SAP BusinessObjects Enterprise administrator.
  Important! Do not select Configure the SAP BusinessObjects Enterprise Administrator password at a later time.
3. Click Next.
  The installer prompts you for the Server Intelligence Agent node name and port.
Specify a node name and port. Click Next.
The installer prompts you to configure the report (CMS) database.

Important! The Report Server is a CA common component that CA products can share. As such, the installer lets you configure the report database to database types and versions that other products support, but CA SiteMinder® does not. For a list of supported database types and versions, see the CA SiteMinder® 12.52 Platform Support Matrix.
Do one of the following steps:
- (Recommended) If you are configuring MySQL, enter the password for the root user account and the report database administrator credentials.
- If you are configuring Microsoft SQL Server:
  1. Select SQL Server (ODBC) and click Browse to open the SQL Server Logon screen.
  2. Select a DSN and enter administrator credentials.
    Note: If you are installing on a 64-bit version of Windows, select Consume DSN created under WOW64. The option lets you use a 32–bit DSN.
  3. Click OK.
- If you are configuring Oracle, enter the required values for the service name and the administrator credentials.
  Note: Do not configure an Auditing Database. This component is not related to CA SiteMinder® audit–based reports. The Content Management Server Auditing Database is used to audit activities specific to the Report Server and is not used for CA SiteMinder®. A CA SiteMinder® audit database is required to run audit–based reports.
Click Next.
The installer prompts you to select a web application server.
Complete the following steps:
1. Select Install Tomcat application server and deploy to it.
  Note: CA SiteMinder® only supports the embedded version of Apache Tomcat.
2. Clear the IIS Web Application Server option.
3. Click Next.
  The installer prompts you for Apache Tomcat information.
Enter the Apache Tomcat ports and click Next.
The installer prompts you to start the installation.
Click Next to start the installation.
The installer prompts you when the installation is complete.
Clear the Launch SAP BusinessObjects Administration Console option and click Finish.
The Report Server is installed.

More information:

Installation Media Names

UNIX

Follow these steps:

Be sure that you have reviewed the installation checklists.
Be sure that you have gathered the required information for the installer.
Be sure to start the installation using a root user account.
Exit all applications that are running.
Open a Bourne shell and navigate to the installation media.
Enter the following command:
```
./installation_media -i console
```
installation_media

Specifies the Report Server installation executable.

Note: For a list of installation media names, see the Policy Server Release Notes.

The CA Business Intelligence installer starts and prompts you for a locale.
Type the value for English and press Enter.
The installer introduction appears.
Press Enter.
The CA license agreement appears.
Complete the following steps:
1. Press Enter to advance the license agreement.
2. Type y to accept the license agreement.
3. Press Enter.
The installer prompts you for non–root user credentials.
Type the user name and group name and press Enter.
The installer prompts you to specify the path to the CA Shared Components directory.
Leave the default value and press Enter.
The installer prompts you to install CA sample templates.
Type N and press Enter.
Note: CA sample templates are not related to the CA SiteMinder® reporting templates. The CA SiteMinder® Report Server Configuration wizard installs the required reporting templates. You run the wizard after installing the Report Server.

The installer prompts you to save a response file for a silent installation.
Type Y and press Enter.
An installation summary appears.
Review the summary and press Enter.
The installer installs the components. The SAP BusinessObjects Enterprise installer prompts you to select an installation language.
Select English and press Enter.
The SAP BusinessObjects Enterprise license agreement appears.
Press y to accept the license agreement.
The installer prompts you enter the Report Server installation directory.
Press Tab to auto–complete the default setting and press Enter.
The installer prompts you to select language packs. English is selected by default.
Leave the default and press Enter.
The installer prompts you for an installation type.
Select User – Regular SAP BusinessObjects Enterprise installation and press Enter.
The installer prompts you for an installation type.
Select New and press Enter.
Note: Do not clear the Enable servers after installation option.

The installer prompts you for the Content Management Server port and the password for the SAP BusinessObjects Enterprise administrator account.
Complete the following steps:
1. Specify the port to which the Content Management Server must connect and listen for requests.
2. Specify a password for the default SAP BusinessObjects Enterprise administrator.
3. Press Enter.
The installer prompts you to select the type of database that is to function as the report (CMS) database.
Complete one of the following steps:
- (Recommended) To install the embedded version of MySQL, select Install MySQL and press Enter.
- To configure an existing Oracle database, select Use an existing database server and press Enter.
- (RHEL 6) To install SQLAnywhere, select Install SQLAnywhere and press Enter.
Important! The Report Server is a CA common component that CA products can share. As such, the installer lets you configure the report database to database types and versions that other products support, but CA SiteMinder® does not. For a list of supported database types and versions, see the CA SiteMinder® 12.52 Platform Support Matrix.

The installer prompts for additional report database information.
Complete one of the following steps:
- (MySQL/SQLAnywhere) Enter the required values for the root user account and the report database administrator credentials.
- (Oracle) Complete the steps:
  1. Select Oracle and press Enter.
    The installer prompts for database information.
  2. Type the service name and administrator credentials.
Press Enter.
- If you are installing the embedded version of MySQL, the installer prompts you for Auditing Database information.
- If you are configuring Oracle, the installer prompts you to install the Auditing Database.
  The Auditing Database is not related to CA SiteMinder® audit–based reports. The Content Management Server Auditing Database is used to audit activities specific to the Report Server and is not used for CA SiteMinder®. A CA SiteMinder® audit database is required to run audit–based reports.
Complete one of the steps:
- (MySQL/SQLAnywhere) Accept the defaults and press Enter.
- (Oracle) Complete the following steps:
  1. Select the Do not install Auditing Database option.
  2. Press Enter.
    The installer prompts you to reinitialize the database.
  3. Select Yes and press Enter.
The installer prompts you for a Service Intelligence Agent node name and port.
Type a node name and port and press Enter.
The installer prompts you to select a web application server.
Select the Install Tomcat deploy web applications option.
Note: CA SiteMinder® only supports the embedded version of Apache Tomcat.

The installer prompts you for Apache Tomcat ports.
Type the required Apache Tomcat port information and press Enter.
The installer displays the path of the installation directory.
Press Enter to start the installation.
The installer displays the installation progress and confirms when the installation is complete.
Press Enter to exit the installer.

More information:

Installation Media Names

Troubleshoot the Report Server Installation

Use the following files to troubleshoot the Report Server installation:

CA_Business_Intelligence_InstallLog.log
We recommend opening this log first to view reported errors.
ca-install.log
We recommend scrolling to the bottom of this file to view reported errors. Search for “BIEK_GetExitCode” to verify the returned value of the “BIEK_GetExitCode” function. If the returned value is not 0, then there is an installation error. Search for the following keywords to determine the cause of the error:
- Error
- Warning
- CMS
- InfoStore

The log files are located in a temporary location during the installation. The TEMP environment property on the system determines the temporary location. If the installation fails, you can locate the log file in this temporary location. After a successful installation, the log files are located at the top level of the Report Server installation directory.

How to Install the Report Templates

Complete the following procedures to install the report templates:

Gather information for the installer.
Install the report templates.
Restart the Report Server.
Increase the Job Server service timeout value.

Gather Information for the Installer

The Report Server Configuration Wizard requires the following information:

BusinessObjects administrator password—Identify the password for the default BusinessObjects administrator account. The Report Server installer creates a default administrative account during installation. A password for this account was required to complete the installation. The Report Server Configuration Wizard requires the password to use the default administrative account to install the report templates.
CA SiteMinder® audit database type—Identify the type of database that is to function as a CA SiteMinder® audit database. A separate CA SiteMinder® audit database is required to run audit-based reports. The Report Server Configuration Wizard requires the database type to configure the Report Server to use a set of report templates based on the audit database type.
Note: You do not have to configure a CA SiteMinder® audit database before running the Report Server Configuration Wizard.

A worksheet is provided to help you gather and record required information before installing the report templates.

Install the Report Templates

You install the CA SiteMinder® report templates with the Report Server Configuration Wizard. The following sections detail how to run the Report Server Configuration Wizard on Windows and UNIX.

Before You Install

Consider the following items before you install the report templates:

You run the Report Server Configuration Wizard using the installation media on the Technical Support site.
Note: For a list of installation media names, see the Policy Server Release Notes.

Important! (UNIX) The installation media requires executable permissions. Run the following command to add the permission:
```
chmod +x installation_media
```
installation_media

Specifies the name of the Report Server Configuration Wizard installation executable.
(UNIX) If you execute the Report Server Configuration Wizard across different subnets, it can crash. Install the report templates directly on the Report Server host system.

More information:

Locate the Installation Media

Installation Media Names

Windows

To install the report templates on Windows

Be sure that you have gathered the required information for the installer.
Exit all applications that are running.
Double–click installation_media.

installation_media

Specifies the name of the Report Server Configuration Wizard installation executable.

The installer starts.

Note: For a list of installation media names, see the Policy Server Release Notes.
For each prompt, use your completed Report Server configuration worksheet to enter the required values.
Review the installation settings and click Install.
The report templates are installed.
Restart the Report Server.
The Report Server is configured to use the CA SiteMinder® report templates.

More information:

Locate the Installation Media

Installation Media Names

UNIX GUI

To install the report templates using a UNIX GUI

Be sure that you have gathered the required information for the installer.
Exit all applications that are running.
Open a shell and navigate the installation media.
Enter the following command:
```
./installation_media
```
installation_media

Specifies the name of the Report Server Configuration Wizard installation executable.

The installer starts.

Note: For a list of installation media names, see the Policy Server Release Notes.
For each prompt, use your completed Report Server configuration worksheet to enter the required values.
Note: Oracle is the only supported audit database for a Solaris Report Server. If you installed the Report Server to Solaris, you are not prompted for an audit database type. The Report Server Configuration Wizard automatically installs Oracle-specific report templates.
Review the installation settings and click Install.
The report templates are installed.
Restart the Report Server.
The Report Server is configured to use the CA SiteMinder® report templates.

More information:

Locate the Installation Media

Installation Media Names

UNIX Console

To install the report templates using a UNIX console

Be sure that you have gathered the required information for the installer.
Exit all applications that are running.
Open a shell and navigate to the installation media.
Enter the following command:
```
./installation_media -i console
```
installation_media

Specifies the name of the Report Server Configuration Wizard installation executable.

-i console

Specifies that installation start in a UNIX console.

The installer starts.

Note: For a list of installation media names, see the Policy Server Release Notes.
For each prompt, use your completed Report Server configuration worksheet to enter the required values.
Note: Oracle is the only supported audit database for a Solaris Report Server. If you installed the Report Server to Solaris, you are not prompted for an audit database type. The Report Server Configuration Wizard automatically installs Oracle-specific report templates.
Review the installation settings and press Enter.
The report templates are installed.
Restart the Report Server.
The Report Server is configured to use the CA SiteMinder® report templates.

More information:

Locate the Installation Media

Installation Media Names

Increase the Job Server Service Timeout Value

Some of the Report Server services have a default timeout of 10 minutes. The Report Server can take longer than 10 minutes to generate large analysis reports.

Increase the timeout value of the Crystal Reports Job Server service to be sure that large analysis reports are successfully generated.

Increase the Timeout Value on Windows

Follow these steps:

Click Start, Programs, BusinessObjects XI Release 3.1, BusinessObjects Enterprise, Central Configuration Manager.
The Central Configuration Manager console appears.
Right-click Crystal Reports Job Server and select Stop.
The Crystal Reports Job Server service stops.
Right-click Crystal Reports Job Server and select Properties.
The Crystal Reports Job Server Properties dialog appears.
From the Properties tab, append the following entry to the end of the string in the Command field:
```
-requesttimeout 6000000
```
Note: The timeout value is measured in milliseconds. Specifying 6000000 increases the timeout value to one (1) hour.
Click OK.
The Central Configuration Manager appears.
Right-click Crystal Reports Job Server and select Start.
The Crystal Reports Job Server service starts.
Exit the Central Configuration Manager.
The timeout value for the Crystal Reports Job Server service is set to one (1) hour.

Increase the Timeout Value on UNIX

Follow these steps:

Navigate to report_server_home/CommonReporting3/bobje.

report_server_home

Specifies the Report Server installation path.
Open the ccm.config file, and append the following entry to the end of the value for reportjobserverLAUNCH key:
```
-requesttimeout 6000000
```
Note: The timeout value is measured in milliseconds. Specifying 6000000 increases the timeout value to one (1) hour.
Save and close the ccm.config file.
The timeout value for the Crystal Reports Job Server service is set to one (1) hour.

How to Register the Report Server

Registering the Report Server requires access to the Policy Server host system, the Report Server host system, and the Administrative UI host system. The registration process:

Establishes a trusted relationship between the Report Server and the Policy Server.
Establishes a trusted relationship between the Report Server and the Administrative UI.

Complete the following steps to register the Report Server:

Create the client name and passphrase.
Gather the registration information.
Register the Report Server with a Policy Server.
Restart the Report Server.
Configure the connection to the Administrative UI.

Create a Client Name and Passphrase

You run the XPSRegClient utility to create a client name and passphrase. A client name and passphrase are:

Values that the Policy Server uses to identify the Report Server you are registering
Values that you use with the XPSRegClient tool to register the Report Server with the Policy Server

To run the registration tool

Open a command–line window from the Policy Server host system.
Navigate to siteminder_home/bin.

siteminder_home

Specifies the Policy Server installation path.
Run the following command:
```
XPSRegClient client_name[:passphrase] -report -t timeout -r retries
-c comment -cp -l log_path -e error_path -vT -vI -vW -vE -vF
```
client_name

Identifies the name of Report Server you are registering.

Limit: The value must be unique. For example, if you have previously used reportserver1, enter reportserver2.

Note: Record this value. This value is required to complete registration process from the Report Server host system.

passphrase
Specifies the password required to complete the Report Server registration.

Limits: The passphrase
- Must contain at least six (6) characters.
- The passphrase cannot include an ampersand (&) or an asterisk (*).
- If the passphrase contains a space, it must be enclosed in quotation marks.
If you do not specify the passphrase in this step, XPSRegClient prompts you to enter and confirm it.

Note: Record this value. This value is required to complete registration process from the Report Server host system.
-report

Specifies that a Report Server is being registered.

-t timeout

(Optional) Specifies how long you have to complete the registration process from the Report Server host system. The Policy Server denies the registration request when the timeout value is reached.

Unit of measurement: minutes

Default: 240 (4 hours)

Minimum Limit: 1

Maximum Limit: 1440 (one day)

-r retries

(Optional) Specifies how many failed attempts are allowed when you complete the registration process from the Report Server host system. A failed attempt can result from submitting an incorrect passphrase to the Policy Server during the registration.

Default: 1

Maximum Limit: 5

-c comment

(Optional) Inserts the specified comments into the registration log file for informational purposes.

Note: Surround comments with quotes.

-cp

(Optional) Specifies that registration log file can contain multiple lines of comments. The registration tool prompts for multiple lines of comments and inserts the specified comments into the registration log file for informational purposes.

Note: Surround comment with quotes.

-l log path

(Optional) Specifies where the registration log file must be exported.

Default: siteminder_home\log, where siteminder_home is where the Policy Server is installed.

-e error path

(Optional) Sends exceptions to the specified path.

Default: stderr

-vT

(Optional) Sets the verbosity level to TRACE.

-vI

(Optional) Sets the verbosity level to INFO.

-vW

(Optional) Sets the verbosity level to WARNING.

-vE

(Optional) Sets the verbosity level to ERROR.

-vF

(Optional) Sets the verbosity level to FATAL.
The utility lists the name of the registration log file. If you did not provide a passphrase, the utility prompts for one.
Press Enter.
The registration tool creates the client name and passphrase.

You can now register the Report Server with the Policy Server. You complete the registration process from the Report Server host system.

Gather Registration Information

Completing the registration process between the Report Server and the Policy Server requires specific information. Gather the following information before running the XPSRegClient utility from the Report Server host system.

Client name—The client name you specified using the XPSRegClient tool.
Passphrase—The passphrase you specified using the XPSRegClient tool.
Policy Server host—The IP address or name of the Policy Server host system.

Register the Report Server with the Policy Server

You register the Report Server with the Policy Server to create a trusted relationship between both components. You configure the connection from the Report Server host system using the Report Server registration tool.

Follow these steps:

From the Report Server host system, open a command–line window and navigate to report_server_home\external\scripts.

report_server_home

Specifies the Report Server installation location.

Default: (Windows) C:\Program Files\CA\SC\CommonReporting3

Default: (UNIX) /opt/CA/SharedComponents/CommonReporting3
Run one of the following commands:
- (Windows)
```
regreportserver.bat -pshost host_name -client client_name -passphrase passphrase -psport portnum -fipsmode 0|1
```
  Important! Before running a CA SiteMinder® utility or executable on Windows Server 2008, open the command line window with administrator permissions. Open the command line window this way, even if your account has administrator privileges.
- (UNIX)
```
regreportserver.sh -pshost host_name -client client_name -passphrase passphrase -psport portnum -fipsmode 0|1
```
-pshost host name

Specifies the IP address or name of the Policy Server host system to which you are registering the Report Server.

-client client name

Specifies the client name. The client name identifies the Report Server instance that you are registering.

Note: This value must match the client name that you specified using the XPSRegClient utility when you registered the Report Server on the Policy Server host system.

Example: If you specified "reportserver1" when using the XPSRegClient utility, enter "reportserver1".

-passphrase passphrase

Specifies the passphrase that is paired with the client name. The client name identifies the Report Server instance that you are registering.

Note: This value must match the passphrase that you specified using the XPSRegClient utility when you registered the Report Server on the Policy Server host system.

Example: If you specified CA SiteMinder® when using the XPSRegClient utility, enter CA SiteMinder®.

-psport portnum

(optional) Specifies the port on which the Policy Server is listening for the registration request.

fipsmode
(optional) Specifies how the communication between the Report Server and the Policy Server is encrypted.

Default: 0
- Zero (0) specifies FIPS–compatibility mode.
- One (1) specifies FIPS–only mode.
Press Enter.
You receive a message stating that the registration is successful.

Restart the Report Server

(Windows) Follow these steps:

Click Start, Programs, BusinessObjects XI 3.1, BusinessObjects Enterprise, Central Configuration Manager.
The Central Configuration Manager console appears.
Stop the Apache Tomcat and Server Intelligence Agent Services.
The Report Server stops.
Start the Apache Tomcat and Server Intelligence Agent Services.
The Report Server is restarted.

(UNIX) Follow these steps:

Log in to the system as the non–root user that installed the Report Server.
Be sure that at least one of the following environment variables is set to a valid utf8/UTF-8 locale:
- LC_ALL
- LANG
- LC_CTYPE
Navigate to report_server_home/CommonReporting3/external/scripts and run the following command:
```
../setupenv.sh
```
report_server_home

Specifies the Report Server installation path.
Be sure that:
- The IAM_RPTSRV_HOME variable is set to report_server_home/CommonReporting3.
  report_server_home
  
  Specifies the Report Server installation path.
- (Oracle report database only) The LD_LIBRARY_PATH variable is set as follows:
```
$ORACLE_HOME/lib32:$ORACLE_HOME/lib:$LD_LIBRARY_PATH
```
  Example:
```
export LD_LIBRARY_PATH=$ORACLE_HOME/lib32:$ORACLE_HOME/lib:$LD_LIBRARY_PATH
```
Navigate to report_server_home/CommonReporting3/bobje and run the following command:
```
./stopservers
```
report_server_home

Specifies the Report Server installation path.
Run the following command:
```
./tomcatshutdown.sh
```
The Report Server stops.
Run the following command:
```
./startservers
```
Run the following command:
```
./tomcatstartup.sh
```
The Report Server is restarted.

Configure the Connection to the Administrative UI

You configure the Report Server and Administrative UI connection to configure a trusted relationship between both components. You configure the connection from the Administrative UI.

Note: The Administrative UI can have a trusted relationship with one or more Policy Servers. However, each trusted relationship only allows one Report Server connection. If you must connect to a new Report Server, either delete the current Report Server connection or connect to another Policy Server to configure the connection.

To configure the connection to the Administrative UI

Log into the Administrative UI.
Click Administration, Admin UI.
Click Report Connections, Create Report Server Connection.
The Create Report Server Connection pane appears.

Note: Click Help for descriptions of settings and controls, including their respective requirements and limits.
Type a connection name in the Connection Name field.
Type the Report Server host system name or IP address in the Report Server Host field.
Enter the Apache Tomcat connection port in the Tomcat Port field.
Note: This value is the web server port you entered when installing the Report Server.
Enter the administrator password in the respective fields.
Note: This value is the password you entered for the default BusinessObjects administrator account when installing the Report Server.
Click Submit.
The connection between the Report Server and the Administrative UI is configured.

You have completed installing and registering the Report Server. You can now run policy analysis reports.

Note: Creating and managing audit reports requires a separate audit database.

How to Configure an Audit Database

A CA SiteMinder® audit database is required to run CA SiteMinder® audit–based reports.

Note: Although you can write audit information to a text file, you must store your audit information in a supported ODBC database to create and manage audit-based reports. For a list of the supported versions, see the CA SiteMinder® 12.52 Platform Support Matrix.

Complete the following steps to configure an audit database:

(Optional) If you have not already done so, configure a CA SiteMinder® audit database.
Important! If you are configuring the audit database in Oracle, be sure that the user account you supply does not have the DB role. If the user account has the DB role, audit–based reports do not return correct results.
Register the audit database with the Administrative UI.
Configure connectivity between the audit database and the Report Server.

More information:

Locate the Platform Support Matrix

Register the Audit Database with the Administrative UI

You register the audit database with the Administrative UI to create a trusted connection between the components. Registering the audit database with the Administrative UI lets CA SiteMinder® administrators create and manage audit-based reports.

Note: The Administrative UI can have a trusted relationship with one or more Policy Servers. However, each trusted relationship only allows one audit database connection. If you must connect to a new audit database, either delete the current connection or connect to another Policy Server to configure the connection.

To register the audit database with the Administrative UI

Log in to the Administrative UI.
Click Administration, Admin UI.
Click Report Connections, Create Audit Report Connection.
The Create Audit Report Connection pane appears.

Note: Click Help for descriptions of settings and controls, including their respective requirements and limits.
Select the database vendor from the Database Vendor drop-down list.
The vendor-specific fields appear.
Type the name of the connection in the Connection Name field.
Enter the audit database host system name or IP address in the Database Server Host field.
Enter the audit database data source information in the DSN field:
- Oracle—Enter the Oracle Net Service name you specified when creating the audit database DSN.
  Note: The service name must be associated with the DSN you entered in the Data Tab of the Policy Server Management Console when configuring the audit database connection to the Policy Server. The service name must match the DSN you create on the Report Server.
- SQL Server—Enter the DSN.
  Note: The DSN name must match the DSN you specified in the Data Tab of the Policy Server Management Console when configuring the audit database connection to the Policy Server. The DSN name must also match the DSN you create on the Report Server.
Enter the port on which the audit database server is listening in the Database Server Port field.
Complete one of the following steps:
- Oracle—Re–enter the Oracle Net Service Name in the Service Name field.
- SQL Server—Enter the audit database name in the Database Name field.
Enter administrator credentials for the audit database in the respective fields.
Note: The administrator credentials must match the credentials that you specified in the Data tab of the Policy Server Management Console when configuring the audit database connection to the Policy Server.
Click Submit.
The audit database is registered with the Administrative UI.

Audit Database and Report Server Connectivity

A Report Server connects to a CA SiteMinder® audit database to create audit-based reports. When an audit-based report is scheduled in the Administrative UI, the Administrative UI passes the following connection information to the Report Server:

(Oracle) The Oracle Net Service Name that identifies the audit database
(Microsoft SQL Server) The name of the:
- Audit database
- Data source used to connect to audit database
The user account credentials required to access the audit database

To configure connectivity between the audit database and the Report Server, do one of the following:

(Oracle) Be sure that the:
- Oracle Net client is installed to the Report Server host system.
- Oracle Net Service Name that identifies the audit database is present in the tnsnames.ora file on the Report Server host system.
(Microsoft SQL Server) Be sure that the data source used to connect to the audit database is present on the Report Server host system.

Note: For more information about supported database drivers, see the 12.52 CA SiteMinder® Platform Support Matrix.

More information:

Locate the Platform Support Matrix

Start the Report Server

(Windows) Follow these steps:

Click Start, Programs, BusinessObjects XI 3.1, BusinessObjects Enterprise, Central Configuration Manager.
The Central Configuration Manager console appears.
Start the Apache Tomcat and Server Intelligence Agent Services.
The Report Server is started.

(UNIX) Follow these steps:

Log in to the system as the non–root user that installed the Report Server.
Be sure that at least one of the following environment variables is set to a valid utf8/UTF-8 locale:
- LC_ALL
- LANG
- LC_CTYPE
Navigate to report_server_home/CommonReporting3/external/scripts and run the following script:
```
../setupenv.sh
```
report_server_home

Specifies the Report Server installation path.
Be sure that:
- The IAM_RPTSRV_HOME variable is set to report_server_home/CommonReporting3.
  report_server_home
  
  Specifies the Report Server installation path.
- (Oracle report database only) The LD_LIBRARY_PATH variable is set to $ORACLE_HOME/lib32:$ORACLE_HOME/lib:$ETPKIHOME/lib:$LD_LIBRARY_PATH
  Example: export LD_LIBRARY_PATH=$ORACLE_HOME/lib32:$ORACLE_HOME/lib:$ETPKIHOME/lib:$LD_LIBRARY_PATH
- The ETPKIHOME variable is set to report_server_home/CommonReporting3.
  report_server_home
  
  Specifies the Report Server installation path.
Navigate to report_server_home/CommonReporting3/bobje

report_server_home

Specifies the Report Server installation path.
Run the following command:
```
./startservers
```
Run the following command:
```
./tomcatstartup.sh
```
The Report Server is started.

Stop the Report Server

(Windows) Follow these steps:

Click Start, Programs, BusinessObjects XI 3.1, BusinessObjects Enterprise, Central Configuration Manager.
The Central Configuration Manager console appears.
Stop the Apache Tomcat and Server Intelligence Agent Services.
The Report Server is stopped.

(UNIX) Follow these steps:

Log in to the system as the non–root user that installed the Report Server.
Be sure that at least one of the following environment variables is set to a valid utf8/UTF-8 locale:
- LC_ALL
- LANG
- LC_CTYPE
Navigate to report_server_home/CommonReporting3/external/scripts and run the following command:
```
../setupenv.sh
```
report_server_home

Specifies the Report Server installation path.
Be sure that:
- The IAM_RPTSRV_HOME variable is set to report_server_home/CommonReporting3.
  report_server_home
  
  Specifies the Report Server installation path.
- (Oracle report database only) The LD_LIBRARY_PATH variable is set to $ORACLE_HOME/lib32:$ORACLE_HOME/lib:$ETPKIHOME/lib:$LD_LIBRARY_PATH
  Example: export LD_LIBRARY_PATH=$ORACLE_HOME/lib32:$ORACLE_HOME/lib:$ETPKIHOME/lib:$LD_LIBRARY_PATH
- The ETPKIHOME variable is set to report_server_home/CommonReporting3.
  report_server_home
  
  Specifies the Report Server installation path.
Navigate to report_server_home/CommonReporting3/bobje.

report_server_home

Specifies the Report Server installation path.
Run the following command:
```
./stopservers
```
Run the following command:
```
./tomcatshutdown.sh
```
The Report Server is stopped.