The Model Tables chapter describes the database tables used to store model information in Hyperion Business Modeling. These tables contain data for both regular models and enterprise models. Key fields are used to uniquely identify records across different database containers. Some tables are created during environment initialization, while others are populated when models are saved or modified. Descriptions are provided for each of the major model tables.

1. Hyperion Business Modeling
®
Release 3.0
Database Tables Reference
Hyperion Solutions Corporation
P/N: D503630000

2. Copyright 2000-2002 Hyperion Solutions Corporation. All rights reserved.
Hyperion, Hyperion Essbase and the “H” logo are registered trademarks of Hyperion
Solutions Corporation. Hyperion Solutions is a trademark of Hyperion Solutions Corporation.
All other brand and product names are trademarks or registered trademarks of their respective
holders.
No portion of this manual may be reproduced or transmitted in any form or by any means,
electronic or mechanical, including photocopying, recording, or information storage and
retrieval systems, for any purpose other than the purchaser’s personal use, without the express
written permission of Hyperion Solutions Corporation.
Notice: The information contained in this document is subject to change without notice.
Hyperion Solutions Corporation shall not be liable for errors contained herein or
consequential damages in connection with the furnishing, performance, or use of this material.
Hyperion Solutions Corporation
1344 Crossman Avenue
Sunnyvale, CA 94089

3. Contents
Chapter 1: Introduction ......................................................................................... 7
Purpose ....................................................................................................................... 7
Supported Databases ................................................................................................... 7
What’s Inside .............................................................................................................. 8
Reference Conventions ............................................................................................... 9
Modifying Data in External Databases ....................................................................... 9
Chapter 2: Master List of Database Tables ............................................... 11
Master List of Database Tables ........................................................................................ 11
Chapter 3: Model Tables ..................................................................................... 15
Generated Tables .............................................................................................................. 16
List of Indexes .................................................................................................................. 16
HABM_boxes ................................................................................................................... 18
HABM_categories ............................................................................................................ 20
HABM_financial .............................................................................................................. 21
HABM_groups ................................................................................................................. 23
HABM_groupxref ............................................................................................................ 24
HABM_layout .................................................................................................................. 25
HABM_links .................................................................................................................... 26
HABM_models ................................................................................................................ 28
HABM_notes.................................................................................................................... 31
HABM_periods ................................................................................................................ 32
HABM_scenarios ............................................................................................................. 33
HABM_timelines* ........................................................................................................... 34
HABM_units .................................................................................................................... 35
HABM_variables.............................................................................................................. 36
Hyperion Business Modeling Database Tables Reference s iii

4. HBM_modelPreferences .................................................................................................. 37
HBM_users ....................................................................................................................... 39
Chapter 4: Enterprise Model Tables ............................................................. 41
List of Indexes .................................................................................................................. 43
HBM_boxIDChanges ....................................................................................................... 45
HBM_categoryIDChanges ............................................................................................... 45
HBM_containers .............................................................................................................. 46
HBM_entBoxLinks .......................................................................................................... 47
HBM_entErrors ................................................................................................................ 48
HBM_entEssDimensions ................................................................................................. 49
HBM_entExchangeRates ................................................................................................. 49
HBM_entLinkFlowCosts ................................................................................................. 50
HBM_entModelChanges .................................................................................................. 51
HBM_entModelLayout .................................................................................................... 52
HBM_entModelLinks ...................................................................................................... 53
HBM_entModels .............................................................................................................. 53
HBM_entModelUDEssDatabaseTypes ............................................................................ 54
HBM_entPublishedBoxes ................................................................................................ 55
HBM_entPublishedCategories ......................................................................................... 57
HBM_entPublishedFinancial ........................................................................................... 58
HBM_entPublishedGroups .............................................................................................. 60
HBM_entPublishedGroupxref .......................................................................................... 61
HBM_entPublishedLinks ................................................................................................. 62
HBM_entPublishedModelPref ......................................................................................... 64
HBM_entPublishedModels .............................................................................................. 66
HBM_entPublishedNotes ................................................................................................. 69
HBM_entPublishedUnits .................................................................................................. 70
HBM_entPublishedVariables ........................................................................................... 71
HBM_publishingContainers ............................................................................................. 72
HBM_tagsetIDChanges .................................................................................................... 72
HBM_entUDEssDatabaseTypes ...................................................................................... 73
HBM_unitNameChanges ................................................................................................. 73
HBM_variableIDChanges ................................................................................................ 74
iv s Hyperion Business Modeling Database Tables Reference

5. Chapter 5: Results Tables .................................................................................. 75
HABM_resultupdate ........................................................................................................ 76
HBM_activityResults ....................................................................................................... 77
HBM_inventoryResults.................................................................................................... 78
HBM_resourceResults ..................................................................................................... 79
HBM_revenueCostResults ............................................................................................... 80
HBM_tagByBoxDetResults ............................................................................................. 81
HBM_tagByBoxSumResults ........................................................................................... 82
HBM_tagsResourceResults.............................................................................................. 83
HBM_tagsTotalResults .................................................................................................... 84
HBM_utilizationResults ................................................................................................... 85
HBM_boxCostFlows........................................................................................................ 86
HBM_boxLinkFlows ....................................................................................................... 87
HBM_entModelResults.................................................................................................... 88
HBM_totalModelResults ................................................................................................. 89
Chapter 6: Results Views Tables ................................................................... 91
Viewing Results Views .................................................................................................... 92
HABM_activity ................................................................................................................ 96
HABM_inventory ............................................................................................................ 97
HABM_resource .............................................................................................................. 98
HABM_revenuecost ......................................................................................................... 99
HABM_tagByBoxDetailed ............................................................................................ 100
HABM_tagByBoxSummary .......................................................................................... 101
HABM_tagsResource .................................................................................................... 102
HABM_tagsTotal ........................................................................................................... 103
HABM_utilization.......................................................................................................... 104
HBM_entModelRes ....................................................................................................... 105
HBM_totalModel ........................................................................................................... 106
Chapter 7: History of Database Changes ................................................ 107
Model Table Changes .................................................................................................... 108
Enterprise Model Table .................................................................................................. 116
Results Tables Changes.................................................................................................. 126
Results Views Tables Changes ...................................................................................... 131
Hyperion Business Modeling Database Tables Reference s v

