11 Configuring Connections to External Systems

This chapter describes how to configure connections to systems that are external
to Oracle Business Intelligence.
This chapter includes the following sections:
Section 11.1, "Configuring Email and Agents"
Section 11.2, "Configuring for Actions with the Action Framework"
Section 11.3, "Configuring for Connections to the Marketing Content Server"
Section 11.4, "Configuring Connections to Data Sources"
Section 11.5, "Configuring for Integration with EPM Workspace"
Section 11.6, "Configuring Oracle Business Intelligence to Use Hyperion SSO Toke
ns when Communicating with Essbase, Hyperion Financial Management, and EPM Works
pace"
As part of the process of configuring connections to external systems, you can c
onfigure a database for the Oracle BI Scheduler. See "Configuring a Database for
the Oracle BI Scheduler" in Oracle Fusion Middleware Scheduling Jobs Guide for
Oracle Business Intelligence Enterprise Edition.
11.1 Configuring Email and Agents
You can use Fusion Middleware Control to configure common email settings that ar
e used by agents. Advanced configuration settings are described in Chapter 20, "
Configuring and Managing Agents."
11.1.1 Using Fusion Middleware Control to Configure Oracle BI Scheduler Email Se
ttings that Affect Agents
Before you begin this procedure, ensure that you are familiar with the informati
on in Section 3.2, "Using Fusion Middleware Control to Update Oracle Business In
telligence Configuration Settings."
To use Fusion Middleware Control to configure Oracle BI Scheduler email settings
that affect agents:
Go to the Business Intelligence Overview page, as described in Section 2.2.3, "U
sing Fusion Middleware Control to Manage Oracle Business Intelligence System Com
ponents."
Display the Mail tab of the Deployment page as appropriate.
Click Lock and Edit Configuration to enable changes to be made.
Complete the elements using the descriptions in the help topic for the page. Cli
ck the Help button on the page to access the page-level help for the following o
ptions:
SMTP Server
Port
Display name of sender
This option is used in the SMTP From field as a meaningful substitution for the
sender's address. The default is Oracle Business Intelligence.

Email address of sender

This option specifies the email address on the SMTP Server that is used as the s
ender's reply-to address for all mail sent from Oracle BI Scheduler. The initial
value is defaultuser@defaultmailserver.com, which you must change to reflect a
valid email address. Note that if you want to indicate that email recipients nee
d not reply, add no_reply@mycompany.com or do_not_reply@mycompany.com to this fi
eld.
Username
Password
Confirm password
Number of retries upon failure
Maximum recipients
Addressing method To, Blind Copy Recipient (Bcc)
Connection Security
Specify CA certificate source
CA certificate directory
CA certificate file
SSL certificate verification depth
SSL cipher list
Click Apply, then click Activate Changes.
Return to the Business Intelligence Overview page and click Restart.
See Chapter 20, "Configuring and Managing Agents" for information about advanced
configuring settings for agents.
For information about using methods in the Oracle BI Systems Management API to c
hange configuration settings, see Chapter 23, "Introducing the Oracle BI Systems
Management API."
11.2 Configuring for Actions with the Action Framework
Users can create actions in the Oracle BI Presentation Services user interface.
An action is an operation or process that can be invoked explicitly by a user cl
icking an action link. Actions can also be invoked automatically, as the final s
tep of an agent.
You can configure for the use of actions in your organization. For a comprehensi
ve discussion of how to use the Action Framework to enable actions for external
systems, including a complete description of each configuration setting and deta
iled examples, see Oracle Fusion Middleware Integrator's Guide for Oracle Busine
ss Intelligence Enterprise Edition.
11.3 Configuring for Connections to the Marketing Content Server
Oracle Marketing Segmentation handles segmentation, which involves dividing a ta
rget audience into different segments given different criteria based on the subj
ect areas. When a segment is ready, users create lists of the contacts and accou

