Accessing Shared Connections from an XML File

Note:

The procedures in this topic apply to shared connections only.

Starting with the 11.1.2.2.310 release, when connecting to Smart View data sources, you can use shared connection information from an XML file to connect to providers. The XML file can exist either locally on each individual Smart View client machine or on a web server. You point to this XML file in the Shared Connections URL field of the Options dialog box, and then access the available connections as you would any other shared connection to which you have access.

To connect to an Oracle BI EE provider from the Shared Connections panel in Smart View, you must follow the procedures in this topic. However, you may also connect to Oracle BI EE data sources from the Private Connections Panel using the procedure described in Creating Private Connections.

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.

Caution!

The procedure in this topic is a system administration procedure and should be completed by the person who administers Smart View in your environment.

  To set up shared connections in an XML file:

  1. Create an empty XML file using any text editor and save it on your Smart View 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.

  2. Add the following line to the beginning of the file:

    <?xml version="1.0" encoding="UTF-8"?>
  3. Next, add the opening res_GetProvisionedDataSources tag:

    <res_GetProvisionedDataSources>
  4. Add entries for the applicable providers.

    You can add entries for Oracle Hyperion Provider Services (Essbase), Planning, Financial Management, Reporting and Analysis, Strategic Finance, and Oracle BI EE.

    When you create your entries, copy the syntax exactly and make ONLY these substitutions:

    • In the Product tag, displayVersion attribute:

      version—The version number of the specified provider.

    • In the Server tag, context attribute:

      webServerHost—The web server host machine name.

      19000|8900|9704 or configured webServerPort number—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="APS-11.1.2" displayVersion="version">
    <Server name="Oracle Hyperion Provider Services" context="http://webServerHost:19000 or configured webServerPort number/aps/SmartView"></Server>
    </Product>

    Planning

    <Product id="HP" name="HP-11.1.2" displayVersion="version">
    <Server name="Oracle Hyperion Planning, Fusion Edition" context="http://webServerHost:19000 or configured webServerPort number/HyperionPlanning/SmartView"></Server>
    </Product>

    Financial Management

    <Product id="HFM" name="HFM-11.1.2" displayVersion="version">
    <Server name="Oracle Hyperion Financial Management, Fusion Edition" context="http://webServerHost:19000 or configured webServerPort number/hfmadf/../hfmofficeprovider/HFMOfficeProvider.aspx"></Server>
    </Product>

    Reporting and Analysis

    <Product id="RAFramework" name="RAFramework-11.1.2" displayVersion="version">
    <Server name="Reporting and Analysis Framework" context="http://webServerHost:19000 or configured webServerPort number/raframework/browse/listXML"></Server>
    </Product>

    Strategic Finance

    <Product providerType="ExtensionProvider" id="HSF" name="HSF-11.1.2" displayVersion="version">
    <Server name="Oracle Hyperion Strategic Planning, Fusion Edition" context="webServerHost:8900 or configured webServerPort number/StrategicPlanning/SmartView"></Server>
    </Product>

    Oracle BI EE

    <Product providerType="ExtensionProvider" id="27EE9B0D-D5F5-42c9-AFC5-44FEA770C693" name="OBI EE-11.1.1.7" displayVersion="version">
    <Server name="Oracle BI, Fusion Edition" context="OBI:http://webServerHost:9704 or configured webServerPort number/analytics/jbips"></Server>
    </Product>
  5. 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:

  6. 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>
  7. 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.

  8. Test the file:

    1. 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.

    2. 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.

    3. Connect to the file using the Shared Connections option in the Smart View Panel, as described in Connecting to Data Sources.

      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.

  9. 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:

      1. Do not modify this file in any way.

      2. 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.

      3. 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.

      4. Test by connecting to the file using the Shared Connections option in the Smart View Panel, as described in Connecting to Data Sources.

        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:

      1. 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
      2. Test by connecting to this URL using the Shared Connections option in the Smart View Panel, as described in Connecting to Data Sources.

        If you have problems connecting, contact your Smart View administrator.

      3. Internet Explorer users: To use the URL given in step a, Oracle recommends setting the following options in Internet Explorer:

        1. Select Tools, then Internet Options.

        2. In the General tab, Browsing history group, select Settings.

        3. In the Check for newer versions of stored pages section, select Every time I visit the webpage, and then click OK.

        4. In the Internet Options dialog box, select the Advanced tab.

        5. In the Security section, select the Empty Temporary Internet Files folder when browser is closed option.

        6. Click OK to close Internet Options and restart the browser.