6. Index ............................................................................................................................ 137
vi s Hyperion Business Modeling Database Tables Reference

7. Chapter Introduction
1
Purpose
Hyperion Business Modeling uses a relational database as its primary storage
environment for model, and results data. You can store the database tables in any
relational database container supported by an ODBC (Open Database
Conductivity) or JDBC (Java Database Conductivity) driver.
Supported Databases
We have tested the software with the following databases:
q Microsoft Access 2000
q Microsoft Access (XP)
q SQL Server 7
q SQL Server 2000 (Enterprise Edition)
q Oracle 8
q Oracle 9.0.1.1
q DB2 7.1
Hyperion Business Modeling Database Tables Reference s 7

8. Introduction
What’s Inside
This guide contains descriptions of the database tables contained in Hyperion
Business Modeling Release 3.0. The tables contain information about the models
and enterprise models, the data used to create the models, and their scenarios and
results. When you save a model to a relational database container, these tables are
automatically populated with this information.
In most cases, information about both regular and enterprise models is saved to the
same tables. For example, details about boxes for both regular models and
enterprise models are saved in HABM_boxes.
Information about the management of the enterprise model, including publishing,
currency exchange and layout changes, is saved to the Enterprise Model tables.
To improve performance, calculation results and the corresponding IDs for boxes,
categories, and so on, are saved to the Results tables in a numeric format. In order
to view these results, you can refer to the associated table in the Results Views
tables. For example, the information stored in HBM_activityResults can be
viewed if you open HABM_activity Results View table.
You will find information about the structures of these tables and notes about how
these tables are used. The tables are listed in alphabetical order in the following
sections:
q "Model Tables" on page 15
q "Enterprise Model Tables" on page 41
q "Results Tables" on page 75
q "Results Views Tables" on page 91
Note: The details supplied in this document are specific to Oracle.
If you are using Access, you should be aware that the software considers
the limitations of Access when processing data.
The software also takes different data types into account (if any) when
processing data on DB2 or SQL Server.
For a complete list of all database tables, refer to "Master List of Database Tables"
on page 11.
Note: The number of characters allocated for objects, IDs or results are
larger in order to be MBCS compliant.
8 s Hyperion Business Modeling Database Tables Reference

9. Introduction
1
Reference Conventions
The following table shows the conventions used in this document.
Item Meaning
rsetid Bold in the Field column indicates a key field used as part
of an index for the table. See "List of Indexes" on page 16
for a list of indexes for Model tables.
Note: No index fields are required for Results tables or
for temporary files that are created for the application to
track internal changes, such as HBM_boxIDChanges
timelines* Fields or tables that are marked by an asterisk are created
but not used in this release of Hyperion Business
Modeling.
Modifying Data in External Databases
If you modify data externally (using spreadsheets or other software packages such
as Hyperion Application Link, Microsoft Excel, Microsoft Access, and so on), the
data must be validated against the constraints and conditions of Hyperion Business
Modeling before the model can be opened.
To flag the changes for validation, you must set two flags before opening the
model in Hyperion Business Modeling, as follows:
q The external update (extupdate) flag in the HABM_Models database table
must be set to Yes (Y) to indicate that changes have been made in the external
database that must be verified before opening the model.
q The status flag in the HABM_Models database table must be set to No (N) to
indicate that the model has not been verified, calculated, or saved.
See "HABM_models" on page 28 for additional information.
When Hyperion Business Modeling is next opened, the first user to access the
model is presented with a dialog asking the user to validate the data before loading.
CAUTION: If the data is modified externally, and the external update and
status flags are not set, the validation does not run. Although the model may
open, the data may be corrupted.
Hyperion Business Modeling Database Tables Reference s 9

10. Introduction
The flags are automatically reset to the default after the data is verified.
For additional information, refer to the Hyperion Business Modeling Model
Builder’s Guide.
10 s Hyperion Business Modeling Database Tables Reference

11. Chapter Master List of Database
2 Tables
The master list provides the name and type of every table that currently exists in
Hyperion Business Modeling, listed in alphabetical order.
For detailed information about particular tables, refer to the following chapters:
q "Model Tables" on page 15
q "Enterprise Model Tables" on page 41
q "Results Tables" on page 75
q "Results Views Tables" on page 91
q "History of Database Changes" on page 107
Master List of Database Tables
See Page
Database table Type Number
HABM_activity Results Views 96
HABM_boxes Model 18
HABM_categories Model 20
HABM_financial Model 21
HABM_groups Model 23
HABM_groupxref Model 24
HABM_inventory Results Views 97
HABM_layout Model 25
Hyperion Business Modeling Database Tables Reference s 11

