- Installation and Configuration Guide
- Accessing Shared Connections from an XML File
- Setting Up the Shared Connections XML File
Setting Up the Shared Connections XML File
Setting up the shared connections XML file involves preparing the XML file distributing it to your users.
To set up shared connections in an XML file:
- Create an empty XML file using any text editor and save it on your Oracle Smart View for Office client machine.
Give the file a meaningful name, such as
SmartViewProviders.xml
, and ensure that it has the.xml
extension.Note:
Only ASCII characters are supported in the XML file. Do not use non-ASCII characters in any of the entries you make in this file.
- Add the following line to the beginning of the file:
<?xml version="1.0" encoding="UTF-8"?>
- Next, add the opening res_GetProvisionedDataSources tag:
<res_GetProvisionedDataSources>
- Add entries for the applicable providers.
You can add entries for Oracle Hyperion Provider Services (Oracle Essbase), Oracle Hyperion Planning, Oracle Hyperion Financial Management, Oracle Hyperion Reporting and Analysis, Oracle Hyperion Strategic Finance, Oracle Business Intelligence Enterprise Edition, Oracle Enterprise Performance Management Cloud, and Narrative Reporting. The XML can contain entries for supported cloud providers, on-premises providers, or a mix of both.
When you create your entries, copy the syntax exactly and make ONLY these substitutions:
-
In the
Product
tag,name
attribute:name
—An internal identifier for the provider. This will not display to users. -
In the
Product
tag,displayVersion
attribute:version
—The version number of the specified provider. This will not display to users. -
In the
Server
tag,context
attribute:webServerHost
—The web server host machine name.webServerPort
—The web server port number. Use the default port number that is already noted in the syntax for each provider. Or, if you have configured your system using non-default port numbers, provide them.
The syntax for each provider type is below.
Provider Services (Essbase)
<Product id="APS" name="name" displayVersion="version"> <Server name="Oracle Hyperion Provider Services" context="http://webServerHost:webServerPort/aps/SmartView"></Server> </Product>
Oracle Hyperion Planning
<Product id="HP" name="name" displayVersion="version"> <Server name="Oracle Hyperion Planning, Fusion Edition" context="http://webServerHost:webServerPort/HyperionPlanning/SmartView"></Server> </Product>
Financial Management
<Product id="HFM" name="name" displayVersion="version"> <Server name="Oracle Hyperion Financial Management, Fusion Edition" context="http://webServerHost:webServerPort/hfmadf/../hfmofficeprovider/HFMOfficeProvider.aspx"></Server> </Product>
Reporting and Analysis
<Product id="RAFramework" name="name" displayVersion="version"> <Server name="Reporting and Analysis Framework" context="http://webServerHost:webServerPort/raframework/browse/listXML"></Server> </Product>
Strategic Finance
<Product providerType="ExtensionProvider" id="HSF" name="name" displayVersion="version"> <Server name="Oracle Hyperion Strategic Planning, Fusion Edition" context="webServerHost:webServerPort/StrategicPlanning/SmartView"></Server> </Product>
Oracle BI EE
<Product providerType="ExtensionProvider" id="27EE9B0D-D5F5-42c9-AFC5-44FEA770C693" name="name" displayVersion="version"> <Server name="Oracle BI, Fusion Edition" context="OBI:http://webServerHost:webServerPort/analytics/jbips"></Server> </Product>
Planning in EPM Cloud
<Product id="HP" name="name" displayVersion="version"> <Server name="Planning and Budgeting Cloud" context="http://serviceURL/HyperionPlanning/SmartView"></Server> </Product>
Planning Modules
<Product id="HP" name="name" displayVersion="version"> <Server name="Enterprise Planning and Budgeting Cloud" context="http://serviceURL/HyperionPlanning/SmartView"></Server> </Product>
Narrative Reporting
<Product id="EPRCS" name="name" displayVersion="version"> <Server name="Enterprise Performance Reporting Cloud" context="http://serviceURL/epm/SmartView"> </Server> </Product>
Oracle Financial Consolidation and Close Cloud
<Product id="HP" name="name" displayVersion="version"> <Server name="Financial Consolidation and Close Cloud" context="http://serviceURL/HyperionPlanning/SmartView"></Server> </Product>
Oracle Tax Reporting Cloud
<Product id="HP" name="name" displayVersion="version"> <Server name="Tax Reporting Cloud" context="http://serviceURL/HyperionPlanning/SmartView"></Server> </Product>
-
- Optional: If you are planning to access help locally or from an internal URL, add an entry for locating the help:
-
Help installed on a local drive:
<helpurlcontext>file:///parent_language_folder_path/</helpurlcontext>
For example:
<helpurlcontext>file:///C:/Oracle/SmartView/smartview_help/</helpurlcontext>
-
Help installed on a web server:
<helpurlcontext>http://webServerHost:webServerPort/pathToHelpFiles/smartview_help/</helpurlcontext>
For example:
<helpurlcontext>http://abcxyzco.com:12345/user_documentation/smartview_help/</helpurlcontext>
Notes:
-
Perform this step ONLY if you are planning to access shared connections from an XML file AND are required to access help either from a local drive or a web server within your organization. See Installing and Configuring Help Locally or on a Web Server for instructions on setting up help.
-
If you use the
<helpurlcontext>
tag, the help location you specify overrides the default or modified location specified in the<helpurlcontext>
tag in theproperties.xml
file, as described in Optional Local Help Configuration via the Shared Connections XML File.
-
- Optional: Add an entry for the User Productivity Kit (UPK):
<UPK>http://link to User Productivity Kit</UPK>
For example:
<UPK>http://download.abcxyzco.com/ocomdocs/PlayerPackage/data/toc.html</UPK>
- Add the closing
res_GetProvisionedDataSources
tag to complete the file, then save it.</res_GetProvisionedDataSources>
See Connection File Syntax and Example for the full syntax and an example of how this file should be set up.
- Test the file:
- Perform an action:
-
If you plan to have users copy the XML file to their local drive, ensure that the file is copied to a local drive on your Smart View client machine.
For example, the file may be copied to the
SmartView\bin
directory. -
Alternatively, if you plan to copy the file to a web server, ensure that the file is accessible to your users from a fully-qualified URL that includes the XML file name and the
.xml
extension.
-
- Start Smart View and in the Options dialog box, edit the Shared Connections URL to add the full path to the file or a URL, ensuring that the
.xml
file name extension is included.Note:
This feature will not work if the
.xml
file name extension in not included at the end of the local drive path or URL.-
Local drive example:
C:/Oracle/SmartView/bin/SmartViewProviders.xml
Ensure that you use forward slashes (
/
) as separators in the file path.The directory path and file should now be available in the list of shared connections.
-
Web server URL syntax:
http://webServerHost:webServerPort/pathToFile/filename.xml
Web server URL example:
http://abcxyzcowebserver:1234/SmartViewDataSources/SmartViewProviders.xml
The URL should now be available in the list of shared connections.
-
- Connect to the file using the Shared Connections option in the Smart View Panel, as described in "Connecting to Data Sources" in the Oracle Smart View for Office User's Guide.
If you do not see provider entries listed in the Shared Connections drop-down list, then the XML file may contain incorrect syntax or invalid characters.
Tip:
Verify the XML by opening the file in a browser; for example, in Internet Explorer. The browser will specify the invalid syntax. Correct any errors in the XML file editor, save, and refresh the browser display.
- Perform an action:
- When the XML file is correct and complete, perform one of the following procedures:
-
If you plan to have users copy the XML file to their local drive, distribute the file to your Smart View users with these instructions:
-
Do not modify this file in any way.
-
Copy the file to a local drive on your Smart View client machine.
For example, the file may be copied to the
SmartView\bin
folder. -
Start Smart View and in the Options dialog box, edit the Shared Connections URL with the full path to the file on the local drive, including the file name and
.xml
extension; for example:C:/Oracle/SmartView/bin/SmartViewProviders.xml
Ensure that you use forward slashes (
/
) as separators in the file path.The directory path and file is now available in the list of shared connections.
-
Test by connecting to the file using the Shared Connections option in the Smart View Panel, as described in "Connecting to Data Sources" in the Oracle Smart View for Office User's Guide.
If you have problems connecting, contact your Smart View administrator.
-
-
If you plan to copy the XML file to a web server, notify your Smart View users with these instructions:
-
Start Smart View and in the Options dialog box, edit the Shared Connections URL with the URL provided, including the file name and
.xml
extension; for example:http://abcxyzcowebserver:1234/SmartViewDataSources/SmartViewProviders.xml
-
Test by connecting to this URL using the Shared Connections option in the Smart View Panel, as described in "Connecting to Data Sources" in the Oracle Smart View for Office User's Guide.
If you have problems connecting, contact your Smart View administrator.
-
Internet Explorer users: To use the URL given in step a, Oracle recommends setting the following options in Internet Explorer:
-
Select Tools, then Internet Options.
-
In the General tab, Browsing history group, select Settings.
-
In the Check for newer versions of stored pages section, select Every time I visit the webpage, and then click OK.
-
In the Internet Options dialog box, select the Advanced tab.
-
In the Security section, select the Empty Temporary Internet Files folder when browser is closed option.
-
Click OK to close Internet Options and restart the browser.
-
-
-