You are on page 1of 51

Hyperion Planning Table Definitions

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

Copyright @ 2010, Solutions Experts, Inc. All rights resreved

5/16/2010

Hyperion Planning Table Definitions

Table of Contents
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

Copyright @ 2010, Solutions Experts, Inc. All rights resreved

5/16/2010

Hyperion Planning Table Definitions


HSP_MEMBER_TO_UDA.............................................................................................. 28
HSP_MENU_ITEMS ....................................................................................................... 29
HSP_MRU_MEMBERS................................................................................................... 29
HSP_OBJECT................................................................................................................... 30
HSP_OBJECT_TYPE....................................................................................................... 31
HSP_PENDING_DELS.................................................................................................... 31
HSP_PENDING_XACTS ................................................................................................ 32
HSP_PLAN_TYPE........................................................................................................... 32
HSP_PLANNING _UNIT ................................................................................................ 32
HSP_PLANNING_UNIT_LOG ....................................................................................... 33
HSP_PM_ACTIONS ........................................................................................................ 34
HSP_PM_EFFECTS......................................................................................................... 34
HSP_PM_RULES............................................................................................................. 35
HSP_PM_STATES........................................................................................................... 35
HSP_PRINT_OPTS.......................................................................................................... 36
HSP_SCENARIO ............................................................................................................. 37
HSP_STRINGS................................................................................................................. 38
HSP_SYSTEMCFG.......................................................................................................... 38
HSP_TASK....................................................................................................................... 40
HSP_TEXT_CELL_VALUE ........................................................................................... 41
HSP_TIME_PERIOD ....................................................................................................... 41
HSP_UDA......................................................................................................................... 42
HSP_USER_PREFS ......................................................................................................... 42
HSP_USER_TASKS ........................................................................................................ 43
HSP_USER_VARIABLE................................................................................................. 43
HSP_USER_VARIABLE_VALUE ................................................................................. 43
HSP_USERS..................................................................................................................... 44
HSP_USERSINGROUP ................................................................................................... 44
HSP_VERSION................................................................................................................ 44
Sample Queries ................................................................................................................. 45
QUERY1: Account member ......................................................................................... 46
QUERY2: Custom dimension member ........................................................................ 48
QUERY3: Smart lists.................................................................................................... 49
QUERY 4: Member Access.......................................................................................... 50
QUERY 5: Member to Attribute................................................................................... 50

Dave Farnsworth

Page 3

Copyright @ 2010, Solutions Experts, Inc. All rights resreved

5/16/2010

Hyperion Planning Table Definitions


Table descriptions
Table Name
HSP_ACCESS_CONTROL

HSP_ACCOUNT
HSP_ACCOUNT_DESC
HSP_ACTION
HSP_ACTIVITY_LEASE

HSP_ALIAS
HSP_ANNOTATION

HSP_ATTRIBUTE_DIM
HSP_ATTRIBUTE_MEMBER
HSP_AUDIT_OPTIONS
HSP_AUDIT_RECORDS
HSP_CALC_MGR_RULES
HSP_CALC_MGR_RULESETS
HSP_CALC_MGR_USER_VAR_PPT
HSP_CALC_MGR_VARIABLES
HSP_CALENDAR

HSP_CELL_NOTE

HSP_CELL_NOTE_ITEM
HSP_CHECKOUTS

HSP_COLUMN_DETAIL

Dave Farnsworth

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

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

Copyright @ 2010, Solutions Experts, Inc. All rights resreved

System
System

Member

Attribute
Attribute
Application
Settings
System
Calc Mgr
Calc Mgr
Calc Mgr
Calc Mgr
Application
Settings
Cell Notes

Cell Notes
System

Supporting
Detail

5/16/2010

Hyperion Planning Table Definitions


HSP_COLUMN_DETAIL_ITEM

Supporting detail

HSP_COMPOSITE_BLOCK
HSP_COMPOSITE_FORM
HSP_CUBES

defines the plan types

HSP_CURRENCY
HSP_DIMENSION
HSP_DRIVER_MEMBER
HSP_ENITITY
HSP_ENUMERATION
HSP_ENUMERATION_ENTRY
HSP_FORM
HSP_FORM_ATTRIBUTES
HSP_FORM_CALCS
HSP_FORM_LAYOUT

HSP_FORM_MENUS
HSP_FORM_VARIABLES
HSP_FORMOBJ_DEF

HSP_FORMOBJ_DEF_MBR
HSP_FX_RATE_VALUES
HSP_FX_RATES

HSP_FX_TABLES
HSP_FX_VALUES

HSP_GROUP
Dave Farnsworth

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

Copyright @ 2010, Solutions Experts, Inc. All rights resreved

Supporting
Detail
Forms
Forms
Application
Settings
Application
Settings
Application
Settings

Application
Settings
Smart Lists
Smart Lists
Forms
Forms
Forms
Forms

Forms
Forms
Forms

Forms
FX Rates
FX Rates

FX Rates
FX Rates

Permissions
5/16/2010

Hyperion Planning Table Definitions


groups for Planning
HSP_JOB_STATUS
HSP_LINKS
HSP_LOCK
HSP_MEMBER
HSP_MEMBER_FORMULA
HSP_MEMBER_TO_ATTRIBUTE

