You are on page 1of 72

Safe Harbor Statement

The following is intended to outline our general product direction. It is intended for
information purposes only, and may not be incorporated into any contract. It is not
a commitment to deliver any material, code, or functionality, and should not be
relied upon in making purchasing decisions. The development, release, and timing
of any features or functionality described for Oracle’s products remains at the sole
discretion of Oracle.

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | 2


Siebel - BI Publisher 12c Integration

Ravi Kanth Kodali


Oracle - Siebel Technical Support

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. |


Objective

List out all the steps required for integrating BI Publisher 12c with Siebel Innovation Packs 16 and later versions

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. |


Steps for Integrating BIP 12c with IP2016 and IP2017
 Introduction
 Install BI Publisher 12c
 Post Installation considerations
 Enable BIP12c logging
 Enable Super user
 Disable External File References on the Oracle BI Publisher Server
 Modify the xmlp-server-config.xml
 Restart the BIP Services
 Deploy Siebel .jar files in BIP12c
 Modify and deploy the xmlpserver.ear file
 Review XMLP responsibilities in Siebel
 Define Siebel web services in Siebel
 Add an Explicit Reference to Container URL for Oracle BI Publisher Server[IP2017]
 Add an Explicit Reference to JAR Files for Oracle BI Publisher Server[IP2016]
 Implement EAI File Handling Changes for Siebel Reports Report Generation
 Configure BI Publisher to Use Siebel Security model
 Import the Siebel certificates to BIP server
 Restart services
 Test (Siebel Security model, Reports Upload & Execution)
 Process of Enabling and Configuring report Scheduling

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | 5


Introduction
Siebel Innovation Pack 16/17 and later versions can now be integrated with BI Publisher 12c (12.2.1.3/12.2.1.4) and BI Publisher 11g
(11.1.1.9). Starting from Siebel 21.5+, latest Oracle Analytics Publisher (part of OAS 5.5) is supported
OBIEE co-existence :
It is currently not possible to use a single instance of OBIEE 12c for both Siebel Analytics and Siebel Reporting (using the BI Publisher
component). That means you cannot use the BIP 12c that co exists with OBIEE 12c. Because BIP 12c that comes along with OBIEE 12c uses
catalogs as opposed to a standard file system (Siebel Reporting integration only uses file system approach). By default it uses 'Oracle BI EE
Catalog'. But for Siebel integration, that should be changed to 'File System' which is not possible in 12c to modify to catalog.

So the only option here to use is stand alone BIP 12c for Siebel Integration, so that it will be by default set to File System catalog. While
installing you just need to choose only BI Publisher.
To use BI Publisher 12c with Siebel using Reports integration. It is must to have a completely separate Standalone install for Siebel
Integration. This applies to BIP 11g (11.1.1.9) as well.
Please note that there is no changes from User experience perspective and functionality/features wise for 11g/12c/OAS
If you are installing BIP 12.2.1.4, there is a known issue in installing the base as stand alone. After installing the base and before
configuration, also take the interim patch mentioned in KM “Siebel Integration with BI Publisher release 12.2.1.4 (Doc ID 2521918.1)”

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. |


Install Oracle BI Publisher (12.2.1.3/12.2.1.4/OAS 5.5)
Download BI Publisher 12c Or latest OAS 5.5 components from Oracle Software Delivery Cloud
Take the appropriate BIP
https://edelivery.oracle.com/osdc/faces/SoftwareDelivery version by referring the
“Oracle Business
For example refer below screen shot showing 12.2.1.3 components
Intelligence Enterprise
Edition (OBIEE) Error
Correction Support (Doc ID
1664916.1)”

Refer “Oracle BI Publisher


(BIP) Product Information
Center (PIC) (Doc ID
1338762.1)” for BIP
compatibility details and
other information related to
BIP.

Please note that OAS 5.5


is only supported from
Siebel 21.5+

Siebel Integration with BI


Publisher release 12.2.1.4
(Doc ID 2521918.1)

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. |


Install Oracle BI Publisher 12c (12.2.1.3/12.2.1.4)
• Refer BI Publisher documentation for installation of BI Publisher 12.2.1.3/12.2.1.4
• Install WebLogic before installing BI Publisher 12c.
• After Installation, BIP Services can be started by logging into WebLogic console.
- Test accessing the WebLogic console - http://<hostname>:9500/console
- Test accessing the Enterprise Manager URL - http://<hostname>:9500/em
- Test accessing the BI Publisher URL - http://<hostname>:9502/xmlpserver

