C Access Multiple Essbase Servers From Smart View

When multiple Essbase instances are deployed, you can access all available server nodes in the connection panel using a single sign-on to one centralized Smart View URL.

Note:

This feature is available only for independent deployments.

By default, only a single Essbase server node, usually named EssbaseCluster, is accessible from Smart View. To enable centralized URL access to more than one server node, you must perform some configuration steps.

In the following Smart View image,


Multiple Essbase server nodes accessible under a centralized Smart View URL. The URL is https://myhost.example.com:9001/essbase/smartview. The Nodes are Financial (with applications ASOSamp and Sample nested underneath), Planning (with application Sample nested underneath), and ROcluster (with application Sample underneath, expanded to show database Basic).

  • The centralized Smart View URL is https://myhost.example.com:9001/essbase/smartview.

  • Two Essbase servers, with aliases Financial and Planning, are running on separate instances that an administrator configured to be accessible under one centralized Smart View URL.

  • The node named ROcluster is an active-active (read-only) cluster. A read-only cluster is not required for centralized Smart View URL access, but is an option available if you want to set up a cube that offers high availability without writeback.

To enable single URL access to multiple Essbase instances from Smart View, select a workflow, depending on your deployment type.

The workflows are mutually exclusive. If Essbase is configured with EPM Shared Services, only Essbase instances that are registered with EPM will be displayed in the centralized Smart View URL.

Access Multiple Essbase Servers in EPM Shared Services

To set up and access multiple Essbase servers with EPM Shared Services, follow this workflow:

  1. Register multiple Essbase servers with EPM Shared Services, and optionally with EAS Lite, using the instructions at: Manage Multiple Essbase 21c Servers in Shared Services and Administration Services

  2. Connect to Smart View, as described in Connect to the Cube from Smart View. All registered Essbase servers should be listed in the connections panel.

  3. If you want to set up active-active/read-only clusters of one cube, see Configure Active-Active (Read-Only) Essbase Clusters.

Access Multiple Essbase Servers Using a Centralized Smart View URL