HSP_MEMBER_TO_UDA

HSP_MENU_ITEM

HSP_MRU_MEMBERS
HSP_OBJECT
HSP_OBJECT_TYPE
HSP_PENDING_DELS

HSP_PENDING_XACTS

HSP_PLAN_TYPE
HSP_PLANNING_UNIT
HSP_PLANNING_UNIT_LOG

HSP_PM_ACTIONS
HSP_PM_EFFECTS
HSP_PM_RULES

Dave Farnsworth

Stores URL links


Tracks component locking
Describes the settings for
a dimension member
Contains member formula
Describes the mapping
from a standard member
to an attribute member
Describes the mapping
from a standard member
to an UDA
Describes user defined
menu items that appear as
a right click menu on a
data grid
Used to track the users
POV settings
Base table for all planning
objects
Internal list of object types
Internal table used to track
members as they get
deleted.
Tracks delete and Add
transactions. The table is
cleared following a
refresh.
internal table that lists
plan types
Track planning units and
their process states
Tracks the history defines
project management states
planning units and their
process states
Defines process state
management actions
Defines PM effects of
transitioning into a state
Defines PM transition
rules from state to state
Page 6

Copyright @ 2010, Solutions Experts, Inc. All rights resreved

System
Application
Settings
System
Member
Member
Attribute

Member

Application
Settings

System
Primary Table
System
System

System

Application
Settings
Application
Settings
System

Application
Settings
Application
Settings
Application
Settings
5/16/2010

Hyperion Planning Table Definitions


HSP_PM_STATES
HSP_PRINT_OPTS
HSP_SCENARIO

Defines PM states
Defines PDF print options
for a given form or user
Describes the scenario
dimension

HSP_SPREAD_PATTERN
HSP_STRINGS

String translation table

HSP_SYSTEMCFG

Describes the system level


information for the
Planning application
List of variables that may
be used in a form
definition
Contains the text value
that is linked to the
numerical ID
Describes each time
period
Each row describes a
UDA for a dimension.
Enforces the name
uniqueness required by
Essbase.
User preferences for a user

HSP_TASK

HSP_TEXT_CELL_VALUE

HSP_TIME_PERIOD
HSP_UDA
HSP_UNIQUE_NAMES

HSP_USER_PREFS
HSP_USER_TASKS

Tracks tasks when


completed or alert sent

HSP_USER_VARIABLE
HSP_USER_VARIABLE_VALUE
HSP_USERS
HSP_USERSINGROUP
HSP_VERSION

Stores version members


and properties

HSP_WF_SET_SCREEN

Dave Farnsworth

Page 7

Copyright @ 2010, Solutions Experts, Inc. All rights resreved

System
Application
Settings
Application
Settings
Application
Settings
Application
Settings
Application
Settings
Application
Settings
Cell Text

Application
Settings
Member
Member

Application
Settings
Application
Settings
Application
Settings
Application
Settings
Permissions
Permissions
Application
Settings
Application
Settings

5/16/2010

Hyperion Planning Table Definitions

HSP_ACCESS_CONTROL
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

HSP_ACCOUNT
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

Dave Farnsworth

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

Page 8

Copyright @ 2010, Solutions Experts, Inc. All rights resreved

5/16/2010

Hyperion Planning Table Definitions

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

1=skip missing values


2=skip zero values
3=skip both missing &
zero values
1=expense
2=revenue
3=asset
4=liability
5=equity
6=statistical
7=saved assumption
Essbase variance
reporting attributes
1=expense
2=non-expense
0=none
1=average
2=ending
3=historical
Bitmask indicating the
cubes that use the account
1=revenue
2=net income
4=balance sheet
1=currency
2=non-currency
3=percentage
Indicates source cube for
data source
1=revenue
2=net income
4=balance sheet

HSP_ACCOUNT_DESC
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

Copyright @ 2010, Solutions Experts, Inc. All rights resreved

5/16/2010

Hyperion Planning Table Definitions


integer
integer
integer
varchar(2000)

Object ID of version
Object ID of entity
Object ID of account
Contents of description

Internal table
Column Name
ID

Column Type
integer

FROM_ID

integer

TO_ID

integer

ACTION_ID

integer

OBJECT_TYPE

integer

PRIMARY_KEY

Varchar(255)

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

MESSAGE
ACTION_TIME

Nvarchar(127)
datetime

VERSION_ID
ENTITY_ID
ACCOUNT_ID
CONTENTS

HSP_ACTION

Time stamp

HSP_ACTIVITY_LEASE
Internal table used to track activities across servers.
Column Name
Column Type
integer
ACTIVITY_ID
integer
SERVER_ID
datetime
EXPIRATION_DATE

Description
ID of the activity
ID of the server
Time activity expires

HSP_ALIAS
Each row links an alias object with a member name object.
Dave Farnsworth

Page 10

Copyright @ 2010, Solutions Experts, Inc. All rights resreved

5/16/2010

Hyperion Planning Table Definitions


Column Name
MEMBER_ID

Column Type
integer

ALIASTBL_ID

integer

ALIAS_ID

integer

Description
FK(object) Member
object for the alias
FK(object) Object ID of
the alias table
FK(object) Object ID for
the alias