12. Master List of Database Tables
See Page
Database table - (continued) Type Number
HABM_links Model 26
HABM_models Model 28
HABM_notes Model 31
HABM_periods Model 32
HABM_resource Results Views 98
HABM_resultupdate Results 76
HABM_revenuecost Results Views 99
HABM_scenarios Model 33
HABM_tagByBoxDetailed Results Views 100
HABM_tagByBoxSummary Results Views 101
HABM_tagsResource Results Views 102
HABM_tagsTotal Results Views 103
HABM_timelines* Model 34
HABM_units Model 35
HABM_utilization Results Views 104
HABM_variables Model 36
HBM_activityResults Results 77
HBM_boxCostFlows Results 86
HBM_boxIDChanges Enterprise Model 45
HBM_boxLinkFlows Results 87
HBM_categoryIDChanges Enterprise Model 45
HBM_containers Enterprise Model 46
HBM_entBoxLinks Enterprise Model 47
HBM_entErrors Enterprise Model 48
HBM_entEssDimensions Enterprise Model 49
12 s Hyperion Business Modeling Database Tables Reference

13. Master List of Database Tables
See Page
Database table - (continued) Type Number
HBM_entExchangeRates Enterprise Model 48
HBM_entLinkFlowCosts Enterprise Model 50
HBM_entModelChanges Enterprise Model 51
HBM_entModelLayout Enterprise Model 52
HBM_entModelLinks Enterprise Model 53
HBM_modelPreferences Model 37
HBM_entModelRes Results Views 88
2
HBM_entModelResults Results 88
HBM_entModels Enterprise Model 53
HBM_entModelUDEssDatabase Enterprise Model 52
Types
HBM_entPublishedBoxes Enterprise Model 55
HBM_entPublishedCategories Enterprise Model 57
HBM_entPublishedFinancial Enterprise Model 58
HBM_entPublishedGroups Enterprise Model 60
HBM_entPublishedGroupxref Enterprise Model 61
HBM_entPublishedLinks Enterprise Model 62
HBM_entPublishedModelPref Enterprise Model 64
HBM_entPublishedModels Enterprise Model 66
HBM_entPublishedNotes Enterprise Model 69
HBM_entPublishedUnits Enterprise Model 70
HBM_entPublishedVariables Enterprise Model 71
HBM_entUDEssDatabaseTypes Enterprise Model 73
HBM_inventoryResults Results 78
HBM_publishingContainers Enterprise Model 72
Hyperion Business Modeling Database Tables Reference s 13

14. Master List of Database Tables
See Page
Database table - (continued) Type Number
HBM_resourceResults Results 79
HBM_revenuecostResults Results 80
HBM_tagByBoxDetResults Results 81
HBM_tagByBoxSumResults Results 82
HBM_tagsetIDChanges Enterprise Model 72
HBM_tagsResourceResults Results 79
HBM_tagsTotalResults Results 84
HBM_totalModel Results Views 89
HBM_totalModelResults Results 89
HBM_unitNameChanges Enterprise Model 73
HBM_users Model 39
HBM_utilizationResults Results 85
HBM_variableIDChanges Enterprise Model 74
14 s Hyperion Business Modeling Database Tables Reference

15. Chapter Model Tables
3
These tables store all model information. Each model has a unique three-digit
identifier (or ID) which forms part of the identification of every object. A model
object can be a box, link, period, timeline, and so on. Object IDs can be a
maximum of nine digits.
Model and object IDs are valid for the current container only. Model names do not
change when moving or copying models between containers. However, the model
and its objects can have different IDs across different containers. Always use an
object ID in conjunction with modelid to uniquely identify a record.
The tables are created when the environment is initialized. Saving or modifying
the model populates the tables.
All Model tables are used for both regular and enterprise model data. For
information on database tables that are created specifically for the enterprise
model, refer to "Enterprise Model Tables" on page 41.
You can find the following model tables and their descriptions in this chapter:
q "HABM_boxes" on page 18
q "HABM_categories" on page 20
q "HABM_financial" on page 21
q "HABM_groups" on page 23
q "HABM_groupxref" on page 24
q "HABM_layout" on page 25
q "HABM_links" on page 26
q "HABM_models" on page 28
q "HABM_notes" on page 31
q "HABM_periods" on page 32
Hyperion Business Modeling Database Tables Reference s 15

16. Model Tables
q "HABM_scenarios" on page 33
q "HABM_timelines*" on page 34
q "HABM_units" on page 35
q "HABM_variables" on page 36
q "HBM_modelPreferences" on page 37
q "HBM_users" on page 39
To see the indexes used with these tables, see "List of Indexes" on page 16.
Generated Tables
The HABM_timelines table is generated but not used with this release of Hyperion
Business Modeling. It is intended for future use, and should not be modified at the
present time.
List of Indexes
Each database table has one or more associated index files that specify the pointer
or field name used to search the database for a record. In the individual tables, field
names that are presented in bold indicate a key field that is used as part of the index
for the table.
The following indexes are used in this release.
Table Index Index Sort Field
HABM_boxes HABM_boxes_indx boxid
HABM_boxes_indx2 modelid
HABM_categories HABM_categ_indx categoryid
HABM_categ_indx2 modelid
HABM_financial HABM_fin_indx finid
HABM_fin_indx2 modelid
HABM_groups HABM_groups_indx groupid
HABM_groups_indx2 modelid
16 s Hyperion Business Modeling Database Tables Reference

