Essbase Connection Properties

The following properties are available for Essbase Connection objects, grouped by the categories shown in the connection editors.

Data Source

Property Type Default Description

DataSource

string

The name of the data source to be used by the Essbase JNDI functionality supported by the dodeca-essbase service.

JNDI allows the specification of connection information on the dodeca-essbase service application server. This removes the need to store (encrypted) credentials in the Essbase connection metadata, which is retained on the client. It also provides a way to manage the credentials completely on the application server.

The data source refers to a JNDI connection, which is configured in the context.xml residing on the server. The context can contain three differenct JNDI connection configurations, all of which are optional and include the following:

  1. essbase/DEFAULT - Provides default settings to every EssConnection object even if a DataSource is not used.

  2. essbase/<ServerName> - Provides server specific settings to override the default settings

  3. essbase/<ServerName>2 - Provides server specific settings aimed at phantom connections used for send and calc operations.

If no DataSource is specified, Essbase connections will continue to work as they did prior to the introduction of the JNDI functionality.

Essbase

Property Type Default Description

Application

string

The name of the Essbase application.

Database

string

The name of the Essbase database.

Server

string

The name of the Essbase OLAP server.

Essbase Connector Services

Property Type Default Description

APSUrl

string

If specified, the APSUrl property overrides the aps.url setting in the dodeca-essbase.properties file associated with the dodeca-essbase service, which is identified by the ServletPath setting.

If not specified, the aps.url value specified in the dodeca-essbase.properties file is used.

RESTUrl

string

The base URL of the REST API for Oracle Essbase. This value is typically in the following form: https://server:433/essbase/rest/v1.

ServletPath

string

The HTTP address where the servlet is running.

Essbase Parameters

Property Type Default Description

ExtendedCubeInfoEnabled

bool

false

Cube information is obtained when an Essbase connection is used by the Dodeca client. Most of the cube information can be obtained without opening the outline, except for the following extended information: SmartLists (i.e. the text list strings and associated values for SmartLists) and the date format string.

Since opening an outline can be time consuming, setting the ExtendedCubeInformationEnabled property to False when the extended information is not needed avoids the overhead incurred when the outline is opened.

The date format string is used internally by the dodeca-essbase service in the data audit log functionality. If ExtendedCubeInformationEnabled is set to False and if date measures are updated, the data audit log tables may not accurately reflect the updated data.

Stateless

bool

true

The flag that indicates whether the servlet holds an Essbase connection in a cache on the server.

Essbase Security

Property Type Default Description

AdminPassword

string

The Essbase (and Essbase Deployment Services/Analytic Provider Services) password used for operations that require administrator privileges.

Refer to the AdminUsername setting for additional information.

AdminUsername

string

The Essbase (and Essbase Deployment Services/Analytic Provider Services) password used for operations that require administrator privileges.

The administrator credentials are only required and used for the following:

  • Beginning with Essbase 11.1.2.1.102, the Java API, which is used by the dodeca-essbase service, requires administrator privileges when obtaining information that requires opening the outline.

  • When an application uses the EssbaseUserRolesFromGroupNames authentication service and the view selector is configured to show saved views that are owned and shared by users who are members of a specific Essbase group, the client uses the AdminUsername and AdminPassword to request the names of all the users that are assigned to the group. The Java API is used by the dodeca-essbase service to obtain the users in a given group, and the API requires administrator privileges for this operation. This applies to Essbase versions 9.3.0 and later.

AuthenticationMode

EssbaseAuthenticationMode

EssbaseAuthenticationMode.UserCredentials

Specifies whether to connect directly with provided user credentials or as the authenticated user via impersonation.

Password

string

The Essbase (and Essbase Deployment Services/Analytic Provider Services) password.

UseAuthenticatedUsernameAndPassword

bool

false

When an authentication service is associated with the Dodeca application, the UseAuthenticatedUsernameAndPassword property controls whether the authenticated username and password are used as the Essbase connection username and password.

When an Essbase authentication service is used, the behavior is similar regardless of whether the UseAuthenticatedUsernameAndPassword property is True or False, because any connection to Essbase from the client will attempt to use the authenticated credentials unless a Username and Password are explicitly specified for the Essbase connection metadata instance. The difference is that when the UseAuthenticatedUsernameAndPassword is True and a connection fails, the default login services will not prompt the user for alternate credentials.

When a non-Essbase authentication service is used, it may be desirable to use the authenticated credentials for the Essbase connection. This can be achieved by setting the UseAuthenticatedUsernameAndPassword property to True. If the connection fails, the default login services will not prompt the user for alternate credentials.

Username

string

The Essbase (and Essbase Deployment Services/Analytic Provider Services) username.

Information

Property Type Default Description

ID

string

The string value that uniquely identifies the metadata.

Name

string

The name of the metadata object.

Logging

Property Type Default Description

DoRequestResponseLogging

bool

false

Controls whether the XML for the requests to and responses from the server are logged on the server for all clients when using this connection. The server must have the appropriate servlet filter enabled and properly configured via parameters in the web.xml file.

Logging can quicky generate a large number of files on the server. Logging is intended to be used on an as needed basis and is primarily used for debugging purposes. Instead of setting the DoEssbaseRequestResponseLogging property to True, which enables logging for all clients, the Utilities → Log Essbase Request and Response XML tool, which is included in the default Admin toolbars configuration, can be used to enable logging for the current client and session only.

Miscellaneous

Property Type Default Description

LoginDialogCaption

string

The caption used by the Essbase Login dialog when prompting the user to provide credentials for this connection. If not set, the caption is derived from the connection settings.

Test

Property Type Default Description

TestTokens

TokenTable