After installing the base version 12.2.1.3.0/12.2.1.4.0/OAS 5.5, make sure to install its latest available patch to have fixes for known issues. Based on
your BIP version please refer the below documents to get the details of its latest patch available. You can download it from the same note.
 Overview of Available Update Patches for Oracle BI Publisher Enterprise 11g Article ID 1276869.1]
 Required and Recommended Patches and Patch Sets For Oracle Business Intelligence 12c (Doc ID 2070465.1)
 Guidance And Recommended Patching Maintenance For Oracle Analytics Server (OAS) (Doc ID 2815208.1)

Note: For any issues Or queries related to BIP Installation Or for Installation documentation Or looking for compatibility details Or for any
other related queries Or issues related to BIP, please raise an SR under Oracle – BIP support . While raising the SR, select the product as
‘BI Publisher (formerly XML Publisher)’.

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. |


Post Installation considerations

BIP 12c installs on different ports when compared to 11g. Please find the details of some differences

– Port number
– Path difference
– Start and stop of complete BIP Server
– Change of catalog
– Deployment of xmlpserver.ear file

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. |


Post Installation considerations

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. |


Post Installation considerations

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. |


Post Installation considerations

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. |


Enable BIP12c logging

1. Login to BI Publisher enterprise manager - http:/biphost:9500/em

2. Click on the tree hierarchy which is present on the top left hand side

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. |


Enable BIP12c logging

3. Expand until bi_server1, and then right click on it . Under ‘Logs’ choose ‘Log Configuration’.

4. It will open ‘Log Configuration’ window. Search for ‘Oracle xdo’

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. |


Enable BIP12c logging
5. Under All Categories search for ‘xdo’
6. This will retrieve the record Oracle.xdo. Under ‘Oracle Diagnostic Logging Level (Java level)’ choose ‘Trace:32(FINEST)’ and click on ‘Apply’

7. Wait until you receive the confirmation.


8. Restart find the detailed bipublisher.log generated under
C:\Oracle\Middleware\Oracle_Home\user_projects\domains\bi\servers\bi_server1\logs\bipublisher
Note: If you restart bi_server, changes here will be lost and it will reset to default log level ‘Notification’.

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. |


Enable Super user

 Before starting integration steps Or before applying any BIP patches, make sure to take the back up of the “xmlpserverconfig.xml” file
and “xmlpserver.ear” file of BIP Server, particularly before doing any modifications at BIP server level.

“xmlp-server-config.xml” file, which is located under


BIP11ghome\user_projects\domains\bifoundation_domain\config\bipublisher\repository\Admin\Configuration

“xmlpserver.ear” file located under Oracle_BI1/bifoundation/jee/

 Make sure to set the Super user credentials before/while setting the ‘Siebel security’ model in BIP server

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | 16


Disabling External File References on the Oracle BI Publisher Server

• Click on ‘Administration’. Select ‘Properties’ under ‘Runtime Configuration’


• Change the default value for the Disable External Reference attribute to FALSE, and then click Apply.

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | 17


Modify the xmlp-server-config.xml

Take the backup and modify the ‘xmlp-server-config.xml’ located under


”C:\Oracle\Middleware\Oracle_Home\user_projects\domains\bi\bidata\components\bipublisher\repository\Admin\Configuration”.
Add the property <property name="Siebel_enable_10g_reportpath" value="true"/> in the “xmlp-server-config.xml” file, as shown below:

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. |


Restart the BIP Services

• Login into the WebLogic 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.

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. |


Restart the BIP Services

• Start the application by selecting the application and click on 'Start' button
• 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’.

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | 20


Restart the BIP Services

