Essbase Enterprise Services
Properties File Documentation

The Essbase Enterprise Services Properties File (essbase.properties) is the main configuration file for the Services. It contains general information on the Services, identifies the connected OLAP servers, the type of name service, the domain storage and connection pools.

The Properties file contains the following sections:

• General Enterprise Services information
  • License Key
  • Data directory
  • Command console ON/OFF
  • Message log
  • Server TCP/IP settings
  • Location service
  • Messaging service
• Domain Store Type
  • file - requires a file name
  • rdbms - requires a driver name (DB2, Oracle, SQLServer), user name, and password
  • ldap - requires a host name, user name, and password
• External Security Authentication
  • Internal - Essbass Enterprise Services security
  • External - ldap
  • External - Windows NT
  • External - custom
• OLAP Server Identification
• Sample Properties File

General Enterprise Services

The first section in the properties file contains a variety of Enterprise Services overhead parameters. In this section a path to a domain database is declared, the command console can be turned on and off, and the level of message logging can be set.

The properties of this overhead section are:

• License Key - This is the license key for evaluations of the clustering feature only. This license key is written on the printed license agreement that comes along with the evaluation release. The key is 36 hexidecimal characters in length. The use of this key enables EES to cluster all connected OLAP servers whether those servers have clustering enabled or not. This key has an expiration date. Beyond that date EES will only cluster OLAP servers that have the clustering option enabled.
• Data directory - The directory containing domain databases.
• Embedded Command console - A value of 'true' automatically starts the EES console when EES is started.
• Message log - There are three levels of message logging: information, error, and request. The three levels are independent. For examples, you can have error logging without request logging. The Message Log can be directed to a specified file. That file can be retained from one session to the next. New messages are appended to the existing file. The file can alternately be recreated on each start of the Enterprise Server. New messages overwrite the previous message file. Click here to see the Message log section of a sample Properties file.
• Server TCP/IP settings - This is set to the default port of 5001.
• Location service - This turns on the location service, allowing this EES server (and other EES servers on the local intranet) to be located and listed by the EES console.
• Messaging service - This turns on the automatic email warning messages, and determines the email server and user names.

Domain Store type

The possible Enterprise Services domain store types are file, ldap, rdbms, and 'other'. The required properties are different in each case.

Required Properties for file type domain store

The only required property file type is the name of the domain store file.

Required Properties for rdbms type domain store

The required properties for rdbms (relational database management system) domain store type are:

• product - the options are DB2, Oracle, and SQLserver.
• driver - The jdbc driver
• url - database url
• user - rdbms user name. Comment out this entry to use the starter of EES instead.
• password - rdbms user password

Required Properties for ldap type domain store

The required properties for ldap domain store type are:

• host - host name
• port - port number
• user - ldap user. Comment out this entry to use the starter of EES instead.
• password - ldap user password

Required Properties for 'other' type domain store

The 'other' domain store type is used in systems with specific needs. Use of this domain store type require the system administrator to make decisions and find information that is outside of the environments tested for Essbase Enterprise Services systems. The required properties for other domain store type are decided by the user. Do not use the 'other' domain store type unless you know your system thoroughly.

External Security Authentication

Essbase Enterprise Services enables user authentication external of Essbase. There are several accepted authentication schemes:

• Enterprise server - Essbase Enterprise server authentication (default).
• LDAP - LDAP authentication.
• Windows NT - Windows NT authentication.
• Custom - customize to use virtually any external authentication scheme.

The internal authentication by Essbase Enterprise Services is the default scheme. The external authentication schemes (LDAP, Windows NT, and Custom) are set up by editing the Essbase Properties file (essbase.properties) in the ESS_HOME\bin directory). Click here to see the security section of Essbase.Properties.

The identification of an external authentication scheme is specific to the EES domain. More than one scheme can be supported concurrently. For example, some users can be designated as authenticated through the Enterprise Server and other users can be designated as authenticated through LDAP.

The steps to implement an external authentication scheme are as follows.

