Professional Documents
Culture Documents
This document is directed to all of the Oracle/Hyperion Planning technicians. Its contents are an amalgamation of unofficial documents, my knowledge and hours of experimentation. Use the information to help understand the Planning tables but whatever you do, dont take anything as fact. I cant stress this enough. Be sure to look at the queries found at the end of this document. They will help you understand the relationships between tables. Regards, Dave Farnsworth Solutions Experts, Inc. www.solutionsexperts.com dave@solutionsexperts.com
Disclaimer The author has made every effort to ensure the accuracy of the information herein. There is no official public documentation available for the Planning tables. This information has been compiled using notes, conversations and experience. The content and uses of the planning tables changes from version to version. Use this document as a guide only. However, this information is supplied without warranty, either express or implied. The author will not be held liable for any damages caused either directly or indirectly by the instructions contained herein.
Dave Farnsworth
Page 1
5/16/2010
Table descriptions ............................................................................................................... 4 HSP_ACCESS_CONTROL ............................................................................................... 8 HSP_ACCOUNT................................................................................................................ 8 HSP_ACCOUNT_DESC.................................................................................................... 9 HSP_ACTION .................................................................................................................. 10 HSP_ACTIVITY_LEASE................................................................................................ 10 HSP_ALIAS ..................................................................................................................... 10 HSP_ANNOTATION....................................................................................................... 11 HSP_ATTRIBUTE_DIM ................................................................................................. 11 HSP_ATTRIBUTE_MEMBER........................................................................................ 12 HSP_AUDIT_OPTIONS.................................................................................................. 12 HSP_CALENDAR ........................................................................................................... 13 HSP_CELL_NOTE........................................................................................................... 13 HSP_CELL_NOTE_ITEM............................................................................................... 14 HSP_CHECKOUTS ......................................................................................................... 14 HSP_COLUMN_DETAIL ............................................................................................... 14 HSP_COLUMN_DETAIL_ITEM.................................................................................... 15 HSP_CUBES .................................................................................................................... 15 HSP_CURRENCY ........................................................................................................... 16 HSP_DIMENSION........................................................................................................... 16 HSP_DRIVER_MEMBER ............................................................................................... 18 HSP_ENTITY................................................................................................................... 18 HSP_ENUMERATION.................................................................................................... 19 HSP_ENUMERATION_ENTRY..................................................................................... 19 HSP_FORM...................................................................................................................... 20 HSP_FORM_ATTRIBUTES ........................................................................................... 20 HSP_FORM_CALCS ....................................................................................................... 21 HSP_FORM_LAYOUT ................................................................................................... 21 HSP_FORM_MENUS...................................................................................................... 22 HSP_FORM_VARIABLES ............................................................................................. 22 HSP_FORMOBJ_DEF ..................................................................................................... 22 HSP_FORMOBJ_DEF_MBR .......................................................................................... 23 HSP_FX_RATES ............................................................................................................. 24 HSP_FX_TABLES ........................................................................................................... 25 HSP_FX_VALUES .......................................................................................................... 25 HSP_GROUP.................................................................................................................... 25 HSP_LINKS ..................................................................................................................... 26 HSP_LOCK ...................................................................................................................... 26 HSP_MEMBER................................................................................................................ 26 HSP_MEMBER_FORMULA .......................................................................................... 28 HSP_MEMBER_TO_ATTRIBUTE ................................................................................ 28 Dave Farnsworth Page 2 5/16/2010
Dave Farnsworth
Page 3
5/16/2010
Description Category Describes the access rights Permissions for the user or group to the specified object Describes the attributes for Member each account Internal table used to track changes Internal table used to track task or activities across multiple servers Links the alias to the member name Stores annotations made by users for planning units and forms Describes the attribute dimension Describes the attributes for each attribute dimension. controls audit options Audit detail System System
HSP_ALIAS HSP_ANNOTATION
Member
Attribute Attribute Application Settings System Calc Mgr Calc Mgr Calc Mgr Calc Mgr Application Settings Cell Notes
HSP_CELL_NOTE
HSP_CELL_NOTE_ITEM HSP_CHECKOUTS
HSP_COLUMN_DETAIL
Specifies the range of years, start fiscal year and base time period Defines the cell intersection for the cell note. Cell note message List of users who have checked out a form for off-line access Defines the cell intersection for the supporting detail Page 4
Supporting Detail
Dave Farnsworth
5/16/2010
defines the plan types Stores currency information but not rates Each row describes a dimension Describes the formula for a member Describes the members of the entity dimension Defines smartlist tables Defines contents of the smartlists Describes each form Used to display attributes on data forms Associates calcs and business rules with a form Describes the location & position of each dimension for a specified axis Defines form menus Defines user variables used informs Defines the row, column and page definition on a form Defines the members for a dimension on a form NOT USED Each row represents an exchange rate between 2 currencies Defines exchange rate tables Represents an exchange rate between 2 currencies for a given time Defines the security Page 5
Application Settings Smart Lists Smart Lists Forms Forms Forms Forms
HSP_FX_TABLES HSP_FX_VALUES
FX Rates FX Rates
Permissions 5/16/2010
HSP_MEMBER_TO_UDA
Member
HSP_MENU_ITEM
Application Settings
HSP_PENDING_XACTS
System
Dave Farnsworth
HSP_TASK
HSP_TEXT_CELL_VALUE
Application Settings Application Settings Application Settings Application Settings Permissions Permissions Application Settings Application Settings
Dave Farnsworth
Page 7
5/16/2010
Each row describes the access rights for the user or group to the specified object Column Name Column Type Description integer USER_ID FK(object) Object IID of a user integer OBJECT_ID FK(object) Object whose access is being controlled integer ACCESS_MODE Permissions allowed to the object by the user/group 1=read 3=write -1=deny FLAGS integer Determines the hierarchy access given to the object 0=member 5=children 6=ichildren 8=descendants 9=idescendants
Each row describes a member of the account dimension. Column Name Column Type integer ACCOUNT_ID smallint USE_445
TIME_BALANCE
smallint
SKIP_VALUE
smallint
Description FK(member) 0=dont adjust 1=445 monthly spread 2=454 monthly spread 3=544 monthly spread Essbase time balance attribute 0=none 1=first 2=last 3=average Essbase skip attribute 0=none 5/16/2010
Dave Farnsworth
Page 8
ACCOUNT_TYPE
smallint
VARIANCE_REP
smallint
CURRENCY_RATE
smallint
PLANNING_METHOD USED_IN
smallint smallint
DATA_TYPE
smallint
SRC_PLAN_TYPE
integer
SUB_ACCOUNT_TYPE
integer
An account may have different account descriptions for each planning unit (scenario, version, entity). If any, the descriptions are stored here. Column Name Column Type Description integer SCENARIO_ID Object ID of scenario Dave Farnsworth Page 9 5/16/2010
Description Internally generated action ID Source IF from where change occurred Target where change is applied Change type 1=add 2=modify 3=delete Object type that was changed Identifies the object modified Time stamp
Internal table used to track activities across servers. Column Name Column Type integer ACTIVITY_ID integer SERVER_ID datetime EXPIRATION_DATE
Each row links an alias object with a member name object. Dave Farnsworth Page 10 5/16/2010
Each row is a user entered annotation stored by object planning unit or form. Objects may have more multiple annotations. Column Name Column Type Description integer OBJECT_ID Object associated with annotation integer ANNOT_SEQ Internally assigned sequence number because an object may have multiple annotations integer AUTHOR_ID ID of the user datetime CREATED Creation date varchar(40) TITLE Title of annotation varchar(2000) CONTENTS Annotation text
Each row describes a single attribute dimension. A dimension can have multiple attributes. Column Name Column Type Description integer ATTR_ID FK(object) integer DIM_ID FK(dimension) identifies the associated dimension integer ATTRIB_TYPE Essbase attribute type 0=text Dave Farnsworth Page 11 5/16/2010
Table defines the attribute values. Each row contains a member for an attribute. Column Name Column Type Description integer ATTR_MEM_ID FK(member) integer ATTR_ID FK(attribute_dim) identifies the associated dimension smallint LEVEL0 0=not leaf level 1=is leaf Varchar(32) TEXT_VAL Holds text attribute value numeric NUMBER_VAL Holds numeric attribute value smallint BOOLEAN_VAL 0=false 1=true datetime DATE_VAL Holds date attribute value
Contains application audit options. Column Name Column Type smallint AUDIT_FORMS smallint AUDIT_DATA smallint AUDIT_PUS smallint AUDIT_COPY_VERS smallint AUDIT_MEMBERS smallint AUDIT_CALCS smallint AUDIT_ALIAS_TABLES smallint AUDIT_USERS smallint AUDIT_GROUPS smallint AUDIT_SECURITY AUDIT_FORM_FOLDERS smallint smallint AUDIT_OFFLINE Dave Farnsworth Page 12
Description 0=no, 1=yes, default=0 0=no, 1=yes, default=0 0=no, 1=yes, default=0 0=no, 1=yes, default=0 0=no, 1=yes, default=0 0=no, 1=yes, default=0 0=no, 1=yes, default=0 0=no, 1=yes, default=0 0=no, 1=yes, default=0 0=no, 1=yes, default=0 0=no, 1=yes, default=0 0=no, 1=yes, default=0 5/16/2010
HSP_AUDIT_RECORDS Audit records generated when auditing is implemented. Column Name Column Type Varchar(100) TYPE Varchar(500) ID_1 Varchar(500) ID_2 Varchar(100) USE_NAME datetime TIME_POSTED Varchar(100) ACTION Varchar(100) PROPERTY Varchar(1500) OLD_VAL Varchar(1500) NEW_VAL
Description
Describes the application calendar. Column Name Column Type integer CALENDAR_ID integer FIRST_YEAR integer NUMBER_YEARS smallint FY_MONTH BASE_TIME_PERIOD PERIODS_IN_YEAR PREFIX CURRENT_YEAR CURRENT_TP smallint smallint Varchar(20) datetime integer
Description FK(object) First year of calendar Number of years in calendar First month of fiscal year. Jan=1, Feb=2, etc. Holds numeric attribute value Number of periods in year Prefix for custom time periods Holds date attribute value FK(time_period)
Each row of the table identifies a cell note entry and the associated Essbase dimension data points. Dave Farnsworth Page 13 5/16/2010
Table defines the detail text and values associated with a cell note entry. Column Name Column Type Description integer From HSP_CELL_NOTE NOTE_ID Varchar(2000) Cell note CONTENTS
Table lists users that have a form checked out for offless.ine ac Column Name Column Type Description integer FK(HSP_USERS) user who USER_ID checked out form integer FK(HSP_FORM) form that FORM_ID was checked out datetime Date & time the user CHECK_OUT checked out the form
Each row of the table identifies a supporting detail entry and the associated Essbase dimension data points. Column Name Column Type Description Dave Farnsworth Page 14 5/16/2010
Table defines the detail text and values associated with a supporting detail entry. Column Name Column Type Description integer From DETAIL_ID HSP_COLUMN_DETAIL float Detail value VALUE integer Numerical position of detail POSITION starting with 0 integer Generation of detail starting GENERATOR with 0 integer 0=ignore OPERATOR 1=add 2=subtract 3=multiply 4=divide Varchar(1500) Detail description LABEL
Each row is a cube that Planning creates in Essbase Column Name Column Type integer CUBE_ID integer PLAN_TYPE
Description FK(object) 1=revenue 2=p&l 4=balance sheet 8=workforce 16=capex Timestamp indicating last refresh 0=generic 5/16/2010
LOCATION_ALIAS
Varchar(80)
Each row describes a currency. Column Name Column Type integer CURRENCY_ID Varchar(10) SYMBOL datetime SCALE integer TRIANGLE_CUR CURRENCY_TYPE smallint
REPT_CURRENCY THOUSANDS_SEP
smallint smallint
DECIMAL_SEP NEGATIVE_SIGN
smallint smallint
NEGATIVE_COLOR
smallint
Description FK(object) Eg. $ Valid values 1-10 Intermediate currency if triangulated 1=pre-defined 2=user-defined 3=pre-defined but overridden by a userdefined with same currency code 1=not reporting currency 2=reporting currency 0=none 1=comma 2=period 3=space 0=period 1=comma 0=prefixed minus 1=suffixed minus 2=brackets 0=black 4=red
Each row is a dimension for the planning application. In addition to user defines and attribute dimensions, all required planning dimensions are listed in the table whether they are used or not. For dimensions not in use such as FX Rates, dim type will be 0. Column Name Column Type Description integer FK(object) DIM_ID Varchar(10) 1=Access control is on for ENFORCE_SECURITY this dimension Dave Farnsworth Page 16 5/16/2010
DENSITY
integer
USED_IN
smallint
DIM_EDITOR DENSITY1
smallint smallint
DENSITY2 DENSITY3 DENSITY4 DENSITY5 POSITION1 POSITION2 POSITION3 POSITION4 POSITION5 ENUM_ORDER1 ENUM_ORDER2 ENUM_ORDER3 ENUM_ORDER4 ENUM_ORDER5 DRIVER_DIM_ID
smallint smallint smallint smallint smallint smallint smallint smallint smallint smallint smallint smallint smallint smallint integer
Dave Farnsworth
Page 17
5/16/2010
Each row describes a member formula for a member. Column Name Column Type integer BASE_DIM_ID
DIM_ID
integer
Description FK(dimension) base dimension which the formula drives FK(dimension) the driver dimension that this member belongs FK(member) Function that describes the relationship to the member Relative position of this driver member to other driver member values for this dimension
Rows describe the entities dimension members Column Name Column Type integer ENTITY_ID DEFAULT_CURRENCY integer
USED_IN
smallint
Description FK(member) FK(currency) default currency associated with entity Bitmask of the plan types that use this dimension. Bitmask value is the sum of the Plantypes. i.e. 3= revenue & P&L, 7= revenue , P&L and balance sheet ID of employee Requisition number of tobe-hired. 0=none (default) 1=employee 2=department-general 3=TBH-input
Dave Farnsworth
Page 18
5/16/2010
A row in this table defines a smartlist. Column Name Column Type integer ENUM_ID NAME integer
LABEL DISPLAY_ORDER
smallint Varchar(255)
MISSING_LABEL
Varchar(255)
OVERRIDE_GRID_MISSING
smallint
AUTO_GEN_ID
ALLOW_ENTRY_ON_THE_FLY
Description FK(member) linked to the smartlist Non-translatable name that can be use in calculations Name shown to the end-user 0=by ID 1=by name 2=by label Value to display when a data cell contains #Missing 0=use for grid setting 1=use the missing label defined above 0=no auto generated IDs 1=auto gen IDs 0=not allowed 1=allow users to enter new values (AUTO_GEN must be set to 1)
A row in this table defines a value within a smartlist that was defined in Column Name Column Type Description integer FK(member) linked to ENUM_ID the smartlist integer ID of smartlist entry ENTRY_ID Varchar(80) Non-translatable name NAME that can be use in calculations Varchar(255) Name shown to the LABEL end-user Dave Farnsworth Page 19 5/16/2010
A row in this table describes a single form Column Name Column Type integer FORM_ID smallint PRECISION1
PRECISION2
smallint
PRECISION3
smallint
Description Internally generated id Number of decimals displayed for currency data Number of decimals displayed for noncurrency data Number of decimals displayed for percentage data Minimum precision
Maximum precision
Scaling format of the displayed data Determines whether row formatting takes precedence over column. 0=row(default) 1=column 1=standard 2=custom Object of the cube Display alias Default data cell column width
Table indicates which attributes are to be displayed on the grid. Column Name Column Type Description integer Order of the attribute POSITION Dave Farnsworth Page 20 5/16/2010
Table associates the Essbase calculation/business rules with the form. Column Name Column Type Description integer ID (from HSP_FORM) FORM_ID of the associated form integer Id of calc script CALC_ID Varchar(80) Name of script CALC_NAME integer Plan type associated PLAN_TYPE with the calc script 0=no RUN_ON_LOAD 1=yes 0=no RUN_ON_SAVE 1=yes 0=graphical HBR CALC_TYPE 1=Extended HBRcalc script 2=sequence HBR 3=native essbase Flag indicates whether USE_MRU to use sticky PV selections 0=no 1=yes 0=no(default) HIDE_PROMPT 1=yes
A row describes the location for each dimension on the form Column Name Column Type integer FORM_ID Dave Farnsworth Page 21
Table stores menus associated with form definitions Column Name Column Type integer POSITION FORM_ID MENU_ID integer smallint
Description Order which menus are displayed ID (from HSP_FORM) of the associated form FK(object) ID of associated menu
Table stores user variables used by form definitions. Column Name Column Type integer POSITION FORM_ID VARIABLE_ID integer smallint
Description Order which menus are displayed ID (from HSP_FORM) of the associated form FK(user_variable) ID of the user variables
Each row describes a single row, column or page definition. Column Name Column Type integer OBJDEF_ID integer FORM_ID Dave Farnsworth Page 22
LOCATION
float
STYLE
integer
Each row describes the selected member associated with the form object definition. Column Name Column Type Description integer FK(formobj_def) OBJDEF_ID float maps to the ordinal ORDINAL field of FORM_LAYOUT. Used to determine the dimension integer FK(MEMBER) MBR_ID float ? = Children QUERY_TYPE ? = IChildren ? = Descendants ? = IDescendants float Allows more than 1 SEQUENCE member to be specified for a dimension. Varchar(80) Essbase substitution SUBST_VAR variable name HSP_FX_RATE_VALUES Note: this table is no longer used Column Name FX_TABLE_ID FROM_CUR TO_CUR FP_START Dave Farnsworth
Each row describes an exchange rate between 2 currencies. Column Name Column Type integer FX_TBL_ID integer FROM_CUR integer TO_CUR Dave Farnsworth Page 24
Each row describes an exchange rate table Column Name Column Type integer FX_TBL_ID integer CALENDAR_ID
Description FK(object) FK(calendar) applies to the time periods specified in this calendar
Description FK(fx_table) FK(currency) FK(currency) Relative starting period to which the rates apply Ending period that rates apply. Average rate for period Rate at the end of time period
Stores URL links based on user type. Column Name Column Type integer LINK_ID smallint USER_TYPE
Description ID is auto generated 1=planner 2=interactive 3=admin Name of URL URL Description for URL
Description ID of object being locked Id of session holding the lock FK(users) User holding the lock
Each row stores a dimension member. Column Name MEMBER_ID DIM_ID CONSOL_OP1
Description FK(object) FK(dimension) Essbase consolidation attribute for Revenue plan type 0=add 1=subtract 5/16/2010
Dave Farnsworth
Page 26
CONSOL_OP2
smallint
CONSOL_OP3
smallint
CONSOL_OP4
smallint
CONSOL_OP5
smallint
DATA_STORAGE
smallint
TWOPASS_CALC
smallint
USED_FOR_CONSOL
smallint
HAS_MBR_FX
smallint
BASE_MBRID
integer
ENABLED_FOR_PM
smallint
PS_MEMBER_ID
integer
Dave Farnsworth
Page 27
Stores the member formula for a member. Column Name Column Type integer MEMBER_ID ntext FORMULA
Each row links a standard dimension member to an attribute value. A member can be linked to only a single value for an attribute dimension. Column Name Column Type Description integer FK(member) MEMBER_ID integer FK(attribute_dim) ATTR_ID integer FK(attribute_member) ATTR_MEM_ID integer ID that identifies PERSPECTIVE1 independent member integer ID that identifies PERSPECTIVE2 independent member
Rows describe the member to UDA association. A member can have only one association per UDA. Column Name Column Type Description integer FK(member) MEMBER_ID integer FK(UDA) UDA_ID Dave Farnsworth Page 28 5/16/2010
Table stores user defined menus that appear when the user right clicks a grid. Column Name Column Type Description integer ID of menu item MENU_ITEM_ID integer FK(object) MENU_ID Varchar(255) Name shown to user LABEL Varchar(255) Path to icon resource ICON file integer 0=menu or submenu or MENU_ITEM_TYPE separator 1=URL 2=data entry form 3=business rule integer References the REQUIRED_DIM_ID dimension that is required to be clicked on before menu appears. NULL = no required dimension smallint 0=no OPEN_IN_NEW_WINDOW 1=yes Based on MENU_ITEM_TYPE integer Numeric properties INT_PROP1 associated with menu item integer INT_PROP2 integer INT_PROP3 Varchar(255) Text properties STR_PROP1 associated with menu item Varchar(255) STR_PROP2 Varchar(255) STR_PROP3 Varchar(255) STR_PROP4
Used to track user POV settings for data entry. Dave Farnsworth Page 29 5/16/2010
Each row contains a Planning object. Every Planning object can be found here. The key is OBJECT_ID. Column Name Column Type Description integer Internally generated ID OBJECT_ID Varchar(80) Name for the object OBJECT_NAME integer FK(strings) DESCRIPTION smallint FK(object_type) OBJECT_TYPE integer FK(object) PARENT_ID integer FK(object) OWNER_ID integer Generation number for GENERATION object float Relative position within POSITION the hierarchy to other objects smallint 0=no children HAS_CHILDREN 1=has children datetime when created CREATED datetime When last modified MODIFIED datetime When last moved MOVED Varchar(80) Used when renaming OLD_NAME members. OBJECT_NAME & OLD_NAME are always equal unless there is a rename. In that case, they are set to the same after the refresh. integer Not used SECCLASS_ID smallint 0=not marked MARKED_FOR_DELETE 1=marked smallint 0=no REMOVABLE 1=yes
Dave Farnsworth
Page 30
5/16/2010
Description 1=hierarchy node (folder) 2=dimension 3=attribute dimension 4=calendar 5=user 6=group 7=form 8=FX table 9=currency 10=alias 11=cube 12=planning unit 13=planning unit history 14=annotation 15=access control 16=supporting detail 17=user preferences 18=account annotations 30=attribute member 31=category 32=account 33=entity 34=time period 35=version 37=currency member 38=year 45=shared member 50=user defined dimension member Name for the object type
TYPE_NAME
integer
Used by the refresh process. The content and function of this table changes dramatically between version particularly pre & post 9.3. Dave Farnsworth Page 31 5/16/2010
Used by the refresh process. The content and function of this table changes dramatically between version particularly pre & post 9.3. Column Name Column Type Description integer FK(object) OBJECT_ID integer FK(plan_type) PLAN_TYPE integer Transaction type XACT_TYPE 0=delete 1=add datetime When object was XACT_DATE deleted Varchar(80) Name of member to OBJECT_NAME delete Varchar(80) Old name of member to OLD_NAME delete integer Object type of object SRC_MBR
List of the plan types for the application. Column Name Column Type integer PLAN_TYPE Varchar(40) TYPE_NAME
Used to track planning units (scenario, version, entity) and their process state for PM. Column Name Column Type Description integer Internally generated ID PLAN_UNIT_ID integer FK(dimension) SCENARIO_ID integer FK(dimension) VERSION_ID integer FK(dimension) ENTITY_ID integer FK(users) OWNER_ID integer FK(dimension) ORIGINATOR_ID Dave Farnsworth Page 32 5/16/2010
PROCESS_STATE
smallint
Used to track history of the planning unit process state changes for PM. Column Name Column Type Description integer Internally generated ID PLAN_UNIT_ID integer Sequence of actions LOG_SEQ integer FK(users) use who AUTHOR_ID performed the actions smallint 0=promote ACTION 1=reject 2=approve 3=signoff 4=start 5=exclude smallint Current process state at PROCESS_STATE the time of the action 0=not started 1=first pass 2=under review 3=approved 4=signed off 5=not signed off datetime Time of change STATUS_CHANGED
Dave Farnsworth
Page 33
5/16/2010
Description ID of action Name of action (must be unique) Whether user can modify =no 1=yes Indicates display order
PROPAGATE_TO POSITION
integer integer
Defines process management effects of transitioning into a state. Column Name Column Type integer EFFECT_ID Varchar(80) not null NAME unique integer EFFECT_ACTIONS
EMAIL_FROM
integer
EMAIL_FORM_OTHER
integer
Description ID of STATE Name of EFFECT (must be unique) Actions performed on this effect 0=audit action (send to table history) 1=audit indirect(eg, rollup, indirect, send to history table) 2=send e-mail notification 1=other 2=previous owner 4=new owner 8=actor\16=app owner Email address to use when email_from = Other 1=other 2=previous owner 4=new owner
EMAIL_TO
Dave Farnsworth
Page 34
5/16/2010
MESSAGE_TYPE
MESSAGE_OTHER
Defines process management transition rules between states. Column Name Column Type integer FROM_STATE_ID nteger CHANGEABLE_BY
SCENARIO_ID EFFECT_ID
integer integer
Description ID of initial state 0=owner 1=anyone with access 2=admin 3=no one ID action performed ID of new state after performing action 0=owner 1=anyone with access 2=admin 3=no one 4=self scnario rule is bound 0=all scenario ID of effect to apply for rule s
Defines process management states Column Name STATE_ID NAME MODIFIABLE Dave Farnsworth
Description ID of state Name of state (must be unique) Whether user can 5/16/2010
AFFECTED
smallint
PRECEDENCE
integer
COLOR
Varchar(80)
Contains the PDF print options for a given user or form. If user is used, all forms have the same print option. If no user option is specified then the form print format is used. Column Name Column Type Description integer FK(object) OBJECT_ID Varchar(255) 0=portrait ORIENTATION 1=landscape integer Font used for printing FONT integer Base font. Default = 8 FONT_SIZE integer % of screen used for ROW_HEADER_WIDTH row hdr. 35=default smallint 6=default NUM_DATA_COLS smallint 0=no REPEAT_HEADER 1=yes (default) smallint Whether to apply FORMAT_DATA currency formatting 0=no 1=yes (default) smallint Apply precision defined LIMIT_PRECISION in form
Dave Farnsworth
Page 36
5/16/2010
SHOW_SUPPORT
smallint
SHOW_ADESC
smallint
SHOW_ATTRIB
smallint
SHOW_CURRENCY
smallint
Stores the scenario properties for each scenario member in the application. Column Name Column Type Description integer FK(member) SCENARIO_ID integer FK(member) start year START_YR_ID for scenario integer FK(time_period) start START_TP_ID month integer FK(member) ending END_YR_ID year integer FK(time_period) END_TP_ID ending month integer FK(fx_table) FX_TABLE smallint 0=no USEBEGBALANCE 1=yes smallint 0=no ENABLEPORPM 1=yes Dave Farnsworth Page 37 5/16/2010
THE_STRING
Nvarchar(254)
Description Internally generated ID Unique for each language. This is the MSFT language ID A string in the given language. THE_STRING is in Unicode.
System level information for application Column Name Column Type integer VERSION RELEASE OFFICIAL_TARGETS OFFICIAL_BUPS MAX_PER_USER integer integer integer integer
BOOL_TRUE
integer
BOOL_FALSE
integer
CALC_SUM
integer
CALC_COUNT
integer
Description version number for databasev Release number for database Number of official target versions Number of personal bottom up versions Maximum personal versions allowed per users String value corresponding to the attribute true String value corresponding to the attribute false String value corresponding to the attribute Sum String value corresponding to the attribute Count 5/16/2010
Dave Farnsworth
Page 38
CALC_MAX
integer
CALC_AVG
integer
DATE_FMT QUALIFIER
Varchar(32) smallint
QUALIFIER_TYPE
smallint
LAST_VERSION_IDX SUPPORT445
integer smallint
EMAIL_SERVER MULTI_CURRENT
Varchar(255) smallint
SHARED_MEMBER_SEC
smallint
Dave Farnsworth
Page 39
USERSUPDATE USEFULLNAME
datetime smallint
CSS_VERSION
smallint
EIE_SERVER ESS_DEF_PSWD
Varchar(255) Varchar(30)
LOGIN_LEVEL
integer
TI_OPTIONS REF_APP
Table contains a list of variables that may be used in a form definition. Column Name Column Type Description Dave Farnsworth Page 40 5/16/2010
STR_PROP1 INT_PROP2
Varchar(255) Integer
Table contains the text cell value to numeric mappings. Column Name Column Type integer TASK_ID Varchar(255) VALUE
Each row in this table describes a member of the time perion dimension. Column Name Column Type Description integer FK(MEMBER) Time TP_ID period identifier. integer Index of time periods. PERIOD Leaf members are 1 through N. All others are 0. Dave Farnsworth Page 41 5/16/2010
Each row describes a UDA for a dimension. Dimensions can have multiple UDAs but UDAs must be unique within a dimension. Column Name Column Type Description integer Internally generated UDA_ID UDA identifier integer FK(DIMENSION) this DIM_ID is the dimension that this UDA belongs Varchar(80) Value of the UDA UDA_VALUE HSP_UNIQUE_NAMES There is a row for every member name & alias in Essbase. The table ensures the uniqueness required by Essbase. Column Name Column Type Description integer FK(OBJECT) OBJECT_ID Varchar(80) Name of the object OBJECT_NAME
Contains the user planning web preferences Column Name Column Type integer USER_ID EMAIL EMAIL_ENABLE EMAIL_OPTIONS LANG_CODE COUNTRY_CODE THOUSAND_SEP DECIMAL_SIGN Dave Farnsworth Varchar(255) Smallint Integer Varchar(2) Varchar(2) Smallint Smallint Page 42
Description FK(USERS) object Id for user or group email address of user 0=enable 1=disable Determines how email notification is done
5/16/2010
Tracks tasks when completed or alert sent Column Name Column Type integer TASK_ID integer USER_ID datetime COMPLETED_DATE ALERT_SENT_DATE datetime
Description FK(USER_VARIABLE) Fk(USER) When task was completed When alert was sent
Contains a list of variables that may be used in a form definition Column Name Column Type integer VARIABLE_ID Smallint DIM_ID Smallint VARIABLE_NAME
Contains a the associated variable value on a per user basis. Dave Farnsworth Page 43 5/16/2010
Each row has a user with some access to the application Column Name Column Type integer USER_ID Varchar(255) SID integer ROLE
SYNC_PSWD
smallint
OFFLINE_ENABLED HUB_ROLES
smallint integer
Description FK(OBJECT) Security identifier 0=admin 1=planner 2=interactive 3=owner 0=dont sync essbase Pw with NT 1=sync essbase with NT 0=no 1=yes Default =0
Each row has a user ssociated with the group. Column Name Column Type integer GROUP_ID integer USER_ID
Stores the version properties for each version member in the application. Column Name Column Type Description integer FK(MEMBER) VERSION_ID Smallint 0=Personal VESRION_TYPE 1=Official BU 2=Official Target Dave Farnsworth Page 44 5/16/2010
The queries were written for SQLServer. They use the CASE statement. To modify the queries for ORACLE, use the DECODE statement in place of CASE. For example, in the query below, replace the case statement that is between the 2 green comment lines with the following: -- begin decode snippet
Decode(M.consol_op3, 0, '+' , , , , , , 1, 2, 3, 4, 5, 6, '-' '*' '/' '%' '~' '^') consol_value,
-- end decode
SELECT O.OBJECT_ID, O.OBJECT_NAME MEMBER_NAME, (select oa.object_name from HSP_ALIAS A, HSP_OBJECT OA where a.member_id = o.object_id and oa.object_id = a.alias_id) -- begin case statement case M.consol_op3 When 0 then '+' When 1 then '-' When 2 then '*' When 3 then '\' When 4 then '%' When 5 then '^' When 6 then '~' end as consol_value, -- end of case PO.PARENT_ID, PO.OBJECT_NAME PARENT_NAME,
Alias_name,
Dave Farnsworth
Page 45
5/16/2010
Alias_name,
PO.OBJECT_NAME PARENT_NAME, case M.consol_op3 When 0 then '+' When 1 then '-' When 2 then '*' When 3 then '\' When 4 then '%' When 5 then '^' When 6 then '~' end as consol, Case M.DATA_STORAGE When 0 then 'Store Data' When 1 then 'Never Share' When 2 then 'Label Only' When 3 then 'Shared Member' When 4 then 'Dynamic Calc and Store' When 5 then 'Dynamic' End STORAGE, Case M.TWOPASS_CALC When 0 then 'No' When 1 then 'Yes' End TWOPASS,
Dave Farnsworth
Page 46
5/16/2010
End VARIANCE_REP, Case AA.CURRENCY_RATE When 0 then 'None' When 1 then 'Average' When 2 then 'Ending' When 3 then 'Historical' else '' End CURRENCY_RATE, AA.USED_IN, Case M.DATA_TYPE When 1 then 'Currency' When 2 then 'Non Currency' When 3 then 'Percentage' else '' End DATA_TYPE, Case AA.SRC_PLAN_TYPE When 0 then 'NA'
Dave Farnsworth
Page 47
5/16/2010
SELECT O.OBJECT_ID, O.OBJECT_NAME MEMBER_NAME, (select oa.object_name from HSP_ALIAS A, HSP_OBJECT OA where a.member_id = o.object_id and oa.object_id = a.alias_id) PO.PARENT_ID, case M.consol_op3 When 0 then '+' When 1 then '-' When 2 then '*'
Alias_name,
Dave Farnsworth
Page 48
5/16/2010
Dave Farnsworth
Page 49
5/16/2010
Alias_name,
Dave Farnsworth
Page 51
5/16/2010