nts that satisfy the criteria for the segment. Users then specify whether to sto
re the generated lists on the file system, in a database, or on a specified Cont
ent Server.
For users to store the lists on a Content Server, you as the administrator must
configure the connection to the Content Server by specifying the appropriate URL
and credentials. You use Fusion Middleware Control to make this specification.
You can also manually specify additional settings in the instanceconfig.xml file
.
You can configure for connections to the Marketing Content Server, as described
in the following sections:
Section 11.3.1, "Using Fusion Middleware Control to Configure the Connection to
the Marketing Content Server"
Section 11.3.2, "Manually Editing Settings for the Marketing Content Server Conn
ection"
11.3.1 Using Fusion Middleware Control to Configure the Connection to the Market
ing Content Server
Before you begin this procedure, ensure that you are familiar with the informati
on in Section 3.2, "Using Fusion Middleware Control to Update Oracle Business In
telligence Configuration Settings."
To use Fusion Middleware Control to configure the connection to the Marketing Co
ntent Server:
Go to the Business Intelligence Overview page, as described in Section 2.2.3, "U
sing Fusion Middleware Control to Manage Oracle Business Intelligence System Com
ponents."
Display the Marketing tab of the Deployment page.
Click Lock and Edit Configuration to enable changes to be made.
Complete the elements using the descriptions in the help topic for the page. Cli
ck the Help button on the page to access the page-level help for the following o
ptions:
URL option
Username option
Password option
Confirm Password option
Click Apply, then click Activate Changes to execute your changes and release the
lock to enable another system administrator to make changes
Return to the Business Intelligence Overview page and click Restart.
For information about using methods in the Oracle BI Systems Management API to c
onfigure the connection to the content server, see Chapter 23, "Introducing the
Oracle BI Systems Management API."
11.3.2 Manually Editing Settings for the Marketing Content Server Connection
Use various elements in the instanceconfig.xml file to change additional setting
s for the connection to the Marketing Content Server.
Before you begin this procedure, ensure that you are familiar with the informati
on in Section 3.4, "Using a Text Editor to Update Configuration Settings."

To manually edit additional settings for the Marketing Content Server connection
:
Open the instanceconfig.xml file for editing, as described in Section 3.6, "Wher
e Are Configuration Files Located?"
Locate the section in which you must add the elements that are described in the
following list:
SocketTimeoutSec: Specifies the number of seconds that the socket waits for the
Content Server to respond while transferring records. The default value is 60. T
here is no minimum or maximum value.
FileSizeMB: Specifies the size in megabytes of files that are generated during L
istGeneration and inserted into the Content Server. The default is 10. The minim
um size is 1MB and the maximum size is 50MB.
Include the elements and their ancestor elements as appropriate, as shown in the
following example:
<ServerInstance>
<MarketingContentServer>
<URL>myhost.com:6666/st1b2rep/idcplg</URL>
<SocketTimeoutSec>120</SocketTimeoutSec>
<FileSizeMB>5</FileSizeMB>
</MarketingContentServer>
</ServerInstance>
You do not specify values for user name and password in the instanceconfig.xml f
ile. Instead you specify values in Fusion Middleware Control that are stored sec
urely within the central credentials wallet, along with all other user names and
passwords.
Also, do not change the URL element. This value is centrally managed by Fusion M
iddleware Control.
Save your changes and close the file.
Restart Oracle Business Intelligence.
11.4 Configuring Connections to Data Sources
Connections to data sources are defined in the Oracle BI repository. Repository
developers use the Administration Tool to configure data source connections by i
mporting metadata and configuring connection pools. See "Importing Metadata and
Working with Data Sources" in Oracle Fusion Middleware Metadata Repository Build
er's Guide for Oracle Business Intelligence Enterprise Edition for more informat
ion.
You might need to update connection pool information in the repository during mi
grations to production and other environments. You can use the Oracle BI Server
XML API to automate these connection pool changes. See "Moving from Test to Prod
uction Environments" in Oracle Fusion Middleware XML Schema Reference for Oracle
Business Intelligence Enterprise Edition for more information.
11.5 Configuring for Integration with EPM Workspace
You can integrate Oracle Business Intelligence with Oracle Hyperion Enterprise P
erformance Management Workspace, after appropriate versions of the two component
s are installed. Oracle BI Publisher integrates with EPM Workspace when installe
d as part of the Oracle Business Intelligence Suite. BI Publisher cannot integra
te with EPM Workspace in standalone mode. As a result of this integration, users
can log into EPM Workspace and seamlessly use Oracle Business Intelligence and

BI Publisher without an additional login challenge.

