SampleApp Deploy Instructions 825
SampleApp Deploy Instructions 825
Deployment Instructions
Build 825
Table of Contents
1 Prerequisites ..................................................................................................................... 4
1.1 OBIEE Release Version ............................................................................................... 4
1.2 Oracle Database Connection ....................................................................................... 4
1.3 FAQ / Known Issues..................................................................................................... 4
2 Deploying SampleApp Core (Required).......................................................................... 5
2.1 Copying Files into Appropriate Locations ................................................................. 5
2.2 Creating Main SampleApp Oracle Data source .......................................................... 6
2.3 Deploying Weblogic Server Users and Custom Apps ............................................... 7
2.4 OBIEE Configuration Edits and Starting .................................................................. 14
2.5 Deploying SampleApp BIP Content .......................................................................... 20
3 Deploying SampleApp Action Framework Content (Optional) ................................... 22
3.1 Prerequisites .............................................................................................................. 22
3.2 Deploying ActionSamples.ear ................................................................................... 22
3.3 Adding Required Credentials .................................................................................... 24
3.4 Configuring OBI EE Actions Framework files .......................................................... 25
3.5 Restarting services and Verifying the install ........................................................... 25
4 Deploying SampleApp Essbase Content (Optional) .................................................... 26
4.1 Prerequisites .............................................................................................................. 26
4.2 Creating Essbase Data source .................................................................................. 26
4.3 Configuration Edits and Server Starting .................................................................. 27
5 Deploying SampleApp ORCL OLAP Content (Optional) ............................................. 29
5.1 Prerequisites .............................................................................................................. 29
5.2 Creating the OLAP Data source ................................................................................ 29
5.3 RPD Edits.................................................................................................................... 30
6 Deploying SampleApp Mapviewer Content (Optional) ................................................ 31
6.1 Prerequisites .............................................................................................................. 31
6.2 Creating the Mapviewer Navteq Data source ........................................................... 31
6.3 Configuration Edits and Server Starting .................................................................. 32
7 Deploying SampleApp 3NF Content, (FOD, Optional) ................................................. 36
7.1 Prerequisites .............................................................................................................. 36
This SampleApp build has been developed using Oracle Business Intelligence, v. 11.1.1.3.0
available for download on Oracle Technology Network.
It is required that you have a connection to an 11g Oracle database from the machine where your BIEE platform is
installed.
Note : you may run SampleApp using an Express version of Oracle Db, but in that case
- You may not import Navteq dump data and activate Geographical mapping, Datamining and OLAP options
of Samples from this database.
- You will need to update Physical Database Type to Oracle 10g XE in the physical layer of all oracle
databases entries in the RPD.
Please download the OBIEE 11g SampleApp FAQ / Known Issues document from this url
http://www.oracle.com/technetwork/middleware/bi-foundation/obiee-samples-167534.html
to obtain the latest information about Frequently Asked Questions and Known issues on OBIEE 11g SampleApp
deployment.
This paragraph describes how to deploy the SampleApp Core content. This content deployment is the base for any
of SampleApp functionality to work, it is NOT an option.
From your SampleApp install folder, navigate to subfolder 2_SampleApp_XXXX_Core. This folder contains all the
necessary files for deploying SampleApp Core content.
2.1.1 Webcat :
Copy both files SampleApp_webcat1.zip and SampleApp_webcat2.zip to subfolder and all unzip them there:
\InstallHome\instances\instance1\bifoundation\OracleBIPresentationServicesComponent\coreapplication_obips1\catalog
2.1.4.1 Userpref_currencies.xml :
Copy the Userpref_currencies.xml file into the directory in your BIEE install (override existing file if any) :
\InstallHome\instances\instance1\config\OracleBIPresentationServicesComponent\coreapplication_obips1
FYI, this file contains currency code setup examples for SampleApp currency showing reports
It is required that you have a connection to an 11g Oracle database from the machine where your BIEE platform is
installed. You need to create the SampleApp data source schema within that database, and populate with sample
data. To do so, perform the following steps :
IMPORTANT Note :
The BISAMPLE user creation script defaults with the password „BISAMPLE‟ (same as user name) within the script.
It is recommended that you keep this value unchanged, to simplify configuration. Should you change this password
to something different, be aware that you will need to edit following configurations :
RPD connection pools password value (for respective Connection Pools impacted) need to be
updated with the correct password value
In webcat, some objects of type Action (example „Annotate‟ action) contains the connection
information to the database in its setups, including hardcoded password value. This needs to be
updated as well.
You will be prompted with your Administrator credentials created during platform install. Bringing up this service
may take a few minutes depending on your environment, wait until the command line stops scrolling and indicates
server is up. Keep this command window up to keep server up.
In the next screen, choose the default option „Install this deployment as an application‟ and click
Next.
In the next screen, under the Source Accessibility section, choose „I will make the deployment
accessible from the following location’.
Click Finish.
In the deployment screen, confirm that the new application called analyticsRes is now available.
In the 'Import Directory on Server', point to the directory where you saved the SampleApp Install
files and navigate to the FMW_Users_Definition subdirectory within that.
For eg:- /scratch/laliv/2_SampleApp_715_Install_Core/FMW_Users_Definition.
Click on Save.
Verify that you can see the new users like abell, etc created now. You should be able to login using any of these
users in OBIEE.
The list of users in this build is listed in the table below. Passwords for all SampleApp users imported, as well as
the RPD encryption password is uniquely set to : Admin123
2.4.1.1 USER_REF_GUIDS
Make sure the following tag (in green) is set as shown below in your NQConfig file and save it :
->[SERVER]
...
FMW_UPDATE_ROLE_AND_USER_REF_GUIDS = YES;
->[USAGE_TRACKING]
ENABLE = YES;
...
DIRECT_INSERT = YES;
PHYSICAL_TABLE_NAME = "XX - System DB (ORCL)"."Catalog"."dbo"."S_NQ_ACCT";
CONNECTION_POOL = "XX - System DB (ORCL)"."UT Connection Pool";
IMPORTANT Note :
Replace XX - System DB (ORCL) with the database name in your rpd that connects to your system DB.
Eg:-“09 - System DB (ORCL)"."Catalog"."dbo"."S_NQ_ACCT";
<ServerInstance>
...
<SpatialMaps><LayerDataLayout><MaxRecords>1000</MaxRecords></LayerDataLayout></SpatialMaps>
<LightWriteback>true</LightWriteback>
...
IMPORTANT Note :
Always open Admintool by opening the Start program menu, and navigating on to the menu icon within the Oracle
Business Intelligence menu.
Do NOT open the RPD simply double click on the RPD file or typing Admintool.exe in command line
Open Admintool then open the SampleApp.RPD file offline from your installer location :
RPD Password for opening offline : Admin123
DB_HOST - This variable holds the value of the database host machine.
DB_PORT - This variable holds the value of the port.
DB_SID - This variable holds the SID information.
DB_USERNAME - This variable holds the database username. (Must be BISAMPLE)
Run a consistency check of your RPD. Incase you see errors or warnings coming up, please
process previous steps again starting from the original RPD.
Incase you see these warnings messages coming up when doing consistency check :
[39028] The features in Database '02 - Sample App Xml Data' do not match the defaults. This can cause query
problems.
You must fix each of these warnings by double clicking on each database icon in the physical layer, navigate to
Features tab, and click the bottom button „Reset to Defaults‟. This must be done for each database that has the
warning message.
Save your offline RPD.
UPDATE - BI_EE_HOME_PATH
Look for this entry and update it to the correct path on your BIEE install machine. After you make this update, the
entry would look something like this on a windows setup
<Expr><![CDATA['C:\BISHIPHOME\instances\instance1\bifoundation\OracleBIServerComponent\coreapplication_
obis1']]></Expr>
On a Linux setup, an example entry would be
<Expr><![CDATA['/scratch/laliv/obi11g/instances/instance1/bifoundation/OracleBIServerComponent/coreapplicatio
n_obis1 ']]></Expr>
UPDATE - DB_PORT_VALUE
Look for this entry and update it to the database port. After you make this update, the entry would look something
like this.
<Expr><![CDATA['1521']]></Expr>
UPDATE - DB_HOST_VALUE
Look for this entry and update it to the database host machine. After you make this update, the entry would look
something like this.
<Expr><![CDATA['dadvmc0062.us.oracle.com']]></Expr>
UPDATE - DB_SID_VALUE
Look for this entry and update it to the database SID. After you make this update, the entry would look something
like this.
<Expr><![CDATA['ORCL']]></Expr>
UPDATE - DB_USERNAME_VALUE
Look for this entry and update the value of the database username. (Value must be BISAMPLE).
<Expr><![CDATA['BISAMPLE']]></Expr>
UPDATE - ESSB_HOST_VALUE
NOTE:- This variable is only needed if you install the optional SampleApp Essbase content .
Look for this entry and update it to the Essbase host machine. After you make this update, the entry would look
something like this.
<Expr><![CDATA['dadvmc0062.us.oracle.com']]></Expr>
Once this is executed successfully, the output rpd (SampleApp.rpd) will have the variable values
that you provided in the XML patch file. Set this as the default rpd using the steps described in
2.4.3.1
Now click on the Deployment tab on the right. Next, go to the Repository tab.
In the 'Upload BI Server Repository' section, click on the Browse button and locate the
SampleApp.rpd that you updated with correct connection information, on your client machine.
Enter Admin123 as the password ( this is the offline password for SampleApp.rpd)
Note :
If starting using EM is not successful and complaining about OPMNCTL not up, please follow starting process with
OPMNCTL
The BI Publisher Samples depend on a few data sources. Some of these are set up as part of the installation.
Others will require manual configuration through the BI Publisher Admin pages. We will cover all here.
Data Sources
JDBC Connection
JNDI Connection
File
LDAP Connection
OLAP Connection
Inspect the File data source “demofiles”. From the operating system see that there are .xml demo files present in
the directory
For users to be able to see data when they run BIP reports, the BI Author & BI Consumer roles must be granted
access to data sources.
Under Administration URL in OBIEE web interface, click on „Manage BI Publisher‟ link
Then click on the link „Security Center‟ and select Roles and Permissions.
In the Add Data Sources column, click the “key” icon for the BI Author role.
Under Database Connections, add the BISAMPLE, Oracle BIEE, & demo data sources to the
Allowed Data Sources list.
Under File Directories, add demo files to the Allowed Data Sources list.
Click Apply.
Repeat steps 2 – 5 to grand access to the BI Consumer role to the data sources BISAMPLE,
Oracle BIEE, demo, & demo files.
This paragraph describes how to deploy Action Framework SampleApp content with BIEE services.
From your SampleApp install folder, navigate to subfolder 3_SampleApp_XXXX_Actions. This folder contains all
the necessary files for deploying SampleApp Core content.
3.1 Prerequisites
All the steps to deploy SampleApp Core content successfully completed. IN PARTICULAR : IT IS REQUIRED
THAT YOU HAVE PROPERLY IMPORTED FMW_Users_Definition as part of the Sample App core install
process. Make sure you have completed this step as described in the paragraph 2.3.3 of this document. To
validate that this setup is properly active, you should be able to login in Answers with credentials abell/Admin123.
Click on Next. The next screen lets you Choose the targeting style. Choose the default option
'Install this deployment as an application' and click on Next.
In the 'Select Deployment targets' screen that shows up next, choose 'bi_cluster' and 'All servers
in the cluster' option. Click Next.
In the Optional Settings screen, enter ActionSamples in the Name field. For the remaining options,
go with the default selections. and click Next.
In the final screen, click on Finish.
When you see the Overview page for the Actionsamples, click on Activate Changes button under
Change Center on the left.
Now click on the Deployments link. In the Deployments page, confirm that you can see the entry
for ActionSamples that you just created. Choose ActionSamples, click on Start->Servicing All
Requests option.
NOTE:
If the CreateCredentials.py is not in the directory current directory, then provide the full path to the file.
Replace username and password with you OBIEE install login username and password.
If the credentials already exist on your setup, then the above command will fail with an error message that the
credential already exists.
Once the script executes successfully, it should create the required credentials. To confirm, log into EM at
http://localhost:7001/em.
Expand the tree menu on the left to show items under Weblogic domain, then right click on the on the
bifoundation_domain, select the Security menu from the choices, then select Credentials
In the credential store config screen, confirm that you have the following entries created.
ActionFrameworkConfig.xml
ActionsSAMLPolicy.xml
wss_username_token_policy.xml
into: /InstallHome/user_projects/domains/bifoundation_domain/config/fmwconfig/biinstances/coreapplication
default-keystore.jks
into: /InstallHome/user_projects/domains/bifoundation_domain/config/fmwconfig
Restart the ActionSamples managed service from the WLS deployments page.
Restart bi_server1 Managed Server (bi_cluster) from the WLS deployments page.
Restart OBIEEservers via OPMNCTL or via EM
Login to analytics. Go to the catalog, 4. Actionable Intelligence and Actions folder within that.
Execute any of the action saved in the folders by providing the appropriate input values.
This paragraph describes how to deploy the SampleApp Oracle OLAP content. This deployment is optional and
comes in addition to SampleApp Core deployment.
From your SampleApp install folder, navigate to subfolder 4_SampleApp_XXXX_ESSBASE. This folder contains
all the necessary files for deploying SampleApp ESSBASE content
4.1 Prerequisites
NOTE : to have full features of OBIEE integration with Essbase working, you need to run Talleyrand version of
Essbase server, or. If you do run earlier Essbase server release, you need to apply appropriate Essbase patch to
fix integration bugs, otherwise not all BIEE features will work. Refer to OBIEE/ Essbase SRSP for more details, or
contact PM for more details.
NOTE : the steps below assume that you have access to admintool to process config edits. Incase you have no
admintool access, you can refer to step 2.4.3.2 in the doc to edit via xml api.
Open RPD (pwd = Admin123) on your Sample install, double click on logical Business Model '2 -
Essbase Sample' and untick the 'Disabled' tick-mark. Do the same for Business Model '3 - Sample
Federated'
On the RPD, navigate to Manage > Variables and update the value of
- RPD variable ESSB_HOST with the name of your essbase server host
- Session variable ESSB_CUBE with the name of your essbase Cube (BISAMPLE)
On the RPD, in the physical layer, edit the connection pool „Sample Essbase Connection 1‟ under
„03 - Essbase Sample E1‟. Update the username and password to appropriate values to connect
to your essbase server. Repeat the step for the connection pool under „04 - Essbase Sample E2
(Default Import)‟.
This paragraph describes how to deploy the SampleApp Oracle OLAP content. This deployment is optional and
comes in addition to SampleApp Core deployment.
From your SampleApp install folder, navigate to subfolder 5_SampleApp_XXXX_OLAP. This folder contains all the
necessary files for deploying SampleApp OLAP content.
5.1 Prerequisites
All the steps to deploy SampleApp Core content successfully completed. IN PARTICULAR,
BISAMPLE schema needs to be created and populated.
FMW_Users_Definition import completed. Make sure you have completed this step as described in the paragraph
2.3.6 of this document. To validate that this setup is properly active, you should be able to login in Answers with
credentials marty/Admin123.
IMPORTANT Note :
Only the FMW imported login marty/Admin123 has OLAP specific security settings setup in the rpd. This is
necessary for the correct functioning of objects within the " Sample OLAP" Subject Area.
Do not use any other login on this subject area. Running OLAP Subject Area queries with other users than
marty/Admin123 will result extremely poor performance and wrong results.
This deployment needs to be executed on the same BISAMPLE schema where the core tables are installed. The
relational tables and olap cube CANNOT exist on two separate databases.
NOTES: This add-on has only been tested on Oracle DB versions 11.1.0.7.0 and 11.2.0.1.0
Confirm that all the OLAP content files are present within a single directory. Open a command
window from this directory and connect to the oracle database with BISAMPLE/BISAMPLE user.
Run the script 1_source_views.sql located in this directory.
Run the script 2_create_bisample_cubes.sql. The program creates the OLAP cubes in the
BISAMPLE user. Confirm that the program gives the "Installation complete" message at the end.
Confirm that OLAP was successfully created :
If you have access to Analytic Workspace Manager :
Use Analytic Workspace Manager, connect to BISAMPLE user, view OLAPSAMPLE analytic
workspace.
Confirm that the two cubes OLAP_BUDGET_CUBE and OLAP_REV_CUBE are created and
loaded.
If you do not have Analytic Workspace Manager installed,
Open RPD (pwd = Admin123) on your Sample install, double click on logical Business Model '4 - Olap Sample' and
untick the 'Disabled' tickmark.
This paragraph describes how to deploy the SampleApp Oracle Mapviewer content. This deployment is optional
and comes in addition to SampleApp Core deployment.
From your SampleApp install folder, navigate to subfolder 6_SampleApp_XXXX_MAPVIEWER. This folder some
of the necessary files for deploying SampleApp Mapviewer content
6.1 Prerequisites
You must have a connection to an 11g Oracle database from the machine where your BIEE platform is installed.
You will need to create a Navteq schema within that database for holding the NAVTEQ spatial data. To do so,
perform the following steps :
IMPORTANT Note :
The OBIEE_NAVTEQ user creation script defaults with the password „obiee_navteq‟ (same as user name) within
the script. It is recommended that you keep this value unchanged to simplify configuration.
Confirm that WLS server and WLS managed servers are up and running, and make sure OMPNCTL is not running
(neither OBIS nor OBIPS are running).
6.3.1.1 <security_config>
In the <security_config> property of this file, make the following changes:
Change the <proxy_enabled_hosts> property to the following : Substitute the hostname, IP address and port to the
correct values on your setup.
<proxy_enabled_hosts>
http://dadvmc0508.us.oracle.com:9704/mapviewer,http://dadvmc0508.us.oracle.com:9704/,http://10.228.2
35.83:9704/,http://10.228.235.83:9704/mapviewer
</proxy_enabled_hosts>
Substitute any entries with these tags with the property entries below:
<disable_direct_info_request> true </disable_direct_info_request>
<disable_info_request> true </disable_info_request>
<disable_csf>true</disable_csf>
<enforce_security_role> true </enforce_security_role>
<map_data_source name="OBIEE_NAVTEQ_Sample"
jdbc_host="10.229.147.238" (use your db ip)
jdbc_sid="orcl" (use your db sid)
jdbc_port="1521" (use your db port)
jdbc_user="obiee_navteq"
jdbc_password="!obiee_navteq" (use your selected password if different from OOB)
jdbc_mode="thin"
number_of_mappers="3"
allow_jdbc_theme_based_foi="false"
/>
Make sure all tags have been closed correctly and also make sure the above data source is not within the
comments section (ensure that it is outside the comments section which is represented by <!-- .. -->)
6.3.2.1 OBIEE_WORLD_MAP
Select type of map source : Choose Internal
Name : OBIEE_WORLD_MAP
Data Source : OBIEE_NAVTEQ_SAMPLE
Base map : WORLD_MAP
# Zoom Levels : 16
Minimum Map Scale:9999
Maximum Map Scale : 250000000
Min X:-180.0
Max X:180.0
Min Y:-90.0
Max Y:90.0
Leave the other options as default and click on Submit. This will create a Map Tile Layer called
OBIEE_WORLD_MAP.
6.3.2.3 OBIEE_SF_MAP1
Select type of map source : Choose Internal
Name : OBIEE_SF_MAP1
Data Source : OBIEE_NAVTEQ_SAMPLE
Base map : WORLD_MAP
# Zoom Levels : 8
Minimum Map Scale:1000
Maximum Map Scale : 500000
Min X:-123.0
Max X:-122.0
Min Y:37.0
Max Y:38.0
Leave the other options as default and click on Submit. This will create a Map Tile Layer called OBIEE_SF_MAP1.
6.3.2.4 OBIEE_SYDNEY_MAP
Select type of map source : Choose Internal
Name : OBIEE_SYDNEY_MAP
Data Source : OBIEE_NAVTEQ_SAMPLE
Base map : WORLD_MAP
# Zoom Levels : 8
Minimum Map Scale:1000
Maximum Map Scale : 250000
Min X:150.937
Max X:151.504
Min Y:-34.13
Max Y:-33.67
Leave the other options as default and click on Submit. This will create a Map Tile Layer called
OBIEE_SYDNEY_MAP.
6.3.2.6 Verify
To confirm that the Mapviewer configuration is working, choose the Map Tile Layer called OBIEE_WORLD_MAP
and click on 'View Map / Manage tiles' option. In the window that opens up, click on the 'Show Map' button. This
should display the world map. Repeat the steps for the Map Tile Layer called OBIEE_WORLD_MAP_FAST and
confirm that the world map is displayed
6.3.3 Starting the OBIEE Services and Verifying the Mapviewer connection
If you do not see "OBIEE_NAVTEQ_Sample" entry, try one or more of the following.
- Clear your browser cache
- Restart Mapviewer service
- Restart OPMN service
- Leave the system idle for a few minutes after making the above configurations.
Now confirm that you can now see "OBIEE_NAVTEQ_Sample" entry under "Layers", "Background
Maps" and "Images" tab.
This paragraph describes how to deploy the SampleApp Oracle OLTP model and its direct mapping within OBIEE.
The OLTP 3NF model is the FOD (Oracle Fusion Order Demo) datamodel. This deployment is optional and comes
in addition to SampleApp Core deployment.
From your SampleApp install folder, navigate to subfolder 7_SampleApp_XXXX_FOD. This folder contains all the
necessary files for deploying SampleApp FOD content
7.1 Prerequisites
All the steps to deploy SampleApp Core content must have successfully completed.
It is required that you have a connection to an 11g Oracle database where your BISAMPLE schema is installed.
You need to create the FOD data source schema within that database, and populate with sample data. To do so,
perform the following steps :
IMPORTANT Note :
The FOD user creation script defaults with the password „FOD‟ (same as user name) within the script. It is
recommended that you keep this value unchanged to simplify configuration. Should you need to change the
password value to something different, be aware that you will need to edit following configurations :
RPD connection pools password value for FOD Connection Pool, need to be updated with the
correct password value
This option will be described in next build of SampleApp. If you need to deploy with this alternative before next
build, please contact PM.
You should now be able to login in Answers, query the FOD subject area and retrieve results from it.
NOTES:- This add-on has only been tested on Oracle DB versions 11.1.0.7.0 and 11.2.0.1.0
In the dmuser schema, execute the following two scripts to create the two data mining models.
dmdtdemo.sql
This script will create a classification model called DT_SH_Clas_sample (using Decision tree algorithm).
dmglcdem.sql
This script will create a classification model called GLMC_SH_Clas_sample (using GLM)
You need to update the connection pool settings in the rpd for the database connection to the data mining schema.
To do this, you need to have access to offline or online editing of your RPD. Open the SampleApp.RPD file online
or offline from the location :
\InstallHome\instances\instance1\bifoundation\OracleBIServerComponent\coreapplication_obis1\repository
RPD Password for opening offline : Admin123
9.1.1 Prerequisites
This step requires that Core content be properly installed, and particularly, that Weblogic Custom Service
deployment (step 2.3) is properly completed. After exposing analyticsRes to WLS successfully, this directory can
be used for custom skins. Follow the steps below for deploying SampleApp custom skin.
IMPORTANT Note :
If some subfolders should already exist within analyticsRes folder on your system, increment their content with the
files from this SampleApp deployment.