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:

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

  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.

    The XML can contain entries for supported Oracle Enterprise Performance Management Cloud and Oracle Analytics Cloud data sources, and supported Oracle Enterprise Performance Management System and Oracle Business Intelligence Enterprise Edition data sources.

    Note:

    Entries for each connection use the private connection format.

    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, name attribute:

      name —The application name the user will see in the Shared Connection drop-down list.

      Note:

      This property does not apply to Essbase. The name that appears in the drop-down list will always be Oracle® Essbase.
    • In the Server tag, context attribute:

      serviceURL —The URL for a cloud data source connection.

      webServerHost —The web server host machine name for an on-premises data source connection.

      webServerPort —The web server port number for an on-premises data source connection. 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.

    Planning in EPM Cloud

    <Product id="HP" name="name" displayVersion="version">
    <Server name="Planning" context="https://serviceURL/HyperionPlanning/SmartView"></Server>
    </Product>

    Planning Modules in EPM Cloud

    <Product id="HP" name="name" displayVersion="version">
    <Server name="Planning Modules" context="https://serviceURL/HyperionPlanning/SmartView"></Server>
    </Product>

    Financial Consolidation and Close in EPM Cloud

    <Product id="HP" name="name" displayVersion="version">
    <Server name="Financial Consolidation and Close" context="https://serviceURL/HyperionPlanning/SmartView"></Server>
    </Product>

    Tax Reporting in EPM Cloud

    <Product id="HP" name="name" displayVersion="version">
    <Server name="Tax Reporting" context="https://serviceURL/HyperionPlanning/SmartView"></Server>
    </Product>

    Narrative Reporting in EPM Cloud

    <Product id="EPRCS" name="name" displayVersion="version"> 
    <Server name="Narrative Reporting" context="https://serviceURL/epm/SmartView"> </Server>
    </Product>

    Reporting Settings in EPM Cloud)

    <Product id="RAFramework" name="name" displayVersion="version">
    <Server name="Reporting Settings" context="https://serviceURL/hr/modules/com/hyperion/reporting/web/repository/HRRepositoryXML.jsp

    Oracle Analytics Cloud

    <Product providerType="ExtensionProvider" id="27EE9B0D-D5F5-42c9-AFC5-44FEA770C693" name="name" displayVersion="version">
    <Server name="Oracle Analytics Cloud" context="OBI:https://serviceURL/analytics/jbips"></Server>
    </Product>

    Oracle Analytics Cloud - Essbase or other cloud version of Essbase

    <Product id="APS" name="name" displayVersion="version">
    <Server name="Oracle® Essbase" context="https://serviceURL/essbase/smartview"></Server>
    </Product>

    Oracle Hyperion Provider Services (for on-premises Oracle Essbase)

    <Product id="APS" name="name" displayVersion="version">
    <Server name="Oracle® Essbase" context="http(s)://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(s)://webServerHost:webServerPort/HyperionPlanning/SmartView"></Server>
    </Product>

    Oracle Hyperion Financial Management

    <Product id="HFM" name="name" displayVersion="version">
    <Server name="Oracle Hyperion Financial Management, Fusion Edition" context="http(s)://webServerHost:webServerPort/hfmadf/../hfmofficeprovider/HFMOfficeProvider.aspx"></Server>
    </Product>

    Oracle Hyperion Reporting and Analysis Framework, Reporting Settings (for on-premises Release 11.1.2.4.9xx and later)

    <Product id="RAFramework" name="name" displayVersion="version">
    <Server name="Reporting and Analysis Framework" context="http(s)://webServerHost:webServerPort/hr/modules/com/hyperion/reporting/web/repository/HRRepositoryXML.jsp

    Oracle Hyperion Reporting and Analysis (for on-premises Release 11.1.2.4.7xx and earlier)

    <Product id="RAFramework" name="name" displayVersion="version">
    <Server name="Reporting and Analysis Framework" context="http(s)://webServerHost:webServerPort/raframework/browse/listXML"></Server>
    </Product>

    Oracle Hyperion Strategic Finance

    <Product providerType="ExtensionProvider" id="HSF" name="name" displayVersion="version">
    <Server name="Oracle Hyperion Strategic Planning, Fusion Edition" context="http(s)://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(s)://webServerHost:webServerPort/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" 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 Microsoft Edge. 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" 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:

      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" in the Oracle Smart View for Office User's Guide .

        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.

        Note:

        Starting with EPM System Release 11.2.2 and the EPM Cloud 20.09 update, Internet Explorer is no longer supported. This step is kept here for the purpose of backward compatibility.