17. Model Tables
Table (Cont’d) Index Index Sort Field
HABM_groupxref HABM_grpxref_indx modelid
HABM_layout HABM_layout_indx modelid
HABM_links HABM_links_indx linkid
HABM_links_indx2 modelid
HABM_links_indx3 srcbox
HABM_models HABM_models_indx modelid
HABM_models_indx2 name
HABM_notes HABM_notes_indx modelid 3
objid
HABM_periods HABM_periods_indx modelid
timelineid
HABM_scenarios HABM_scen_indx scenarioid
HABM_scen_indx2 scenarioalias
HABM_scen_indx3 modelid
HABM_timelines HABM_timelines_indx timelineid
HABM_timelines_indx2 modelid
HABM_units HABM_units_indx description
HABM_units_indx2 unitid
HABM_variables HABM_var_indx variableid
HABM_var_indx2 modelid
scope
HBM_model HBM_pref_indx preferenceid
Preferences
HBM_users HBM_users_indx userid
Hyperion Business Modeling Database Tables Reference s 17

18. Model Tables
HABM_boxes
This table contains a record for each box in the model. Model linking and
embedding are performed through the use of imported aggregates.
For enterprise models, the results of any changes made by linking are stored in this
table and HABM_financial..
Field Type Required Reference Description
boxid1 numeric (12,0) Yes Unique Box ID
modelid2 numeric (12,0) Yes HABM_models. Model to which box
modelid belongs
scenarioid numeric (12,0) Yes HABM_scenarios. Unique Scenario ID
scenarioid
periodid numeric (12,0) Yes HABM_periods. Unique Period ID
periodid
operation char (1) Operations used to
change boxes:
A=Add
D=Delete
U=Update
C=Calculate
shortname varchar (80) Yes Abbreviated name of
the box
name varchar (200) Yes Name of the box
unitid numeric (12,0) HABM_models.units ID of the unit assigned
to the box
type numeric (3,0) Yes Type of Box3:
0 - Supply
1 - Resource
2 - Activity
3 - Summary
4 - Demand
5 - Route
6 - Inventory
18 s Hyperion Business Modeling Database Tables Reference

19. Model Tables
Field Type Required Reference Description
capacity numeric (24,6) Capacity of Box
sqty numeric (24,6) Starting Quantity
scost numeric (24,6) Starting Cost
policy_type char (1) Type of policy, as
follows:
For Route Box:
R - Ratio
C - Capability
F - Fixed
3
For Inventory Box:
d - Differential
i - Input
c - Closing
policy_qty numeric (24,6) Ongoing policy
quantity
controlid varchar (80) Control ID for route
boxes using a control/
subordinate policy
cpctyformlid numeric (12,0) HABM_variables. If capacity is a formula
variableid
polcyformlid numeric (12,0) HABM_variables. If policy is a formula
variableid
1. Part of the key for unique index HABM_boxes_indx.
2. Part of the key for index HABM_boxes_indx2.
3. Seven Hyperion Business Modeling box types, group boxes, pinin, and pinout.
Hyperion Business Modeling Database Tables Reference s 19

20. Model Tables
HABM_categories
This table contains information about the model’s financial categories.
Field Type Required Reference Description
categoryid1 numeric (12,0) Yes Generated category ID
modelid2 numeric (12,0) Yes HABM_models. Model ID
modelid
scenarioid numeric (12,0) Yes HABM_scenarios. Unique Scenario ID
scenarioid
periodid numeric (12,0) Yes HABM_periods. Unique Period ID
periodid
operation char (1) Operations used to
change categories:
A=Add
D=Delete
U=Update
C=Calculate
categorynum numeric (12,0) Yes Category ID created by
the user
description varchar (200) Category description
minval numeric (24,6) Value defines the From
limit
maxval numeric (24,6) Value defines the To
limit
type char (1) Yes Identifies category type
as:
R=Revenue
C=Cost
parentid numeric (12,0) HABM_categories. Where this category
categoryid aggregates to
1. Part of the key for unique index HABM_categ_indx.
2. Part of the key for index HABM_categ_indx2.
20 s Hyperion Business Modeling Database Tables Reference

21. Model Tables
HABM_financial
This table contains financial information used by the model, including boxes
associated with financial data, values, ranges, and financial category IDs.
Field Type Required Reference Description
finid1 numeric (12,0) Yes Financial record ID
modelid2 numeric (12,0) Yes HABM_models. Model to which the
modelid box belongs
scenarioid numeric (12,0) Yes HABM_scenarios. Unique Scenario ID
scenarioid
periodid numeric (12,0) Yes HABM_periods. Unique Period ID
periodid 3
operation varchar (1) Operations used to
change boxes:
A=Add
D=Delete
U=Update
C=Calculate
boxid numeric (12,0) Yes HABM_boxes.boxid Box ID
unitvalue numeric (24,6) Yes Unit value used
totalvalue numeric (24,6) Yes Total value used
valtype numeric (3,0) The type of value
selected for the cost
per box3.
expval numeric (24,6) Expected value
range numeric (24,6) Range
minval numeric (24,6) Value defines the
From limit
maxval numeric (24,6) Value defines the To
limit
categoryid numeric (12,0) Yes HABM_categories. Category ID
categorynum
variableid numeric(12,0) HABM_variables. Variable ID displays,
variableid if formula used
1. Part of the key for index HABM_fin_indx.
2. Part of the key for index HABM_fin_indx2.
Hyperion Business Modeling Database Tables Reference s 21

22. Model Tables
3. A numeric value is assigned to each condition as follows:
- Total = 1, No Total = 0
- No expected value = 2, Expected Value = 0
- No Constant Factor = 0
Depending on the conditions which have been set, the numeric value for all conditions is totalled and
displayed as the valtype. For example, if you have a Total (1) with no Expected Value (2), the valtype is 1
+ 2 = 3. Similarly, if you have No Total (0) with No Constant Factor (0), the valtype is 0 + 0 = 0.
22 s Hyperion Business Modeling Database Tables Reference