HSP_ANNOTATION
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

HSP_ATTRIBUTE_DIM
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

Copyright @ 2010, Solutions Experts, Inc. All rights resreved

5/16/2010

Hyperion Planning Table Definitions


1=numeric
2=Boolean
3=date
PERSPECTIVE 1
PERSPECTIVE 1

integer
integer

HSP_ATTRIBUTE_MEMBER
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

HSP_AUDIT_OPTIONS
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

Copyright @ 2010, Solutions Experts, Inc. All rights resreved

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

Hyperion Planning Table Definitions

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

HSP_CALENDAR
Describes the application calendar.
Column Name
Column Type
integer
CALENDAR_ID
integer
FIRST_YEAR
integer
NUMBER_YEARS
smallint
FY_MONTH
BASE_TIME_PERIOD

smallint

PERIODS_IN_YEAR
PREFIX

smallint
Varchar(20)

CURRENT_YEAR
CURRENT_TP

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)

HSP_CELL_NOTE
Each row of the table identifies a cell note entry and the associated Essbase dimension
data points.
Dave Farnsworth

Page 13

Copyright @ 2010, Solutions Experts, Inc. All rights resreved

5/16/2010

Hyperion Planning Table Definitions


Column Name
NOTE_ID
PLAN_TYPE

Column Type
integer
smallint

DIM1
DIM2

DIMIth

DIM20

integer
smallint

smallint

datetime

Description
Auto generated ID
Plantype where the cell note
belongs
1,2,4,8,16
ID of first dimension
ID of second dimension

ID of Ith dimension

ID of 20th dimension

HSP_CELL_NOTE_ITEM
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

HSP_CHECKOUTS
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

HSP_COLUMN_DETAIL
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

Copyright @ 2010, Solutions Experts, Inc. All rights resreved

5/16/2010

Hyperion Planning Table Definitions


DETAIL_ID
PLAN_TYPE

integer
smallint

DIM1
DIM2

DIMIth

DIM20

integer
smallint

smallint

datetime

Auto generated ID
Plantype where the cell note
belongs
1,2,4,8,16
ID of first dimension
ID of second dimension

ID of Ith dimension

ID of 20th dimension

HSP_COLUMN_DETAIL_ITEM
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

HSP_CUBES
Each row is a cube that Planning creates in Essbase
Column Name
Column Type
integer
CUBE_ID
integer
PLAN_TYPE

LAST_REFRESH

datetime

TYPE

smallint

Dave Farnsworth

Description
FK(object)
1=revenue
2=p&l
4=balance sheet
8=workforce
16=capex
Timestamp indicating last
refresh
0=generic

Page 15

Copyright @ 2010, Solutions Experts, Inc. All rights resreved

5/16/2010

Hyperion Planning Table Definitions

LOCATION_ALIAS

Varchar(80)

1=workforce
2=capex
Location alias used by Xref

HSP_CURRENCY
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

smallint

THOUSANDS_SEP

smallint

DECIMAL_SEP

smallint

NEGATIVE_SIGN

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

HSP_DIMENSION
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

Copyright @ 2010, Solutions Experts, Inc. All rights resreved

5/16/2010

Hyperion Planning Table Definitions


DIM_TYPE

datetime

DENSITY

integer

USED_IN

smallint

DIM_EDITOR

smallint

DENSITY1

smallint

DENSITY2

smallint

DENSITY3

smallint

DENSITY4

smallint

DENSITY5

smallint

POSITION1
POSITION2
POSITION3
POSITION4
POSITION5
ENUM_ORDER1

smallint
smallint
smallint
smallint
smallint
smallint

ENUM_ORDER2
ENUM_ORDER3
ENUM_ORDER4
ENUM_ORDER5
DRIVER_DIM_ID

smallint
smallint
smallint
smallint
integer

Dave Farnsworth

0=none
1=account
2=time
3=entity
6=Attribute
(not used)
0=dense
1=sparse
Bitmask of the plan types
that use this dimension.
Bitmask value is the sum of
the Plan types. i.e. 3=
revenue & P&L, 7= revenue
, P&L and balance sheet
1=can be accessed by
dimension editor
Stored by plan type.
Density1 = Revenue
0=dense
1=sparse
0=dense
1=sparse
0=dense
1=sparse
0=dense
1=sparse
0=dense
1=sparse
Stored by plan type.

Smart list evaluation order


by plan type

Associated driver
dimension ID

Page 17

Copyright @ 2010, Solutions Experts, Inc. All rights resreved

5/16/2010

Hyperion Planning Table Definitions


HSP_DRIVER_MEMBER
Each row describes a member formula for a member.
Column Name
Column Type
integer
BASE_DIM_ID

DIM_ID

integer

MEMBER_ID
QUERY_TYPE

integer
integer

POSITION

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

HSP_ENTITY
Rows describe the entities dimension members
Column Name
Column Type
integer
ENTITY_ID
DEFAULT_CURRENCY integer

USED_IN

smallint

EMPLOYEE_ID
REQUISITION_NO

Varchar(255)
Varchar(255)

ENTITY_TYPE

smallint

Dave Farnsworth

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

Page 18

Copyright @ 2010, Solutions Experts, Inc. All rights resreved

