X

Best Practices from Oracle Development's A‑Team

Working with the Developer Client Tool for Oracle Analytics Cloud (OAC) with ADW in a Proxy-enabled Network

Jay Pearson
Consulting Solutions Architect, Business Intelligence

 Background

This article walks through the steps to configure the Developer Client Tool for Oracle Analytics Cloud (OAC) in a proxy-enabled network. These features have been tested on OAC 105.6.0-91 and Developer Client Tool 105.6 with an Oracle ADW database.

The blog demonstrates how to perform the following in a proxy-enabled network:

* Open Oracle BI Admin Tool Offline

* Open Oracle BI Admin Tool in the Cloud

* Import RPD Metadata (tables, keys, views, aliases etc.) 

* Preview data from within the RPD

* Connect to the Catalog Manager online

The appendix can be used to assist in identifying and debugging Oracle BI Admin Tool proxy related errors.

 Download & Install the Developer Client Tool for OAC

Download Developer Client Tool for OAC from here. It is recommended that the Client Tool version match or be higher than the OAC version.

Unzip and run the .exe with "Run as Administrator":

It is recommended to include the Client Tool version number in the install home directory:

This allows for multiple versions of the Client Tool to be installed and easily identified: 

It can be helpful to create a shortcut on the Desktop to: <OracleBIClient>\bi\bitools\bin\admintool.cmd:

 Open Oracle BI Admin Tool Offline in a Proxy-enabled Network

Since this example uses ADW, the wallet files need to be unzipped to <OracleBIClient>\domains\bi\config\fmwconfig\bienv\core:

(This is a standard requirement for ADW and not proxy specific.)

Edit <OracleBIClient>\domains\bi\config\fmwconfig\bienv\core\sqlnet.ora

WALLET_LOCATION should be updated to point to the location where wallet has been unzipped.

Add SQLNET.USE_HTTPS_PROXY=on

WALLET_LOCATION = (SOURCE = (METHOD = file) (METHOD_DATA = (DIRECTORY="C:\Oracle\OAC_Client_5.6.0\domains\bi\config\fmwconfig\bienv\core")))
SSL_SERVER_DN_MATCH=yes
SQLNET.USE_HTTPS_PROXY=on

~

ORACLE INSTANT CLIENT IS REQUIRED IN ORDER TO CONNECT TO ADW IN A PROXY-ENABLED NETWORK!

Downloaded latest Oracle Instant Client from here.

These steps were validated using "Instant Client for Microsoft Windows (x64)" - Version 19.6.0.0.0 - Basic Package -  instantclient-basic-windows.x64-19.6.0.0.0dbru.zip.

Unzip Instant Client files to: <OracleBIClient>\bi

Confirm the extracted Instant Client files are saved under: <OracleBIClient>\bi\instantclient_19_6

Edit <OracleBIClient>\bi\bifoundation\server\bin\nqinit.cmd

Search on "instantclient"

Change from: set EXTRA_PATH=%EXTRA_PATH%;%BI_PRODUCT_HOME%\instantclient_12_2

To new Instant Client path: set EXTRA_PATH=%EXTRA_PATH%;%BI_PRODUCT_HOME%\instantclient_19_6

Launch Oracle BI Admin Tool from <OracleBIClient>\bi\bitools\bin\admintool.cmd or the desktop shortcut previously created.

File -> Open -> Offline

From the Physical Layer -> Modify the Connection Pool -> Data Source Name -> Add Proxy Address or Proxy IP and Proxy Port.

i.e.

(description= (retry_count=20)(retry_delay=3)(address=(https_proxy=www-proxy-xyz.us.company.com)(https_proxy_port=80)(protocol=tcps)(port=1522)(host=adb.us-ashburn-1.oraclecloud.com))(connect_data=(service_name=abc_odiadw_medium.adwc.oraclecloud.com))(security=(ssl_server_cert_dn="CN=adwc.uscom-east-1.oraclecloud.com,OU=Oracle BMCS US,O=Oracle Corporation,L=Redwood City,ST=California,C=US")))

The proxy may also be an IP Address. i.e.

(https_proxy=12.345.6.78)(https_proxy_port=1234)

Confirm that View Data and Import Metadata are operational with the BI Admin Tool Offline in the Proxy-enabled Network.

 Open Oracle BI Admin Tool in the Cloud in a Proxy-enabled Network

!!! IMPORTANT !!!

Do not upload the RPD to OAC with (https_proxy=www-proxy-xyz.us.company.com)(https_proxy_port=80) in the Connection Pool Data Source Name.

Proxy settings should be manually added each time from the Oracle BI Admin Tool when needing to Import Metadata or View Data in the Proxy-enabled Network. They should then be removed before uploading/replacing the RPD to OAC.

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