23. Model Tables
HABM_groups
This table contains information about groups that support the functionality of tag
sets. The HABM_groupxref table associates groups with boxes in the model. A
group can be a tag attached to some boxes.
In the future, the application will have visual groups, that enable you to represent
a group visually as a single box. The visualone field identifies this property.
Field Type Required Reference Description
groupid1 numeric (12,0) Yes Group to which
objects belong
modelid2 numeric (12,0) Yes HABM_models. Model ID 3
modelid
scenarioid numeric (12,0) Yes HABM_scenarios. Unique Scenario ID
scenarioid
periodid numeric (12,0) Yes HABM_periods. Unique Period ID
periodid
operation char (1) Operations used to
change boxes:
A=Add
D=Delete
U=Update
C=Calculate
shortname varchar (8) Yes Tag set ID
groupname varchar (50) Yes Textual description of
group
visualone* char (1) Yes Representation of the
group as one box in
the schematic
1. Part of the key for unique index HABM_groups_indx
2. Part of the key for index HABM_groups_indx2
Hyperion Business Modeling Database Tables Reference s 23

24. Model Tables
HABM_groupxref
This table contains the detail (cross-reference) part of the HABM_groups table.
Field Type Required Reference Description
groupid numeric (12,0) Yes HABM_groups. Box group
groupid
modelid1 numeric (12,0) Yes HABM_models. Model ID
modelid
scenarioid numeric (12,0) Yes HABM_scenarios. Unique Scenario ID
scenarioid
periodid numeric (12,0) Yes HABM_periods. Unique Period ID
periodid
operation char (1) Operations used to
change boxes:
A=Add
D=Delete
U=Update
C=Calculate
boxid numeric (12,0) Yes HABM_boxes. Box in current group
boxid
1. Part of the key for index HABM_grpxref_indx.
24 s Hyperion Business Modeling Database Tables Reference

25. Model Tables
HABM_layout
This table contains the X-Y coordinates that identify the location and size of all
boxes in the model or enterprise model.
Field Type Required Reference Description
modelid1 numeric (12,0) Yes HABM_models. ID of the model to
modelid which the box belongs
scenarioid numeric (12,0) Yes HABM_scenarios. Unique scenario ID
scenarioid
periodid numeric (12,0) Yes HABM_periods. Unique period ID
periodid 3
boxid numeric (12,0) Yes HABM_boxes. Unique box ID of the
boxid box selected on the
schematic
xcoord numeric (12,0) Yes X coordinate for the
selected model
ycoord numeric (12,0) Yes Y coordinate for the
selected model
boxwidth numeric (12,0) Yes Width of the selected
box in pixels
boxheight numeric (12,0) Yes Height of the selected
box in pixels
viewlevel numeric (1) Yes The type of model, as
follows:
0 - Regular model
1 - Enterprise model
1. Part of the key for index HABM_layout_indx.
Hyperion Business Modeling Database Tables Reference s 25

26. Model Tables
HABM_links
Each record in this table contains link information between two boxes. The
srcbox and dstbox fields reference two boxes.
Field Type Required Reference Description
linkid1 numeric (12,0) Yes Unique link ID
modelid2 numeric (12,0) Yes HABM_models. Model to which box
modelid belongs
scenarioid numeric (12,0) Yes HABM_scenarios. Unique Scenario ID
scenarioid
periodid numeric (12,0) Yes HABM_periods. Unique Period ID
periodid
operation char (1) Operations used to
change links:
A=Add
D=Delete
U=Update
C=Calculate
srcbox3 numeric (12,0) Yes HABM_boxes. Box ID of the source
boxid (from) box
dstbox numeric (12,0) Yes HABM_boxes. Box ID of the
boxid destination (to) box
unitvalue numeric (24,6) Unit factor value
totalvalue numeric (24,6) Yes Total factor value
valtype numeric (3,0) Yes The number represents
the type of value
selected for the input
link factor (Unit,
Constant, Total).4
expval numeric (24,6) Expected value per
box unit, as defined by
the user
range numeric (24,6) Yes Range
26 s Hyperion Business Modeling Database Tables Reference

27. Model Tables
Field (Cont’d) Type Required Reference Description
minval numeric (24,6) Yes Minimum
maxval numeric (24,6) Yes Maximum
priority numeric (3,0) Yes Priority of link
newpriority numeric (3,0) New or defined
priority of link
variableid numeric (12,0) HABM_variables. Variable ID displays, if
variableid formula used
1. Part of the key for unique index HABM_links_indx.
2.
3.
Part of the key for index HABM_links_indx2.
Part of the key for index HABM_links_indx3.
3
4. A numeric value is assigned to each condition as follows:
- Total = 1, No Total = 0
- No expected value = 2, Expected Value = 0
- Constant Factor = 4, No Constant Factor = 0
Depending on the conditions that are set, the numeric value for all conditions is totalled and displayed as
the valtype. For example, if you have a Total (1) with no Expected Value (2), the valtype is 1 + 2 = 3.
Similarly, if you have No Total (0) with No Constant Factor (0), the valtype is 0 + 0 = 0.
Hyperion Business Modeling Database Tables Reference s 27

