AST White Paper-EBS-OBIEE 11g Integration
AST White Paper-EBS-OBIEE 11g Integration
AST White Paper-EBS-OBIEE 11g Integration
1755 Park Street, Suite 100 | Naperville, Illinois 60563 | 1.888.278.0002 | www.astcorporation.com
Contents
ABSTRACT...............................................................................1
PURPOSE...............................................................................1
PREREQUISITESANDASSUMPTIONS.....................................1
EMBEDDINGLINKTONAVIGATE(EBSTOOBIEE).....................2
CREATEFUNCTION................................................................2
CREATEMENU.......................................................................4
ASSIGNMENUTOARESPONSIBILITY....................................5
ASSIGNRESPONSIBILITYTOUSERS.......................................7
SETTINGUPTHEPROFILE......................................................8
MODIFYINGTHEOBIEEREPOSITORYFILE(RPD)....................11
SETUPTHECONNECTIONPOOLS........................................11
SETUPTHEINITIALIZATIONBLOCK......................................11
MODIFYINGOBIEECONFIGURATIONFILES(XML)..................16
MODIFYAUTHENTICATIONSCHEMAS.XML.........................16
MODIFYINSTANCECONFIG.XML.........................................18
MODIFYACTIONFRAMEWORKCONFIG.XML.......................19
CREATINGAPPLICATIONROLES.............................................22
CREATEAPPLICATIONROLEINEM......................................22
ASSIGNACCESSTONEWAPPLICATIONROLE.....................24
ASSIGNPRIVILEGESTOCATALOG/SUBJECTAREAACCESS.....25
ASSIGNPRIVILEGESTODASHBOARDS&ANSWERS............25
ASSIGNPERMISSIONSTOCATALOGCOMPONENTS...........27
ASSIGNPERMISSIONSTOPRESENTATIONSUBJECTAREAS28
EMBEDDINGLINKTONAVIGATEBACK(OBIEETOEBS)..........31
ACTIONLINKTOEBSFORM.................................................31
PASSINGCONTEXTTOEBSFORMS.....................................31
SIGNOUTANDSIGNIN.......................................................33
TROUBLESHOOTING&TIPS...................................................35
COOKIEFORINTEGRATION.................................................35
VERIFYVARIABLEVALUESFORINTEGRATION....................35
CONNECTIONPOOLANDUSEOFVARIABLES.....................36
VERIFYAPPLICATIONROLESBEINGPASSES........................36
REFERENCES..........................................................................38
ORACLEDOCUMENTATION.................................................38
Oracle E-Business Suite -- Oracle Business Intelligence Enterprise Edition 11g Integration
Page i
Abstract
P URPOSE
What if you want to use users defined in your Oracle E-Business Suite for login and use Oracle Business
EE/BI Applications? They can login into EBS using their username/password and navigate to OBIEE so
they do not have to remember two usernames and passwords separately.
This document details the steps required to integrate Oracle BI Applications (7.9.6.3) with Oracle EBusiness Suite Applications R12.1.3 in the following ways:
Single Sign-On first into Oracle E-Business Suite R12.1.3 and have that authentication passed
through to Oracle BI EE 11g
Embed links to Oracle BI EE 11g dashboard/answers in Oracle E-Business Suite pages
Create Action Links within Oracle BI EE 11g reports and dashboards that take you back into Oracle
E-Business Suite in context
Activate Sign-Out Link within Oracle BI EE 11g that take you back into Sign-In page of your choice
(Oracle E-Business Suite or Oracle BI EE)
P REREQUISITESAND A SSUMPTIONS
This document is using instance with software versions. Integration steps for other versions may vary.
o
For Oracle EBS R12, there are no pre-requisite patches required since base R12 has all the
functionality that OBIEE leverages, namely the OBIEE profile is defined in b5869360.ldt,
OracleOasis.jsp and APP_SESSION package which are in base R12.
Please make backup of all files before making changes (i.e. repository, configuration files, catalog
etc.)
As an example:
o
We will create two responsibilities in EBS (OBIEE-Financials & OBIEE-Projects) and users will
have access to Financial Analytics or Project Analytics based on these responsibilities.
OBIEE-Financials: This application role will have access to only Finance Analytics (Dashboard
and Subject Areas)
OBIEE-Projects: This application role will have access to only Project Analytics (Dashboard and
Subject Areas)
Oracle E-Business Suite -- Oracle Business Intelligence Enterprise Edition 11g Integration
Page 1
EmbeddingLinktoNavigate(EBStoOBIEE)
To embed a link in Oracle E-Business Suite that opens Oracle Business Intelligence
dashboards/answers, you need to create a form functions, menu and responsibility.
Before you begin, log in to Oracle E-Business Suite as the system administrator. Then, select
the System Administrator responsibility from the responsibility navigator pane on the left.
The available menus appear on the right.
Follow the steps in this section to create the following objects, in sequence:
o
Function
Menu
Responsibility
User
Profile
Figure 1: Login to Oracle E-Business Suite
C REATE F UNCTION
From the Application menu, select Function. The Form Functions dialog appears.
Oracle E-Business Suite -- Oracle Business Intelligence Enterprise Edition 11g Integration
Page 2
Enter a description
Oracle E-Business Suite -- Oracle Business Intelligence Enterprise Edition 11g Integration
Page 3
C REATE M ENU
From the Application menu, select Menu. The Menus dialog appears.
Oracle E-Business Suite -- Oracle Business Intelligence Enterprise Edition 11g Integration
Page 4
For Function, enter the name of the function(s) created in the previous section (i.e.
OBIEE-DASBOARD and OBIEE-ANSWERS)
Save you changes using the Save button on the toolbar, and then close the Menus
dialog.
Oracle E-Business Suite -- Oracle Business Intelligence Enterprise Edition 11g Integration
Page 5
For Data Group, enter Standard for Name and re-enter the application name for
Application
For Menu, enter the name of the menu you created in the previous section (OBIEE)
Save you changes using the Save button on the toolbar, and then close the
responsibilities dialog.
Repeat same steps given above to create another responsibility name: OBIEEProjects
Oracle E-Business Suite -- Oracle Business Intelligence Enterprise Edition 11g Integration
Page 6
From the Security Menu, Click on User and then Select Define
Specify the responsibilities that this user will have access to. (OBIEE-Financials or
OBIEE-Projects)
Oracle E-Business Suite -- Oracle Business Intelligence Enterprise Edition 11g Integration
Page 7
Save you changes using the Save button on the toolbar, and then close the Users
dialog.
Select Responsibility and then enter the name of the responsibility which you created
earlier (OBIEE-Financials)
Oracle E-Business Suite -- Oracle Business Intelligence Enterprise Edition 11g Integration
Page 8
Click Find
On the resulting screen, specify the Oracle Business Intelligence URL. For example:
Oracle E-Business Suite -- Oracle Business Intelligence Enterprise Edition 11g Integration
Page 9
http://my_server.domain.com:port (http://otap1.lahd.pola:9704)
For port, enter the Web server port where Oracle Business Intelligence is running (for
example, 9704).
Repeat same steps given above for another responsibility name: OBIEE-Projects
Note: The BI URL should be the fully qualified hostname including the domain name. It shouldnt
be an IP Address.
Oracle E-Business Suite -- Oracle Business Intelligence Enterprise Edition 11g Integration
Page 10
ModifyingtheOBIEERepositoryFile(rpd)
You have to modify OBIEE repository file (rpd) for EBS-OBIEE integration. If you haved
implemented BI Application, all required variables, connections pools will already be there for
you. If not, you need to create them manually using this document as an example.
In physical layer, select the Oracle EBS OLTP Initblocks Connection Pool
On the Connection Scripts tab, the value of Execute on Connect property should be:
call/*valueof(NQ_SESSION.ACF)*/APP_SESSION.validate_icx_session(valueof(NQ_SESSION.ICX_SESSION_COOKIE))
Check whether the Initialization Block EBS Security Context exists or not.
If it exists, please skip steps (a) and (b) below, start with (c.) and verify that the settings for
this initialization block is similar to as mentioned here:
a. From the Action menu, select new and then select New, then Session and then
Initialization Block
b. Enter/Select the name of the initialization block EBS Security Context
c. If Initialization Block EBS Security Context is disabled, Right click on it and select
Enable.
d. For default Initalization string enter the following:
selectFND_GLOBAL.RESP_ID,
Oracle E-Business Suite -- Oracle Business Intelligence Enterprise Edition 11g Integration
Page 11
FND_GLOBAL.RESP_APPL_ID,
FND_GLOBAL.SECURITY_GROUP_ID,
FND_GLOBAL.RESP_NAME,
FND_GLOBAL.USER_ID,
FND_GLOBAL.EMPLOYEE_ID,
FND_GLOBAL.USER_NAME,
FND_GLOBAL.RESP_NAMEfromdual
e. For Connection Pool, Click Browse and select the Oracle EBS OLTP Initblocks
Connection Pool
f.
Clock Ok
IninitializationblockEBSSecurityContextClickonEditData
TargetDeleteexistingtargetvariableOLTP_EBS_USER
AddnewtargetvariableUSER
Oracle E-Business Suite -- Oracle Business Intelligence Enterprise Edition 11g Integration
Page 12
Similarly,createseesionvariableROLES
i.
Click ok
j.
k. Click on ok.
We already have Initialization Block EBS Security Context in repository. If this is disabled
by default, please select, right-click and Enable it.
Finally, Initialization block EBS Security Context should look like as given below.
Oracle E-Business Suite -- Oracle Business Intelligence Enterprise Edition 11g Integration
Page 14
Oracle E-Business Suite -- Oracle Business Intelligence Enterprise Edition 11g Integration
Page 15
ModifyingOBIEEConfigurationFiles(xml)
You need to modify few OBIEE configuration files to enable EBS OBIEE integration for user
security.
After making changes in all XML configuration files, Restart Oracle Business Intelligence
services.
M ODIFYAUTHENTICATIONSCHEMAS . XML
This file can be found on server at:
ORACLE_HOME/bifoundation/web/display
Example: /u01/oracle/prod/Oracle_BI1/bifoundation/web/display
Locate the sub-element RequestVariable source="cookie" and change the value of the
nameInSource attribute from ICX_SESSION to the name of the EBS ICX authentication
cookie prefix.
<RequestVariable source="cookie" type="auth" nameInSource="TEST"
biVariableName="NQ_SESSION.ICX_SESSION_COOKIE" />
Note: Ask your Oracle E-Business Suite administrator for the name of the EBS ICX
authentication cookie if you do not know it. Alternatively, follow these steps to find the cookie
name: Log in to Oracle E-Business Suite. Enter the following text in the address bar of your
browser:
javascript:write(document.cookie)
The cookie is displayed. For example: TEST=hEXoGr7ZPJW0ZDVE3gTU7YPM4d
The value you need to provide in authenticationschemas.xml is the prefix of the EBS ICX
authentication cookie. In the previous example, the EBS ICX authentication cookie is
TEST=hEXoGr7ZPJW0ZDVE3gTU7YPM4d, and the prefix is TEST.
In the same entry (RequestVariable source="cookie"), ensure that the value of the
biVariableName attribute is the same as the value you entered as part of the connection script
when you created the connection pool for the Oracle E-Business Suite database.
Find the following element: <SchemaKeyVariable source="cookie"
Change the value of the nameInSource attribute from ICX_SESSION to the name of the EBS
ICX authentication cookie prefix (i.e. TEST).
For example:
<SchemaKeyVariable source="cookie" nameInSource="TEST" forceValue="EBS-ICX"/>
Save and close the file.
Oracle E-Business Suite -- Oracle Business Intelligence Enterprise Edition 11g Integration
Page 16
Original XML:
<!-- Scheme for Oracle EBS Apps ICX session integration -->
<AuthenticationSchema name="EBS-ICX" displayName="Oracle
eBusiness Applications ICX Session" options="noLogoffUI
noLogonUI" >
<!-- Note: The name of the cookie here is site-dependent and needs
to be customized. -->
<!-- The URL parameter name is fixed and should not be changed.
-->
<RequestVariable source="cookie" type="auth"
nameInSource="ICX_SESSION"
biVariableName="NQ_SESSION.ICX_SESSION_COOKIE"/>
<RequestVariable source="url" type="informational"
nameInSource="ACF" biVariableName="NQ_SESSION.ACF"/>
</AuthenticationSchema>
Modified XML:
<!-- Scheme for Oracle EBS Apps ICX session integration -->
<AuthenticationSchema name="EBS-ICX" displayName="Oracle
eBusiness Applications ICX Session" options="noLogoffUI
noLogonUI" >
<!-- Note: The name of the cookie here is site-dependent and needs
to be customized. -->
<!-- The URL parameter name is fixed and should not be changed.
-->
<RequestVariable source="cookie" type="auth"
nameInSource="TEST"
biVariableName="NQ_SESSION.ICX_SESSION_COOKIE"/>
<RequestVariable source="url" type="informational"
nameInSource="ACF" biVariableName="NQ_SESSION.ACF"/>
</AuthenticationSchema>
Original XML:
<!-- Note: The name of the cookie here is site-dependent and needs
to be customized. -->
<SchemaKeyVariable source="cookie"
nameInSource="ICX_SESSION" forceValue="EBS-ICX"/>
Modified XML:
<!-- Note: The name of the cookie here is site-dependent and needs
to be customized. -->
Oracle E-Business Suite -- Oracle Business Intelligence Enterprise Edition 11g Integration
Page 17
M ODIFYINSTANCECONFIG . XML
This file can be found on server at:
ORACLE_INSTANCE/config/OracleBIPresentationServicesComponent/coreapplication_obipsn
Example:
/u01/oracle/prod/instances/obprod/config/OracleBIPresentationServicesComponent/coreapplicati
on_obips1
<EnabledSchemas>UidPwd,Impersonate,UidPwd-soap,Impersonate-soap,EBSICX</EnabledSchemas>
Ignore the comment in instanceconfig.xml that says this setting is centrally managed. EBSICX must be manually added to the EnabledSchemas element.
If you want to have Sign-Out link in OBIEE page (so you can log out from OBIEE and go
to any webpage of you choice, for example EBS login page); You need to perform the
following steps in order to get the Log out (Sign out) link displayed in OBIEE 11g.
Inside the <Authentication> section, add the following tag block <SchemaExtensions> as
given below:
<!AddingLogoutLink>
<SchemaExtensions>
<Schemaname="EBSICX"logonURL="{yourSSOlogonURL}"logoffURL="{your
logoffURL}"/>
</SchemaExtensions>
<!AddingLogoutLink>
As example, you may use the following log-off / log-on URL options:
EBS Homepage: http://<your EBS server:port>/OA_HTML/OA.jsp?OAFunc=OAHOMEPAGE
Analytics logoff: http://<your BI server:port>/analytics/saw.dll?Logoff
Analytics logon : http://<your BI server:port>/analytics/saw.dll?bieehome&startPage=1
Oracle E-Business Suite -- Oracle Business Intelligence Enterprise Edition 11g Integration
Page 18
Original XML:
<Authentication>
<!--This Configuration setting is managed by Oracle Business
Intelligence Enterprise Manager-->
<EnabledSchemas>UidPwd,Impersonate,UidPwd-soap,Impersonatesoap</EnabledSchemas>
</Authentication>
Modified XML:
<Authentication>
<!--This Configuration setting is managed by Oracle Business
Intelligence Enterprise Manager-->
<EnabledSchemas>UidPwd,Impersonate,UidPwd-soap,Impersonatesoap,EBS-ICX</EnabledSchemas>
<!--Adding Logout Link-->
<SchemaExtensions>
<Schema name="EBS-ICX"
logonURL="http://epap1.lahd.pola:8016"
logoffURL="http://epap1.lahd.pola:8016"/>
</SchemaExtensions>
<!--Adding Logout Link-->
</Authentication>
This change is needed when you create action link inside OBIEE to navigate back to Oracle EBS
form.
Original XML:
<obi-action-config xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance" xsi:noNamespaceSchemaLocation="afconfig.xsd">
<aliases/>
<registries/>
Oracle E-Business Suite -- Oracle Business Intelligence Enterprise Edition 11g Integration
Page 19
<content-types>
<content-type>
<typename>webservices</typename>
<displayname>Web Services and BPEL Processes</displayname>
<actionType>WebServiceActionType</actionType>
</content-type>
<content-type>
<typename>misc</typename>
<displayname>Mixed Services</displayname>
<actionType>URLActionType</actionType>
</content-type>
</content-types>
<accounts/>
</obi-action-config>
Modified XML:
<?xml version="1.0" encoding="UTF-8"?>
<obi-action-config xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance" xsi:noNamespaceSchemaLocation="afconfig.xsd">
<aliases/>
<registries/>
<content-types>
<content-type>
<typename>webservices</typename>
<displayname>Web Services and BPEL Processes</displayname>
<actionType>WebServiceActionType</actionType>
</content-type>
<content-type>
<typename>misc</typename>
<displayname>Mixed Services</displayname>
<actionType>URLActionType</actionType>
</content-type>
</content-types>
<accounts/>
Oracle E-Business Suite -- Oracle Business Intelligence Enterprise Edition 11g Integration
Page 20
<ebusinesssuiteconfig>
<visible>true</visible>
</ebusinesssuiteconfig>
</obi-action-config>
After making changes in all XML configuration files, Restart Oracle Business Intelligence
services.
Oracle E-Business Suite -- Oracle Business Intelligence Enterprise Edition 11g Integration
Page 21
CreatingApplicationRoles
You need to create an application role which must be same as responsibility name you created in
EBS (in this example, we created EBS responsibility OBIEE-Financials so we need to create
application role name OBIEE-Financials using Oracle Enterprise Manager 11g.
To access to subject areas and catalog, we can add this new application role to an eixisting
application role as a member (in this example, it will be member of BIAuthor) or we can use
these newly created application roles without using any other existing application roles. In this
example, we will use newly created application roles directly; without using any existing
application roles.
Click in Create
Click OK
Oracle E-Business Suite -- Oracle Business Intelligence Enterprise Edition 11g Integration
Page 22
Note: No need to assign members or users in these application role here in Enterprise
Manager.
NOTE: You Application Role name must be the same as the responsibility name you created in
EBS.
Oracle E-Business Suite -- Oracle Business Intelligence Enterprise Edition 11g Integration
Page 23
Search, move OBIEE application role name from left to right pane (Selected Roles), Click
OK
Click on OK
Now, newly created application role OBIEE is member of existing application role BIAuthor
(which already have privileges for subject areas and catalog)
Oracle E-Business Suite -- Oracle Business Intelligence Enterprise Edition 11g Integration
Page 24
AssignPrivilegestoCatalog/SubjectAreaAccess
We need to assign appropriate access to application role inside Dashboards Administration area
so users related to new responsibility can access catalog as per requirement.
Oracle E-Business Suite -- Oracle Business Intelligence Enterprise Edition 11g Integration
Page 25
Oracle E-Business Suite -- Oracle Business Intelligence Enterprise Edition 11g Integration
Page 26
Oracle E-Business Suite -- Oracle Business Intelligence Enterprise Edition 11g Integration
Page 27
Select OK
Note: For all shared folders which you do not want to show for any users, Select No Access for
Authenticated User.
A SSIGNPERMISSIONSTOPRESENTATIONSUBJECTAREAS
In repositorys presentation subject area, you need to assign permissions to newly created
application role (i.e. OBIEE-Financials, OBIEE-Projects).
Check permission property tab for all related subject areas (in presentation layer) and make
appropriate changes for appropriate application role. i.e. select Read, Read/Write, No Access
radio buttons etc
Using BI Administration desktop tool, open repository in ONLINE mode.
Oracle E-Business Suite -- Oracle Business Intelligence Enterprise Edition 11g Integration
Page 28
In presentation layer, repeat following to all subject areas where you want to assign
permissions to newly created Application Role.
Select Read or Read/Write radio button for newly created application roles as per your
requirement.
Click OK
AssignappropriatepermissionstoallsubjectareasrelatedtoFinancialAnalytics.(forOBIEE
Financialsrole)
Oracle E-Business Suite -- Oracle Business Intelligence Enterprise Edition 11g Integration
Page 29
Assign appropriate permissions to all subject areas related to Project Analytics. (for OBIEEProjects role)
NOTE: You are assigning these permissions in ONLINE mode so you may need to check and
validate them again whenever you are deploying repository file.
Oracle E-Business Suite -- Oracle Business Intelligence Enterprise Edition 11g Integration
Page 30
EmbeddingLinktoNavigateBack(OBIEEtoEBS)
You can choose few options when you want to navigate back to EBS from OBIEE. In this
document, we will discuss 2 options (a) Navigate back to Oracle EBS form using Action Link (b)
Sign-Out from OBIEE and show any login web page of our choice (example, EBS login page or BI
Analytics login page).
Create a new Action which will enable OBIEE to call the e-Business Suite Target form.
Oracle E-Business Suite -- Oracle Business Intelligence Enterprise Edition 11g Integration
Page 31
In the resultant screen, two mandatory parameters, FunctionCode and Connection pool need to
be specified. For FunctionCode, Specify the function code of the target form which need to be
launched. Also, Specify the connection pool (mentioned under section rpd changes ). In addition
to these two mandatory parameters, create new parameters which has the same name as the
identified parameter (Identified in Step 1) and specify a value.
For better user experience, Mark the FunctionCode and ConnectionPool parameters as
Hidden.
Save the Action
Navigate to location where the Action is saved and Click on Execute to test the Action
documentation. Steps below provides a simple example on how to use Action Link in Analysis:
Navigate to New->Analysis
Select a Subject Area and then select a column on which the Action Link is to be set as an
Interaction
Click on + icon and Specify the Action Link (which was created in earlier step).
Specify parameters if a dialog box for parameters is prompted. Set the value to be based on
Column. Check the Hidden Checkbox. Click on ok.
Login to e-Business Suite. Click on the OBIEE Answers link to navigate to OBIEE
<Authentication>
<EnabledSchemas>UidPwd,Impersonate,UidPwd-soap,Impersonatesoap</EnabledSchemas>
Oracle E-Business Suite -- Oracle Business Intelligence Enterprise Edition 11g Integration
Page 34
Troubleshooting&Tips
C OOKIEFOR I NTEGRATION
How to get cookies value which is being used for EBS-OBIEE integration?
a. Log in to Oracle E-Business Suite. Enter the one of following text in the address bar of your
browser:
o
javascript:alert(document.cookie),
javascript:document.write(document.cookie)
javascript:document.writeLn(document.cookie);
Oracle E-Business Suite -- Oracle Business Intelligence Enterprise Edition 11g Integration
Page 35
When you come to BI Abalytics home page, click your username (top-right corner of screen)
Click on My Account
Oracle E-Business Suite -- Oracle Business Intelligence Enterprise Edition 11g Integration
Page 36
Oracle E-Business Suite -- Oracle Business Intelligence Enterprise Edition 11g Integration
Page 37
References
O RACLE D OCUMENTATION
Please refer to Chapter 2 from document below: (2 Integrating Security for Oracle BI
Applications)
http://download.oracle.com/docs/cd/E20490_01/bia.7963/e19042/security.htm#CJADEAEH
Please refer to Chapter 6 from document below: (6 Integrating with Oracle E-Business Suite
Security)
http://docs.oracle.com/cd/E21764_01/bi.1111/e16364/ebs_actions.htm#CJADIFBA
Oracle E-Business Suite -- Oracle Business Intelligence Enterprise Edition 11g Integration
Page 38