Integration BIP 11g with Siebel 8.1.1.10 …

Introduction
  • Differences Of BIP 11g In Comparison With BIP 10g
  • Integration Details of BIP 11g with Siebel 8.1.1.10
  • References
Introduction:
  • BI Publisher is integrated as the standard Reporting solution with the Siebel product . BI Publisher product offers many advantages, rich in features, offering a great reporting solution.
  • BI Publisher 10g (10.1.3.4.1/10.1.3.4.2) Or BI Publisher 11g (11.1.1.7) is supported for Siebel integration.
  • BI Publisher provides client side tool Oracle BI Publisher Desktop to aid in the building and testing of layout templates. This consists of a plug-in to MS Word for the building of RTF templates and the Template Viewer, this helps you to test and debug all BI Publisher template types.
  • The primary reason for recommending BIP 11g is, BIP 10g is now out of premier support.
  • Refer MOS Certifications:
                 http://www.oracle.com/us/support/lifetime-support/index.html
                    Lifetime Support Policy: Oracle Fusion Middleware Products
  •      
  •      In this course we are going to discuss steps required for BI Publisher 11g  integration with Siebel 8.1.1.10 release.


  • Functional differences of BIP 11g in comparison with BIP 10g In terms of Siebel:


Feature
11g difference
Comments
Uploading reports
Reports in 11g contain two files: XDO, XDM (In 10g, data from both files were stored in an XDO)
– XDO contains the Report Definition
– XDM contains the Datamodel Definition (Contains information for GetReportData() to get Data from Siebel)
The Oracle BI Publisher server will need to be upgraded from 10G to 11G.  In this scenario, the reports will need to be migrated. Siebel will upload individual Reports, the Upload Report API will convert the existing 10G XDO to 11G XDO & XDM combination.
Schedule reports view
In 11G, the Scheduled Report and Scheduled Job History are two different screens, which means users will be required to navigate in the embedded BI Publisher UI to view the relevant Scheduled Reports.
In the Siebel UI, the Scheduled Reports link will only allow the users to view the “Scheduled Job History” and not the Scheduled Reports.  Therefore, when executing the reports with frequency “Run Weekly/Daily” OR “Run Monthly”, please make sure that the user navigates to the BI Publisher UI to view the Scheduled Reports, as the reports will not appear immediately in the Job History, as the reports will be executed at a later date/time.
Data Service wsdl
Different location required for Dataservice.wsdl
Copy the DATASERVICE.WSDL to BIP_11G_InstallUser_Projectsdomainsbifoundation_domain as part of the Post Installation/Upgrade instruction.
Scheduler UI integration
Different scheduler symbolic URL parameters
Different scheduler symbolic URL arguments need to be defined.
              


                                       Integration Details of BIP 11g with Siebel 8.1.1.10


Overview Steps:
  • Install Oracle BI Publisher 11g (11.1.1.7)
  • Deploying Siebel .jar files in BIP11g
  • Modify and deploy the xmlpserver.ear file
  • Defining XMLP responsibilities in Siebel
  • Defining Siebel web services in Siebel
  • Adding an Explicit Reference to JAR Files for Oracle BI Publisher Server
  • Implementing EAI File Handling Changes for Siebel Reports Report Generation
  • Configuring BI Publisher to Use Siebel Security
  • Disabling External File References on the Oracle BI Publisher Server
  • Modify the xmlp-server-config.xml
  • Restart the BIP Services
  • Testing Siebel security model
  • Testing reports upload from Siebel application
  • Testing reports execution
  • Process of Enabling and Configuring report Scheduling


                Install Oracle BI Publisher 11g (11.1.1.7)


BI Publisher Software Download