5/16/2010

Hyperion Planning Table Definitions


HSP_ENUMERATION
A row in this table defines a smartlist.
Column Name
Column Type
integer
ENUM_ID
NAME

integer

LABEL

smallint

DISPLAY_ORDER

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)

HSP_ENUMERATION_ENTRY
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

Copyright @ 2010, Solutions Experts, Inc. All rights resreved

5/16/2010

Hyperion Planning Table Definitions

HSP_FORM
A row in this table describes a single form
Column Name
Column Type
integer
FORM_ID
smallint
PRECISION1

PRECISION2

smallint

PRECISION3

smallint

PRECISION_MIN1
PRECISION_MIN2
PRECISION_MIN3
PRECISION_MAX1
PRECISION_MAX2
PRECISION_MAX3
SCALING

smallint
smallint
smallint
smallint
smallint
smallint
smallint

FMT_PRECEDENCE

smallint

FORM_TYPE

smallint

CUBE_ID
FORM_OPT
COLUMN_WIDTH

integer
integer
integer

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

HSP_FORM_ATTRIBUTES
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

Copyright @ 2010, Solutions Experts, Inc. All rights resreved

5/16/2010

Hyperion Planning Table Definitions


FORM_ID

integer

DIM_ID

integer

LOCATION

integer

ATT_DIM_ID

integer

dimension
ID (from HSP_FORM)
of the associated form
Dimension id from
HSP_DIMENSIONS
Placement of the
attribute dimension
Attribute dimension id

HSP_FORM_CALCS
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

HSP_FORM_LAYOUT
A row describes the location for each dimension on the form
Column Name
Column Type
integer
FORM_ID
Dave Farnsworth

Page 21

Copyright @ 2010, Solutions Experts, Inc. All rights resreved

Description
ID (from HSP_FORM)
5/16/2010

Hyperion Planning Table Definitions


LAYOUT_TYPE

smallint

ORDINAL

float

DIM_ID
STYLE

integer
integer

of the associated form


0=POV
1=Page
2=Row
3=Column
Sequence of the
dimension on the axis
FK(dimension)
1=show dimensions in
POV

HSP_FORM_MENUS
Table stores menus associated with form definitions
Column Name
Column Type
integer
POSITION
FORM_ID

integer

MENU_ID

smallint

Description
Order which menus are
displayed
ID (from HSP_FORM)
of the associated form
FK(object) ID of
associated menu

HSP_FORM_VARIABLES
Table stores user variables used by form definitions.
Column Name
Column Type
integer
POSITION
FORM_ID

integer

VARIABLE_ID

smallint

Description
Order which menus are
displayed
ID (from HSP_FORM)
of the associated form
FK(user_variable) ID
of the user variables

HSP_FORMOBJ_DEF
Each row describes a single row, column or page definition.
Column Name
Column Type
integer
OBJDEF_ID
integer
FORM_ID
Dave Farnsworth

Page 22

Copyright @ 2010, Solutions Experts, Inc. All rights resreved

Description
ID of object definition
ID (from HSP_FORM)
5/16/2010

Hyperion Planning Table Definitions


OBJDEF_TYPE

smallint

LOCATION

float

STYLE

integer

of the associated form


0=POV
1=Page
2=Row
3=Column
Physical location of this
OBJ_DEF on a grid.
Can be viewed as
row/col number. POV
is always =1
F(Form_Style)

HSP_FORMOBJ_DEF_MBR
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

Column Type
integer
integer
integer

Description
FK(fx_table)
FK(currency)
FK(currency)

FP_START

integer

Relative starting period

Dave Farnsworth

Page 23

Copyright @ 2010, Solutions Experts, Inc. All rights resreved

5/16/2010

Hyperion Planning Table Definitions


TP_END

integer

AVG01

float

END01
AVG02
END02

to which the rates apply


Ending period that rates
apply.
Average rate for period
1
Rate at the end of time
period 1
Average rate for period
2
Rate at the end of time
period 2

AVG03
END03
AVG04
END04
AVG05
END05
AVG06
END06
AVG07
END07
AVG08
END08
AVG09
END09
AVG10
END10
AVG11
END11
AVG12
END12
AVG13
END13

HSP_FX_RATES
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

Copyright @ 2010, Solutions Experts, Inc. All rights resreved

Description
FK(fx_table)
FK(currency)
FK(currency)
5/16/2010

Hyperion Planning Table Definitions


TYPE

smallint

METHOD

smallint

HISTORICAL_RATE

float

BEGBALANCE_RATE

float

1=input
2=inverse
3=implied
1=multiply
2=divide
Historical exchange
rate
Beginning exchange
rate

HSP_FX_TABLES
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

HSP_FX_VALUES
Column Name
FX_TABLE_ID
FROM_CUR
TO_CUR

Column Type
integer
integer
integer

Description
FK(fx_table)
FK(currency)
FK(currency)

FP_START

integer

TP_END

integer

AVG_VAL
END_VAL

float

Relative starting period


to which the rates apply
Ending period that rates
apply.
Average rate for period
Rate at the end of time
period

HSP_GROUP
Each row has a planning group
Dave Farnsworth

Page 25

