OBIEE 11g SampleAppDeployment InstructionsThis document contains instructions to deploy SampleApp content on a pre-installed 11g OBIEE platform. SampleApp is a free content set, not maintained by Oracle as a licensed product.Build 811THE CONTENT OF THIS BUILD IS DRAFT AND WORK IN PROGRESS, REPORT RPD MODELLING BUGS in BUG DB UNDER 2025 / SAMPLEAPP COMPONENT.WEBCAT CONTENT IS NOT CODE COMPLETE YET, AND NOT EXPECTED FUNCTIONALWITH THIS BUILDImportant KNOWN BUG in this build, to be fixed manually during install : make sure to complete STEP 2.4.3.1 during installTable of Contents1Prerequisites (4)1.1Shiphome Build (4)1.2Oracle Database Connection (4)1.3Admintool Access (4)2Deploying SampleApp Core (Required) (5)2.1Copying Files into Appropriate Locations (5)2.2Creating Main SampleApp Oracle Data source (6)2.3Deploying Weblogic Server Users and Custom Apps (7)2.4OBIEE Configuration Edits and Starting (10)2.5Deploying SampleApp BIP Content (15)3Deploying SampleApp Action Framework Content (Optional) (16)3.1Prerequisites (16)3.2Deploying ActionSamples.ear (16)3.3Adding Required Credentials (18)3.4Configuring OBI EE Actions Framework files (19)3.5Restarting services and Verifying the install (19)4Deploying SampleApp Essbase Content (Optional) (20)4.1Prerequisites (20)4.2Creating Essbase Data source (20)4.3Configuration Edits and Server Starting (21)5Deploying SampleApp ORCL OLAP Content (Optional) (23)5.1Prerequisites (23)5.2Creating the OLAP Data source (23)5.3RPD Edits : (24)6Deploying SampleApp Mapviewer Content (Optional) (25)6.1Prerequisites (25)6.2Creating the Mapviewer Navteq Data source (25)6.3Configuration Edits and Server Starting (26)7Deploying SampleApp FOD Content (Optional) (30)7.1Prerequisites (30)7.2Creating a brand new FOD Data source (30)7.3Using a pre-existing FOD Data source that already exists (31)7.4Testing the Analytics connection (31)8Deploying SampleApp ODM (Oracle Data Mining) Content (Optional) (32)8.1Creating Datamining Datasource (32)8.2Creating the data mining models (32)8.3RPD edits (32)9Other Items (34)9.1Deploying Custom Skin (34)1Prerequisites1.1Shiphome Build∙This SampleApp build has been developed using Shiphome build June 11th∙RPD is upgraded to Encryption model (RPD pwd = Admin123)SampleApp builds must be deployed on RC5 or RC4 Shiphome builds. Deploying a SampleApp build on an old platform build will result in high risk of failure, or at best, of not having all content functional.1.2Oracle Database ConnectionIt 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 activate Geographical mapping, Datamining and OLAP options of Samples from this database.1.3Admintool AccessTo complete full options deployment, access to Admintool is required for small config edits to RPD (connectivity information). However, for Core (only) configuration, an alternative to Admintool access is provided by using XML patching, see 2.4.3.2 in this document.2Deploying SampleApp Core (Required)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.1Copying Files into Appropriate Locations2.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\catalog2.1.2 SampleAppFiles folder :Copy the “SampleAppFiles” subfolder and all its content to the directory in your BIEE install :\InstallHome\instances\instance1\bifoundation\OracleBIServerComponent\coreapplication_obis1\sample\FYI, this contains the XML extra datasource that is used in the SampleApp Federation example.2.1.3 analyticsRes folder :Copy all the content within the analyticsRes folder to the following location in your BIEE install :\InstallHome\instances\instance1\bifoundation\OracleBIPresentationServicesComponent\coreapplication_obips1\analyticsRes FYI, this contains all the custom files (custom images, writeback templates) that are consumed by SampleApp dashboards and reports. If some of the subfolders already exist within analyticsRes folder on your system, increment their content with the files from this SampleApp deployment.2.1.4 Other configuration files :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_obips1FYI, this file contains currency code setup examples for SampleApp currency showing reports2.1.5 Note about RPD file :The SampleApp.rpd file that is in the install directory does NOT need to be moved into your BIEE install. It will be used directly by EM administration process, and needs to be copied to the machine where you will run EM browser from.2.2Creating Main SampleApp Oracle Data sourceIt 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 :2.2.1 Creating BISAMPLE USEROnly if this user does not exist on your DB yet :∙Open a connection to this db, with system or DBA privileges (system/system).∙Run the script BISAMPLE_USER.SQL located in the “SampleApp install files”.∙Once executed, verify that you can successfully connect as user BISAMPLE/BISAMPLE.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 beupdated as well.2.2.2 Loading BISAMPLE SCHEMAThere are two options available to load the BISAMPLE schema data.Option 1 creates the tables and uses insert statements to populate data.Option 2 uses a database dump.Use one of the above options according to your convenience.2.2.2.1 Option 1 – Using insert statements∙First step is to create the tables in BISAMPLE schema. To do this, open a connection to the oracle db with BISAMPLE/BISAMPLE user. Run the script BISAMPLE_SCHEMA_XXXX.SQL located inthe “SampleApp install files”.∙Next step is populating the tables with data. Using a connection to the oracle db asBISAMPLE/BISAMPLE, run the script BISAMPLE_DATA_XXXX.SQL contained in the zip fileBISAMPLE_DATA_XXXX.zip located in the “SampleApp install files”.2.2.2.2 Option 2 – Using database dumpThe Oracle Database export file BISAMPLE.dmp is within the zip file BISAMPLE_DMP.zip. This needs to be imported into the BISAMPLE schema using the following import command, from the command line (Command Prompt in Windows) :c:\> imp BISAMPLE/BISAMPLE@connectString file=BISAMPLE.dmp FULL=YConnectString is the connection string to your Oracle Database 11g where the user BISAMPLE was created in the step above. Wait for the import process to complete successfully.2.2.3 Validation Test:Once BISAMPLE schema is loaded, verify that the tables have been created and populated by issuing the following command : SELECT * FROM SAMP_CHANNELS_D.2.3Deploying Weblogic Server Users and Custom Apps2.3.1 Start Weblogic AdminServerOn your server, navigate to :\InstallHome\user_projects\domains\bifoundation_domain\binand run startWebLogic.cmd or startWebLogic.sh depending on your environment OSYou 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 in RUNNING mode. Keep this command window up to keep server up.2.3.2 Start Weblogic Managed Server (bi_server1)2.3.2.1 Option 1 : use WLS Console UI (recommended)∙Login onto http://localhost:7001/console using your Administrator credentials created during platform install.∙Under Environment block (mid of page, towards left side), click on Servers link.The bi_server1 line should show as shutdown state at this point∙Click on control page tab∙Select the bi_server1 line by clicking on the left tick box,∙Click start button at the top of the list and confirm starting this serviceState will update to “RUNNING” mode after a few minutes.2.3.2.2 Option 2 : use command lineFrom your sever location :\InstallHome\user_projects\domains\bifoundation_domain\binRun startManagedWebLogic.cmd or startManagedWebLogic.sh depending on your environment OS. You must add the following argument :startManagedWebLogic.cmd bi_server1You 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.2.3.3 Deploy Custom content folder location in WLSThis step allows to point WLS to the file folder location where you have pasted custom files for SampleApp (Images, styles, messages…).∙Login to weblogic Administration console (http://localhost:7001/console use the login you created in BIEE installation to log in).∙Navigate to deployments area. Click on the Install button in the deployments area to install a new web application. (If Install button is not enabled, click on Lock & Edit on the left frame).∙In the Install Application Assistant dialog, provide the path\installhome\instances\instance1\bifoundation\OracleBIPresentationServicesComponent\coreapplication_obips1. This should give the option to select analyticsRes as a valid application to deploy.∙Select analyticsRes and click on Next.∙In the next screen, choose the default option …Install this deployment as an application‟ and click Next.∙Choose bi_server1 as the deployment target 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.∙Click on …Activate Changes‟.∙Once this completes, start the deployment called …analyticsRes‟.2.3.4 Import FMW Security users (Weblogic users)This step is required in order to have most of the SampleApp features to work. Make sure the FMW import happens properly on your environment.∙Open the weblogic Administration console online (http://localhost:7001/console use the login you created in BIEE installation to log in).∙From home screen, click on Security Realms link, then drill on myrealm.∙Go to the migration page tab. Go to the Import tab.∙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.This should import all the SampleApp users into your environment. To confirm it, click on Users and Groups tab. 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.2.3.5 ****** CREDENTIALS ********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 : Admin1232.4OBIEE Configuration Edits and Starting2.4.1 NQSConfig.ini Preliminary EditsOpen NQSConfig.ini file from the following location :\InstallHome\instances\instance1\config\OracleBIServerComponent\coreapplication_obis12.4.1.1 USER_REF_GUIDSMake sure the following tag is set as shown below in your NQConfig file and save it :->[SERVER]...FMW_UPDATE_ROLE_AND_USER_REF_GUIDS = YES;2.4.1.2 USAGE TRACKINGThe following entry is not mandatory, but will allow the usage tracking SampleContent to show data, it is advised that you set these tags as described :->[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";2.4.2 Instanceconfig.xml EditsOpen Instanceconfig.xml file from the following location :\InstallHome\instances\instance1\config\OracleBIPresentationServicesComponent\coreapplication_obips1Make sure you have all the following tags in the file, within the existing <ServerInstance> tag. Some of these entries may already be present in your file. Ensure that entries are made only once and are in appropriate locations.<ServerInstance>...<SpatialMaps><LayerDataLayout><MaxRecords>1000</MaxRecords></LayerDataLayout></SpatialMaps><LightWriteback>true</LightWriteback>...<ps:Catalog xmlns:ps="oracle.bi.presentation.services/config/v1.1"><ps:UpgradeAndExit>false</ps:UpgradeAndExit><ps:UpdateAccountGUIDs>UpdateAndStartNormally</ps:UpdateAccountGUIDs></ps:Catalog>…</ServerInstance>2.4.3 RPD Edits *** IMPORTANT KNOW BUG TO FIX DURING INSTALL***You need to have access to offline editing of your RPD to edit necessary changes for connectivity to your database system. There are two alternative ways provided below to complete necessary RPD edits for your configuration ∙Option 1 (general case) : Use Admintool to edit your RPD file∙Option 2 : use RPD XML patching to update your RPD fileUse one of the above options according to your convenience.2.4.3.1 Option 1 (general case) : Use Admintool to edit your RPDOpen the SampleApp.RPD file offline from your installer location :RPD Password for opening offline : Admin1232.4.3.1.1.1 Edit BI_EE_HOME Variable Value :Navigate to Manage>Variables menu, double click on the BI_EE_HOME Repository Variable, update the default initializer string from its current value to the correct full path of the following directory on your BIEE install :\InstallHome\instances\instance1\bifoundation\OracleBIServerComponent\coreapplication_obis1For example, in a Linux environment, as an example, that value could be :/scratch/laliv/obi11g/instances/instance1/bifoundation/OracleBIServerComponent/coreapplication_obis12.4.3.1.1.2 Update variables that contain database connection informationThe connection pools setting uses repository variables to connect to the underlying database. You must update these variables to allow the RPD to properly connect. On the RPD click on Manage->Variables and update the following variables to appropriate values to connect to your database.∙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)2.4.3.1.1.3 Update Database Password in RPD connection poolsIf you have not changed the OOB password for BISAMPL E user (pwd = …BISAMPLE‟), then there should be no edit needed in the RPD. If you have changed the value of the password for the BISAMPLE user or if you are not sure, you need to edit password values for all the Connection Pool entries in RPD that use the above variables. The password must be set to your correct password value.2.4.3.1.1.4 Fixing Consistency WarningsImportant note KNOW BUG TO FIX MANUALLY:Run a consistency check of your RPD. It is possible that you have many warnings coming up, one per physical db, with messages :[39028] The features in Database '02 - Sample App Xml Data' do not match the defaults. This can cause query problems.Should this be the case, 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.2.4.3.1.1.5 Save your offline RPD.2.4.3.2 Option 2 : use RPD XML patching to update your RPD fileAn alternate way of updating the RPD variables is by using an XML patch file. In this approach, you don‟t need to open the RPD through an Admin tool. Instead, the values of the variables will be updated in an XML file and then these values will be updated in the RPD by running a command line utility called biserverxmlexec. This will update the rpd in an offline mode. Open the SampleApp_Patch.xml file from the SampleApp Install files. Update the following entries to appropriate values depending on your setup.∙UPDATE - BI_EE_HOME_PATHLook 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_VALUELook 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_VALUELook 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['']]></Expr>∙UPDATE - DB_SID_VALUELook 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_VALUELook for this entry and update the value of the database username. (Value must be BISAMPLE).<Expr><![CDATA['BISAMPLE']]></Expr>∙UPDATE - ESSB_HOST_VALUENOTE:- 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['']]></Expr>∙After making the above edits, save the XML file and run the biserverxmlexec from a command prompt to update the rpd variables with the values in the XML file. Following is the syntax of thecommand.biserverxmlexec -P repository_password –I input_script_pathname –B base_repository_pathname –Ooutput_repository_pathname.Execute the command with the following parameter values-P – Admin123-I SampleApp_Patch.xml-B SampleApp.rpd-O SampleApp.rpd∙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 in2.4.3.12.4.1 Removing drop-shadow effect on graphsBy default, whenever a chart is created, there is a drop-shadow effect on it. This property makes it difficult to read some of the SampleApp charts. In order to turn it off this property, edit the file dvt-graph-skin.xml from the following location on your installation.\InstallHome\Oracle_BI1\bifoundation\web\msgdb\s_blafp\viewui\chartEdit the <Graph> tag, add the attribute visualEffects="NONE" so it looks like the following<Graph visualEffects="NONE">Save the file.2.4.2 Setting the default rpd and webcat paths through EMLogin to the EM administration screen using the url http://localhost:7001/em (Replace the hostname and port-number based on your setup)2.4.2.1 RPD and Webcat selection2.4.2.1.1.1 RPD selection∙Use the login you created in BIEE installation to log in to the EM console.∙Expand 'Business Intelligence' node on the left and choose Coreapplication.∙Now click on the Deployment tab on the right. Next, go to the Repository tab.∙Click on 'Lock and Edit Configuration' to enable you to change the default settings.∙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)Keep on the same configuration screen to update webcat selection2.4.2.1.1.2 Webcat selectionYour platform install, does not yet point to SampleApp catalog, you need to update the path at the bottom of the same EM screen, with the location looking like this.$ORACLE_INSTANCE/bifoundation/OracleBIPresentationServicesComponent/$COMPONENT_NAME/catalog/XXXXXX.∙Change the path from XXXXXX to SampleApp so the location looks like this.$ORACLE_INSTANCE/bifoundation/OracleBIPresentationServicesComponent/$COMPONENT_NAME/catalog/SampleApp.2.4.2.1.1.3 Apply changes∙Click on Apply (top right corner of screen)∙Click on 'Activate Changes‟2.4.2.2 Other online config editsCaching enablementEM screen also offers you the possibility of turning OBIEE cache on or off. Leaving cache set to off will allow to see physical SQL logs for every query. Performance should not be of issue with the low data volume in the sample database. To Switch Cache off, click on tab …Capacity Management‟, sub-tab …Performance‟. Disable cache there and click on Activate changes.2.4.3 Start BIEE services and login2.4.3.1 Starting services From EM screen∙Login to the EM administration screen using the url http://localhost:7001/em (Replace the hostname and port number based on your setup). Use the login you created in BIEE installation tolog in.∙Expand 'Business Intelligence' node on the left and choose Coreapplication.∙Click on the Overview Tab,∙Click on blue button …Restart‟ (or green button …Start‟) under the Manage System category, middle of screen,∙Click yes on dialog box to confirm the move. Wait for message that confirms successful restart.Note :If starting using EM is not successful and complaining about OPMNCTL not up, please follow starting process with OPMNCTL2.4.3.2 Start services using OPMNCTL∙Open a command prompt, navigate to \InstallHome \instances\instance1\bin∙run “opmnctl sta tus, this will show you status of all the OBIEE core services∙run “opmnctl startall” or “opmnctl stopall” depending on your need.2.4.3.3 Login into http://localhost:9704/analyticsThe list of possible users for If starting using EM is not successful and complaining about OPMNCT2.5Deploying SampleApp BIP Content2.5.1 DatasourcesThe 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.From the web UI – :9704/analytics -- logged in as a user with Admin permissions, navigate to BI Publisher Admin pages: Administration -> Manage BI Publisher You‟re in the right spot when yo u see a single Administration tab and six groups of links e.g. in the upper left side you should see:Data Sources∙ JDBC Connection∙ JNDI Connection∙ File∙ LDAP Connection∙ OLAP ConnectionFrom Administration, click the link for JDBC Connection.2.5.1.1 Create the “BISAMPLE” JDBC connection.Click on the Add Data Source.Provide the following details about your database where BISAMPLE schema was installed,∙host,∙port,∙sid,∙and Username and PasswordUse the “Test Connection” button to ensure i t is connecting correctly. Note that you must name the JDBC connection exactly as BISAMPLE for many of the reports to run2.5.1.2 “Oracle BI EE” JDBC connectionInspect the “Oracle BI EE” JDBC connection. Us e the “Test Connection” button to ensure it is connectin g correctly.2.5.1.3 “demo” data sourceE dit the “demo” data source to use a real database connection. You will need to configure “demo” to use an oe (Order Entry) schema available in all Oracle Databases. You may need to unlock the OE schema. Like above, the d ata source needs to remain “demo”.I nspect the File data source “demofiles”. From the opera ting system see that there are .xml demo files present in the directory3Deploying SampleApp Action FrameworkContent (Optional)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.1PrerequisitesAll 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.3.2Deploying ActionSamples.ear3.2.1 Copying ActionsSamples.ear file3.2.1.1 Copying .ear file on your serverNavigate to subfolder 3_SampleApp_XXXX_Actions/ Actions_Definitions in your install directory, copy the file ActionSamples.ear to the following directory on your OBIEE server (the last folder …Actions‟ may need to be created on your server) :\InstallHome\instances\instance1\bifoundation\OracleBIServerComponent\coreapplication_obis1\sample\SampleAppFiles\Actio ns3.2.1.2 OPTIONAL: customizing Sample Actions services (editing Jdev Project)NOTE: the file " ActionsSamples V3 (Jdev_project).zip" included under the install directory :\InstallHome\instances\instance1\bifoundation\OracleBIServerComponent\coreapplication_obis1\sample\SampleAppFiles\Actio nsis the Jdev source project that was used to create this .ear file. This Jdev project is not needed to run SampleApp, but is included as part of the install incase user needs to customize the Sample actions services, or is interested in seeing the details of their setup.3.2.2 Deploying Sample Actions services in WLS∙Logon to weblogic Administration console using the url http://hostname:7001/console (use your hostname instead). Use the username/password that you provided while initial install of theproduct.∙Click on Deployments link under 'Domain Structure'. Click on the Install button on the Deployments page on the right. (If the Install button is not enabled, then click on the 'Lock & Edit' button underChange Center on the left)。