BIP 11g Installation:
  • Refer standard 11.1.1.7 documentation for installation of BI Publisher 11.1.1.7.
  • By default BI Publisher 11.1.1.7 installs on Weblogic.
  • After Installation BIP Services can be started by logging into Web logic server :
       -> Access the Weblogic console (eg: http://url:7001/console)
       ->  Enter the credentials and click on ‘Login’


Start BI Publisher Services
  • Select ‘Deployments‘ from left pane
  • Select ‘Lock & Edit’
  • Navigate to the application ‘bipublisher (11.1.1)’
  • Select check box and choose ‘Servicing all request’ under ‘Start’ button
  • Select ‘Activate changes‘ to apply changes.
  • Test accessing the BI Publisher server application:
                 Access the url (eg:http://machinehost:7001/xmlpserverconsole)


                   Deploying Siebel “.jar” Files In Weblogic Server
 
Steps to deploy the Siebel ‘.jar’ files in Weblogic server:
  • Following standard Siebel java function files need to be modified before deploying in weblogic server:


                           SiebelXMLP.JAR,
SiebelCustomXMLP.JAR,
SiebelCustomXMLP_SIA.JAR,
              XSLFunctions.JAR, (Optional),
              InkToolsLib.jar & (Optional)
              iSignBmp.jar.
  •   Copy these ‘.jar’ files from Siebel path  (SIEBEL_ROOTsiebsrvrCLASSES) to any
                other location .
  •   Can also be copied over to
          “MIDDLEWARE_HOMEuserprojectsdomainsbifoundation_domainClasses”
Navigate to MANIFEST.MF file located under META-INF


Navigate to MANIFEST.MF file located under META-INF


Modify the MANIFEST.MFfile, add a new line at the top with text
“Extension-name: XSLFUNCTIONS”


Save the file, which will write the changes back to the archive.


  • Update the manifest file MANIFEST.MF of SiebelXMLP.jar like below..
  •  Follow the same approach to modify the manifest file for other .jar files
  •  Make sure each library has a unique ‘Extension-name‘.


Let us see steps to deploy the modified ‘SiebelCustomXMLP.jar’ in weblogic console as library file:
  • Login into the Weblogic Console
  • Click on ‘Deployments‘
  • Select ‘Lock & Edit‘


Let us see steps to deploy the modified ‘SiebelCustomXMLP.jar’ in weblogic console as library file:
  • Login into the Weblogic Console
  • Click on ‘Deployments‘
  • Select ‘Lock & Edit‘
Select the directory, where the modified.jar files exists, after that select the .jar file that is to be deployed.


Follow the default steps to deploy the .jar library


Verify for the Library file name deployed as per the extension name e.g. ‘SiebelCustomXMLP’?


Modify And Deploy The ‘xmlpserver.ear’ File
Steps to modify and deploy the xmlpserver.ear file to Include the custom Java Functions in BI Publisher.
1. Use WinZip or 7-Zip to open and modify the XMLPSERVER.EAR located under        
   Oracle_BI1/bifoundation/jee/xmlpserver.ear. Make sure to take the backup of theexisting   
   file before modifying.



Modify And Deploy The ‘xmlpserver.ear’ File


Drag the ‘weblogic-application.xml’ located under XMLPSERVER.EAR/META-INF into any other  
   location. And then modify it with the following to include all the libraries which we have  
   deployed in weblogic
  <library-ref>  
    <library-name>SiebelXMLP</library-name>
  </library-ref>
  <library-ref>  
     <library-name>SiebelCustomXMLP</library-name>
  </library-ref>
  <library-ref>  
    <library-name>SiebelCustomXMLP_SIA</library-name>
  </library-ref>
  <library-ref>  
     <library-name>XSLFUNCTIONS</library-name>
  </library-ref>
Note:
Please make sure to give the exact extension names which were used while deploying the Siebel .jar files as libraries in weblogic server. And also please note that TAGs are closed correctly, if not, when deploying the XMLPSERVER.EAR file, it will error out.



Save the changes to the file and drag the weblogic-application.xml back into the archive. Make sure to keep the modified xmlpserver.ear file to its original location (Oracle_BI1/bifoundation/jee/xmlpserver.ear)



4. Deploy the modified xmlpserver.ear file into weblogic console.
  • Login into the weblogic server
  • Click on ‘Deployments’
  • Select ‘Lock & Edit’
  • Navigate to the application ‘bipublisher’
  • Select the check box and then click on ‘Update’ button
  • After that click on ‘Activate changes’




Start the application by selecting the application and selecting on ‘Start’ button
  • Navigate to the application directory ‘bipublisher‘.
  • Select the check box and then select ‘Servicing all requests’ under ‘Start’ button to start the application.   
Wait until ‘State’ shows as ‘Active’.


                         Defining XMLP Responsibilities In Siebel


Setting Up BI Publisher Roles as Siebel CRM Responsibilities:
  • Using Siebel Administrator credentials, navigate to Administration – Application, and then Responsibilities.
  • In the Responsibilities list, add a new record for each of the BI Publisher functional roles:
    • XMLP_ADMIN — Serves as the administrator role for the BI Publisher server.
    • XMLP_DEVELOPER — Allows users to upload reports from Siebel to BIP Server.
    • XMLP_SCHEDULER — Allows users to schedule reports.
    • XMLP_SIEBEL_GUEST – Allows users to execute reports
Associating Siebel Reports Views with Siebel Responsibilities



Defining Siebel Web Services In Siebel
Modify the Inbound Web service for the Siebel application by executing following steps:
     a. Navigate to the Administration – Web Services screen, then the Inbound Web Services view.
     b. Import the BIPSiebelSecurityWS.XML file from the SIEBEL_TOOLS_ROOTREPPATCH directory
         (where Siebel Tools is installed) to create a new inbound Web service.
     C. In the Name field in the Inbound Web Services list, query for BIPSiebelSecurityWS.
     d. Change the host, port, and locale of the Siebel Server by doing the following:
where:
  Computer Name is the Siebel Server name on which the Web service resides.
  Lang is the three-letter designator for the locale of the Siebel Server.


Configuring an Outbound Web Service for Siebel Reports
  1. Navigate to the Administration – Web Services screen, then the Outbound Web Services view and query for ‘PublicReportServiceService’
  2. Change (or verify) the service port address corresponds with Oracle BI Publisher Server.
      The format is:
          where:
         WebServerHostName is the full path for Oracle BI Publisher Server
         port is the port on which Oracle BI Publisher Server resides
           For example, the address might be:


Adding an Explicit Reference to JAR Files for Oracle BI Publisher Server
  • Explicit reference to Siebel JAR files is necessary for successful upload of report templates and for scheduled reports.  
  • Make sure to install JDK 1.6 32 before executing below steps.
     (JDK 1.6 64 bit and JDK 1.7 is not yet supported for Siebel – BI Publisher integration)
  • Set the JVM Classpath by using server manager command line:
For Windows based Operating System
     Change param CLASSPATH = C:sba81siebsrvrCLASSESSiebelXMLP.jar;C:sba81siebsrvrCLASSESxdoparser.jar;C:sba81siebsrvrCLASSESfix6312772.jar;C:sba81siebsrvrCLASSESxdocore.jar;C:sba81siebsrvrCLASSESxmlparserv2-904.jar;C:sba81siebsrvrCLASSESversioninfo.jar;C:sba81siebsrvrCLASSESshare.jar;C:sba81siebsrvrCLASSESjewt4.jar;C:sba81siebsrvrCLASSESjdbc12.jar;C:sba81siebsrvrCLASSESi18nAPI_v3.jar;C:sba81siebsrvrCLASSEScollections.jar;C:sba81siebsrvrCLASSESbipres.jar;C:sba81siebsrvrCLASSESbicmn.jar;C:sba81siebsrvrCLASSESSiebel.jar;C:sba81siebsrvrCLASSESXSLFunctions.jar;C:sba81siebsrvrCLASSESSiebelCustomXMLP.jar;C:sba81siebsrvrCLASSESSiebelCustomXMLP_SIA.jar;C:sba81siebsrvrclasseswlfullclient.jar for named subsystem XMLPJvmSubsys
For UNIX based Operating System
     Change param CLASSPATH = ${SIEBEL_HOME}/classes/SiebelXMLP.jar:${SIEBEL_HOME}/classes/xdoparser.jar:${SIEBEL_HOME}/classes/fix6312772.jar:${SIEBEL_HOME}/classes/xdocore.jar:${SIEBEL_HOME}/classes/xmlparserv2-904.jar:${SIEBEL_HOME}/classes/versioninfo.jar:${SIEBEL_HOME}/classes/share.jar:${SIEBEL_HOME}/classes/jewt4.jar:${SIEBEL_HOME}/classes/jdbc12.jar:${SIEBEL_HOME}/classes/i18nAPI_v3.jar:${SIEBEL_HOME}/classes/collections.jar:${SIEBEL_HOME}/classes/bipres.jar:${SIEBEL_HOME}/classes/bicmn.jar:${SIEBEL_HOME}/classes/Siebel.jar:${SIEBEL_HOME}/classes/XSLFunctions.jar:${SIEBEL_HOME}/classes/SiebelCustomXMLP.jar:${SIEBEL_HOME}/classes/SiebelCustomXMLP_SIA.jar:${SIEBEL_HOME}/classes/wlfullclient.jar for named subsystem XMLPJvmSubsys
     
Set the JVM DLL path
For Windows based Operating System:
Change parameter dll = C:jdk1.6.0_24jrebinclientjvm.dll for named subsystem  xmlpjvmsubsys
For UNIX based Operating System :
Change parameter dll = /java/jdk1.6.0_24/jre/bin/j9vm/libjvm.so for named subsystem    xmlpjvmsubsys
  For  Other OS:
  • Solaris:                                              /java/jdk1.6.0_24/jre/lib/sparc/client/libjvm.so
  • AIX:                                                   /java/jdk1.6.0_24/jre/bin/j9vm/libjvm.so
  • Novell SUSE Linux                           /java/jdk1.6.0_24/jre/lib/i386/client/libjvm.so
  • Oracle Enterprise Linux                    /java/jdk1.6.0_24/jre/lib/i386/client/libjvm.so
  • HP-UX                                               /java/jdk1.6.0_24/jre/lib/IA64N/server/libjvm.so
  • Set the environment variables JAVA_HOME and LIBPATH ${LIBPATH}


For Windows, set JAVA_HOME.
Eg: C:Javajdk1.6.0_24
For UNIX based Operating System set both JAVA_HOME & LIBPATH:
JAVA_HOME should be set to like  /usr/java


LIBPATH ${LIBPATH} environment variable should be set to like
/usr/jdk1.6.0_xx/jre/bin:/usr/jdk1.6.0_xx/jre/bin/j9vm
Restart the Siebel Services Including gateway to take changes into effect.
NOTE:
If you use an unsupported version of JDK, then you might receive a SBLEAI-05006 error while uploading the reports. To correct the error, install a supported version. From Siebel 8.1.1.4 JDK 1.6 is required for BIP Integration.
Download the JDK 1.6 32 bit from ‘http://www.oracle.com/technetwork/java/javasebusiness/downloads/java-archive-downloads-javase6-419409.html’
Implementing EAI File Handling Changes for Siebel
Reports:
  • For Siebel Fix Packs 8.1.1.10 and 8.2.2.3, a new EAIFileTransportFolders enterprise parameter is introduced.
  • Parameter allows to restrict write access for the EAI File Transport to specific folders within the Siebel file
  system.
  • However, for report generation to work properly, this parameter must be set to specific to your deployment
  • To implement EAI file handling changes for Siebel Reports report generation, change enterprise parameter   
  ‘EAIFileTransportFolders’  to following:
<siebsrvr_root>sessiebsrvrxmlpreports;<siebsrvr_root>sessiebsrvrxmlpdata
where:
<siebsrvr_root> is the actual path where the Siebel Server is installed.
Path  ‘<siebsrvr_root>sessiebsrvrxmlpreports’ is for reports generation
Path ‘<siebsrvr_root>sessiebsrvrxmlpdata’ is for report sample xml file generation
  • Multiple paths will be separated by semi colon (;)
  • Restart the Siebel Server including gateway to take into effect


       Configuring BI Publisher to Use Siebel Security
Log in to BI Publisher with Administrator privileges. From the Administration page select Security Configuration

Update Siebel Web Service Endpoint String with:
    • Administrator Username : SADMIN
    • Administrator Password:  SADMINPASSWORD
    • Replace machine.domain.com with your Siebel web server name.


  • Also set the Super Username and Super  User Password, because once you define the Siebel security model  default credentials will not work. And if you are not even able to login to BI Publisher with Siebel security credentials then these super user credentials will be used for logging into BI Publisher and to modify /review the settings.
  • Check ‘Enable Local Super user’
  • Provide values for
             Superuser  name : SUPERUSER
                         Password : SUPERUSERPASSWORD


Disabling External File References on the Oracle BI Publisher Server
  • Log in to BI Publisher with Administrator privileges. Select  ‘Properties’ under ‘Runtime Configuration’
  • Change the default value for the Disable External Reference attribute to FALSE, and then click  Apply.
  • Restart  BI Publisher services to make the changes take effect.


Modify The ‘xmlp-server-config.xml


Add “<property name=”Siebel_enable_10g_reportpath” value=”true”/>” in the   “xmlp-server-config.xml” file, which is located under    
”C:BIP11ghomeuser_projectsdomainsbifoundation_domainconfigbipublisherrepositoryAdminConfiguration”


Restart The BI Publisher Server
  • Login into the Weglogic server
  • Click on ‘Deployments’
  • Select ‘Lock & Edit’
  • Navigate to the application ‘bipublisher‘
  • Select the check box and then select ‘Force stop now ’ under ‘Stop’ button to stop the application.   


  • Navigate to the application folder ‘bipublisher‘
  • Select the check box and then select ‘Servicing all requests’ under ‘Start’ button to start the application.   
  Wait until ‘State’ shows as ‘Active’.


Testing Siebel Security Model:
  1. Login to BI Publisher with SADMIN/SADMINPASSWORD
  1. Click on ‘Administration’ and then select ‘Roles and Permissions’ under Security center.
  2. Verify all the XMLP_* roles are visible?


Test Reports Upload From Siebel Application
1. Login to Siebel Application
2. Navigate to Administration – BI Publisher Reports,  Click on ‘Reports – Standard Templates’
3. Select any record, for example ‘Account List’ and then click on ‘Upload Files’. Wait until you receive message
   ‘Upload Successful’


. Verify directory ‘SiebelCRMReports’ is created under location  
    “C:Middlewareuser_projectsdomainsbifoundation_domainconfigbipublisherrepositoryReports”


. Verify 2 folders for report ‘Account List’ will be created under  ‘SiebelCRMReports’
    Account List.xdm & Account List.xdo


Note: In 11g there are two files: XDO, XDM (In 10g, data from both files were stored in XDO)
XDO contains the Report Definition, XDM contains the Data model Definition (Contains information for GetReportData() to get Data from Siebel.
6. Account List.xdo folder contains 3 files (.xdo, rtf and xlf) and also view the reports folder in BI
   Publisher.


Test Reports Execution
1. Login to Siebel Application
2. Navigate to Account List View,  Click on ‘Reports icon’
3. From the drop down list select ‘Account List’
4. Output Type window pops up, provide the values for the ‘Report Output Type’ , ‘Custom Name’ and ‘Report
5. Open the generated report output.  It can also be opened later from ‘My Reports’ view under ‘BI Publisher
   reports’ screen.
  • Open the generated report output from ‘My Report’ view under ‘BI Publisher reports’ screen


Forgot password of old Siebel DBF file

If you have an old Siebel database and you have forgotten the user id and password you can execute below set of command on that dbf to get your user id created on the dbf. Please find the steps as below.
Steps:
1.      Copy the .dbf to ToolsLOCAL


2.    Launch dbisqlc.exe from toolsbin
UserName = DBA
Password = ENTRPRISENAME
Click On Database Tab -> Select Database File as the .dbf in the ToolsLOCAL
Click on OK


3.Once connected run below mentioned command.
grant connect to SSE_ROLE
grant connect to USERNAME identified by PASSWORD
grant connect to SIEBEL identified by PASSWORD
grant group to SSE_ROLE
grant membership in group SSE_ROLE to USERNAME
Commit
NOTE: USERNAME & PASSWORD Need to be in CAPITAL CASE


4.   Make environment specific changes in your Tools.cfg and create a local DSN to connect the .dbf file