Installation and Upgrade Guides › Policy Server Installation Guide › Installing Reports › How to Register the Report Server

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:

1. Create the client name and passphrase.
2. Gather the registration information.
3. Register the Report Server with a Policy Server.
4. Restart the Report Server.
5. 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

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

   siteminder_home

   Specifies the Policy Server installation path.

3. 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.

4. 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:

1. 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

2. 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.

3. Press Enter.

   You receive a message stating that the registration is successful.

Restart the Report Server

(Windows) Follow these steps:

1. Click Start, Programs, BusinessObjects XI 3.1, BusinessObjects Enterprise, Central Configuration Manager.

   The Central Configuration Manager console appears.

2. Stop the Apache Tomcat and Server Intelligence Agent Services.

   The Report Server stops.

3. Start the Apache Tomcat and Server Intelligence Agent Services.

   The Report Server is restarted.

(UNIX) Follow these steps:

1. Log in to the system as the non–root user that installed the Report Server.
2. 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
3. Navigate to report_server_home/CommonReporting3/external/scripts and run the following command:

   ../setupenv.sh
   

   report_server_home

   Specifies the Report Server installation path.

4. 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
     

5. Navigate to report_server_home/CommonReporting3/bobje and run the following command:

   ./stopservers
   

   report_server_home

   Specifies the Report Server installation path.

6. Run the following command:

   ./tomcatshutdown.sh
   

   The Report Server stops.

7. Run the following command:

   ./startservers
   

8. 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

1. Log into the Administrative UI.
2. Click Administration, Admin UI.
3. 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.

4. Type a connection name in the Connection Name field.
5. Type the Report Server host system name or IP address in the Report Server Host field.
6. 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.

7. 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.

8. 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.