28. Model Tables
HABM_models
This table includes information about the owner, access privileges and password,
currency, timelines, and update information for regular and enterprise models.
Field Type Required Reference Description
modelid1 numeric (12,0) Yes Model ID in this
environment
name2 varchar (200) Yes Name of an enterprise
model or regular model
title varchar (1,000) Yes Long title of an
enterprise model or
regular model
owner numeric (12,0) HBM_users. ID of the model owner
userid or creator
userlock numeric (12,0) This information is used
for model locking.
For regular models, an
incremented value is
applied to each
concurrent user that
opens the application, to
control the saving of
changes.
For enterprise models,
this value indicates the
state of the models, as
follows:
0 - Unlocked
1 - Locked
crncy char (3) Model currency,
expressed in ISO 4217
3-character currency
code
28 s Hyperion Business Modeling Database Tables Reference

29. Model Tables
Field (Cont’d) Type Required Reference Description
finmultiplier numeric (12,0) A label identifying the
display attributes for
financial data. For
example, if you do not
want to view long
numbers in reports, you
could enter your data in
millions, and set the
multiplier to 1,000.
modelversion varchar (10) Version of Hyperion
Business Modeling in
which the model is 3
created. For example,
Hyperion Activity
Based Modeling 1.5, or
Hyperion Business
Modeling 2.1 or 3.0
modeltype numeric (1) The type of model can
be set to one of the
following values:
0 - Regular model
1 - Enterprise model
extupdate3 char (1) The external update flag
can be set to the
following values:
Y = Data has been
modified externally
N = Data has not been
modified externally
(default)
Set the external update
flag to Y to indicate that
changes have been made
in the external database
that must be verified
before opening the
model.
Hyperion Business Modeling Database Tables Reference s 29

30. Model Tables
Field (Cont’d) Type Required Reference Description
status char (10) Status flags can be set to
the following values:
N = Model is not
verified (unverified)
Y = Model has been
verified
CS = Model has been
calculated and saved
If the model is updated
externally, both the
extupdate and status
flags must be updated as
follows:
extupdate = Y
status = N
Note: The calculated
per unit values is reset
when the model is
calculated first.
timelineid numeric (12,0) HABM_timelines. Standard timeline
timelineid
lastupdate 4 date Date and time of last
modification
1. Part of the key for unique index HABM_models_indx.
2. Part of the key for index HABM_models_indx2.
3. Whenever you modify data directly in an external spreadsheet or database, you must set the
extupdate flag to “Y” to indicate changes have been made. Before the model can be loaded in
Hyperion Business Modeling, the system checks the flag. If the model data has been changed, the
modifications must be validated by the system before the model can be opened. You must also set the
status flag to “N” to indicate that the model has not been verified, calculated or saved. Refer to "Modifying
Data in External Databases" on page 9 for additional information.
4. A time stamp that can be used in establishing the validity of model linking and signalling model updates.
30 s Hyperion Business Modeling Database Tables Reference

31. Model Tables
HABM_notes
This table holds notes for boxes only.
Field Type Required Reference Description
modelid1 numeric (12,0) Yes HABM_models. Model ID
modelid
scenarioid numeric (12,0) Yes HABM_scenarios. Unique Scenario ID
scenarioid
periodid numeric (12,0) Yes HABM_periods. Unique Period ID
periodid
operation char (1) Operations used to
3
change notes:
A=Add
D=Delete
U=Update
C=Calculate
objid1 numeric (12,0) Yes HABM_boxes/ Object ID
HABM_links/
HABM_models/....
type numeric (3,0) Yes Object type
title varchar (200) Note title
keywords2* varchar (1,024) Used for search in
notes
content varchar (2,000) Text of the note
attachment* raw null Data attachment, such
as graphic, bitmap,
image, text, and so
on.
1. Part of the key for unique index HABM_notes_indx.
2. Contains search items if the user needs to attach text notes with an object.
Hyperion Business Modeling Database Tables Reference s 31

32. Model Tables
HABM_periods
A default timeline and period length are set when you create the model.
Field Type Required Reference Description
modelid1 numeric (12,0) Yes HABM_models. Model ID
modelid
timelineid1 numeric (12,0) Yes Timeline owning this
period
periodid numeric (12,0) Yes Period’s unique ID
periodalias varchar (10) Character representation
of the period
name varchar (200) Yes Name assigned to period
numunits* numeric (4,0) Number of units in
period
unit* char (1) Unit used to define the
period
1. Part of the key for index HABM_periods_indx.
32 s Hyperion Business Modeling Database Tables Reference

33. Model Tables
HABM_scenarios
This table contains details for all scenarios of a model.
Field Type Required Reference Description
scenarioid1 numeric (12,0) Yes Unique scenario ID
modelid2 numeric (12,0) Yes HABM_models. Model ID
modelid
scenarioalias3 varchar (10) Yes System generated alias for
the scenario
timelineid numeric (12,0) Yes Timeline used
description varchar (1,000) Yes Short description of
3
scenario
owner numeric (12,0) HBM_users. User ID of owner
userid
1. Part of the key that identifies unique index HABM_scen_indx.
2. Part of the key that identifies index HABM_scen_indx3.
3. Part of the key that identifies index HABM_scen_indx2.
Hyperion Business Modeling Database Tables Reference s 33

34. Model Tables
HABM_timelines*
This table contains details for all timelines of a model.
Note: This table is generated but not used in this release of Hyperion
Business Modeling. It is intended for future use, and should not be
modified at the present time.
Field Type Required Reference Description
timelineid1 numeric (12,0) Yes Unique timeline ID
modelid2 numeric (12,0) Yes HABM_models. Unique model ID
modelid
timelinealias char (1) Yes System generated alias for
the timeline
name varchar (200) Yes Name of the timeline
startingdate date Yes Short description of
scenario
1. Part of the key that identifies unique index HABM_timeln_indx.
2. Part of the key that identifies index HABM_timeln_indx2.
34 s Hyperion Business Modeling Database Tables Reference

