Bitmask Data Types (C)

The values for these data types consist of bit values that are combined to provide additional values when appropriate. For example, a caller needing WRITE access to a database must have the READ and WRITE privileges, thus ESS_ACCESS_WRITE equals the bit values for ESS_PRIV_READ and ESS__PRIV_WRITE. Similarly, ESS_OBJTYPE_BACKUP is a combination of ESS_OBJTYPE_ASCBACKUP and ESS_OBJTYPE_BINBACKUP.

Data TypeEssbase TypeDescription
typedef unsigned shortESS_ACCESS_TSecurity access level. Possible bit values are:

  • ESS_PRIV_NONE - 0x0000 - no privilege

  • ESS_PRIV_READ - 0x0001 - read data

  • ESS_PRIV_WRITE - 0x0002 - write data

  • ESS_PRIV_CALC - 0x0004 - calculate data

  • ESS_PRIV_DBLOAD - 0x0010 - load and unload databases

  • ESS_PRIV_DBDESIGN - 0x0020 - manage databases

  • ESS_PRIV_DBCREATE - 0x0040 - create, delete, and edit databases

  • ESS_PRIV_APPLOAD - 0x0100 - load and unload applications

  • ESS_PRIV_APPDESIGN - 0x0200 - manage applications

  • ESS_PRIV_APPCREATE - 0x0400 - create, delete, and edit applications

  • ESS_PRIV_USERCREATE - 0x1000 - create, delete, and edit users

The access types are combinations of privileges. The valid values are:

  • ESS_ACCESS_NONE - 0x0000

  • ESS_ACCESS_READ - 0x0111

  • ESS_ACCESS_WRITE - 0x0113

  • ESS_ACCESS_CALC - 0x0117

  • ESS_ACCESS_METAREAD - 0x0118

  • ESS_ACCESS_DBMANAGE - 0x0137 (also known as ESS_ACCESS_DBDESIGN, preserved for backward compatibility)

  • ESS_ACCESS_DBCREATE - 0x0177

  • ESS_ACCESS_APPDESIGN - 0x0377

  • ESS_ACCESS_APPCREATE - 0x0777

  • ESS_ACCESS_FILTER - 0x0110

  • ESS_ACCESS_DBALL - 0x00ff - full database access

  • ESS_ACCESS_APPALL - 0x0fff - full application/database access

  • ESS_ACCESS_ADMIN - 0xffff - administrator (unrestricted access) (also known as ESS_ACCESS_SUPER, preserved for backward compatibility)

The Oracle's Hyperion® Shared Services security role mappings are:

  • ESS_USERPROVROLE_NONE = ESS_ACCESS_NONE = 0x0000

  • ESS_USERPROVROLE_USERCREATE = ESS_PRIV_USERCREATE = 0x1000

    Note:

    This role cannot be set by Essbase in Shared Services mode; it can only be set in Shared Services.

  • ESS_USERPROVROLE_APPCREATE = ESS_PRIV_APPCREATE = 0x0400

  • ESS_USERPROVROLE_APPMANAGER = ESS_ACCESS_APPMANAGE or ESS_ACCESS_APPDESIGN = 0x0377

  • ESS_USERPROVROLE_APPLOAD = ESS_PRIV_APPLOAD = 0x0100

  • ESS_USERPROVROLE_DBFILTER = ESS_ACCESS_FILTER = 0x0110

  • ESS_USERPROVROLE_DBREAD = ESS_ACCESS_READ = 0x0111

  • ESS_USERPROVROLE_DBWRITE = ESS_ACCESS_WRITE = 0x0113

  • ESS_USERPROVROLE_DBCALC = ESS_ACCESS_CALC = 0x0117

  • ESS_USERPROVROLE_DBMANAGER = ESS_ACCESS_DBMANAGE or ESS_ACCESS_DBDESIGN = 0x0137

  • ESS_USERPROVROLE_ADMINISTRATOR = ESS_ACCESS_ADMIN or ESS_ACCESS_SUPER = 0xffff

typedef unsigned longESS_OBJTYPE_T

File object type.

Single object types are:

  • ESS_OBJTYPE_NONE

  • ESS_OBJTYPE_OUTLINE

  • ESS_OBJTYPE_CALCSCRIPT

  • ESS_OBJTYPE_REPORT

  • ESS_OBJTYPE_RULES

  • ESS_OBJTYPE_ALIAS

  • ESS_OBJTYPE_STRUCTURE

  • ESS_OBJTYPE_ASCBACKUP

  • ESS_OBJTYPE_BINBACKUP

  • ESS_OBJTYPE_EXCEL

  • ESS_OBJTYPE_LOTUS2 (No longer supported)

  • ESS_OBJTYPE_LOTUS3 (No longer supported)

  • ESS_OBJTYPE_TEXT

  • ESS_OBJTYPE_PARTITION

  • ESS_OBJTYPE_LOTUS4 (No longer supported)

  • ESS_OBJTYPE_WIZARD

  • ESS_OBJTYPE_OTL_E

  • ESS_OBJTYPE_SELECTION

  • ESS_OBJTYPE_LRO

#define ESS_OBJTYPE_MAX 0x08000000 /* maximum single object type value */ Combined object types are:

  • ESS_OBJTYPE_BACKUP

  • ESS_OBJTYPE_WORKSHEET

  • ESS_OBJTYPE_DATA

  • ESS_OBJTYPE_ALL