**** Complete all configurations listed in Step 2 (if not already complete) ****

Launch Oracle BI Administrator Tool (found in <OracleBIClient>\bi\bitools\bin\admintool.cmd or desktop shortcut previously created.

File -> Open -> In the Cloud

* Enter OAC user/password

* Cloud: bootstrap

* Host name: OAC Hostname. i.e. jaysoac-ateam.analytics.ocp.oraclecloud.com

* Port: 443

* Check SSL!

* The default SSL Trust Store Password is: changeit

* Check Proxy!

* Enter Proxy Server Name / or IP Address and Proxy Port

Modify the Connection Pool Data Source Name to include the Proxy Address or Proxy IP and Proxy Port (as outlined in Step 2). Don't forget to remove before publishing the RPD to the Cloud!

From the Physical Layer -> Modify the Connection Pool -> Data Source Name -> Add Proxy Address or Proxy IP and Proxy Port.

i.e.

(description= (retry_count=20)(retry_delay=3)(address=(https_proxy=www-proxy-xyz.us.company.com)(https_proxy_port=80)(protocol=tcps)(port=1522)(host=adb.us-ashburn-1.oraclecloud.com))(connect_data=(service_name=abc_odiadw_medium.adwc.oraclecloud.com))(security=(ssl_server_cert_dn="CN=adwc.uscom-east-1.oraclecloud.com,OU=Oracle BMCS US,O=Oracle Corporation,L=Redwood City,ST=California,C=US")))

The proxy may also be an IP Address. i.e.

(https_proxy=12.345.6.78)(https_proxy_port=1234)

 Connect to Catalog Manager online in a Proxy-enabled Network

When connecting to Catalog Manager online in a Proxy these errors may be encountered:

Unable to connect to OracleBI Presentation Server.

Please check if Presentation Server/WebServer is running and URL is correctly typed
http://<host>:<port> /analytics or sawtcp://<host>:<port>  or just BIPS
<host>:<port>.

2 counts of InaccessibleWSDLException."

To resolve this error:

Open: <OracleBIClient>\bi\bifoundation\web\catalogmanager\runcatinternal.cmd in a text editor.

Search on: "set jvmBasicArgs=-Xmx1440M"

Update jvmBasicArgs to include Proxy Host and Proxy Port:

set jvmBasicArgs=-Xmx1440M -Dhttps.proxyHost=<host> -Dhttps.proxyPort=<port>

Launch Catalog Manager: <OracleBIClient>\bi\bitools\bin\runcat.cmd

Set URL to: https://<Instance Name>-< Tenant Name>.analytics.ocp.oraclecloud.com/analytics-ws

 Appendix: Identifying and Debugging Oracle BI Admin Tool Proxy Errors

When trying to view data or import RPD metadata in a proxy-enabled network without the correct proxy configurations the RPD may hang or error out.

Examples of errors that may be encountered from the RPD:

The connection has failed.

[nQSError: 17014] Could not connect to Oracle database.

[nQSError: 17001] Oracle Error code: 12170, message:

ORA-12170: TNS: Connect timeout occurred

at OCI call OCIServerAttach.

The connection has failed.

[nQSError: 17014] Could not connect to Oracle database.

[nQSError: 17001] Oracle Error Code: 28759, message:

ORA-28579: failure to open file

at OCI call OCIServerAttach.

To debug further look in the NQSAdminTool.log located at: <OracleBIClient>\domains\bi\servers\obis1\logs\<user>_NQSAdminTool.log.

Examples of proxy related errors that might be found in NQSAdminTool.log:

[nQSError: 17014] Could not connect to Oracle database.

[nQSError: 17001] Oracle Error code: 12154, message: ORA-12154: TNS:could not
resolve the connect identifier specified at OCI call OCIServerAttach.]

[nQSError: 17001] Oracle Error code: 12170, message: ORA-12170: TNS:Connect timeout occurred
 at OCI call OCIServerAttach.]]

 Want to Learn More?

Click here for more A-Team Oracle Analytics (OAC) Blogs.

 Summary

This article walked through the steps to configure the Developer Client Tool for Oracle Analytics Cloud (OAC) with ADW in a proxy-enabled network. The blog outlined how to open, connect, and utilize the Oracle BI Admin Tool and Catalog Manager in a proxy-enabled network. Additionally, the blog provides a starting point for identifying and debugging Oracle BI Admin Tool proxy errors.

Be the first to comment

Comments ( 0 )
Please enter your name.Please provide a valid email address.Please enter a comment.CAPTCHA challenge response provided was incorrect. Please try again.Captcha