35. Model Tables
HABM_units
This table contains unit IDs and a description of the model.
Field Type Required Reference Description
modelid numeric (12,0) Yes HABM_models. Model ID
modelid
scenarioid numeric (12,0) Yes HABM_scenarios. Unique Scenario ID
scenarioid
periodid numeric (12,0) Yes HABM_periods. Unique Period ID
periodid
operation char (1) Operations used to
3
change units:
A=Add
D=Delete
U=Update
EA= External Add
ED= External Delete
EU= External Update
unitid1 numeric (9,0) Yes Unit ID
description2 varchar (50) Yes Unit description
1. Part of the key for unique index HABM_units_indx2.
2. Part of the key for unique index HABM_units_indx.
Hyperion Business Modeling Database Tables Reference s 35

36. Model Tables
HABM_variables
This table contains data about variables used in a particular model.
Field Type Required Reference Description
variableid1 numeric (12,0) Yes Formula ID
modelid2 numeric (12,0) Yes HABM_models. Variable model ID
modelid
scenarioid numeric (12,0) Yes HABM_scenarios. Unique Scenario ID
scenarioid
periodid numeric (12,0) Yes HABM_periods. Unique Period ID
periodid
operation char (1) Operations used to
change variables:
A= Add
D= Delete
U= Update
C = Calculation of an
enterprise model
vname varchar (200) Yes Variable name
shortname varchar (80) Yes Variable ID created by
the user
scope2 char (1) Yes Variable scope:
C=constant
L= local formula 3
vbody varchar (250) Yes Variable body or
constant value
calvalue numeric (24,6) The value of the
calculated formula
1. Part of the key for unique index HABM_var_indx.
2. Part of the key for index HABM_var_indx2.
3. Local formulas are used only on one data item, like box capacity, factor value, and so on. Unlike the
constant formulas that can be re-used, these formulas cannot be shared (unless the user types them in
again). Refer to the Hyperion Business Modeling Model Builder’s Guide for further information.
36 s Hyperion Business Modeling Database Tables Reference

37. Model Tables
HBM_modelPreferences
This table is used to save model-specific settings.
Field Type Required Reference Description
preferenceid1 numeric (12,0) Yes Unique preference ID
modelid numeric (12,0) Yes HABM_models. ID of the model to
modelid which the preference
setting is attached
flowdecdigits numeric (1) The number of decimal
digits set for reporting
the operational flow. 3
The default is zero (0).
findecdigits numeric (1) The number of decimal
digits set for reporting
financial figures.
The default is 2.
perunitdec numeric (1) The number of decimal
digits digits set for reporting
per unit values.
The default is 4.
costofcapid varchar (200) The ID for the EP
variable representing
the cost of capital.
The default value is
“cc.”
costofcapname varchar (200) The name of the EP
variable representing
the cost of capital.
The default is “Cost of
Capital.”
taxrateid varchar (200) The ID for the EP
variable representing
the applicable tax rate.
The default is “tr.”
Hyperion Business Modeling Database Tables Reference s 37

38. Model Tables
Field (Cont’d) Type Required Reference Description
taxratename varchar (200) The name of the EP
variable representing
the applicable tax rate.
The default is “Tax
Rate.”
capchargesid numeric (12,0) The ID of the EP
Totaler representing the
capital charges.
The default is “900.”
capcharges varchar (200) The name of the EP
name Totaler representing the
capital charges.
The default is “Capital
Charges.”
capcharges numeric (12,0) This value defines the
rangefrom beginning (or from)
limit of the EP Totaler
range.
The default is set to
“901.”
capcharges numeric (12,0) This value defines the
rangeto end (or to) limit of the
EP Totaler range. The
default is set to “999.”
autolink char (1) Set to automatically
link supply and
demand boxes with the
same unit and ID
within an enterprise
model, as follows:
Y - Autolink
N - Do not autolink
1. Part of the key for unique index HBM_pref_indx.
38 s Hyperion Business Modeling Database Tables Reference

39. Model Tables
HBM_users
This table contains information about the model owner or creator, and is used for
notification of changes to the model.
Note: Notification of model changes are sent to the specified model owner
only.
Field Type Required Reference Description
userid1 numeric (12,0) Yes Unique user ID for
model owner or creator
firstname varchar (200) Yes First name of the model
owner or creator 3
lastname varchar (200) Yes Last name of the model
owner or creator
emailaddress varchar (200) Yes E-mail address of the
model owner or creator
1. Part of the key for unique index HBM_users_indx.
Hyperion Business Modeling Database Tables Reference s 39

40. Model Tables
40 s Hyperion Business Modeling Database Tables Reference

41. Chapter Enterprise Model Tables
4
These tables store information that is used to manage the enterprise model,
including:
q Reporting currency and exchange rates
q Publishing
q Layout
q Linking between models in the enterprise model
q Change management between published versions
For specific details about the enterprise model as a model (such as boxes,
variables, and so on) or individual models within the enterprise model, refer to the
tables in "Model Tables" on page 15.
The tables are automatically created when the environment is initialized. Saving
the enterprise model populates the tables.
You can find the following enterprise model tables and their descriptions in this
chapter:
q "HBM_boxIDChanges" on page 45
q "HBM_categoryIDChanges" on page 45
q "HBM_containers" on page 46
q "HBM_entBoxLinks" on page 47
q "HBM_entErrors" on page 48
q "HBM_entEssDimensions" on page 49
q "HBM_entExchangeRates" on page 49
q "HBM_entModelChanges" on page 51
Hyperion Business Modeling Database Tables Reference s 41