1. In Essbase.Properties, locate the nativeSecurity.enabledProviders entry and set the value to the external schemes required. For example, to set up LDAP and Windows NT, specify: ldap, winnt.
2. For LDAP authentication, edit the nativeSecurity.ldap entries to suit your installation requirements. For LDAP authentication you must specify the server name, the port, the LDAP directory manager, and the manager's password.
3. For Windows NT authentication, edit the nativeSecurity.winnt entry to suit your installation requirements. For Windows NT you must specify the server name.
4. For a custom authentication method, edit the nativeSecurity.custom.jspiAdapterClassName entry to specify the class name of your adapter class that implements native security. A sample adapter class is available in the EES_HOME\samples\jspi directory. Make sure this class is accessible through the CLASSPATH.
5. Start the Essbase Enterprise server.
6. Use the Enterprise server console to create the users. Set the Authenticator property of each user to the scheme required (ldap, winnt, or custom).

OLAP Server Identification

This section of the properties file is used to start the Essbase OLAP agent and to establish an administrative user account.

The properties of the OLAP server section are:

• autoStart - If set to True, starts the OLAP agent if it is not running.
• admin.name - The administrative account name on the OLAP server. Comment this out in order to use EES starter.
• admin.password - The password for the administrative account.
• autoCreateUser - If set to True, creates the user on OLAP server, if it does not already exist.
• autoChangePassword - If set to True, allows change of the password in OLAP server, if it is different than the one in EES store.

Sample Properties File

The following is a copy of the contents of the original essbase.properties file delivered with Essbase Enterprise Services.

################################################################################
# Essbase Properties File. Used by Essbase Enterprise Services.
################################################################################

# License key.
# Substitute xxxxx with your actual license key before starting the server.
licenseKey=xxxxx

# Data directory.
system.dataDir=../data

# Embedded Command console.
system.cmdShell.start=true


#
# Message log:
#    log.info    - log information.
#    log.error   - log errors.
#    log.request - log requests.
#    log.file.enable      - Enable logging to a file
#    log.file.name        - Name of the log file
#    log.file.option      0 - recreate log file every time EES server starts, 
#                         1 - allow log file to grow indefinitely.
#    log.file.buffer.size - Log buffer size. 0 - use default size.
#
system.log.info=true
system.log.error=true
system.log.request=true

system.log.file.enable=false
system.log.file.name=../data/essbase.log.txt
system.log.file.option=0
system.log.file.buffer.size=0

# Server TCP/IP settings.
server.tcpip.port=5001

# Location service.
service.location.start=false

# Messaging service. Set the email.server and email.sender below to suit your environment.
service.messaging.start=false
service.messaging.email.server=localhost
service.messaging.email.sender=admin@localhost

################################################################################
# BEGIN: Domain store (domain.store)
#
# Possible domain store types are: file, rdbms.
#
# Properties for file type:
#   name - name of the domain store file name.
# Properties for rdbms type:
#   driver - The jdbc driver, url - database url,
#   user - rdbms user. Comment out this entry to use the starter of EES instead.
#   password - rdbms user password.
################################################################################
domain.store.type=file

# Domain store type: file
domain.store.file.name=../data/domain.db

# Domain store type: rdbms.
# DB2 entries:
#domain.store.rdbms.product=DB2
#domain.store.rdbms.jdbc.driver=COM.ibm.db2.jdbc.net.DB2Driver
#domain.store.rdbms.jdbc.url=jdbc:db2:localhost:essbase
#domain.store.rdbms.user=db2admin
#domain.store.rdbms.password=db2admin
#domain.store.rdbms.connectionPool.capacity=2

# Oracle entries:
#domain.store.rdbms.product=Oracle
#domain.store.rdbms.jdbc.driver=oracle.jdbc.driver.OracleDriver
#domain.store.rdbms.jdbc.url=jdbc:oracle:thin:@localhost:1521:essbase
#domain.store.rdbms.user=scott
#domain.store.rdbms.password=tiger
#domain.store.rdbms.connectionPool.capacity=2

# SQLServer entries:
#domain.store.rdbms.product=SQLServer
#domain.store.rdbms.jdbc.driver=com.jnetdirect.jsql.JSQLDriver
#domain.store.rdbms.jdbc.url=jdbc:JSQLConnect://localhost/database=essbase
#domain.store.rdbms.user=sa
#domain.store.rdbms.password=
#domain.store.rdbms.connectionPool.capacity=2
################################################################################
# END: Domain store.
################################################################################