You must perform configuration steps to enable the integration, as described in
this chapter. For information on using Oracle Business Intelligence within EPM W
orkspace, see the Oracle Hyperion Enterprise Performance Management Workspace do
cumentation in the Oracle Enterprise Performance Management System Release libra
ry at the following location:
http://docs.oracle.com/cd/E17236_01/index.htm
The following sections describe how to configure for the integration:
Section 11.5.1, "Step 1: Understanding the Prerequisites"
Section 11.5.2, "Step 2: Copying a JAR File"
Section 11.5.3, "Step 3: Registering Oracle Business Intelligence with EPM Works
pace"
Section 11.5.4, "Step 4: Adding Proxies"
Section 11.5.5, "Step 5: Configuring for Single Sign-On"
Section 11.5.6, "Step 6: Provisioning Users"
Notes:
If you used the Workspace integration with Oracle Business Intelligence Release
10g, then you can upgrade to Oracle Business Intelligence Release 11.1.1.7, but
the integration with EPM Workspace is not upgraded. You must reconfigure for the
integration using the procedures that are described in this chapter.
11.5.1 Step 1: Understanding the Prerequisites
Before configuring the integration, ensure that the following are true:
That you use the appropriate versions of Oracle Business Intelligence and EPM Wo
rkspace, as described in the system requirements and certification documentation
. For information, see Section 1.8, "System Requirements and Certification."
That you have installed and configured EPM Workspace according to Oracle Enterpr
ise Performance Management System Installation and Configuration Guide, which is
available from the Oracle Enterprise Performance Management System Release libr
ary.
That Oracle Business Intelligence and EPM Workspace have been configured to use
the same identity store. For information on identity stores, see the following s
ources:
Oracle Fusion Middleware Security Guide for Oracle Business Intelligence Enterpr
ise Edition
Oracle Enterprise Performance Management System Security Administration Guide
That you have imported the SSO_TOKEN key from the EPM Workspace instance to the
Oracle Business Intelligence instance. For information, see Section 11.6, "Confi
guring Oracle Business Intelligence to Use Hyperion SSO Tokens when Communicatin
g with Essbase, Hyperion Financial Management, and EPM Workspace."
That the src directory contains the EPM system reg.properties file and that the
ORACLE_HOME\instances\instance1\config\foundation\11.1.2.0 directory contains th
e reg.properties file for Oracle Business Intelligence. The src directory is sto
red in the regSyncUtil_OBIEE-TO-EPM.zip file. You unzip the file and copy the re
g.properties file from the EPM system.
11.5.2 Step 2: Copying a JAR File
You must copy and paste the INTEROP-SDK.JAR file from the EPM Workspace installa
tion to the Oracle Business Intelligence installation. The procedure varies depe
nding on whether you use EPM Workspace Release 11.1.2.3 or later or whether you
use earlier versions.

11.5.2.1 Copying the JAR File for Releases Earlier than EPM Workspace Release 11
.1.2.3
To copy the JAR file:
Change to the following directory in the Oracle Business Intelligence installati
on and make a backup copy of the INTEROP-SDK.JAR file:
ORACLE_BI1\common\SharedServices\11.1.2.0\lib
Copy the INTEROP-SDK.JAR file in the following directory of the EPM Workspace in
stallation.
ORACLE_HOME\Middleware\EPMSystem11R1\common\SharedServices\11.1.2.0\lib
Paste the INTEROP-SDK.JAR file from the EPM Workspace installation to overwrite
the version in the Oracle Business Intelligence installation.
11.5.2.2 Copying the JAR Files for EPM Workspace Release 11.1.2.3.00 or Later
Note:
This approach applies only when registering Oracle Business Intelligence with EP
M Workspace 11.1.2.3.00. It is incompatible with Essbase and associated componen
ts (release 11.1.2.2) that you install with Oracle Business Intelligence 11.1.1.
7.
To copy the JAR files:
Change to the following directory in the Oracle Business Intelligence installati
on and make a backup copy of the INTEROP-SDK.JAR file:
ORACLE_BI1\common\SharedServices\11.1.2.0\lib
Copy the INTEROP-SDK.JAR file in the following directory of the EPM Workspace in
stallation:
ORACLE_HOME\Middleware\EPMSystem11R1\common\SharedServices\11.1.2.0\lib
Paste the INTEROP-SDK.JAR file from the EPM Workspace installation to overwrite
the version in the Oracle Business Intelligence installation.
Change to the following directory in the Oracle Business Intelligence installati
on and make a backup copy of the css.JAR file:
ORACLE_BI1\common\CSS\11.1.2.0\lib
Copy the css.JAR file in the following directory of the EPM Workspace installati
on:
ORACLE_HOME\Middleware\EPMSystem11R1\ common\CSS\11.1.2.0\lib
Paste the css.JAR file from the EPM Workspace installation to overwrite the vers
ion in the Oracle Business Intelligence installation.
Change to the following directory and make a backup copy of the registry-api.jar
file:
ORACLE_HOME\Middleware\EPMSystem11R1\ common\jlib\11.1.2.0
Paste the registry-api.jar file from the EPM Workspace installation to overwrite
the version in the Oracle Business Intelligence installation.