To set up and access multiple Essbase server nodes using a centralized Smart View URL in a non-EPM Shared Services deployment, follow this workflow:

  1. Download scripts from Support.

    1. Log in to the My Oracle Support portal.

    2. Choose the Patches & Updates tab.

    3. Select Number/Name or Bug Number (Simple).

    4. In the Patch Name or Number field, enter patch number 33997658, and click Search.

    5. Download and extract the patch, and view the Readme.

  2. Copy the cloneTokenManagerKeys (.sh or .cmd) script and the updatedClusterId.py file into the bin directory of <Domain Home> on your current Essbase server machine. If you do not know where <Domain Home> is in your environment, refer to Environment Locations in the Essbase Platform for an explanation.

    For Linux,

    1. Copy cloneTokenManagerKeys.sh and updatedClusterId.py into $DOMAIN_HOME/bin. For example:

      /scratch/<home dir>/Oracle/Middleware/Oracle_Home/user_projects/domains/essbase_domain/bin
    2. Open a command prompt in the $DOMAIN_HOME/bin directory, and grant execute permission to cloneTokenManagerKeys.sh. For example,

      chmod +x cloneTokenManagerKeys.sh
    3. Run the script, providing a secondary Admin Server URL to synchronize it (for single sign-on) with the current server.

      The syntax is:

      ./cloneTokenManagerKeys.sh t3://<ADMIN-SERVER-NAME>:<ADMIN-PORT>

      For example:

      ./cloneTokenManagerKeys.sh t3://AdminServer2:7001

      If there are multiple environments to synchronize, enter the Admin Server URLs for each environment, delimited by spaces. For example:

      ./cloneTokenManagerKeys.sh t3://AdminServer2:7001 t3://AdminServer3:7001

      If TLS (SSL) is enabled, use the t3s protocol to specify the URL. For example:

      ./cloneTokenManagerKeys.sh t3s://AdminServer2:7002

    For Windows,

    1. Copy cloneTokenManagerKeys.cmd and updatedClusterId.py into %DOMAIN_HOME%\bin. For example:

      C:\Oracle\Middleware\Oracle_Home\user_projects\domains\essbase_domain\bin
    2. Open a command prompt in the %DOMAIN_HOME%\bin directory.

    3. Run the script, providing a secondary Admin Server URL to synchronize it (for single sign-on) with the current server.

      The syntax is:

      .\cloneTokenManagerKeys.cmd t3://<ADMIN-SERVER-NAME>:<ADMIN-PORT>

      For example:

      .\cloneTokenManagerKeys.cmd t3://AdminServer2:7001

      If there are multiple environments to synchronize, enter the Admin Server URLs for each environment, delimited by spaces. For example:

      .\cloneTokenManagerKeys.cmd t3://AdminServer2:7001 t3://AdminServer3:7001

      If TLS (SSL) is enabled, use the t3s protocol to specify the URL. For example:

      .\cloneTokenManagerKeys.cmd t3s://AdminServer2:7002
  3. Copy the startAPScmd (.sh or .cmd) script into the bin directory of <Domain Home> on your current Essbase server machine.

    For Linux,

    1. Copy startAPScmd.sh into $DOMAIN_HOME/bin. For example:

      /scratch/<home dir>/Oracle/Middleware/Oracle_Home/user_projects/domains/essbase_domain/bin
    2. Open a command prompt in the $DOMAIN_HOME/bin directory, and grant execute permission to the script. For example,

      chmod +x startAPScmd.sh
    3. Run the script. For example:

      ./startAPScmd.sh

    For Windows,

    1. Copy startAPScmd.cmd into %DOMAIN_HOME%\bin. For example:

      C:\Oracle\Middleware\Oracle_Home\user_projects\domains\essbase_domain\bin
    2. Open a command prompt in the %DOMAIN_HOME%\bin directory.

    3. Run the script. For example:

      .\startAPScmd.cmd
  4. Configure your Essbase instances by adding them to Provider Services management using available commands.

    1. Enter help to see all the commands. In this section about setting up a centralized Smart View URL, the commands to focus on are signon, addolapserver, listolapservers, removeolapserver, and signoff. Ignore the commands about clusters unless you want to set up active-active read-only clusters of one cube (if that is the case, see Configure Active-Active (Read-Only) Essbase Clusters).

    2. Enter signon to connect to Provider Services. Provide the user name and password of the WebLogic administrator account. Enter the Provider Services (APS) URL, ending in /japi. OLAP Server name can be left blank.

      APS>signon
      Enter user name : admin
      Enter password :
      Enter APS URL : https://myhost.example.com:9001/essbase/japi
      Enter OLAP server name : 
      You are signed on.
    3. Enter addolapserver to add an Essbase server that will be included in the Smart View panel. You can name the Essbase servers using @alias. If you omit the alias, server nodes in the Smart View panel will appear as URLs (for example, myhost.example.com:1423). You can use this command multiple times to add multiple servers.

      Note:

      Instead of using only the host:port syntax as indicated in the first two examples, Oracle recommends using the Essbase discovery URL (with /essbase/agent appended after the port). If any Essbase applications will be set up for drill through access to external source data, the discovery URL is required.
      APS>addolapserver
      Enter input as olapServerName: 
      (eg- host:port@alias or host:port:secure@alias or http(s)://host:port/essbase/agent@alias)
      myhost.example.com:9000/essbase/agent@Financial
      The olap server is added to the domain.
    4. Enter listolapserver to see all Essbase servers you have added to Provider Services.

      APS>listolapservers 
      myhost.example.com:9000@Financial,myhost2.example.com:6423:secure@Planning

      If you need to remove any Essbase servers from the Provider Services configuration, use removeolapserver.

      APS>removeolapserver
      Enter input as olapServerName:
      myhost.example.com:9000@Financial
      The olap server is removed from the domain.
    5. Enter signoff to exit the utility.

Configure Active-Active (Read-Only) Essbase Clusters

Using the Provider Services startAPScmd utility, you can create active-active (read-only) clusters of identical cubes belonging to multiple Essbase servers. The benefit of active-active clusters is to add high-availability and load balancing for cubes that are heavily used for query and reporting, but do not need to be updated frequently. An active-active cluster enables client requests to be distributed amongst the cubes in the cluster. Active-active clusters support only read operations on the cubes. You cannot update data or modify the outlines.

To set up and manage active-active (read-only) clusters,

  1. Complete steps 1-3 in Access Multiple Essbase Servers Using a Centralized Smart View URL.

  2. Configure and manage your read-only clusters using available commands.

    1. Enter help to see all the commands.

    2. Enter signon to connect to Provider Services. Provide the administrator user name and password. Enter the Provider Services (APS) URL, ending in /japi. OLAP Server name can be left blank.

      APS>signon
      Enter user name : admin
      Enter password :
      Enter APS URL : https://myhost.example.com:9001/essbase/japi
      Enter OLAP server name : 
      You are signed on.
    3. Enter createCluster to create a read-only cluster.

      APS>createCluster
      Enter input as cluster name, component names to be enabled (if multiple, separate the components with a ';')
      (eg- cluster1, host:port:secure/sample/basic;host:port:secure/sample2/basic2)
      ROcluster,myhost2.example.com:6423:secure/Sample/Basic;myhost3.example.com:6424:secure/Sample/Basic
      The cluster is created
    4. Enter listClusters to list all read-only clusters by name.

      APS>listClusters
      ROcluster
    5. Enter getCluster to list the read-only cluster nodes and their current state.

      APS>getCluster
      Enter input as clusterName
      (Eg: demoBasicCluster):
      ROcluster
      Name: ROcluster
      Description:
      Service comp names: myhost2.example.com:6423:secure/Sample/Basic;myhost3.example.com:6424:secure/Sample/Basic
      Comp State: (0-BAD,1-GOOD,2-DISABLED)
              myhost2.example.com:6423:secure/Sample/Basic 1
              myhost3.example.com:6424:secure/Sample/Basic 2
    6. Enter enableCluster to enable a read-only cluster from a disabled state.

      APS>enableCluster
      Enter input as cluster name, component name to be enabled
      (eg- cluster1, host:port/sample/basic)
      ROcluster,myhost3.example.com:6424:secure/Sample/Basic
      The cluster component is enabled
    7. Enter disableCluster to disable a read-only cluster that is currently enabled.

      APS>disableCluster
      Enter input as cluster name, component name to be disabled
      (eg- cluster1, host:port/sample/basic)
      ROcluster,myhost3.example.com:6424:secure/Sample/Basic
      The cluster component is disabled
    8. Enter updateCluster to update a read-only cluster definition.

      APS>updateCluster
      Enter input as cluster name, component names to update (if multiple, separate the components with a ';')
      (eg- cluster1, host:port/sample/basic;host:port/sample2/basic2)
      ROcluster,myhost3.example.com:6424:secure/Sample/Basic
      The cluster component is updated
    9. Enter removeCluster to remove a read-only cluster by name.

      APS>removeCluster
      Enter input as cluster name to be removed
      (eg- cluster1)
      ROcluster
      The cluster is removed
    10. Enter signoff to sign out, and then exit to exit the utility.