################################################################################
# BEGIN: Native security (nativeSecurity)
#
# Possible native security types are: ldap,winnt,custom.
###############################################################################
nativeSecurity.enabledProviders=

# Native security type: winnt.
nativeSecurity.winnt.domain=localhost

# Native security type: ldap.
nativeSecurity.ldap.host=localhost
nativeSecurity.ldap.port=389
nativeSecurity.ldap.user=cn=Directory Manager
nativeSecurity.ldap.password=password

# Native security type: custom.
nativeSecurity.custom.jspiAdapterClassName=com.essbase.samples.jspi.NativeSecurity
################################################################################
# END: Native security.
################################################################################

################################################################################
# BEGIN: OLAP server (olap.server)
#
# autoStart - if true, start the OLAP agent if it is not running.
# admin.name - admin name of the OLAP server. Make sure you have a supervisor 
#              with that name in Essbase OLAP server.
# admin.password - admin password. Make sure this is the right password.
# autoCreateUser - if true, create the user in OLAP server, if it is not exising.
# autoChangePassword- if true, change password in OLAP server, if it is different
#                     than the one in EES store.
################################################################################
olap.server.autoStart=false
olap.server.admin.name=system
olap.server.admin.password=password
olap.server.autoCreateUser=true
olap.server.autoChangePassword=true
################################################################################
# END: OLAP server.
################################################################################

################################################################################
# BEGIN: Cube view connection pools.
################################################################################
# DESC: Following is a connection pool called "demoBasic" that allows every EES
# user to use 4 cube view connections, with a potential for up to 10 connections,
# incremented by two at a time, with a delay of 1 second between each
# attempt to connect to the cube source (olap server: localhost, application: sample,
# cube: basic). 

# NOTE: In order to enable connection pool, uncomment the entry below that has the
# key:
# 	olap.cubeView.enabledConnectionPools=demoBasicPool
# and specify the names of the connection pool separated by comma on the right side
# of the = symbol.
# for eg: olap.cubeView.enablesConnectionPools=demoBasicPool,sampleBasicPool
#
# allowEveryone - if this is true everyone (every Enterprise user) is allowed to access
# the pool. If this is false or this entry is not existing, the entries
# allowUsers and allowGroups are used to allow access.  allowUsers entry can be
# assigned to have a list of Enterprise user names separated by semicolon. allowGroups
# entry can be assigned to have a list of Enterprise group names separated by semicolon.
####################################################################################

#olap.cubeView.enabledConnectionPools=demoBasicPool
olap.cubeView.connectionPool.demoBasicPool=\
        serviceComponent=localhost/demo/basic, serviceComponentIsCluster=false,\
        user=guest, password=password, \
        initialCapacity=4, maxCapacity=10, capacityIncrement=2,\
        allowEveryone=true
olap.cubeView.connectionPool.demoBasicPoolUsingCluster=\
        serviceComponent=demoBasicCluster, serviceComponentIsCluster=true,\
        user=guest, password=password,\
        initialCapacity=4, maxCapacity=10, capacityIncrement=2,\
        allowEveryone=false, allowUsers=system;guest, allowGroups=grp-1;grp-2,\
        prop_aliasNames=false, prop_aliasTableName=Default, \
        prop_enableDatalessNavigation=false, prop_drillLevel=0, \
        prop_emptyGridError=false,\
        prop_includeSelection=false, prop_indentStyle=0,  \
        prop_repeatMemberNames=false,\
        prop_withinSelectedGroup=false, prop_selectionOnly=false,\
        prop_suppressMissing=false, prop_suppressUnderscore=false,\
        prop_suppressZeros=false, prop_useBothForRowDims=false
olap.cubeView.connectionPool.sampleBasicPool=\
        serviceComponent=localhost/sample/basic, serviceComponentIsCluster=false,\
        user=guest, password=password, \
        initialCapacity=4, maxCapacity=10, capacityIncrement=2,\
        allowEveryone=true
################################################################################
# END: Cube view connection pools.
################################################################################

################################################################################
# BEGIN: Cube view clusters.
################################################################################
#olap.cubeView.enabledClusters=demoBasicCluster
olap.cubeView.cluster.demoBasicCluster=\
        serviceComponents=localhost/demo/basic;localhost/demo2/basic
################################################################################
# END: Cube view clusters.
################################################################################