Copyright @ 2010, Solutions Experts, Inc. All rights resreved

5/16/2010

Hyperion Planning Table Definitions


Column Name
GROUP_ID
SID

Column Type
integer
Varchar(256)

Description
FK(object)
Security token
identifier

HSP_LINKS
Stores URL links based on user type.
Column Name
Column Type
integer
LINK_ID
smallint
USER_TYPE

LINK_NAME
LINK_URL
LINK_DESC

Varchar(80)
Varchar(255)
Varchar(255)

Description
ID is auto generated
1=planner
2=interactive
3=admin
Name of URL
URL
Description for URL

HSP_LOCK
Tracks Component locking.
Column Name
OBJECT_ID

Column Type
integer

SESSION_ID

integer

USER_ID

integer

Description
ID of object being
locked
Id of session holding
the lock
FK(users) User holding
the lock

HSP_MEMBER
Each row stores a dimension member.
Column Name
MEMBER_ID
DIM_ID
CONSOL_OP1

Dave Farnsworth

Column Type
integer
smallint
smallint

Page 26

Copyright @ 2010, Solutions Experts, Inc. All rights resreved

Description
FK(object)
FK(dimension)
Essbase consolidation
attribute for Revenue
plan type
0=add
1=subtract
5/16/2010

Hyperion Planning Table Definitions

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

Copyright @ 2010, Solutions Experts, Inc. All rights resreved

2=multiply
3=divide
4=percentage
5=ignore
Essbase consolidation
attribute for P&L plan
type
Essbase consolidation
attribute for Bal sheet
plan type
Essbase consolidation
attribute for WF plan
type
Essbase consolidation
attribute for CapEx
plan type
Essbase data storage
attribute
0=store data
1=never share
2=label only
3=shared member
4=dynamic calc & store
5=dynamic
Essbase two pass
calculation attribute
0=no
1=yes
Member used for
consolidation purposes
0=no (default)
1=yes
Has a member formula
0=no
1=yes
FK(object)In the case
of shared members, this
is the corresponding
base member ID
Indicates if member
participates in process
mgmt
Identifies if member is
used for WF or CAPEX
5/16/2010

Hyperion Planning Table Definitions


ENUMERATION_ID

integer

DATA_TYPE

smallint

FK(enumeration)
Reference to smartlist
0=unspecified
1=currency
2=non currency
3=percentage
4=enum
5=date
6=text

HSP_MEMBER_FORMULA
Stores the member formula for a member.
Column Name
Column Type
integer
MEMBER_ID
ntext
FORMULA

Description
FK(member)
Contents of formula

HSP_MEMBER_TO_ATTRIBUTE
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

HSP_MEMBER_TO_UDA
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

Copyright @ 2010, Solutions Experts, Inc. All rights resreved

5/16/2010

Hyperion Planning Table Definitions

HSP_MENU_ITEMS
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

HSP_MRU_MEMBERS
Used to track user POV settings for data entry.
Dave Farnsworth

Page 29

Copyright @ 2010, Solutions Experts, Inc. All rights resreved

5/16/2010

Hyperion Planning Table Definitions


Column Name
USER_ID
DIM_ID
MEMBER_ID

Column Type
integer
integer
integer

Description
FK(users)
FK(dimension)
FK(member)

HSP_OBJECT
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

Copyright @ 2010, Solutions Experts, Inc. All rights resreved

5/16/2010

Hyperion Planning Table Definitions


HSP_OBJECT_TYPE
List of the planning object types.
Column Name
OBJECT_TYPE

Column Type
integer

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

TYPE_NAME

integer

Name for the object


type

HSP_PENDING_DELS
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

Copyright @ 2010, Solutions Experts, Inc. All rights resreved

5/16/2010

Hyperion Planning Table Definitions


Column Name
OBJECT_ID

Column Type
integer

Description
FK(object)

HSP_PENDING_XACTS
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

HSP_PLAN_TYPE
List of the plan types for the application.
Column Name
Column Type
integer
PLAN_TYPE
Varchar(40)
TYPE_NAME

Description
FK(cube)
Name for plan type

HSP_PLANNING _UNIT
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

Copyright @ 2010, Solutions Experts, Inc. All rights resreved

5/16/2010

Hyperion Planning Table Definitions


PREV_OWNER_ID
LAST_ACTION

integer
smallint

PROCESS_STATE

smallint

FK(dimension)
0=promote
1=reject
2=approve
3=signoff
4=start
5=exclude
Current process state of
planning unit
0=not started
1=first pass
2=under review
3=approved
4=signed off
5=not signed off

HSP_PLANNING_UNIT_LOG
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

Copyright @ 2010, Solutions Experts, Inc. All rights resreved

5/16/2010

Hyperion Planning Table Definitions


HSP_PM_ACTIONS
Defines process management actions
Column Name
ACTION_ID
NAME
MODIFIABLE

Column Type
integer
Varchar(80) not null
unique
smallint

PROPAGATE_TO
POSITION

integer
integer

Description
ID of action
Name of action (must
be unique)
Whether user can
modify
=no
1=yes
Indicates display order

HSP_PM_EFFECTS
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

1=other
2=previous owner
4=new owner

EMAIL_TO

Dave Farnsworth

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