Every time after your restart the BIP services, make sure to test by accessing the BIP URL- (eg: https://<hostname>:9502/xmlpserver)

Please note that after enabling the super user, we can only long to BIP using super user credentials to login to BIP. Previous default credentials
‘weblogic’ user will not work now.

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. |


Deploy Siebel .jar files in BIP12c

Steps to deploy the Siebel ‘.jar’ files in WebLogic server

1. Following standard Siebel java function files need to be modified before deploying in WebLogic server:

–SiebelCustomXMLP.JAR,
–SiebelCustomXMLP_SIA.JAR,
–XSLFunctions.JAR,
–InkToolsLib.jar (Optional),
–iSignBmp.jar (Optional).

2. Create a new folder ‘Classes’ under rootdir>\Middleware\Oracle_Home\user_projects\domains\bi

3. Copy the ‘.jar’ files from Siebel server path (\SIEBEL_ROOT\siebsrvr\CLASSES) to the BIP folder location
<rootdir>\Middleware\Oracle_Home\user_projects\domains\bi\Classes

Note: In latest Siebel reports guide from Bookshelf, it was wrongly mentioned to copy Siebel.jar as well SiebelXMLP.jar along with
above mentioned .jar files. But as per the feedback from development team, these are not required. Hence created a documentation
defect ‘30890908’ to remove these 2 .jar files from Siebel reports guide.

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 22
Deploy Siebel .jar files in BIP12c

Use WinZip or 7-Zip to open the .Jar file

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. |


Deploy Siebel .jar files in BIP12c

• Navigate to MANIFEST.MF file located under META-INF

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. |


Deploy Siebel .jar files in BIP12c
• Modify the MANIFEST.MFfile, add a new line at the top with text “Extension-name: XSLFUNCTIONS”

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. |


Deploy Siebel .jar files in BIP12c
• Save the file, which will write the changes back to the archive.

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. |


Deploy Siebel .jar files in BIP12c

• 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‘.

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 27
Deploy Siebel .jar files in BIP12c

Deploy each modified ‘.jar’ file to WebLogic server.

• Login into the WebLogic Console


• Click on 'Deployments‘
• Select 'Lock & Edit

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. |


Deploy Siebel .jar files in BIP12c

• Select on 'Install' button. And select the directory, where the .jar library file is located.

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. |


Deploy Siebel .jar files in BIP12c

• Select the directory, where the modified.jar files exists, after that select the .jar file that is to be deployed.

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. |


Deploy Siebel .jar files in BIP12c

• Select Install the deployment as a library and click on Next button

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. |


Deploy Siebel .jar files in BIP12c
• Select Admin Server and bi_cluster and click on Next button

Click on Next button

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 32
Deploy Siebel .jar files in BIP12c

• Finally select ‘Finish’ button followed with ‘Save’ button

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. |


Deploy Siebel .jar files in BIP12c

• You should receive message ‘Settings updated successfully’

• Click on ‘Activate Changes’, after that will receive the below


message ‘All changes have been activated’

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. |


Deploy Siebel .jar files in BIP12c

• Verify for the Library file name deployed as per the extension name e.g. 'SiebelCustomXMLP’

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. |


Deploy Siebel .jar files in BIP12c

• Follow the same approach to deploy the other modified .jar files as library files in WebLogic. Once all six ‘.jar’ files gets deployed, verify
all six library files deployed.

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. |


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
<rootdir>/Middleware/Oracle_Home/bi/bifoundation/jee/xmlpserver.ear. Make sure to take the backup of the existing file before
modifying.

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. |


Modify and deploy the xmlpserver.ear file

2. 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> iSignBmp.jar</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: 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.

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 38
Modify and deploy the xmlpserver.ear file

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 39
Modify and deploy the xmlpserver.ear file

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 40
Modify and deploy the xmlpserver.ear file
3. Save the changes to the file and drag the WebLogic-application.xml back into the archive. Make sure to keep the modified xmlpserver.earfile
to its original location (<rootdir>/Middleware/Oracle_Home/bi/bifoundation/jee/xmlpserver.ear)

-> Stop all the servers through C:\Oracle\Middleware\Oracle_Home\user_projects\domains\bi\bitools\bin\stop.cmd


-> Take backup of existing EAR C:\Oracle\Middleware\Oracle_Home\bi\bifoundation\jee \xmlpserver.ear
-> Copy updated .ear to C:\Oracle\Middleware\Oracle_Home\bi\bifoundation\jee directory
-> Delete WL cache. Delete all the content inside
C:\Oracle\Middleware\Oracle_Home\user_projects\domains\bi\servers\bi_server1\tmp\_WL_user\bipublisher_11.1.1\jzpv15
-> Delete all the content inside
C:\Oracle\Middleware\Oracle_Home\user_projects\domains\bi\servers\bi_server1\tmp\_WL_user\bipublisher_11.1.1
\to5gma
-> Start all the servers through C:\Oracle\Middleware\Oracle_Home\user_projects\domains\bi\bitools\bin\start.cmd

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 41
Review XMLP Responsibilities In Siebel
 Using Siebel Administrator credentials, navigate to Administration -Application, and then Responsibilities.
Under Responsibilities list, query for XMLP* for each of the BI Publisher functional roles:
–XMLP_ADMIN,XMLP_ADMIN_USER—Serves as the administrator role for the BI Publisher server.

–XMLP_DEVELOPER, XMLP_DEVELOPER_USER—Allows users to upload reports from Siebel to BIP Server.

–XMLP_SCHEDULER, XMLP_SCHEDULER_USER—Allows users to schedule reports.

–XMLP_SIEBEL_GUEST –Allows users to execute reports

Ensure to assign the XMLP_ADMIN, XMLP_ADMIN_USER role to a user with administration privileges.

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 42
Define 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. In the Name field in the Inbound Web Services list, query for BIPSiebelSecurityWS.

c. Change the host, port, and locale of the Siebel Server by doing the following:

https://<SiebSrvr>:<Portnumber>/siebel/app/eai/<Lang>?SWEExtSource=WebService&SWEExtCmd=Execute&WSSOAP=1

where:
SiebSrvr is the Siebel Server name on which the Web service resides.
Portnumber is the https redirection port and Lang is the three-letter designator for the locale of the Siebel Server.

For IP 16, we need to use http, until unless SSL/https is enabled for your Siebel, and the address would be in
format http://<SiebSrvr>:<Portnumber>/eai_<Lang>?SWEExtSource=WebService&SWEExtCmd=Execute&WSSOAP=1

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 43
Define Siebel web services in Siebel
 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:
https://WebServerHostName:port/xmlpserver/services/PublicReportService_v11

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:

http://BIPServerHostName:9503/xmlpserver/services/PublicReportService_v11

3. Clear the Siebel Server cache to make sure that the changes are propagated to run-time memory.

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 44
Add an Explicit Reference to Container URL for Oracle BI Publisher Server[IP2017]
For successful upload of report templates and for scheduled reports need to set the Container URL for Oracle BI Publisher
Server.
 Navigate to the Administration-Server Configuration screen->Enterprises, and then the Profile Configuration view.
 Query for the XMLPJvmSubsys profile in Name field
 Under Profile Parameters subview, set the value of the Container URL field as follows:
http://<serverName>:<port>/siebel/jbs
where: port is the port number used for the config agent port parameter and for serverName use ‘localhost’
Note: Make sure to use http instead of https in this Container URL

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 45
Add an Explicit Reference to Container URL for Oracle BI Publisher Server[IP2017]
 Set the CONTAINERURL to
http://localhost:<ConfigAgentPort>/siebel/jbs
server name should be set as ‘localhost’ and port is Config Agent Port, value from ses/applicationcontainer/conf/server.xml file
Where 9002 -> is an Connector port parameter value from ses/applicationcontainer/conf/server.xml file
Search for catalina section, and find the connector port being used.
Important points to note down here
For example it looks like:
The <serverName> has to be ‘localhost’ always as the URL points to
the config agent within SES only

1. In case of multi-server environment, the port should be same


for all servers so that the URL mentioned (with localhost) works
properly. So that the local SES tomcat would service all XMLP
requests. This also helps in case if you are not running SES on AI
host.

2. Also make sure that Tomcat SES service running as DOMAIN


account same as Siebel Server, otherwise if it runs as an local
account, then while performing reports upload it will fail due to
permission issue in writing the file.

The idea is, call should not go over the network rather it should go to
ConfigAgent in the same machine. Hence it is localhost and protocol
is http(since this call doesn’t go out).

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 46
Add an Explicit Reference to JAR Files for Oracle BI Publisher Server[IP2016]

Explicit reference to Siebel JAR files is necessary for successful upload of report templates and for scheduled reports.
 Make sure to install JDK 32 bit before executing below steps.

 Set the JVM Classpath on Server Configuration UI. Navigate to Administration-Server Configuration->Enterprises->ProfileConfiguration->Query for XMLPJvmSubsys

 Provide JVM Classpath as <Buildlocation>\ses\siebsrvr\CLASSES\Siebel.jar; <Buildlocation>\ses\siebsrvr\CLASSES\SiebelXMLP.jar;


<Buildlocation>\ses\siebsrvr\CLASSES\xdo-core.jar

 Provide JVM DLL Name as C:\Program Files (x86)\Java\jre1.8.0_31\bin\client\jvm.dll

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 47
Add an Explicit Reference to JAR Files for Oracle BI Publisher Server[IP2016]
For Windows based Operating System:
 Change parameter dll= C:\jdk1.8.0_131\jre\bin\client\jvm.dll for named subsystem xmlpjvmsubsys

 For UNIX based Operating System :

 Change parameter dll= /java/ jdk1.8.0_131/jre/bin/j9vm/libjvm.so for named subsystem xmlpjvmsubsys

Example paths for Other Operating Systems:


 Solaris: /java/ jdk1.8.0_131/jre/lib/sparc/client/libjvm.so

 AIX: /java/ jdk1.8.0_131/jre/bin/j9vm/libjvm.so

 Novell SUSE Linux /java/ jdk1.8.0_131/jre/lib/i386/client/libjvm.so

 Oracle Enterprise Linux /java/ jdk1.8.0_131/jre/lib/i386/client/libjvm.so

 HP-UX /java/ jdk1.8.0_131/jre/lib/IA64N/server/libjvm.so

Note: For Windows, setting environment variable JAVA_HOME is enough. Where as for UNIX based Operating System need to set both JAVA_HOME & LIBPATH
environment variables.

LIBPATH ${LIBPATH} environment variable should be set to like

/usr/ jdk1.8.0_xx/jre/bin:/usr/jdk1.8.0_xx/jre/bin/j9vm

 Restart the Siebel Services Including gateway to take changes into effect

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 48
Implement EAI File Handling Changes for Siebel Reports Report Generation
Starting from Siebel Fix Packs 8.1.1.10 and 8.2.2.3, a new ‘EAIFileTransportFolders’ enterprise parameter is introduced.
This 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>\ses\siebsrvr\xmlp\reports; <siebsrvr_root>\ses\siebsrvr\xmlp\data

where:

<siebsrvr_root> is the actual path where the Siebel Server is installed.

Path ‘<siebsrvr_root>\ses\siebsrvr\xmlp\reports’ is for reports generation

Path‘<siebsrvr_root>\ses\siebsrvr\xmlp\data’ is for report sample xml file generation

Note: Multiple paths will be separated by semi colon (;) Restart the Siebel Server including gateway to take into effect

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 49
Configure BI Publisher to Use Siebel Security model

 Log in to BI Publisher with Administrator privileges. From the Administration page select Security Configuration.
 In the Authorization region of the page, select Siebel

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 50
Configuring BI Publisher to Use Siebel Security
 Update Siebel Web Service Endpoint String with:
https://<SiebSrvrhost>:<Port>/siebel/app/eai/<Lang>?SWEExtSource=WebService&SWEExtCmd=Execute&WSSOAP=1
where SiebSrvrhost is the Siebel Server host name.
Port is the https redirection port
Lang is the three-letter designator for the locale of the Siebel Server.

Administrator Username : SADMIN


Administrator Password: SADMINPASSWORD ( as per your environment)

Note: You can use any Siebel user here who does have the Siebel employee record with Siebel Administrator credentials and all the XMLP
responsibilities.

For Siebel IP 16, we need to use http, until unless SSL/https is enabled for your Siebel side, and the address would be in below format
http://<SiebSrvrhost>:<Portnumber>/eai_<Lang>?SWEExtSource=WebService&SWEExtCmd=Execute&WSSOAP=1

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 51
Import the Siebel certificates to BIP server
 Normally if Siebel is https/SSL enabled, then, then it is must to follow the document “BI Publisher Reports Failing When WSDL and Web
Service End Point Use HTTPS (Doc Id 1326291.1)” which says to install the below certificates in the Java keystore located on the BIP server
o Server Certificate
o Intermediate Certificate (if it exists)
o Root CA Certificate

Otherwise we receive errors when making calls to a Web service that is protected via Secure Sockets Layer (SSL) (that is, uses https://), you
may need to export the certificate from the Web server hosting the Web service and import it into the Java keystore on the machine running BI
Publisher. In other words if you enable ssl/https at browser to webserver then the SSL certificates from the Siebel Web Server(s) need to be
imported in the Java keystore located on the BIP server (\OraHome_1\jdk\jre\lib\security\cacerts). The entire chain of certificates i.e. Root,
Intermediate and Server certificate needs to be imported.

We need to follow the above process only when SSL/https is enabled on Siebel side. But Siebel Innovation Pack 17 is by default https
enabled. So it is must to import all the related certificates we used while setting up Siebel IP 17 to BIP server using Keytool command.

If we did not import these certificates after setting the Siebel security model in BIP, we can not able to login to BIP with Siebel security
credentials. We receive the error like below when try to login to BIP with Siebel Security credentials

error “Caused by: sun.security.validator.ValidatorException: PKIX path building failed:


sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target”

*****In Summary this is mandatory step now for Siebel IP 17 – BIP integration. For IP 16 – BIP Integration, this step is not required by
default until unless your Siebel application is ssl/https enabled.

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 52
Import the Siebel certificates to BIP server
 You would need to import the following SSL certificates from your Siebel IP 17 machine to BIP server using Java Keytool
o Server Certificate
o Intermediate Certificate (if it exists)
o Root CA Certificate

Install the Certificate into your keystore using the Java keytool, as follows. The keystore used by BIP Server resides in the Java Home path. So if
you have installed BIP Server on a machine that does NOT have JAVA_HOME environment variable defined, then BIP will automatically use its
own Java Home which is the 'OraHome_1/jdk/jre/' path.
You should find a file named 'cacerts' under BIP folder location
For BIP 12c, the example location would be
- Keytool.exe located under C:\Oracle\Middleware\Oracle_Home\oracle_common\jdk\jre\bin
- Certificates are stored under C:\Oracle\Middleware\Oracle_Home\oracle_common\jdk\jre\lib\security\cacerts
If you are integrating BIP 11g (11.1.1.9), the example location would be
- Keytool.exe located under \BI\Oracle_BI1\jdk\jre\bin
- Certificates are stored under \BI\Oracle_BI1\jdk\jre\lib\security\cacerts

Your import command should look like this:


keytool -import -trustcacerts -file <certfile> -alias <certalias> -keystore <keystore file>

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 53
Import the Siebel certificates to BIP server
Key steps to be followed for Siebel security model to work

1. Copy all the Siebel certificates certsiebel.cer and certCA.cer to BIP server machine, under any folder Or newly created folder
For example, assume that we have created a folder with name ‘IP17Certs’ in BIP machine.
2. cacerts is the file which stores the certificates and is located under
C:\Oracle\Middleware\Oracle_Home\oracle_common\jdk\jre\lib\security\cacerts
3. Go C:\Oracle\Middleware\Oracle_Home\oracle_common\jdk\jre\bin and then run the below commands

keytool -import -trustcacerts -file C:\IP17Certs\certsiebel.cer -alias test –keystore C:\Oracle\Middleware\Oracle_Home\oracle_common\jdk\jre\lib\security\cacerts

keytool -import -trustcacerts -file C:\IP17Certs\certCA.cer -alias test2 –keystore C:\Oracle\Middleware\Oracle_Home\oracle_common\jdk\jre\lib\security\cacerts

If it ask for password give ‘changeit’


4. Restart WebLogic services, start node manager and restart BIP services following the steps given in next chapter.

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 54
Restart services
1. First restart WebLogic services
Go to path “C:\Oracle\Middleware\Oracle_Home\user_projects\domains\bi\bin\” and run the command
stopWebLogic.cmd/stopWebLogic.sh
After that start them by running the commands startWebLogic.cmd/startWebLogic.sh
2. Restart Node Manager
Go to path “C:\Oracle\Middleware\Oracle_Home\user_projects\domains\bi\bin\” and run the commands
stopNodeManager.cmd/stopNodeManager.sh
After that start them by running the command startNodeManager.cmd/startNodeManager.sh
3. Start the BIP services
1. Login to weblogic console - http://hostname:Port/console
2. Click on 'Deployments', Select 'Lock & Edit‘, Under 'Summary Of deployment' choose 'Control tab
3. Navigate to the application 'bipublisher‘
- Select the check box and then select ‘Force stop now’ under ‘Stop' button to stop the application.
- Select the check box and then select ‘Servicing all requests’ under ‘Start button to start the application
4. Wait until you see the status as 'Active‘.

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 55
Restart services

5. If it is not moving to 'Active' then Login to Enterprise manager- http://hostname:port/em


and check whether biserver is started or not. If not start it.

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 56
Restart services

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 57
Test (Siebel Security model, Reports Upload & Execution)
1. Login to BI Publisher with Siebel Security credentials (used under Siebel security model) and test accessing ‘Roles and Permissions’ tab.
You should be able to login and see the XMLP_* roles under ‘Roles and Permissions’ tab. This confirm the successful Siebel security
model setting defined in BIP and then proceed for reports upload and finally report execution.

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 58
Test (Siebel Security model, Reports Upload & Execution)

2. If Siebel Security model is working fine, then proceed to test reports upload.
• Login to Siebel UI,
• Under Sitemap, go to Administration – BI Publisher Reports
• Click on ‘Reports – Standard Templates’
• Select any record and click on ‘Upload Files’
• Wait until you receive pop up ‘Upload Successful’

3. If reports upload is successful, then test that report by navigating to the corresponding view for which this report is associated
Make sure the data exists (at least one record)
• Click on ‘Report(s)’ icon
• Report Pane screen opens.
• Select the report name, output type, custom name and local
• Click on Submit
• Click on ‘My Reports’ , check whether the report is generated with message ‘success’?

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 59
Process of Enabling and Configuring report Scheduling
Steps:
 Apply the required patches to enable scheduling
 Define eai_anon_lang profile
 Configuring the Data Service WSDL for Oracle BI Publisher Server
 Test scheduling
 Configuring Scheduled Reports view in Siebel UI

 Apply the required patches to enable scheduling


For Innovation Pack 17

With BIP 12c - Apply 12.2.1.3 + Latest Patch of 12.2.1.3

With BIP 11.1.1.9 .0 – move to 11.1.1.9.160719 and then apply the interim patch 24695801

For Siebel Innovation Pack 16

Be on minimum patch set 10 of IP 16. That mean should be on IP 16.10

With BIP 12c - Apply 12.2.1.3 + Latest patch of 12.2.1.3

With BIP 11.1.1.9 .0 – move to 11.1.1.9.160719 and then apply the interim patch 24695801

Note: At the time of updating this document (January 2020), the latest update patch available for Oracle BI Publisher Enterprise 12.2.1.3

• For Oracle BI Publisher Enterprise 12.2.1.3.x: - Patch 30499022 BI Bundle Patch 12.2.1.3.200114 containing Oracle BI Publisher is the latest patch currently.

You can download this patch from document “ Overview of Available Update Patches for Oracle BI Publisher Enterprise 12c (12.2.1.3) (Doc ID 2354481.1)

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 60
Process of Enabling and Configuring report Scheduling
 Define eai_anon_lang profile
In IP 17, while creating Application Interface profile, we use eai_baselanguage by default (for example eai_enu) . And we might also have defined
the Application object Manager Callcener_enu Or sales_enu which every you uses. In a similar fashion we need to add the eai_anon_lang for AI
profile, because for scheduling we use eai_anon_lang to define the address of Siebel Inbound webservice ‘BIPDataService’ (which is involved
and invoked for scheduling)

1. Login into SMC - http://<SiebelSrvr>:<Port>/siebel/smc


2. Click on Profiles->Application Interface
3. Select the AI profile being used and click on ‘Edit’
4. Provide Review Profile Name as Test

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 61
Process of Enabling and Configuring report Scheduling

5. Under Basic Information, click on second tab ‘Applications’


6. And then click on ‘+’ to add the eai_anon_lang

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 62
Process of Enabling and Configuring report Scheduling
7. Under Basic information, give all the details as shown below

Note: Make sure to select the Checkbox for ‘Configure Anonymous Pool for this eai_anon_lang

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 63
Process of Enabling and Configuring report Scheduling
8. Provide all mandatory field details as shown in UI for ‘Enhanced Authentication’ and click on ‘Next’. Finally click on ‘Submit 'and refresh it.

Restart Siebel services as well tomcat services.

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 64
Process of Enabling and Configuring report Scheduling

 Configuring the Data Service WSDL for Oracle BI Publisher Server

Oracle BI Publisher Server uses a Web service to pull data from the Siebel application when a report is scheduled and executed. The WSDL
(Web Service Definition Language) provides a definition of this Web service. Oracle BI Publisher Server must know where this WSDL file is
located.

1. Log in to the Siebel application as a Siebel administrator.


2. Navigate to the Administration -Web Services screen, then the Inbound Web Services view.
3. In the Name field in the Inbound Web Services list, query for BIPDataService.
4. Change the host, port, and locale of the server port’s address to that of the Siebel Server as provided below:

https://<Siebserver>:<Port>/siebel/app/eai_anon/<Lang>?SWEExtSource=SecureWebService&SWEExtCmd=Execute

where:
■ Siebserveris the same as the Siebel Server name on which the Web service resides.
■ Portnumber is the https redirection port
■ Lang is the three-letter designator for the locale of the Siebel Server (for example, enu).

5. Under Operations Applet > for the record ‘GetReportData’ set the field ‘Authentication Type’ value to ‘Username/Password –clear text

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 65
Process of Enabling and Configuring report Scheduling

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 66
Process of Enabling and Configuring report Scheduling
6. Select ‘BIPDataService’, and then click ‘Generate WSDL’ button

7. Save the WSDL as a new data service file named ‘dataservice.wsdl’

8. Copy ‘dataservice.wsdl’ to: BI Publisher folder location - “C:\Oracle\Middleware\Oracle_Home\user_projects\domains\bi”

9. Do clear cache on Siebel side and restart Weblogic services on BIP server side to have changes into effect.

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 67
Process of Enabling and Configuring report Scheduling

 Test scheduling
 Login to Siebel UI
 Navigate to Account List View
 Click on reports icon
 Select the Report Name, Custom Name, Output Type, Locale and expand Schedule. Select the frequency ‘Run Immediately’ and click on
‘Submit’

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 68
Process of Enabling and Configuring report Scheduling
 Login to BIP Server

 Click on ‘Home’
 Navigate to ‘Report Job History’ page to
see the scheduled job status and to open that
Scheduled record output.

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 69
Process of Enabling and Configuring report Scheduling

 Verifying Symbolic URL Arguments that Embed the Oracle BI Publisher Scheduling Views in the Siebel Application
We can also see this BIP ‘Report Job History’ page in Siebel UI by accessing the ‘Scheduled reports’ view.

This view is an embedded Web page from the Oracle BI Publisher Enterprise application.

To configure this view, you implement a symbolic URL to display external contents in the Siebel user interface.

1. Navigate to the Administration -Integration screen, WI Symbolic URL List, and then the Host Administration view.

2. Query for biphost virtual name, and then edit for your deployment. Given your BIPserverhostname:Port under ‘Name’ field.

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 70
Process of Enabling and Configuring report Scheduling
3. Navigate to the Symbolic URL Administration view.

4. Query for ‘BIPReportJobListPage’, and then check for


following values:
■ URL is http://biphost/xmlpserver/servlet/myhistory
■ Host Name is host:port
■ Fixup Name is Default
■ SSO Disposition is Web Control where host:port is the
Oracle BI Publisher host address you choose from a
picklist.

5. Check for Symbolic URL Arguments as shown in the


screen shot.
6.Logout and login back into application

Now you can access the ‘Report Job History’ page of


BIP in Siebel UI by navigating to ‘Scheduled Reports’
view Under screen ‘BI Publisher Reports’.

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 71
References
 Troubleshooting problems with the Siebel BI Publisher integration (Doc Id 1051319.1)
 Siebel Reports with Oracle BI Publisher 11g (Doc ID 2102311.2)
 Overview of Available Update Patches for Oracle BI Publisher Enterprise 11g Article ID 1276869.1]
 Required and Recommended Patches and Patch Sets For Oracle Business Intelligence 12c (Doc ID 2070465.1)
 Guidance And Recommended Patching Maintenance For Oracle Analytics Server (OAS) (Doc ID 2815208.1)
 Siebel Integration With Oracle Analytics Publisher 12.2.5.5.0 (Doc ID 2741984.1)
 Siebel BI Publisher Reports Business Service (8.1.1.7+) (Doc ID 1425724.1)
 Improving the performance of Siebel BI Publisher Report Generation ( Doc Id 1392449.1)
 Siebel Certificates Import To BIP Using KeyTool Is Failing With Error "Java.lang.Exception: Input not an X.509 certificate" (Doc ID
2314415.1)
 Steps to enable BI Publisher logging? (Doc ID 2076111.1)
 Siebel BI Publisher Integration With Security Adapters (Doc ID 2332394.1)
 Siebel Integration with BI Publisher release 12.2.1.4 (Doc ID 2521918.1)

Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | Confidential – Oracle Internal/Restricted/Highly Restricted 72

You might also like