42. Enterprise Model Tables
q "HBM_entModelLayout" on page 52
q "HBM_entModelLinks" on page 53
q "HBM_entModels" on page 53
q "HBM_entModelUDEssDatabaseTypes" on page 54
q "HBM_entPublishedBoxes" on page 55
q "HBM_entPublishedCategories" on page 57
q "HBM_entPublishedFinancial" on page 58
q "HBM_entPublishedGroups" on page 60
q "HBM_entPublishedGroupxref" on page 61
q "HBM_entPublishedLinks" on page 62
q "HBM_entPublishedModelPref" on page 64
q "HBM_entPublishedModels" on page 66
q "HBM_entPublishedNotes" on page 69
q "HBM_entPublishedUnits" on page 70
q "HBM_entPublishedVariables" on page 71
q "HBM_publishingContainers" on page 72
q "HBM_tagsetIDChanges" on page 72
q "HBM_entUDEssDatabaseTypes" on page 73
q "HBM_unitNameChanges" on page 73
q "HBM_variableIDChanges" on page 74
To see the indexes used with these tables, see "List of Indexes" on page 43.
42 s Hyperion Business Modeling Database Tables Reference

43. Enterprise Model Tables
List of Indexes
Most of the database tables have one or more associated index files that specify the
pointer or field name used to search the database for a record. In the individual
tables, field names that are presented in bold indicate a key field that is used as part
of the index for the table.
Note: No index fields are required for Results tables or for temporary files
that are created for the application to track internal changes, such as
HBM_boxIDChanges.
The following indexes are used for enterprise models in this release.
Table Index Index Sort Field 4
HBM_containers HBM_cont_indx containerid
HBM_entBoxLinks HBM_eBLinks_indx linkid
HBM_entErrors HBM_eErrors_indx enterprisemodelid
HBM_entExchangeRates HBM_eRates_indx exrateid
HBM_entLinkFlowCosts HBM_eFCLinks_indx linkid
HBM_entModelChanges HBM_eChg_indx changeid
HBM_entModelLayout HBM_eml_indx enterprisemodelid
HBM_entModelLinks HBM_eLinks_indx modellinkid
HBM_entModels HBM_eModels_indx enterprisemodelid
HBM_entPublished HBM_epbox_indx boxid
Boxes HBM_epbox_indx2 modelid
HBM_entPublished HBM_epcat_indx categoryid
Categories
HBM_epcat_indx2 modelid
HBM_entPublished HBM_epfin_indx finid
Financial HBM_epfin_indx2 modelid
HBM_entPublished HBM_epgrp_indx groupid
Groups HBM_epgrp_indx2 modelid
Hyperion Business Modeling Database Tables Reference s 43

44. Enterprise Model Tables
Table (cont’d) Index Index Sort Field
HBM_entPublished HBM_epgxref_indx modelid
Groupxref
HBM_entPublishedLinks HBM_eplink_indx linkid
HBM_eplink_indx2 modelid
HBM_eplink_indx3 srcbox
HBM_entPublishedModel HBM_epmPref_indx preferenceid
Pref
HBM_entPublishedModels HBM_epm_indx modelid
HBM_epm_indx2 name
HBM_entPublishedNotes HBM_epnote_indx modelid
objid
HBM_entPublishedUnits HBM_epunit_indx description
HBM_epunit_indx2 unitid
HBM_entPublished HBM_epvar_indx variableid
Variables
HBM_epvar_indx2 modelid
scope
HBM_publishing HBM_pcont_indx modelid
Containers
44 s Hyperion Business Modeling Database Tables Reference

45. Enterprise Model Tables
HBM_boxIDChanges
This table contains information on the box ID changes in a published model.
Field Type Required Reference Description
boxid numeric (12,0) Yes HABM_boxes.boxid Unique ID of the
changed box
modelid numeric (12,0) Yes HABM_models. Unique model ID
modelid
oldshortname varchar (80) Yes HABM_boxes. Old box shortname
shortname
newshortname varchar (80) Yes HABM_boxes. New box shortname
4
shortname
HBM_categoryIDChanges
This table contains information on the category ID changes in a published model.
Field Type Required Reference Description
categoryid numeric (12,0) Yes HABM_categories. Unique ID of the
categoryid changed category
modelid numeric (12,0) Yes HABM_models. Unique model ID
modelid
oldcategory numeric (12,0) Yes HABM_categories. Old category ID
num categorynum
newcategory numeric (12,0) Yes HABM_categories. New category ID
num categorynum
Hyperion Business Modeling Database Tables Reference s 45

46. Enterprise Model Tables
HBM_containers
This table describes where each of the models contained in the enterprise model
are located.
Field Type Required Reference Description
containerid1 numeric (12,0) Yes Unique container ID
containername varchar (200) Yes Name of the container
type varchar (200) Yes Type of supported
database:
- DB2
- Oracle
- SQL Server
- Access
- Other
servername varchar (20) Yes Server IP address
port numeric (10,0) Yes Displays the default
port for the selected
database type:
DB2 - 6789
Oracle - (1521)
SQL Server - (1433)
Access - (None)
dbname varchar (200) Yes Data Source Name
(DSN) pointing to the
database server
url varchar (200) Database URL,
including keywords for
certain JDBC drivers
classpath2 varchar (200) JDBC driver path
1. Part of the key for unique index HBM_cont_indx.
2. Part of the key for unique index HBM_cont_indx.
46 s Hyperion Business Modeling Database Tables Reference