Page 34

Copyright @ 2010, Solutions Experts, Inc. All rights resreved

5/16/2010

Hyperion Planning Table Definitions


8=actor\16=app owner
Email address to use
when email_to = Other

EMAIL_TO_OTHER

0=use change status


message
1=use message_other
Message to use when
message_type = other

MESSAGE_TYPE

MESSAGE_OTHER

HSP_PM_RULES
Defines process management transition rules between states.
Column Name
Column Type
integer
FROM_STATE_ID
nteger
CHANGEABLE_BY

ACTION_ID
STATE_ID

integer
integer

NEW_OWNER

integer

SCENARIO_ID

integer

EFFECT_ID

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

HSP_PM_STATES
Defines process management states
Column Name
STATE_ID
NAME
MODIFIABLE
Dave Farnsworth

Column Type
integer
Varchar(80) not null
unique
smallint
Page 35

Copyright @ 2010, Solutions Experts, Inc. All rights resreved

Description
ID of state
Name of state (must be
unique)
Whether user can
5/16/2010

Hyperion Planning Table Definitions

AFFECTED

smallint

PRECEDENCE

integer

COLOR

Varchar(80)

modify
=no
1=yes
Indicates whether
changes to parent or
child can affect state
via propagation
0=no
1=yes
Order of state. Used to
determine the state of
the parent with mixed
state children.
Name of color for state.
Null=black

HSP_PRINT_OPTS
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

Copyright @ 2010, Solutions Experts, Inc. All rights resreved

5/16/2010

Hyperion Planning Table Definitions

SHOW_SUPPORT

smallint

SHOW_ADESC

smallint

SHOW_ATTRIB

smallint

SHOW_CURRENCY

smallint

PAGE_SIZE

Varchar(255)

HEADER_SHADE

smallint

SHOW_CELL_NOTE

smallint

0=no (default)
1=yes
Show supporting dtl.
0=no (default)
1=yes
Show account
descriptions
0=no
1=yes (default)
Show attributes
0=no
1=yes (default)
Show currency cells
0=no
1=yes (default)
Page size for printing .
default = A4
0=no (default)
1=yes
0=no (default)
1=yes

HSP_SCENARIO
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

Copyright @ 2010, Solutions Experts, Inc. All rights resreved

5/16/2010

Hyperion Planning Table Definitions

HSP_STRINGS
Column Name
STRING_SEQ
LANGUAGE

Column Type
integer
smallint

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.

HSP_SYSTEMCFG
System level information for application
Column Name
Column Type
integer
VERSION
RELEASE

integer

OFFICIAL_TARGETS

integer

OFFICIAL_BUPS

integer

MAX_PER_USER

integer

BOOL_TRUE

integer

BOOL_FALSE

integer

CALC_SUM

integer

CALC_COUNT

integer

Dave Farnsworth

Page 38

Copyright @ 2010, Solutions Experts, Inc. All rights resreved

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

Hyperion Planning Table Definitions


CALC_MIN

integer

CALC_MAX

integer

CALC_AVG

integer

DATE_FMT

Varchar(32)

QUALIFIER

smallint

QUALIFIER_TYPE

smallint

MULTI_CURRENCY

smallint

DEF_CUR_ID
PLAN_TYPES

integer
smallint

LAST_VERSION_IDX
SUPPORT445

integer
smallint

EMAIL_SERVER
MULTI_CURRENT

Varchar(255)
smallint

SHARED_MEMBER_SEC

smallint

Dave Farnsworth

Page 39

Copyright @ 2010, Solutions Experts, Inc. All rights resreved

String value
corresponding to the
attribute Min
String value
corresponding to the
attribute Max
String value
corresponding to the
attribute Average
Date format string eg.
Mm/dd/yyyy
0=none
1=prefix
2=suffix
0=none
1=parent
2=grandparent
3=ancestors
0=no
1=yes
FK(currency)
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
Last used version index
0=none
1=445
2=454
3=544
url or IP for mail server
Multi-currency
0-no
1=yes
When enabled take into
account security
applied for parent of
shared member.
0=no
1=yes
5/16/2010

Hyperion Planning Table Definitions


OTLCHGD

smallint

USERSUPDATE

datetime

USEFULLNAME

smallint

CSS_VERSION

smallint

EIE_SERVER
ESS_DEF_PSWD

Varchar(255)
Varchar(30)

LOGIN_LEVEL

integer

MODULE_SUPPORTED

integer

MODULE_ENABLED

integer

WF_VERSION
WF_KEY
WF_OPTIONS
EMAIL_CHARSET

smallint

TI_OPTIONS
REF_APP

Track when there are


changes to the outline
0=no
1=yes
When last change was
applied
Display users full name
0=no (default)
1=yes
Support CSS version
0=none, otherwise css
version
URL to eie server
Essbase default
password when adding
users.
Default = password
Indicates allowable
password
0=planner
1=interactive
2=admin (default)
3=owner
To indicate supported
modules
Flag to indicate enabled
modules
Workforce version
Workforce key
Workforce options
Encoding for sending
emails UTF-8 or
system locale
Flag for task list
options
0=normal
1=reference app

HSP_TASK
Table contains a list of variables that may be used in a form definition.
Column Name
Column Type
Description
Dave Farnsworth