ORACLE_BI1\common\jlib\11.1.2.0
To restore the Oracle Business Intelligence JAR files:
Change to the following directory in the Oracle Business Intelligence installati
on and copy the backed-up INTEROP-SDK.JAR file:
ORACLE_BI1\common\SharedServices\11.1.2.0\lib
Change to the following directory in the Oracle Business Intelligence installati
on and copy the backed-up css.JAR file:
ORACLE_BI1\common\CSS\11.1.2.0\lib
Change to the following directory and copy the backed-up registry-api.jar file:
ORACLE_HOME\Middleware\EPMSystem11R1\ common\jlib\11.1.2.0
11.5.3 Step 3: Registering Oracle Business Intelligence with EPM Workspace
You must register Oracle Business Intelligence with EPM Workspace. Before regist
ering, ensure that the following are true:
That the properties in the registration file are correct before you use any argu
ments. The register, view, and clean arguments require that the registration fil
e be populated with correct properties. Use the product and instance registratio
n files that ship with Oracle Business Intelligence.
That you have the database user name and password for the Hyperion installation
and the user name and password for Hyperion Shared Services. You must enter thes
e values during the registration process.
That you can write to the .properties, .product, and .instance files before edit
ing files and running the registration utility.
That the Oracle Home, the Oracle BI Home, and the Oracle BI Instance in the hype
rionregistry\HSSRegistration.bat file refer to the correct paths.
To register Oracle Business Intelligence with EPM Workspace:
Update the properties that are described in Table 11-1 in the Registration.prope
rties file in the ORACLE_BI_HOME/ bifoundation/web/bin/hyperionregistry/config d
irectory.
At the command prompt, change to the ORACLE_BI_HOME/ bifoundation/web/bin/hyperi
onregistry directory and run the HSSRegistration.bat or HSSRegistration.sh file
with the following arguments:
register
Registers Oracle Business Intelligence with both the Hyperion Installat
ion and Hyperion Shared Services.
view Lists the Oracle Business Intelligence registration information from both t
he Hyperion Installation and Hyperion Shared Services.
clean
Removes Oracle Business Intelligence registration information from both th
e Hyperion Installation and Hyperion Shared Services.
For example, to view the registration information, enter the following command:
HSSRegistration.bat view

Use the help argument for assistance in editing the Registration.properties file
.
Run EPM System Configuration to configure the web server for the EPM instance.
Note:
Do not register Oracle Business Intelligence from the EPM System Configuration,
because that can cause issues with the registration. Run only the web server con
figuration.
Stop and restart Foundation Services.
Use the administration console (interop) of Hyperion Shared Services to provisio
n users of Hyperion Shared Services to list application menus for Oracle Busines
s Intelligence.
Table 11-1 Properties for Registration
Property
BIEE.host

Value

Description

BI host name
Specifies the server on which the Oracle Business Intelligence web application i
s deployed and running.
BIEE.port
9704
Specifies the port on which the Oracle Business Intelligence web application is
deployed and running.
BIEE.ssl
false
Specifies whether Secure Socket Layer (SSL) is configured for Oracle Business In
telligence.
BIEE.appPath
analytics
Specifies the context path of the Oracle Business Intelligence web application.
BIEE.appServerType
WebLogic
Specifies the type of application server on which Oracle Business Intelligence i
s running.
BIP.integratedWithBIEE
true
Specifies whether BI Publisher is integrated with Oracle BI Enterprise Edition.