Connection File Syntax and Example

Below is the file syntax in its entirety:

<?xml version="1.0" encoding="UTF-8"?>
<res_GetProvisionedDataSources>
<Product id="APS" name="APS-11.1.2" displayVersion="version">
<Server name="Oracle Hyperion Provider Services" context="http://webServerHost:19000 or configured webServerPort number/aps/SmartView"></Server>
</Product>
<Product id="HP" name="HP-11.1.2" displayVersion="version">
<Server name="Oracle Hyperion Planning, Fusion Edition" context="http://webServerHost:19000 or configured webServerPort number/HyperionPlanning/SmartView"></Server>
</Product>
<Product id="HFM" name="HFM-11.1.2" displayVersion="version">
<Server name="Oracle Hyperion Financial Management, Fusion Edition" context="http://webServerHost:19000 or configured webServerPort number/hfmadf/../hfmofficeprovider/HFMOfficeProvider.aspx"></Server>
</Product>
<Product id="RAFramework" name="RAFramework-11.1.2" displayVersion="version">
<Server name="Reporting and Analysis Framework" context="http://webServerHost:19000 or configured webServerPort number/raframework/browse/listXML"></Server>
</Product>
<Product providerType="ExtensionProvider" id="HSF" name="HSF-11.1.2" displayVersion="version">
<Server name="Oracle Hyperion Strategic Planning, Fusion Edition" context="http://webServerHost:8900 or configured webServerPort number/StrategicPlanning/SmartView"></Server>
</Product>
<Product providerType="ExtensionProvider" id="27EE9B0D-D5F5-42c9-AFC5-44FEA770C693" name="OBI EE-11.1.1.7" displayVersion="version">
<Server name="Oracle BI, Fusion Edition" context="OBI:http://webServerHost:9704 or configured webServerPort number/analytics/jbips"></Server>
</Product>
<helpurlcontext>a valid entry as per optional step 5</helpurlcontext>
<UPK>http://link to User Productivity Kit</UPK>
</res_GetProvisionedDataSources>

The following example includes an entry for each provider type and also includes an entry for accessing help from an organization's internal web server:

<?xml version="1.0" encoding="UTF-8"?>
<res_GetProvisionedDataSources>
<Product id="APS" name="APS-11.1.2" displayVersion="11.1.2.2.500">
<Server name="Oracle Hyperion Provider Services" context="http://abcsvr.xyzco.com:19000/aps/SmartView"></Server>
</Product>
<Product id="HP" name="HP-11.1.2" displayVersion="11.1.2.2.000">
<Server name="Oracle Hyperion Planning, Fusion Edition" context="http://abcsvr.xyzco.com:19000/HyperionPlanning/SmartView"></Server>
</Product>
<Product id="HFM" name="HFM-11.1.2" displayVersion="11.1.2.2.300">
<Server name="Oracle Hyperion Financial Management, Fusion Edition" context="http://abcsvr.xyzco.com:19000/hfmadf/../hfmofficeprovider/HFMOfficeProvider.aspx"></Server>
</Product>
<Product id="RAFramework" name="RAFramework-11.1.2" displayVersion="11.1.2.2.000">
<Server name="Reporting and Analysis Framework" context="http://abcsvr.xyzco.com:19000/raframework/browse/listXML"></Server>
</Product>
<Product providerType="ExtensionProvider" id="HSF" name="HSF-11.1.2" displayVersion="11.1.2.2.00.2266">
<Server name="Oracle Hyperion Strategic Planning, Fusion Edition" context="http://abcsvr.xyzco.com.com:8900/StrategicPlanning/SmartView"></Server>
</Product>
<Product providerType="ExtensionProvider" id="27EE9B0D-D5F5-42c9-AFC5-44FEA770C693" name="OBI EE-11.1.1.7" displayVersion="11.1.1.7">
<Server name="Oracle BI, Fusion Edition" context="OBI:http://abcsvr.xyzco.com:9704/analytics/jbips"></Server>
</Product>
<helpurlcontext>http://abcxyzcowebserver:12345/user_documentation/smartview_help/</helpurlcontext>
<UPK>http://download.abcxyzco.com/ocomdocs/PlayerPackage/data/toc.html</UPK>
</res_GetProvisionedDataSources>