Page 40

Copyright @ 2010, Solutions Experts, Inc. All rights resreved

5/16/2010

Hyperion Planning Table Definitions


TASK_ID
TASK_ID_LIST
TASK_TYPE

integer
integer
integer

DUE_DATE
ALERT_DATE

datetime
datetime

INSTRUCTIONS
DEPENDANCY

Varchar(2000)
integer

ALERT_FREQUENCY
OVERDUE_FREQUENCY

Big int
Big int

INT_PROP1

Integer

STR_PROP1
INT_PROP2

Varchar(255)
Integer

Task identifier
Task list identifier
Type of task
0=descriptive
1=URL
2=Web Form
3=business rule
4=workflow
Date/time task is due
Date/time at which to
send an alert to user
Identifier of dependant
task
Frequency of alerts
Frequency of overdue
alerts
Auxiliary info about the
task depends on task
type

HSP_TEXT_CELL_VALUE
Table contains the text cell value to numeric mappings.
Column Name
Column Type
integer
TASK_ID
Varchar(255)
VALUE

Description
Internally generated ID
Text message
associated with the ID

HSP_TIME_PERIOD
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

Copyright @ 2010, Solutions Experts, Inc. All rights resreved

5/16/2010

Hyperion Planning Table Definitions


TYPE

smallint

0=leaf
1=rollup
2=year
4= DTS

HSP_UDA
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

HSP_USER_PREFS
Contains the user planning web preferences
Column Name
Column Type
integer
USER_ID
EMAIL
EMAIL_ENABLE

Varchar(255)
Smallint

EMAIL_OPTIONS

Integer

LANG_CODE
COUNTRY_CODE
THOUSAND_SEP
DECIMAL_SIGN

Varchar(2)
Varchar(2)
Smallint
Smallint

Dave Farnsworth

Page 42

Copyright @ 2010, Solutions Experts, Inc. All rights resreved

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

Hyperion Planning Table Definitions


NEGATIVE_SIGN
NEGATIVE_COLOR
PM_OPTIONS
ALIASTBL_ID
ENABLE_MRU
FORM_WARNING
PAGE_SIZE
PAGE_SEARCH
MBRSEL_ALIAS_ENABLE
MBRSEL_DESC_ENABLE
USER_MODE
MRU_SCREEN_PROPS
MRU_USER_MODE

Smallint
Smallint
integer
Integer
Smallint
Integer
Integer
Integer
Smallint
Smallint
Smallint
Varchar(1500)
smallint

0=basic
1=advanced (default)
2=admin

HSP_USER_TASKS
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

HSP_USER_VARIABLE
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

Description
Variable ID
Fk(DIMENSION)
Name of variable

HSP_USER_VARIABLE_VALUE
Contains a the associated variable value on a per user basis.
Dave Farnsworth

Page 43

Copyright @ 2010, Solutions Experts, Inc. All rights resreved

5/16/2010

Hyperion Planning Table Definitions


Column Name
VARIABLE_ID
USER_ID
MEMBER_ID

Column Type
integer
integer
integer

Description
Variable ID
Fk(USERS)
Fk(MEMBERS)

HSP_USERS
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

smallint

HUB_ROLES

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

HSP_USERSINGROUP
Each row has a user ssociated with the group.
Column Name
Column Type
integer
GROUP_ID
integer
USER_ID

Description
FK(OBJECT)
FK(USERS)

HSP_VERSION
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

Copyright @ 2010, Solutions Experts, Inc. All rights resreved

5/16/2010

Hyperion Planning Table Definitions


ACCESS_TYP

Smallint

IN_USE

Smallint

DATE_IN_USE

DateTime

ENABLEFORPM

Smallint

0=Private
1=Public
0=no
1=yes
Date version claimed
for use
0=no
1=yes

Sample Queries
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,

Dave Farnsworth

Alias_name,

Page 45

Copyright @ 2010, Solutions Experts, Inc. All rights resreved

5/16/2010

Hyperion Planning Table Definitions


PO.OBJECT_TYPE
FROM HSP_OBJECT PO,
HSP_OBJECT O,
HSP_MEMBER M
where PO.OBJECT_ID = O.PARENT_ID
and M.member_id = O.object_id
and O.Object_Type = 33

QUERY1: Account member


The query returns parent/child for each member along with most of the attributes.
This query can be used for dimensions other than account except the account
properties will not apply. The final line O.Object_Type = 32 references the
Account object type. You can re-point this other standard dimensions. There is a
special query for custom dimensions.
Note: change, add or delete consolidation columns depending on your needs. For
brevity, consolidation for database #3 (M.Consol_Op3) is specified. Add addition
blocks as required.
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)

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

Copyright @ 2010, Solutions Experts, Inc. All rights resreved

5/16/2010

Hyperion Planning Table Definitions


PO.OBJECT_TYPE,
Case AA.USE_445
When 0 then
When 1 then
When 2 then
When 3 then
else ''
End SPREAD_TYPE,
Case AA.TIME_BALANCE
When 0 then
When 1 then
When 2 then
When 3 then
else ''
End TIME_BALANCE,
Case AA.SKIP_VALUE
When 0 then
When 1 then
When 2 then
When 3 then
else ''
End SKIP_VALUE,
Case AA.ACCOUNT_TYPE
When 1 then
When 2 then
When 3 then
When 4 then
When 5 then
When 6 then
When 7 then
else ''
End ACOUNT_TYPE,
Case AA.VARIANCE_REP
When 1 then
When 2 then
else ''