BIP.appPath
xmlpserver
Specifies the context path of BI Publisher.
HIT.jdbcUrl
jdbc:oracle:thin:host name:1521:orcl
Specifies the JDBC URL where the Hyperion Installation is configured. The databa
se name must be specified in the URL.
HIT.jdbcDriver
oracle.jdbc.OracleDriver
Specifies the JDBC driver for the Hyperion Installation.
Workspace.Host
Workspace host name
Specifies the server on which EPM Workspace is running.
Workspace.Port
19000
Specifies the port on which EPM Workspace is running.
HSS.HostName
HSS host name
Specifies the server on which Hyperion Shared Services is running.
HSS.Port
19000
Specifies the port on which Hyperion Shared Services is running.
11.5.4 Step 4: Adding Proxies
You must manually configure various proxies and contexts for use with Oracle Bus
iness Intelligence within EPM Workspace.
To add proxies for Oracle Business Intelligence in EPM Workspace:
Stop the EPM OHS Server.
On the computer on which EPM Workspace is installed, change to the following dir
ectory:
EPM_HOMEMiddleware\user_projects\epmsystem1\httpConfig\ohs\config\OHS\ohs_compon
ent
Open the httpd.conf file for editing and locate the following two proxy sections
for Presentation Services and BI Publisher near the end of the file, which were

inserted automatically as part of Step 3: Registering Oracle Business Intellige

nce with EPM Workspace.
ProxyPass /analytics http://host-name:port-num/analytics
ProxyPassReverse /analytics http://host-name:port-num/analytics
ProxyPass /xmlpserver http://host-name:port-num/xmlpserver
ProxyPassReverse /xmlpserver http://host-name:port-num/xmlpserver
Add the following lines for proxies after the lines for Presentation Services an
d BI Publisher:
//for the Oracle BI for Microsoft Office client
ProxyPass /biofficeclient http://BI-host-name:BI-port-num/biofficeclient
ProxyPassReverse /biofficeclient http://BI-host-name:BI-port-num/biofficeclient
//for the Download link
ProxyPass /bicontent http://BI-host-name:BI-port-num/ bicontent
ProxyPassReverse /bicontent http://BI-host-name:BI-port-num/ bicontent
//for BI Composer
ProxyPass /bicomposer http://BI-host-name:BI-port-num/bicomposer
ProxyPassReverse /bicomposer http://BI-host-name:BI-port-num/bicomposer
Save your changes and close the file.
Restart the EPM OHS Server.
11.5.5 Step 5: Configuring for Single Sign-On
You must configure Oracle Business Intelligence and EPM Workspace for Single Sig
n-On (SSO).
To configure SSO for the integration of Oracle Business Intelligence with EPM Wo
rkspace:
Follow the steps in Section 11.6.3, "Enabling Oracle Business Intelligence to Ac
cept a Hyperion SSO Token when Integrating Oracle Business Intelligence with EPM
Workspace".
Configure Oracle Business Intelligence to use an SSO provider of "Custom," as de
scribed in "Enabling SSO Authentication Using Fusion Middleware Control" in Orac
le Fusion Middleware Security Guide for Oracle Business Intelligence Enterprise
Edition
Edit the instanceconfig.xml file to add the HyperionCSS authentication schema by
performing these steps:
Open the instanceconfig.xml file for editing, as described in Section 3.6, "Wher
e Are Configuration Files Located?"
Locate the Authentication element and add "HyperionCSS" to the EnabledSchemas se
tting, as shown in the following example:
<ServerInstance>
<Authentication>
<EnabledSchemas>UidPwd,Impersonate,UidPwd-soap,Impersonate-soap,HyperionC
SS</EnabledSchemas>
</Authentication>
</ServerInstance>
Save your changes and close the file.
Edit the bridgeconfig.properties file to enable HyperionCSS authentication by pe

rforming these steps:

Open the file for editing from the following directory:
user_projects\domains\bifoundation_domain\config\fmwconfig\biinstances\coreappli
cation
In the file, edit the following mandatory properties:
oracle.bi.presentation.hyperioncssauthenticatorfilter.Enabled=true
oracle.bi.presentation.hyperioncssauthenticatorfilter.SetAuthSchema=true
In the file, edit the following optional property to specify the directory for s
toring log files. The default value is the Java temp directory.
oracle.bi.presentation.hyperioncssauthenticatorfilter.CssLogFolder = log_directo
ry
Save your changes and close the file.
Restart Oracle BI Presentation Services.
11.5.6 Step 6: Provisioning Users
Use the Hyperion Shared Services console to provision EPM System groups and role
s for each user. To provision roles, use Fusion Middleware Control, as described
in Oracle Fusion Middleware Security Guide for Oracle Business Intelligence Ent
erprise Edition.
11.6 Configuring Oracle Business Intelligence to Use Hyperion SSO Tokens when Co
mmunicating with Essbase, Hyperion Financial Management, and EPM Workspace
You can configure Oracle Business Intelligence to generate a Hyperion Single Sig
n-On (SSO) token when connecting to Essbase and Hyperion Financial Management (H
FM) data sources. The same functionality enables Oracle Business Intelligence to
accept a Hyperion SSO token for authenticating a user when Oracle Business Inte
lligence is integrated with EPM Workspace.
This section contains the following topics:
Section 11.6.1, "Prerequisites for Configuring to Use Tokens"
Section 11.6.2, "Enabling the Oracle BI Server to Generate a Hyperion SSO Token
when Connecting to Essbase or HFM"
Section 11.6.3, "Enabling Oracle Business Intelligence to Accept a Hyperion SSO
Token when Integrating Oracle Business Intelligence with EPM Workspace"
Section 11.6.4, "Common Steps for Enabling Oracle Business Intelligence to Gener
ate or Accept a Hyperion SSO Token"
11.6.1 Prerequisites for Configuring to Use Tokens
When following the procedures for configuring to use tokens, ensure that you hav
e met the following prerequisites:
This configuration involves storing a shared secret in Oracle Business Intellige
nce's version of the EPM Registry. Because only one shared secret can be stored,
if there is a requirement to use this mechanism against several different deplo
yments of the EPM system or Essbase, then all deployments must use the same shar
ed secret.
The users of Oracle Business Intelligence and the EPM system must use the same i

dentity store. This requirement means that Oracle Business Intelligence must be
configured to use the same identity store through security in Oracle Fusion Midd
leware as the Essbase or HFM data source is using through Hyperion Shared Servic
es.
11.6.2 Enabling the Oracle BI Server to Generate a Hyperion SSO Token when Conne
cting to Essbase or HFM
Before enabling to generate a token, see Section 11.6.1, "Prerequisites for Conf
iguring to Use Tokens."
When using Essbase or Hyperion Financial Management as a data source for the BI
Server, you can configure the BI Server to authenticate the end user against the
data source using a Hyperion Shared Services token rather than specifying a use
r name and password in the connection pool. This token enables data security to
be applied in the source system. You can achieve this application by configuring
the connection pool for SSO as described in this section. See Oracle Fusion Mid
dleware Metadata Repository Builder's Guide for Oracle Business Intelligence Ent
erprise Edition for complete information on connection pool options.
The configuration that is described in this section is independent of front-end
SSO configuration for authenticating into Oracle Business Intelligence. For exam
ple a user can log into Oracle Business Intelligence using a user name and passw
ord, or using a non-Hyperion SSO configuration such as Oracle Access Manager. In
these cases, you can configure the BI Server to generate a Hyperion SSO token w
hen a user connects to an Essbase or HFM data source.
Follow the steps in Section 11.6.4, "Common Steps for Enabling Oracle Business I
ntelligence to Generate or Accept a Hyperion SSO Token" to enable Oracle Busines
s Intelligence to generate a Hyperion SSO token that is accepted by a target Ess
base or HFM data source.
Note:
If you use Essbase installed with Oracle Business Intelligence, then you do not
need to perform the steps in Section 11.6.4, "Common Steps for Enabling Oracle B
usiness Intelligence to Generate or Accept a Hyperion SSO Token" to enable SSO f
or Essbase data sources installed using the Oracle Business Intelligence install
er. For Essbase data sources installed using the Oracle Business Intelligence in
staller, you must only select SSO in the data source connection pool.
After these steps are complete, you can select SSO in the General tab of the con
nection pool object that corresponds to the Essbase or Hyperion Financial Manage
ment data source in the repository for Oracle Business Intelligence. You can als
o select the Virtual Private Database option in the corresponding database objec
t to protect cache entries.
11.6.3 Enabling Oracle Business Intelligence to Accept a Hyperion SSO Token when
Integrating Oracle Business Intelligence with EPM Workspace
Before enabling to generate a token, see Section 11.6.1, "Prerequisites for Conf
iguring to Use Tokens."
When Oracle Business Intelligence is integrated with EPM Workspace, Oracle Busin
ess Intelligence is configured to accept a Hyperion Shared Services token as the
SSO mechanism. This configuration means that a user can navigate to Oracle Busi
ness Intelligence within EPM Workspace without being challenged to log into Orac
le Business Intelligence.
The steps required to integrate Oracle Business Intelligence into EPM Workspace
are described in Section 11.5, "Configuring for Integration with EPM Workspace."
One of the prerequisite steps in that section is to enable Oracle Business Inte
lligence to accept a Hyperion SSO token for authentication. The required configu

ration for this prerequisite step is described in Section 11.6.4, "Common Steps
for Enabling Oracle Business Intelligence to Generate or Accept a Hyperion SSO T
oken."
Once that configuration has been performed, you continue with the steps that are
described in Section 11.5, "Configuring for Integration with EPM Workspace."
11.6.4 Common Steps for Enabling Oracle Business Intelligence to Generate or Acc
ept a Hyperion SSO Token
The steps to configure Oracle Business Intelligence to generate or accept a Hype
rion SSO token when connecting to Essbase, HFM, and EPM Workspace are different,
depending on which release of Enterprise Performance Management you are using.
Refer to the certification matrix for Oracle Business Intelligence to verify tha
t the version of Oracle Business Intelligence that you are using is certified to
work with the version of Enterprise Performance Management with which you are i
ntegrating.
This section contains the following topics:
Section 11.6.4.1, "Enabling Oracle Business Intelligence to Generate or Accept a
Hyperion SSO Token when Connecting to Essbase, HFM, and EPM Workspace Release 1
1.1.2.1 or Later"
Section 11.6.4.2, "Enabling Oracle Business Intelligence to Generate a Hyperion
SSO Token when Connecting to Essbase and HFM Release 11.1.2.0 or Earlier"
11.6.4.1 Enabling Oracle Business Intelligence to Generate or Accept a Hyperion
SSO Token when Connecting to Essbase, HFM, and EPM Workspace Release 11.1.2.1 or
Later
Before enabling to generate or accept a token, see Section 11.6.1, "Prerequisite
s for Configuring to Use Tokens."
To configure Oracle Business Intelligence for shared token generation when conne
cting to Essbase and Hyperion Financial Management and to accept tokens when int
egrated into EPM Workspace Release 11.1.2.1 or later (installed with the EPM Sys
tem Installer), you first run the runRegSyncUtil utility, then you run an epmsys
_registry command.
To enable Oracle Business Intelligence to generate or accept a Hyperion SSO toke
n:
Locate the regSyncUtil_OBIEE-TO-EPM.zip file in the BI_ORACLE_HOME/common/CSS/11
.1.2.0 directory and extract it to the same location.
Copy the reg.properties file from the system where Essbase or Hyperion Financial
Management is installed:
EPM_ORACLE_INSTANCE/config/foundation/11.1.2.0
to the following location on the system where Oracle Business Intelligence is in
stalled:
BI_ORACLE_HOME/common/CSS/11.1.2.0/regSyncUtil/src
On Linux systems, make runRegSyncUtil.sh executable using the following command:
chmod +x runRegSyncUtil.sh
Open runRegSyncEditUtil.sh (or runRegSyncEditUtil.bat on Windows systems) for ed
iting. You can find the runRegSyncEditUtil file in the BI_ORACLE_HOME/common/CSS
/11.1.2.0/regSyncUtil directory.
In the file, update the ORACLE_HOME and ORACLE_INSTANCE environment variables as