'NONE'
'445'
'454'
'544'

'NONE'
'FIRST'
'LAST'
'AVERAGE'

'NONE'
'Skip missing'
'Skip zeroes'
'skip missing and zeroes'

'EXPENSE'
'REVENUE'
'ASSET'
'LIABILITY'
'EQUITY'
'STATISTICAL'
'SAVED ASSUMPTION'

'EXPENSE'
'NON EXPENSE'

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

Copyright @ 2010, Solutions Experts, Inc. All rights resreved

5/16/2010

Hyperion Planning Table Definitions


When 1 then 'Revenue'
When 2 then 'Net Income'
When 4 then 'Balance Sheet'
End SRC_PLAN_TYPE
FROM HSP_OBJECT PO,
HSP_OBJECT O,
HSP_MEMBER M,
HSP_ACCOUNT AA

where
and
and
and

PO.OBJECT_ID = O.PARENT_ID
M.member_id = O.object_id
AA.ACCOUNT_ID = O.OBJECT_ID
O.Object_Type = 32

Partial query result

QUERY2: Custom dimension member


The query returns parent/child for each member along consolidation, data storage
and two pass indicators. This query can be used for dimensions other than account
except the account properties will not apply. The final line M.Dim_ID = 50055
references a custom dimension object. Re-point this based on your needs.
Note: change, add or delete consolidation columns depending on your needs. For
brevity, consolidation for database #3 (M.Consol_Op3) is specified. Add addition
blocks as required.

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 '*'

Dave Farnsworth

Alias_name,

Page 48

Copyright @ 2010, Solutions Experts, Inc. All rights resreved

5/16/2010

Hyperion Planning Table Definitions


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,
PO.OBJECT_NAME PARENT_NAME,
PO.OBJECT_TYPE
FROM HSP_OBJECT PO,
HSP_OBJECT O,
HSP_MEMBER M

where PO.OBJECT_ID = O.PARENT_ID


and M.member_id = O.object_id
and M.Dim_ID = 50055

QUERY3: Smart lists


The query returns all smart list names and the members for each list.
SELECT

A.ENUMERATION_ID , A.Name as SMART_LIST_NAME,


B.ENTRY_ID, B.NAME, B.Label
FROM
HSP_ENUMERATION as A INNER JOIN
HSP_ENUMERATION_ENTRY as B ON
A.ENUMERATION_ID = B.ENUMERATION_ID
Order by A.ENUMERATION_ID, B.ENTRY_ID
Smartlist output

Dave Farnsworth

Page 49

Copyright @ 2010, Solutions Experts, Inc. All rights resreved

5/16/2010

Hyperion Planning Table Definitions

QUERY 4: Member Access


The query returns Planning for members and forms.
SELECT

O.OBJECT_NAME MEMBER,
(select OA.OBJECT_NAME
from HSP_OBJECT
OA
where OA.OBJECT_ID = AC.USER_ID) LOGIN_ID,
Case AC.ACCESS_MODE
When 1 then 'READ'
When 3 then 'WRITE'
When -1 then 'DENY'
End as ACCESS_MODE,
Case AC.FLAGS
When 0 then 'MEMBER'
When 5 then 'CHILDREN'
When 6 then 'ICHILREN'
When 8 then 'DESCENDANTS'
When 9 then 'IDESCENDANTS'
End as ACCESS_LEVEL,
OT.TYPE_NAME
From HSP_OBJECT
O,
HSP_ACCESS_CONTROL AC,
HSP_OBJECT_TYPE OT
where O.OBJECT_ID = AC.OBJECT_ID and
O.OBJECT_TYPE = OT.OBJECT_TYPE

Sample Member Access Query Results

QUERY 5: Member to Attribute


The query returns the attributes assigned to the Planning members. Re-pointing
mb.dim_id will restrict the result set to a specific dimension.
Dave Farnsworth

Page 50

Copyright @ 2010, Solutions Experts, Inc. All rights resreved

5/16/2010

Hyperion Planning Table Definitions


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,
PO.OBJECT_NAME PARENT_NAME,
PO.OBJECT_TYPE,
M.ATTR_MEM_ID,
mb.dim_id,
OAN.object_name
attribute_name,
OAV.object_name
attribute_value
FROM HSP_OBJECT PO,
HSP_OBJECT O,
HSP_OBJECT OAN,
HSP_OBJECT OAV,
HSP_MEMBER_to_Attribute M,
hsp_member MB
where PO.OBJECT_ID = O.PARENT_ID
and M.member_id
= O.object_id
and m.attr_id
= OAN.object_id
and m.attr_mem_id = OAV.object_id
and mb.member_id = o.object_id
and mb.dim_id = 50055

Alias_name,

Member to Attribute sample output

Dave Farnsworth

Page 51

Copyright @ 2010, Solutions Experts, Inc. All rights resreved

5/16/2010

You might also like