appropriate for the given Oracle Business Intelligence environment. Note that O
RACLE_HOME should be equivalent to MW_HOME/Oracle_BI1 and ORACLE_INSTANCE should
be equivalent to MW_HOME/instances/instancen.
Save and close the file.
Run the utility. The following example shows how to run the utility on Linux:
BI_ORACLE_HOME/common/CSS/11.1.2.0/regSyncUtil/runRegSyncUtil.sh
Run the following epmsys_registry.sh command:
BI_ORACLE_INSTANCE/config/foundation/11.1.2.0/epmsys_registry.sh removeproperty
SHARED_SERVICES_PRODUCT/@applicationId
Restart the BI Domain, including the Administration and Managed Servers.
Restart all OPMN processes.
If the BI Domain has the "virtualize" property set to "true," then perform the f
ollowing steps to set a system property that enables the CSS to use the appropri
ate attribute for GUIDs:
In the MW_HOME/user_projects/domains/bifoundation_domain/bin directory, edit the
setDomainEnv.sh file on UNIX or .cmd on Windows using the syntax appropriate fo
r your operating system and shell.
Add a Java system property after the EXTRA_JAVA_PROPERTIES line, as shown in the
following example for the Windows platform:
When you integrate with EPM System Release 11.1.2.1, add the Java system propert
y as follows:
set JAVA_PROPERTIES=%JAVA_PROPERTIES% %EXTRA_JAVA_PROPERTIES%
set JAVA_PROPERTIES=%JAVA_PROPERTIES% -Didstore.identityAttribute=<name of the G
UID attribute used by the identity store>
When you integrate with EPM System Release 11.1.2.2 or later, add the Java syste
m property as follows:
set JAVA_PROPERTIES=%JAVA_PROPERTIES% %EXTRA_JAVA_PROPERTIES%
set JAVA_PROPERTIES=%JAVA_PROPERTIES% -Doracle.epm.css.identity.type=fusion
Restart the Oracle WebLogic Server Administration Server and Managed Servers.
After restarting the Managed Servers, confirm that the Java system property has
been applied by reviewing the standard out file (typically bi_server1.out or the
console) and looking for the Java system property that you have added.
When these steps are complete, you can select SSO in the data source connection
pool in the Oracle BI Repository to designate an SSO connection. In the case of
Workspace integration, you can continue to configure Oracle Business Intelligenc
e for SSO using the Hyperion SSO token.
11.6.4.2 Enabling Oracle Business Intelligence to Generate a Hyperion SSO Token
when Connecting to Essbase and HFM Release 11.1.2.0 or Earlier
Before enabling to generate or accept a token, see Section 11.6.1, "Prerequisite
s for Configuring to Use Tokens."
To configure Oracle Business Intelligence for shared token generation when conne
cting to Essbase and Hyperion Financial Management, you first run an epmsys_regi
stry command. Then you select SSO in the data source connection pool in the repo
sitory for Oracle Business Intelligence.

To configure SSO for Essbase and Hyperion Financial Management Release 11.1.2.0
or earlier:
Run the following command from the Oracle Business Intelligence environment:
BI_ORACLE_INSTANCE/config/foundation/11.1.2.0/epmsys_registry.sh/cmd
updateproperty SHARED_SERVICES_PRODUCT/@COMPATIBILITY 11120Select SSO in the data source connection pool in the Oracle BI Repository to des
ignate an SSO connection.
Select the Virtual Private Database option in the corresponding database object
to protect cache entries.
For more information, see "Creating a Database Object Manually in the Physical L
ayer" in Oracle Fusion Middleware Metadata Repository Builder's Guide for Oracle
Business Intelligence Enterprise Edition.
If the BI Domain has the "virtualize" property set to "true," then perform the f
ollowing steps to set a system property that enables the CSS to use the appropri
ate attribute for GUIDs:
In the MW_HOME/user_projects/domains/bifoundation_domain/bin directory, edit the
setDomainEnv.sh file on UNIX or .cmd on Windows using the syntax appropriate fo
r your operating system and shell.
Add a Java system property after the EXTRA_JAVA_PROPERTIES line, as shown in the
following example for the Windows platform:
When you integrate with EPM System Release 11.1.2.1 or earlier, add the Java sys
tem property as follows:
set JAVA_PROPERTIES=%JAVA_PROPERTIES% %EXTRA_JAVA_PROPERTIES%
set JAVA_PROPERTIES=%JAVA_PROPERTIES% -Didstore.identityAttribute=<name of the G
UID attribute used by the identity store>
Restart the Oracle WebLogic Server Administration Server and Managed Servers.
After restarting the Managed Servers, confirm that the Java system property has
been applied by reviewing the standard out file (typically bi_server1.out or the
console) and looking for the Java system property that you have added.