Hyperion® Business Modeling Release 3.0
Database Tables Reference
Hyperion Solutions Corporation
P/N: D503630000
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
Contents
Chapter 1: Introduction ......................................................................................... 7
Purpose ....................................................................................................................... 7Supported Databases ................................................................................................... 7What’s Inside .............................................................................................................. 8Reference Conventions ............................................................................................... 9Modifying 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 .............................................................................................................. 16List of Indexes .................................................................................................................. 16HABM_boxes ................................................................................................................... 18HABM_categories ............................................................................................................ 20HABM_financial .............................................................................................................. 21HABM_groups ................................................................................................................. 23HABM_groupxref ............................................................................................................ 24HABM_layout .................................................................................................................. 25HABM_links .................................................................................................................... 26HABM_models ................................................................................................................ 28HABM_notes.................................................................................................................... 31HABM_periods ................................................................................................................ 32HABM_scenarios ............................................................................................................. 33HABM_timelines* ........................................................................................................... 34HABM_units .................................................................................................................... 35HABM_variables.............................................................................................................. 36
■ iiiHyperion Business Modeling Database Tables Reference
HBM_modelPreferences .................................................................................................. 37HBM_users ....................................................................................................................... 39
Chapter 4: Enterprise Model Tables ............................................................. 41
List of Indexes .................................................................................................................. 43HBM_boxIDChanges ....................................................................................................... 45HBM_categoryIDChanges ............................................................................................... 45HBM_containers .............................................................................................................. 46HBM_entBoxLinks .......................................................................................................... 47HBM_entErrors ................................................................................................................ 48HBM_entEssDimensions ................................................................................................. 49HBM_entExchangeRates ................................................................................................. 49HBM_entLinkFlowCosts ................................................................................................. 50HBM_entModelChanges .................................................................................................. 51HBM_entModelLayout .................................................................................................... 52HBM_entModelLinks ...................................................................................................... 53HBM_entModels .............................................................................................................. 53HBM_entModelUDEssDatabaseTypes ............................................................................ 54HBM_entPublishedBoxes ................................................................................................ 55HBM_entPublishedCategories ......................................................................................... 57HBM_entPublishedFinancial ........................................................................................... 58HBM_entPublishedGroups .............................................................................................. 60HBM_entPublishedGroupxref .......................................................................................... 61HBM_entPublishedLinks ................................................................................................. 62HBM_entPublishedModelPref ......................................................................................... 64HBM_entPublishedModels .............................................................................................. 66HBM_entPublishedNotes ................................................................................................. 69HBM_entPublishedUnits .................................................................................................. 70HBM_entPublishedVariables ........................................................................................... 71HBM_publishingContainers ............................................................................................. 72HBM_tagsetIDChanges .................................................................................................... 72HBM_entUDEssDatabaseTypes ...................................................................................... 73HBM_unitNameChanges ................................................................................................. 73HBM_variableIDChanges ................................................................................................ 74
iv ■ Hyperion Business Modeling Database Tables Reference
Chapter 5: Results Tables .................................................................................. 75
HABM_resultupdate ........................................................................................................ 76HBM_activityResults ....................................................................................................... 77HBM_inventoryResults.................................................................................................... 78HBM_resourceResults ..................................................................................................... 79HBM_revenueCostResults ............................................................................................... 80HBM_tagByBoxDetResults ............................................................................................. 81HBM_tagByBoxSumResults ........................................................................................... 82HBM_tagsResourceResults .............................................................................................. 83HBM_tagsTotalResults .................................................................................................... 84HBM_utilizationResults ................................................................................................... 85HBM_boxCostFlows........................................................................................................ 86HBM_boxLinkFlows ....................................................................................................... 87HBM_entModelResults.................................................................................................... 88HBM_totalModelResults ................................................................................................. 89
Chapter 6: Results Views Tables ................................................................... 91
Viewing Results Views .................................................................................................... 92HABM_activity ................................................................................................................ 96HABM_inventory ............................................................................................................ 97HABM_resource .............................................................................................................. 98HABM_revenuecost ......................................................................................................... 99HABM_tagByBoxDetailed ............................................................................................ 100HABM_tagByBoxSummary .......................................................................................... 101HABM_tagsResource .................................................................................................... 102HABM_tagsTotal ........................................................................................................... 103HABM_utilization.......................................................................................................... 104HBM_entModelRes ....................................................................................................... 105HBM_totalModel ........................................................................................................... 106
Chapter 7: History of Database Changes ................................................ 107
Model Table Changes .................................................................................................... 108Enterprise Model Table .................................................................................................. 116Results Tables Changes.................................................................................................. 126Results Views Tables Changes ...................................................................................... 131
■ vHyperion Business Modeling Database Tables Reference
Index ............................................................................................................................ 137
vi ■ Hyperion Business Modeling Database Tables Reference
Chapter
1
Hyperion Business Mod
Introduction
PurposeHyperion 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 DatabasesWe have tested the software with the following databases:
● Microsoft Access 2000
● Microsoft Access (XP)
● SQL Server 7
● SQL Server 2000 (Enterprise Edition)
● Oracle 8
● Oracle 9.0.1.1
● DB2 7.1
■ 7eling Database Tables Reference
Introduction
What’s InsideThis 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:
● "Model Tables" on page 15
● "Enterprise Model Tables" on page 41
● "Results Tables" on page 75
● "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 ■ Hyperion Business Modeling Database Tables Reference
Introduction
1
Reference ConventionsThe following table shows the conventions used in this document.
Modifying Data in External DatabasesIf 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:
● 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.
● 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.
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.
■ 9Hyperion Business Modeling Database Tables Reference
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 ■ Hyperion Business Modeling Database Tables Reference
Chapter
2
Hyperion Business Mod
Master List of Database 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:
● "Model Tables" on page 15
● "Enterprise Model Tables" on page 41
● "Results Tables" on page 75
● "Results Views Tables" on page 91
● "History of Database Changes" on page 107
Master List of Database Tables
Database table TypeSee Page 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
■ 11eling Database Tables Reference
Master List of Database Tables
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
Database table - (continued) TypeSee Page Number
12 ■ Hyperion Business Modeling Database Tables Reference
Master List of Database Tables
2
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
HBM_entModelResults Results 88
HBM_entModels Enterprise Model 53
HBM_entModelUDEssDatabaseTypes
Enterprise Model 52
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
Database table - (continued) TypeSee Page Number
■ 13Hyperion Business Modeling Database Tables Reference
Master List of Database Tables
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
Database table - (continued) TypeSee Page Number
14 ■ Hyperion Business Modeling Database Tables Reference
Chapter
3
Hyperion Business Mod
Model Tables
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:
● "HABM_boxes" on page 18
● "HABM_categories" on page 20
● "HABM_financial" on page 21
● "HABM_groups" on page 23
● "HABM_groupxref" on page 24
● "HABM_layout" on page 25
● "HABM_links" on page 26
● "HABM_models" on page 28
● "HABM_notes" on page 31
● "HABM_periods" on page 32
■ 15eling Database Tables Reference
Model Tables
● "HABM_scenarios" on page 33
● "HABM_timelines*" on page 34
● "HABM_units" on page 35
● "HABM_variables" on page 36
● "HBM_modelPreferences" on page 37
● "HBM_users" on page 39
To see the indexes used with these tables, see "List of Indexes" on page 16.
Generated TablesThe 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 IndexesEach 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 ■ Hyperion Business Modeling Database Tables Reference
Model Tables
3
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
objid
HABM_periods HABM_periods_indx modelidtimelineid
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 modelidscope
HBM_modelPreferences
HBM_pref_indx preferenceid
HBM_users HBM_users_indx userid
Table (Cont’d) Index Index Sort Field
■ 17Hyperion Business Modeling Database Tables Reference
Model Tables
HABM_boxesThis 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.modelid
Model to which box belongs
scenarioid numeric (12,0) Yes HABM_scenarios.scenarioid
Unique Scenario ID
periodid numeric (12,0) Yes HABM_periods.periodid
Unique Period ID
operation char (1) Operations used to change boxes:A=AddD=DeleteU=UpdateC=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 - Supply1 - Resource2 - Activity3 - Summary4 - Demand5 - Route6 - Inventory
18 ■ Hyperion Business Modeling Database Tables Reference
Model Tables
3
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
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.variableid
If capacity is a formula
polcyformlid numeric (12,0) HABM_variables.variableid
If policy is a formula
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.
Field Type Required Reference Description
■ 19Hyperion Business Modeling Database Tables Reference
Model Tables
HABM_categoriesThis table contains information about the model’s financial categories.
Field Type Required Reference Description
categoryid1
1. Part of the key for unique index HABM_categ_indx.
numeric (12,0) Yes Generated category ID
modelid2
2. Part of the key for index HABM_categ_indx2.
numeric (12,0) Yes HABM_models.modelid
Model ID
scenarioid numeric (12,0) Yes HABM_scenarios.scenarioid
Unique Scenario ID
periodid numeric (12,0) Yes HABM_periods.periodid
Unique Period ID
operation char (1) Operations used to change categories:
A=AddD=DeleteU=UpdateC=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=RevenueC=Cost
parentid numeric (12,0) HABM_categories.categoryid
Where this category aggregates to
20 ■ Hyperion Business Modeling Database Tables Reference
Model Tables
3
HABM_financialThis 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
1. Part of the key for index HABM_fin_indx.
numeric (12,0) Yes Financial record ID
modelid2
2. Part of the key for index HABM_fin_indx2.
numeric (12,0) Yes HABM_models.modelid
Model to which the box belongs
scenarioid numeric (12,0) Yes HABM_scenarios.scenarioid
Unique Scenario ID
periodid numeric (12,0) Yes HABM_periods.periodid
Unique Period ID
operation varchar (1) Operations used to change boxes:A=AddD=DeleteU=UpdateC=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.categorynum
Category ID
variableid numeric(12,0) HABM_variables.variableid
Variable ID displays, if formula used
■ 21Hyperion Business Modeling Database Tables Reference
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 ■ Hyperion Business Modeling Database Tables Reference
Model Tables
3
HABM_groupsThis 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
1. Part of the key for unique index HABM_groups_indx
numeric (12,0) Yes Group to which objects belong
modelid2
2. Part of the key for index HABM_groups_indx2
numeric (12,0) Yes HABM_models.modelid
Model ID
scenarioid numeric (12,0) Yes HABM_scenarios.scenarioid
Unique Scenario ID
periodid numeric (12,0) Yes HABM_periods.periodid
Unique Period ID
operation char (1) Operations used to change boxes:A=AddD=DeleteU=UpdateC=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
■ 23Hyperion Business Modeling Database Tables Reference
Model Tables
HABM_groupxrefThis table contains the detail (cross-reference) part of the HABM_groups table.
Field Type Required Reference Description
groupid numeric (12,0) Yes HABM_groups.groupid
Box group
modelid1
1. Part of the key for index HABM_grpxref_indx.
numeric (12,0) Yes HABM_models.modelid
Model ID
scenarioid numeric (12,0) Yes HABM_scenarios.scenarioid
Unique Scenario ID
periodid numeric (12,0) Yes HABM_periods.periodid
Unique Period ID
operation char (1) Operations used to change boxes:A=AddD=DeleteU=UpdateC=Calculate
boxid numeric (12,0) Yes HABM_boxes.boxid
Box in current group
24 ■ Hyperion Business Modeling Database Tables Reference
Model Tables
3
HABM_layoutThis 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
1. Part of the key for index HABM_layout_indx.
numeric (12,0) Yes HABM_models.modelid
ID of the model to which the box belongs
scenarioid numeric (12,0) Yes HABM_scenarios.scenarioid
Unique scenario ID
periodid numeric (12,0) Yes HABM_periods.periodid
Unique period ID
boxid numeric (12,0) Yes HABM_boxes.boxid
Unique box ID of the 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
■ 25Hyperion Business Modeling Database Tables Reference
Model Tables
HABM_linksEach 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.modelid
Model to which box belongs
scenarioid numeric (12,0) Yes HABM_scenarios.scenarioid
Unique Scenario ID
periodid numeric (12,0) Yes HABM_periods.periodid
Unique Period ID
operation char (1) Operations used to change links:A=AddD=DeleteU=UpdateC=Calculate
srcbox3 numeric (12,0) Yes HABM_boxes.boxid
Box ID of the source (from) box
dstbox numeric (12,0) Yes HABM_boxes.boxid
Box ID of the 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 ■ Hyperion Business Modeling Database Tables Reference
Model Tables
3
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.variableid
Variable ID displays, if formula used
1. Part of the key for unique index HABM_links_indx.2. Part of the key for index HABM_links_indx2.3. Part of the key for index HABM_links_indx3.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.
Field (Cont’d) Type Required Reference Description
■ 27Hyperion Business Modeling Database Tables Reference
Model Tables
HABM_modelsThis 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.userid
ID of the model owner 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 ■ Hyperion Business Modeling Database Tables Reference
Model Tables
3
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 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.
Field (Cont’d) Type Required Reference Description
■ 29Hyperion Business Modeling Database Tables Reference
Model Tables
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.timelineid
Standard timeline
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.
Field (Cont’d) Type Required Reference Description
30 ■ Hyperion Business Modeling Database Tables Reference
Model Tables
3
HABM_notesThis table holds notes for boxes only.
Field Type Required Reference Description
modelid1
1. Part of the key for unique index HABM_notes_indx.
numeric (12,0) Yes HABM_models.modelid
Model ID
scenarioid numeric (12,0) Yes HABM_scenarios.scenarioid
Unique Scenario ID
periodid numeric (12,0) Yes HABM_periods.periodid
Unique Period ID
operation char (1) Operations used to change notes:A=AddD=DeleteU=UpdateC=Calculate
objid1 numeric (12,0) Yes HABM_boxes/HABM_links/HABM_models/....
Object ID
type numeric (3,0) Yes Object type
title varchar (200) Note title
keywords2*
2. Contains search items if the user needs to attach text notes with an object.
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.
■ 31Hyperion Business Modeling Database Tables Reference
Model Tables
HABM_periodsA default timeline and period length are set when you create the model.
Field Type Required Reference Description
modelid1
1. Part of the key for index HABM_periods_indx.
numeric (12,0) Yes HABM_models.modelid
Model ID
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
32 ■ Hyperion Business Modeling Database Tables Reference
Model Tables
3
HABM_scenariosThis table contains details for all scenarios of a model.
Field Type Required Reference Description
scenarioid1
1. Part of the key that identifies unique index HABM_scen_indx.
numeric (12,0) Yes Unique scenario ID
modelid2
2. Part of the key that identifies index HABM_scen_indx3.
numeric (12,0) Yes HABM_models.modelid
Model ID
scenarioalias3
3. Part of the key that identifies index HABM_scen_indx2.
varchar (10) Yes System generated alias for the scenario
timelineid numeric (12,0) Yes Timeline used
description varchar (1,000) Yes Short description of scenario
owner numeric (12,0) HBM_users.userid
User ID of owner
■ 33Hyperion Business Modeling Database Tables Reference
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
1. Part of the key that identifies unique index HABM_timeln_indx.
numeric (12,0) Yes Unique timeline ID
modelid2
2. Part of the key that identifies index HABM_timeln_indx2.
numeric (12,0) Yes HABM_models.modelid
Unique model ID
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
34 ■ Hyperion Business Modeling Database Tables Reference
Model Tables
3
HABM_unitsThis table contains unit IDs and a description of the model.
Field Type Required Reference Description
modelid numeric (12,0) Yes HABM_models.modelid
Model ID
scenarioid numeric (12,0) Yes HABM_scenarios.scenarioid
Unique Scenario ID
periodid numeric (12,0) Yes HABM_periods.periodid
Unique Period ID
operation char (1) Operations used to change units:
A=AddD=DeleteU=UpdateEA= External AddED= External DeleteEU= External Update
unitid1
1. Part of the key for unique index HABM_units_indx2.
numeric (9,0) Yes Unit ID
description2
2. Part of the key for unique index HABM_units_indx.
varchar (50) Yes Unit description
■ 35Hyperion Business Modeling Database Tables Reference
Model Tables
HABM_variablesThis table contains data about variables used in a particular model.
Field Type Required Reference Description
variableid1
1. Part of the key for unique index HABM_var_indx.
numeric (12,0) Yes Formula ID
modelid2
2. Part of the key for index HABM_var_indx2.
numeric (12,0) Yes HABM_models.modelid
Variable model ID
scenarioid numeric (12,0) Yes HABM_scenarios.scenarioid
Unique Scenario ID
periodid numeric (12,0) Yes HABM_periods.periodid
Unique Period ID
operation char (1) Operations used to change variables:
A= AddD= DeleteU= UpdateC = 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=constantL= local formula 3
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.
vbody varchar (250) Yes Variable body or constant value
calvalue numeric (24,6) The value of the calculated formula
36 ■ Hyperion Business Modeling Database Tables Reference
Model Tables
3
HBM_modelPreferencesThis 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.modelid
ID of the model to which the preference setting is attached
flowdecdigits numeric (1) The number of decimal digits set for reporting the operational flow. The default is zero (0).
findecdigits numeric (1) The number of decimal digits set for reporting financial figures. The default is 2.
perunitdecdigits
numeric (1) The number of decimal 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.”
■ 37Hyperion Business Modeling Database Tables Reference
Model Tables
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.”
capchargesname
varchar (200) The name of the EP Totaler representing the capital charges. The default is “Capital Charges.”
capchargesrangefrom
numeric (12,0) This value defines the beginning (or from) limit of the EP Totaler range. The default is set to “901.”
capchargesrangeto
numeric (12,0) This value defines the 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.
Field (Cont’d) Type Required Reference Description
38 ■ Hyperion Business Modeling Database Tables Reference
Model Tables
3
HBM_usersThis 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
1. Part of the key for unique index HBM_users_indx.
numeric (12,0) Yes Unique user ID for model owner or creator
firstname varchar (200) Yes First name of the model owner or creator
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
■ 39Hyperion Business Modeling Database Tables Reference
Model Tables
40 ■ Hyperion Business Modeling Database Tables Reference
Chapter
4
Hyperion Business Mod
Enterprise Model Tables
These tables store information that is used to manage the enterprise model, including:
● Reporting currency and exchange rates
● Publishing
● Layout
● Linking between models in the enterprise model
● 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:
● "HBM_boxIDChanges" on page 45
● "HBM_categoryIDChanges" on page 45
● "HBM_containers" on page 46
● "HBM_entBoxLinks" on page 47
● "HBM_entErrors" on page 48
● "HBM_entEssDimensions" on page 49
● "HBM_entExchangeRates" on page 49
● "HBM_entModelChanges" on page 51
■ 41eling Database Tables Reference
Enterprise Model Tables
● "HBM_entModelLayout" on page 52
● "HBM_entModelLinks" on page 53
● "HBM_entModels" on page 53
● "HBM_entModelUDEssDatabaseTypes" on page 54
● "HBM_entPublishedBoxes" on page 55
● "HBM_entPublishedCategories" on page 57
● "HBM_entPublishedFinancial" on page 58
● "HBM_entPublishedGroups" on page 60
● "HBM_entPublishedGroupxref" on page 61
● "HBM_entPublishedLinks" on page 62
● "HBM_entPublishedModelPref" on page 64
● "HBM_entPublishedModels" on page 66
● "HBM_entPublishedNotes" on page 69
● "HBM_entPublishedUnits" on page 70
● "HBM_entPublishedVariables" on page 71
● "HBM_publishingContainers" on page 72
● "HBM_tagsetIDChanges" on page 72
● "HBM_entUDEssDatabaseTypes" on page 73
● "HBM_unitNameChanges" on page 73
● "HBM_variableIDChanges" on page 74
To see the indexes used with these tables, see "List of Indexes" on page 43.
42 ■ Hyperion Business Modeling Database Tables Reference
Enterprise Model Tables
4
List of IndexesMost 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
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_entPublishedBoxes
HBM_epbox_indx
HBM_epbox_indx2
boxid
modelid
HBM_entPublished Categories
HBM_epcat_indx categoryid
HBM_epcat_indx2 modelid
HBM_entPublished Financial
HBM_epfin_indx
HBM_epfin_indx2
finid
modelid
HBM_entPublishedGroups
HBM_epgrp_indx
HBM_epgrp_indx2
groupid
modelid
■ 43Hyperion Business Modeling Database Tables Reference
Enterprise Model Tables
HBM_entPublishedGroupxref
HBM_epgxref_indx modelid
HBM_entPublishedLinks HBM_eplink_indx linkid
HBM_eplink_indx2 modelid
HBM_eplink_indx3 srcbox
HBM_entPublishedModelPref
HBM_epmPref_indx preferenceid
HBM_entPublishedModels HBM_epm_indx modelid
HBM_epm_indx2 name
HBM_entPublishedNotes HBM_epnote_indx modelidobjid
HBM_entPublishedUnits HBM_epunit_indx description
HBM_epunit_indx2 unitid
HBM_entPublishedVariables
HBM_epvar_indx variableid
HBM_epvar_indx2 modelidscope
HBM_publishingContainers
HBM_pcont_indx modelid
Table (cont’d) Index Index Sort Field
44 ■ Hyperion Business Modeling Database Tables Reference
Enterprise Model Tables
4
HBM_boxIDChangesThis table contains information on the box ID changes in a published model.
HBM_categoryIDChangesThis table contains information on the category 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.modelid
Unique model ID
oldshortname varchar (80) Yes HABM_boxes.shortname
Old box shortname
newshortname varchar (80) Yes HABM_boxes.shortname
New box shortname
Field Type Required Reference Description
categoryid numeric (12,0) Yes HABM_categories.categoryid
Unique ID of the changed category
modelid numeric (12,0) Yes HABM_models.modelid
Unique model ID
oldcategorynum
numeric (12,0) Yes HABM_categories.categorynum
Old category ID
newcategorynum
numeric (12,0) Yes HABM_categories.categorynum
New category ID
■ 45Hyperion Business Modeling Database Tables Reference
Enterprise Model Tables
HBM_containersThis table describes where each of the models contained in the enterprise model are located.
Field Type Required Reference Description
containerid1
1. Part of the key for unique index HBM_cont_indx.
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 - 6789Oracle - (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
2. Part of the key for unique index HBM_cont_indx.
varchar (200) JDBC driver path
46 ■ Hyperion Business Modeling Database Tables Reference
Enterprise Model Tables
4
HBM_entBoxLinksThis table provides information about the links between boxes in two different models within the enterprise model.
Field Type Required Reference Description
linkid1
1. Part of the key for unique index HBM_eBLinks_indx.
numeric (12,0) Yes Unique link ID
enterprisemodelid
numeric (12,0) HABM_modelsmodelid
The ID of the Enterprise model to which the selected box link belongs
srcboxid numeric (12,0) Yes HABM_boxes.boxid
Box ID of the source Demand (from) box
srcmodelid numeric (12,0) Yes HABM_models.modelid
Model ID of the source model
dstboxid numeric (12,0) Yes HABM_boxes.boxid
Box ID of the destination Supply (to) box
dstmodelid numeric (12,0) Yes HABM_models.modelid
Model ID of the destination model
linkfactor numeric (1) The factor applied to the link. The default is 1.
■ 47Hyperion Business Modeling Database Tables Reference
Enterprise Model Tables
HBM_entErrorsThis table provides model owners with access to view errors or warning messages generated in the enterprise model.
If the user needs to make corrections in the original model, the enterprise model user saves the enterprise model, and the appropriate errors or warnings for the state of the enterprise model are saved to the database. Depending on the state of the enterprise model when it is saved, this table saves the following information:
● If the enterprise model is verified with errors or warnings.
● If the enterprise model has been calculated with calculation errors or broken constraints.
The model owner can open HBM_entErrors to view the messages for the enterprise model, and make the appropriate corrections in the original model.
Field Type Required Reference Description
enterprisemodelid1
1. Part of the key for unique index HBM_eErrors_indx.
numeric (12,0) Yes HABM_models.modelid
Unique enterprise model ID
modelid numeric (12,0) Yes HABM_models.modelid
The ID of the source (from) model
itemid numeric (12,0) Yes HABM_boxes.boxid
Box ID named in the calculation error
sourcetype char (1) The source of the error may be:
C - Calculation
V - Verification
errortype char (1) The type of error may be:
E - Error
W - Warning
message varchar (2,000) Text of the error or warning message
48 ■ Hyperion Business Modeling Database Tables Reference
Enterprise Model Tables
4
HBM_entEssDimensionsThis table contains information on Hyperion Business Modeling Essbase databases.
HBM_entExchangeRatesThis table includes the conversion rates for the currency of each model in the enterprise model into the selected reporting currency.
Field Type Required Reference Description
dimensionid numeric (12,0) Yes Unique dimension ID
dimensionname
varchar (200) Yes Dimension name
Field Type Required Reference Description
exrateid1
1. Part of the key for unique index HBM_eRates_indx.
numeric (12,0) Yes Unique exchange rate ID
reportingcrncy char (3) Yes Selected reporting currency for the enterprise model, expressed in ISO 4217 currency code
srccrncy char (3) Yes Original currency of the model, expressed in ISO 4217 currency code
conversionrate
numeric (24,6) Yes Exchange rate to convert the source currency (srccrncy) into the selected reporting currency
lastupdate date Yes Date and time of the last modification
■ 49Hyperion Business Modeling Database Tables Reference
Enterprise Model Tables
HBM_entLinkFlowCostsThis table contains enterprise link financial information between two boxes from two different linked models..
Field Type Required Reference Description
linkid1
1. Part of the key for unique index HBM_eFCLinks_indx.
numeric (12,0) Yes Unique link ID
enterprisemodelid
numeric (12,0) Yes HBM_models.modelid
Enterprise model ID to which the box belongs
flow numeric (24,6) Yes Flow for the selected link
cost numeric (24,6) Yes Cost flowing through the selected link
revenue numeric (24,6) Yes Revenue flowing through the selected link
50 ■ Hyperion Business Modeling Database Tables Reference
Enterprise Model Tables
4
HBM_entModelChangesThis table identifies the owner of a particular model, and shows the publish date for current changes to the enterprise model.
Field Type Required Reference Description
changeid1
1. Part of the key for unique index HBM_eChg_indx.
numeric (12,0) Yes Unique ID assigned to track each time a model is published to the enterprise model
modelid numeric (12,0) Yes HABM_models.modelid
Unique model ID
userid numeric (12,0) Yes HABM_users.userid
User ID of the model owner
enterprisemodelid
numeric (12,0) HABM_models.modelid
Model ID of the enterprise model to which the changes are being published
publishdate date The publishing date of changes to a model, to notify the enterprise model
This date is automatically removed after the enterprise model either accepts or rejects the changes.
status char (1) Status of the published changes:
A - Accepted
R - Rejected
N - Not Reviewed
■ 51Hyperion Business Modeling Database Tables Reference
Enterprise Model Tables
HBM_entModelLayoutThis table contains the X-Y coordinates that identify the location and size of all models in the enterprise model.The X-Y coordinates for boxes are saved in the "HABM_layout" on page 25.
Field Type Required Reference Description
enterprisemodelid1
1. Part of the key for index HBM_eml_indx.
numeric (12,0) Yes HABM_models.modelid
Unique enterprise model ID
modelid numeric (12,0) Yes HABM_models.modelid
ID of the model that is part of the enterprise model
xcoord numeric (12,0) Yes X coordinate for the selected model
ycoord numeric (12,0) Yes Y coordinate for the selected model
modelwidth numeric (12,0) Yes Width of the selected model in pixels
modelheight numeric (12,0) Yes Height of the selected model in pixels
viewlevel numeric (1) Yes The view level of the model, as follows:
0 - Model View
1 - Model Detail
52 ■ Hyperion Business Modeling Database Tables Reference
Enterprise Model Tables
4
HBM_entModelLinksThis table provides details of the virtual links between models that are contained in an enterprise model. This information is used for GUI display only.
HBM_entModelsThis table describes which models are contained in an enterprise model, and identifies whether the selected model is a regular or enterprise model.
Details of the enterprise model are saved in the HABM_models table. For additional information, refer to "HABM_models" on page 28.
Field Type Required Reference Description
modellinkid1
1. Part of the key for unique index HBM_eLinks_indx.
numeric (12,0) Yes Unique link ID
modellinkname
varchar (200) Yes Name of the virtual link between models in the enterprise model
enterprisemodelid
numeric (12,0) Yes HABM_models.modelid
Enterprise model ID
srcmodelid numeric (12,0) Yes HABM_models.modelid
Model ID of the source model on the link in the enterprise model
dstmodelid numeric (12,0) Yes HABM_models.modelid
Model ID of the destination model on the link in the enterprise model
Field Type Required Reference Description
enterprisemodelid1
1. Part of the key for index HBM_eModels_indx.
numeric (12,0) Yes HABM_models.modelid
Unique enterprise model ID
modelid numeric (12,0) Yes HABM_models.modelid
Model ID of the regular model which is part of an enterprise model
■ 53Hyperion Business Modeling Database Tables Reference
Enterprise Model Tables
HBM_entModelUDEssDatabaseTypesThis table describes the model to which the customized Essbase database belongs.
Field Type Required Reference Description
modelid numeric (12,0) Yes HABM_models.modelid
Unique model ID
essdbtypeid numeric (12,0) Yes HBM_entUDESSDatabaseTypes.id
Unique ID of the customized Essbase database
54 ■ Hyperion Business Modeling Database Tables Reference
Enterprise Model Tables
4
HBM_entPublishedBoxesThis table contains a record for each box change published to the enterprise model.
Field Type Required Reference Description
boxid1 numeric (12,0) Yes Unique Box ID
modelid2 numeric (12,0) Yes HABM_models.modelid
ID of the model to which the box belongs
scenarioid numeric (12,0) Yes HABM_scenarios.scenarioid
Unique scenario ID
periodid numeric (12,0) Yes HABM_periods.periodid
Unique period ID
changeid numeric (12,0) Yes HABM_entModelChanges.changeid
Unique change ID is created each time the model is published to the enterprise model
operation varchar (2) The type of operation used to change the box, as follows:
EA = External Add
ED = External Delete
EU = External Update
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 Box:
0 - Supply1 - Resource2 - Activity3 - Summary4 - Demand5 - Route6 - Inventory
■ 55Hyperion Business Modeling Database Tables Reference
Enterprise Model Tables
capacity numeric (24,6) Capacity of the 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
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.variableid
If capacity is a formula
polcyformlid numeric (12,0) HABM_variables.variableid
If policy is a formula
1. Part of the key for unique index HBM_epbox_indx.2. Part of the key for unique index HBM_epbox_indx2.
Field (cont’d) Type Required Reference Description
56 ■ Hyperion Business Modeling Database Tables Reference
Enterprise Model Tables
4
HBM_entPublishedCategoriesThis table contains information for the changes to financial categories published to the enterprise model.
Field Type Required Reference Description
categoryid1 numeric (12,0) Yes Generated category ID
modelid2 numeric (12,0) Yes HABM_models.modelid
Unique model ID
scenarioid numeric (12,0) Yes HABM_scenarios.scenarioid
Unique Scenario ID
periodid numeric (12,0) Yes HABM_periods.periodid
Unique Period ID
changeid numeric (12,0) Yes Unique ID assigned to track each time a model is published to the enterprise model
operation varchar (2) Operations used to change categories:
EA= External AddED= External DeleteEU= External Update
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:
R=RevenueC=Cost
parentid numeric (12,0) HABM_categories.categoryid
Where this category aggregates to
■ 57Hyperion Business Modeling Database Tables Reference
Enterprise Model Tables
HBM_entPublishedFinancialThis table contains a record of changes to financial information published to the enterprise model.
The results of any changes made by linking are stored in this table and HABM_boxes.
1. Part of the key for unique index HBM_epcat_indx2. Part of the key for index HBM_epcat_indx2
Field Type Required Reference Description
finid1 numeric (12,0) Yes Financial record ID
modelid2 numeric (12,0) Yes HABM_models.modelid
Model to which the box belongs
scenarioid numeric (12,0) Yes HABM_scenarios.scenarioid
Unique Scenario ID
periodid numeric (12,0) Yes HABM_periods.periodid
Unique Period ID
changeid numeric (12,0) Yes Unique ID assigned to track each time a model is published to the enterprise model
operation varchar (2) Operations used to change boxes:EA= External AddED= External DeleteEU= External Update
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
58 ■ Hyperion Business Modeling Database Tables Reference
Enterprise Model Tables
4
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.categorynum
Category ID
variableid numeric(12,0) HABM_variables.variableid
Variable ID displays, if formula used
1. Part of the key for index HBM_epfin_indx.2. Part of the key for index HBM_epfin_indx2.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.
Field (cont’d) Type Required Reference Description
■ 59Hyperion Business Modeling Database Tables Reference
Enterprise Model Tables
HBM_entPublishedGroupsThis table contains information about changes to groups or tag sets published to the enterprise model. The HBM_entPublishedGroupxref table associates groups with boxes in the enterprise model.
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
1. Part of the key for unique index HBM_epgrp_indx.
numeric (12,0) Yes Group to which objects belong
modelid2
2. Part of the key for index HBM_epgrp_indx2.
numeric (12,0) Yes HABM_models.modelid
Model ID
scenarioid numeric (12,0) Yes HABM_scenarios.scenarioid
Unique Scenario ID
periodid numeric (12,0) Yes HABM_periods.periodid
Unique Period ID
changeid numeric (12,0) Yes Unique ID assigned to track each time a model is published to the enterprise model
operation varchar (2) Operations used to change boxes:EA= External AddED= External DeleteEU= External Update
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
60 ■ Hyperion Business Modeling Database Tables Reference
Enterprise Model Tables
4
HBM_entPublishedGroupxrefThis table contains the detail (cross-reference to the HBM_entPublishedGroups table) changes published to the enterprise model.
Field Type Required Reference Description
groupid numeric (12,0) Yes HABM_groups.groupid
Box group
modelid1
1. Part of the key for index HBM_epgxref_indx.
numeric (12,0) Yes HABM_models.modelid
Model ID
scenarioid numeric (12,0) Yes HABM_scenarios.scenarioid
Unique Scenario ID
periodid numeric (12,0) Yes HABM_periods.periodid
Unique Period ID
changeid numeric (12,0) Yes Unique ID assigned to track each time a model is published to the enterprise model
operation varchar (2) Operations used to change boxes:EA= External AddED= External DeleteEU= External Update
boxid numeric (12,0) Yes HABM_boxes.boxid
Box in current group
■ 61Hyperion Business Modeling Database Tables Reference
Enterprise Model Tables
HBM_entPublishedLinksEach record in this table contains changes to box link information published to the enterprise model. 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.modelid
Model to which box belongs
scenarioid numeric (12,0) Yes HABM_scenarios.scenarioid
Unique Scenario ID
periodid numeric (12,0) Yes HABM_periods.periodid
Unique Period ID
changeid numeric (12,0) Yes Unique ID assigned to track each time a model is published to the enterprise model
operation varchar (2) Operations used to change links:EA= External AddED= External DeleteEU= External Update
srcbox3 numeric (12,0) Yes HABM_boxes.boxid
Box ID of the source (from) box
dstbox numeric (12,0) Yes HABM_boxes.boxid
Box ID of the 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
62 ■ Hyperion Business Modeling Database Tables Reference
Enterprise Model Tables
4
expval numeric (24,6) Expected value per box unit, as defined by the user
range numeric (24,6) Yes Range
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.variableid
Variable ID displays, if formula used
1. Part of the key for unique index HBM_eplink_indx2. Part of the key for index HBM_eplink_indx23. Part of the key for index HBM_eplink_indx34. 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.
Field (cont’d) Type Required Reference Description
■ 63Hyperion Business Modeling Database Tables Reference
Enterprise Model Tables
HBM_entPublishedModelPrefThis table is used to save changes to model-specific settings published to the enterprise model.
Field Type Required Reference Description
preferenceid1 numeric (12,0) Yes Unique preference ID
modelid numeric (12,0) Yes HABM_models.modelid
ID of the model to which the preference setting is attached
changeid numeric (12,0) Yes HBM_entModelChanges.changeid
Unique change ID
operation char (2) Operations used to change units:
EA= External AddED= External DeleteEU= External Update
flowdecdigits numeric (1) The number of decimal digits set for reporting the operational flow. The default is zero (0).
findecdigits numeric (1) The number of decimal digits set for reporting financial figures. The default is 2.
perunitdecdigits
numeric (1) The number of decimal 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.”
64 ■ Hyperion Business Modeling Database Tables Reference
Enterprise Model Tables
4
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.”
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.”
capchargesname
varchar (200) The name of the EP Totaler representing the capital charges. The default is “Capital Charges.”
capchargesrangefrom
numeric (12,0) This value defines the beginning (or from) limit of the EP Totaler range. The default is set to “901.”
capchargesrangeto
numeric (12,0) This value defines the end (or to) limit of the EP Totaler range. The default is set to “999.”
1. Part of the key for unique index HBM_epmPref_indx.
Field (cont’d) Type Required Reference Description
■ 65Hyperion Business Modeling Database Tables Reference
Enterprise Model Tables
HBM_entPublishedModelsThis table contains changes to information about each model that has been published to the enterprise model.
Field Type Required Reference Description
modelid1 numeric (12,0) Yes HABM_models.modelid
Unique model ID
name2 varchar (200) Yes Name of the model
title varchar (1,000) Yes Model title
changeid numeric (12,0) Yes HBM_entModelChanges.changeid
Unique change ID
operation varchar (2) Operations used to change links:EA= External AddED= External DeleteEU= External Update
owner numeric (12,0) HBM_users.userid ID of the model owner/creator
userlock numeric (12,0) The number of modifications made to the model.
This feature is used for model locking.
crncy char (3) Original currency of the model, expressed in ISO 4217 currency code
finmultiplier numeric (24,6) Yes Financial data multiplier is used to display financial data. For example, if you enter 1,000, the data is displayed in thousands.
66 ■ Hyperion Business Modeling Database Tables Reference
Enterprise Model Tables
4
modelversion varchar (10) Yes Version of Hyperion Business Modeling that was used to create the model
modeltype numeric (1) Type of model, as follows:
0 - Regular model
1 - Enterprise model
extupdate 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.
Field (cont’d) Type Required Reference Description
■ 67Hyperion Business Modeling Database Tables Reference
Enterprise Model Tables
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
timelineid numeric (12,0) HABM_timelines.timelineid
Standard timeline
lastupdate 3 date Date and time of last modification
1. Part of the key for index HBM_epin_indx1.2. Part of the key for index HBM_epm_indx2.3. A time stamp that can be used in establishing the validity of model linking and signalling model updates.
Field (cont’d) Type Required Reference Description
68 ■ Hyperion Business Modeling Database Tables Reference
Enterprise Model Tables
4
HBM_entPublishedNotesThis table contains changes to notes for boxes published to the enterprise model.
Field Type Required Reference Description
modelid1
1. Part of the key for unique index HBM_epnote_indx
numeric (12,0) Yes HABM_models.modelid
Model ID
scenarioid numeric (12,0) Yes HABM_scenarios.scenarioid
Unique Scenario ID
periodid numeric (12,0) Yes HABM_periods.periodid
Unique Period ID
changeid numeric (12,0) Yes Unique ID assigned to track each time a model is published to the enterprise model
operation varchar (2) Operations used to change notes:EA= External AddED= External DeleteEU= External Update
objid2
2. Part of the key for unique index HBM_epnote_indx
numeric (12,0) Yes HABM_boxes/HABM_links/HABM_models/....
Object ID
type numeric (3,0) Yes Object type
title varchar (200) Note title
keywords3*
3. Contains search items if the user needs to attach text notes with an object
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.
■ 69Hyperion Business Modeling Database Tables Reference
Enterprise Model Tables
HBM_entPublishedUnitsThis table contains changes to unit IDs and the description of a model published to the enterprise model.
Field Type Required Reference Description
modelid numeric (12,0) Yes HABM_models.modelid
Model ID
scenarioid numeric (12,0) Yes HABM_scenarios.scenarioid
Unique Scenario ID
periodid numeric (12,0) Yes HABM_periods.periodid
Unique Period ID
changeid numeric (12,0) Yes Unique ID assigned to track each time a model is published to the enterprise model
operation char (2) Operations used to change units:
EA= External AddED= External DeleteEU= External Update
unitid1
1. Part of the key for unique index HBM_epunit_indx2.
numeric (9,0) Yes Unit ID
description2
2. Part of the key for unique index HBM_epunit_indx.
varchar (50) Yes Unit description
70 ■ Hyperion Business Modeling Database Tables Reference
Enterprise Model Tables
4
HBM_entPublishedVariablesThis table contains information for changes to the variables published to the enterprise model.
Field Type Required Reference Description
variableid1
1. Part of the key for unique index HBM_epvar_indx
numeric (12,0) Yes Formula ID
modelid2
2. Part of the key for index HBM_epvar_indx2
numeric (12,0) Yes HABM_models.modelid
Variable model ID
scenarioid numeric (12,0) Yes HABM_scenarios.scenarioid
Unique Scenario ID
periodid numeric (12,0) Yes HABM_periods.periodid
Unique Period ID
changeid numeric (12,0) Yes Unique ID assigned to track each time a model is published to the enterprise model
operation char (2) Operations used to change variables:
EA= External AddED= External DeleteEU= External Update
vname varchar (200) Yes Variable name
shortname varchar (80) Yes Variable ID created by the user
scope2 char (1) Yes Variable scope:
C=constantL= local formula 3
vbody varchar (250) Yes Variable body or constant value
calvalue numeric (12,0) The value of the calculated formula
■ 71Hyperion Business Modeling Database Tables Reference
Enterprise Model Tables
HBM_publishingContainersThis table contains the details about the enterprise model container to which a model is to be published.
HBM_tagsetIDChangesThis table contains information on the tag set ID changes in a published model.
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.
Field Type Required Reference Description
modelid1
1. Part of the key for unique index HBM_pcont_indx.
numeric (12,0) Yes HABM_models.modelid
Unique model ID
containerid numeric (12,0) Yes HABM_containers.containerid
The enterprise model container to which the model is to be published
publishdate date The date that the model is published to the enterprise model container
Field Type Required Reference Description
groupid numeric (12,0) Yes HABM_boxes.boxid Unique ID of the changed tag sets
modelid numeric (12,0) Yes HABM_models.modelid
Unique model ID
oldshortname char (32) Yes HABM_boxes.shortname
Old tag set shortname
newshortname char (32) Yes HABM_boxes.shortname
New tag set shortname
72 ■ Hyperion Business Modeling Database Tables Reference
Enterprise Model Tables
4
HBM_entUDEssDatabaseTypesThis table contains information on user-customized Hyperion Business Modeling Essbase databases.
HBM_unitNameChangesThis table contains information on the unit name changes in a published model.
Field Type Required Reference Description
id numeric (12,0) Yes Unique ID
name varchar (200) Yes Name of the customized Essbase database
dimselections numeric (12,0) Yes HBM_entEssDimensions.dimensionid
Unique dimension ID
Field Type Required Reference Description
unitid numeric (12,0) Yes HABM_units.unitid Unique ID of the changed unit name
modelid numeric (12,0) Yes HABM_models.modelid
Unique model ID
oldunitname varchar (200) Yes HABM_units.description
Old unit description
newunitname varchar (200) Yes HABM_units.description
New unit description
■ 73Hyperion Business Modeling Database Tables Reference
Enterprise Model Tables
HBM_variableIDChangesThis table contains information on the variable ID changes in a published model.
Field Type Required Reference Description
variableid numeric (12,0) Yes HABM_variables.variableid
Unique ID of the changed variable
modelid numeric (12,0) Yes HABM_models.modelid
Unique model ID
oldshortname varchar (80) Yes HABM_variables.shortname
Old variable shortname
newshortname varchar (80) Yes HABM_variables.shortname
New variable shortname
74 ■ Hyperion Business Modeling Database Tables Reference
Chapter
5
Hyperion Business Mod
Results Tables
The following tables are used to save calculated results to ODBC compliant databases. Calculated results may include financial results, operational flow, utilization, activity, inventory, resources, and revenue costs. Results may also be saved for tag set reports.
The Results Tables are created when the environment is initialized. Saving the results populates the tables. To improve performance, unique IDs are use to store these results, rather than full names. To view the results in a readable table, refer to the "Results Views Tables" on page 91.
No index fields are required for Results tables.
You can find the following Results Tables and their descriptions in this chapter:
● "HABM_resultupdate" on page 76
● "HBM_activityResults" on page 77
● "HBM_inventoryResults" on page 78
● "HBM_resourceResults" on page 79
● "HBM_revenueCostResults" on page 80
● "HBM_tagByBoxDetResults" on page 81
● "HBM_tagByBoxSumResults" on page 82
● "HBM_tagsResourceResults" on page 83
● "HBM_tagsTotalResults" on page 84
● "HBM_utilizationResults" on page 85
● "HBM_boxCostFlows" on page 86
● "HBM_boxLinkFlows" on page 87
● "HBM_entModelResults" on page 88
● "HBM_totalModelResults" on page 89
■ 75eling Database Tables Reference
Results Tables
HABM_resultupdateThis table contains a time stamp to indicate the date of the last modification to the results.
Field Type Required Reference Description
modelname varchar (200) Yes HABM_models.modelid
Model given name
For the Economic Profit view, (EP Result) appears at the end of the model name.
scenario varchar (1,000) Short description of the scenario
period varchar (200) Name assigned to period
lastupdate date Date of the last modification to the results1
1. If you are reporting from both the Models and Results tables, check the lastupdate field to ensure the tables are synchronized and have the same time stamp.
76 ■ Hyperion Business Modeling Database Tables Reference
Results Tables
5
HBM_activityResultsThis table contains the activity results calculated by the model for the selected project for all activity boxes.To view the results, refer to "HABM_activity" on page 96.
For the purpose of generating the results of activity boxes, the boxes are treated as tagged boxes. On the schematic, if some costs flow from one activity box into another, these boxes are regarded as stacked boxes. To avoid double-counting, only the results for the first activity box are reported. If there are no costs between the activity boxes, the interim activity boxes are not reported.
Field Type Required Reference Description
modelid numeric (12,0) Yes HABM_models.modelid
Unique ID for the model.
scenarioid numeric (12,0) Unique ID for the scenario
periodid numeric (12,0) ID assigned to period
resulttype numeric (1) Type of results, as follows:
0 - Regular View1 - Economic Profit View
categoryid numeric (12,0) ID of the selected category
toboxid numeric (12,0) ID of the destination (to) box on the schematic
fromboxid numeric (12,0) ID of the input (activity) box on the schematic
unitid numeric (12,0) Name of the specified unit
type char (1) Total value of the revenue cost being calculated.
This figure may be fixed (f) or variable (v), depending on the type of box being calculated.
financialresult numeric (24,6) Total of financial calculations
operationalflow numeric (24,6) Value of the operational flow
■ 77Hyperion Business Modeling Database Tables Reference
Results Tables
HBM_inventoryResultsThis table contains the inventory results calculated for a selected scenario. To view the results, refer to "HABM_inventory" on page 97.
Field Type Required Reference Description
modelid numeric (12,0) Yes HABM_models.modelid
Unique model ID
scenarioid numeric (12,0) Unique ID for the scenario
periodid numeric (12,0) ID assigned to period
resulttype numeric (1) Type of results, as follows:
0 - Regular View1 - Economic Profit View
toboxid numeric (12,0) ID of the destination (to) box
openingcost numeric (24,6) Dollar value of inventory on hand
closingcost numeric (24,6) Dollar value of closing inventory
78 ■ Hyperion Business Modeling Database Tables Reference
Results Tables
5
HBM_resourceResultsThis table contains the resource results calculated for a selected scenario. To view the results, refer to "HABM_resource" on page 98.
Field Type Required Reference Description
modelid numeric (12,0) Yes HABM_models.modelid
Unique model ID
scenarioid numeric (12,0) Unique ID for the scenario
periodid numeric (12,0) ID assigned to period
resulttype numeric (1) Type of results, as follows:
0 - Regular View1 - Economic Profit View
fromboxid numeric (12,0) ID of the source (from) box
toboxid numeric (12,0) ID of the destination (to) box
total char (1) Type of value being calculated
The type may be fixed or variable, depending on the type of box being calculated (financial results or operational flow).
unitid numeric (12,0) ID of the specified unit
financialresource numeric (24,6) The proportion of the dollar value of the source (frombox) into the destination (tobox)
operationalflow numeric (24,6) The proportion of the operational value of the source (frombox) that flows into the destination (tobox)
■ 79Hyperion Business Modeling Database Tables Reference
Results Tables
HBM_revenueCostResultsThis table contains the financial results calculated for a selected scenario. To view the results, refer to "HABM_revenuecost" on page 99.
Field Type Required Reference Description
modelid numeric (12,0) Yes HABM_models.modelid
Unique model ID.
scenarioid numeric (12,0) Unique ID for scenario
periodid numeric (12,0) ID assigned to period
resulttype numeric (1) Type of results, as follows:
0 - Regular View
1 - Economic Profit View
categoryid numeric (12,0) ID of the selected category
toboxid numeric (12,0) ID of the destination (to) box
unitid numeric (12,0) ID of the specified unit
total char (1) Type of value being calculated.
The type may be fixed or variable, depending on the type of box being calculated (financial results or operational flow).
financialresult numeric (24,6) Total of financial calculations
operationalflow numeric (24,6) Value of the operational flow
80 ■ Hyperion Business Modeling Database Tables Reference
Results Tables
5
HBM_tagByBoxDetResultsThis table contains the Box Tag Set Report - Flows and Financials by Category - Detail results, calculated for a selected project (using selected tag sets and boxes). To view the results, refer to "HABM_tagByBoxDetailed" on page 100.
Field Type Required Reference Description
modelid numeric (12,0) Yes HABM_models.modelid
Unique model ID
scenarioid numeric (12,0) ID for the scenario
periodid numeric (12,0) ID assigned to the period
resulttype numeric (1) Type of results, as follows:
0 - Regular View1 - Economic Profit View
categoryid numeric (12,0) ID of the selected category
fromtagid numeric (12,0) ID of the input (from) tag
toboxid numeric (12,0) ID of the destination (to) box
fromboxid numeric (12,0) ID of the tagged input (from) box
unitid numeric (12,0) ID of the specified unit
type char (1) This figure may be fixed (f) or variable (v), depending on the type of box being calculated
resourcefinancial numeric (24,6) Total of financial calculations (resource financial results)
inputfinancial numeric (24,6) Total of financial calculations (input financial results)
operationalflow numeric (24,6) Value of the results of the operational flow
■ 81Hyperion Business Modeling Database Tables Reference
Results Tables
HBM_tagByBoxSumResultsThis table contains the Box Tag Set Report - Flows and Financials results, calculated for a selected project (using selected tag sets and boxes). To view the results, refer to "HABM_tagByBoxSummary" on page 101.
Field Type Required Reference Description
modelid numeric (12,0) Yes HABM_models.modelid
Unique model ID
scenarioid numeric (12,0) Unique ID for the scenario
periodid numeric (12,0) ID assigned to the period
resulttype numeric (1) Type of results, as follows:
0 - Regular View1 - Economic Profit View
fromtagid numeric (12,0) ID of the input (from) tag
toboxid numeric (12,0) ID of the destination (to) box
fromboxid numeric (12,0) ID of the tagged source (from) box
unitid numeric (12,0) ID of the specified unit
type char (1) This figure may be fixed (f) or variable (v), depending on the type of box being calculated.
resourcefinancial numeric (24,6) Total of financial calculations (resource financial results)
inputfinancial numeric (24,6) Total of financial calculations (input financial results)
operationalflow numeric (24,6) Value of the results of the operational flow
82 ■ Hyperion Business Modeling Database Tables Reference
Results Tables
5
HBM_tagsResourceResultsThis table contains the Model Tag Set Report - Flows and Financials by Resource results, calculated for a selected project (using selected tag sets). To view the results, refer to "HABM_tagsResource" on page 102.
Field Type Required Reference Description
modelid numeric (12,0) Yes HABM_models.modelid
Unique model ID
scenarioid numeric (12,0) Unique ID for the scenario
periodid numeric (12,0) ID assigned to the period
resulttype numeric (1) Type of results, as follows:
0 - Regular View1 - Economic Profit View
categoryid numeric (12,0) ID of the selected category
totagid numeric (12,0) ID of the destination (to) tag on the schematic
toboxid numeric (12,0) ID of the tagged destination (to) box on the schematic
fromboxid numeric (12,0) ID of the input (from) box on the schematic
unitid numeric (12,0) ID of the specified unit
type char (1) This figure may be fixed (f) or variable (v), depending on the type of box being calculated.
resourcefinancial numeric (24,6) Total of financial calculations (resource financial result)
operationalflow numeric (24,6) Value of the operational flow
■ 83Hyperion Business Modeling Database Tables Reference
Results Tables
HBM_tagsTotalResultsThis table contains the Model Tag Set Report - Flows and Financials by Category results, calculated for the selected project (by selected tag sets). To view the results, refer to "HABM_tagsTotal" on page 103.
Field Type Required Reference Description
modelid numeric (12,0) Yes HABM_models.modelid
Unique model ID
scenarioid numeric (12,0) Unique ID for the scenario
periodid numeric (12,0) ID assigned to the period
resulttype numeric (1) Type of results, as follows:
0 - Regular View1 - Economic Profit View
categoryid numeric (12,0) ID of the selected category
fromtagid numeric (12,0) ID of the input tag on the schematic
fromboxid numeric (12,0) ID of the input (tagged) box on the schematic
unitid numeric (12,0) ID of the specified unit
type char (1) Type of financial or operational value being calculated. This figure may be fixed (f) or variable (v), depending on the type of box being calculated.
resourcefinancial numeric (24,6) Total of financial calculations (resource financial result)
inputfinancial numeric (24,6) Total of financial calculations (input financial result)
operationalflow numeric (24,6) Value of the operational flow
84 ■ Hyperion Business Modeling Database Tables Reference
Results Tables
5
HBM_utilizationResultsThis table contains data about the utilization percentage results calculated for the selected period and box type. To view the results, refer to "HABM_utilization" on page 104.
Field Type Required Reference Description
modelid numeric (12,0) Yes HABM_models.modelid
Unique model ID
scenarioid numeric (12,0) Unique ID for the scenario
periodid numeric (12,0) ID assigned to the period
resulttype numeric (1) Type of results, as follows:
0 - Regular View
1 - Economic Profit View
toboxid numeric (12,0) ID of the selected box
utilization numeric (24,6) Utilization percentage for the selected box
operationalflow numeric (24,6) Value of the operational flow for the selected box
■ 85Hyperion Business Modeling Database Tables Reference
Results Tables
HBM_boxCostFlowsThis table contains total financials and flows for a selected box. The results are used internally by the application for calculation.
Field Type Required Reference Description
boxid numeric (12,0) Yes HABM_boxes.boxid
Unique box ID
modelid numeric (12,0) Yes HABM_models.modelid
ID of the model to which the box belongs
scenarioid numeric (12,0) Yes HABM_scenarios.scenarioid
Unique scenario ID
periodid numeric (12,0) Yes HABM_periods.periodid
Unique period ID
boxflow numeric (24,6) Yes The total operational flow for the selected box
boxcost numeric (24,6) Yes The total cost for the selected box
boxrevenue numeric (24,6) Yes The total revenue for the selected box
86 ■ Hyperion Business Modeling Database Tables Reference
Results Tables
5
HBM_boxLinkFlowsThis table contains the total operational flow for each box link within an enterprise model. The results are used internally by the application for calculations.
Field Type Required Reference Description
linkid numeric (12,0) Yes HABM_links.linkid
Unique link ID
modelid numeric (12,0) Yes HABM_models.modelid
ID of the model to which the link belongs
scenarioid numeric (12,0) Yes HABM_scenarios.scenarioid
Unique scenario ID
periodid numeric (12,0) Yes HABM_periods.periodid
Unique period ID
linkflow numeric (24,6) Yes Total operational flow of the selected box link
■ 87Hyperion Business Modeling Database Tables Reference
Results Tables
HBM_entModelResultsThis table contains the financials and flow information between models within the enterprise model. The results are displayed in the Enterprise Detailed Model Report by category. To view the results, refer to "HBM_entModelRes" on page 105.
Field Type Required Reference Description
enterprisemodelid
numeric (12,0) Yes HABM_models.modelid
Unique enterprise model ID
tomodelid numeric (12,0) Yes HABM_models.modelid
Model ID of the destination (to) model
frommodelid numeric (12,0) Yes HABM_models.modelid
Model ID of the source (from) model
categoryid numeric (12,0) Yes Category ID
unitid numeric (12,0) Yes ID of the specified unit
type char (1) Yes The type of value being calculated. This figure may be Fixed (F) or Variable (V), depending on the type of box being calculated.
cost numeric (24,6) Yes Value of the financials being calculated.
flow numeric (24,6) Yes Value of the operational flow.
88 ■ Hyperion Business Modeling Database Tables Reference
Results Tables
5
HBM_totalModelResultsThis table contains the total results for a model in an enterprise model, and is also used internally by the application.To view the results, refer to "HBM_totalModel" on page 106.
Field Type Required Reference Description
modelid numeric (12,0) Yes HABM_models.modelid
Unique model ID
type char (1) Total value of the revenue cost being calculated. This figure may be:
F - Fixed
V - Variable
T - Total (Fixed plus Variable)
revenue numeric (24,6) Total revenue for the model
cost numeric (24,6) Total cost for the model
profit numeric (24,6) Total profit for the model
openinginventory
numeric (24,6) The opening inventory for the model
closinginventory
numeric (24,6) The closing inventory for the model
totalinventory
numeric (24,6) The total inventory for the model
■ 89Hyperion Business Modeling Database Tables Reference
Results Tables
90 ■ Hyperion Business Modeling Database Tables Reference
Chapter
6
Hyperion Business Mod
Results Views Tables
While actual calculated results are stored in the Results tables, the Results Views tables are used to view those calculated results, which may include financial results, operational flow, utilization, activity, inventory, resources, and revenue costs. Results may also be saved for tag set reports. See "Results Tables" on page 75 for more information.
To simplify the conversion and storage of these results across a variety of database types, including OLAP tools, full names are used in the Results Views tables to identify field names, rather than using the unique box IDs specified for the Model and Results tables.
The Result Views tables are created when the environment is initialized. Saving the results populates the tables. No index fields are required for Results tables.
You can find the following Results Views Tables and their descriptions in this chapter:
● "HABM_activity" on page 96
● "HABM_inventory" on page 97
● "HABM_resource" on page 98
● "HABM_revenuecost" on page 99
● "HABM_tagByBoxDetailed" on page 100
● "HABM_tagByBoxSummary" on page 101
● "HABM_tagsResource" on page 102
● "HABM_tagsTotal" on page 103
● "HABM_utilization" on page 104
● "HBM_entModelRes" on page 105
● "HBM_totalModel" on page 106
■ 91eling Database Tables Reference
Results Views Tables
Viewing Results ViewsA number of pre-formatted queries have been created to enable you to view the results for your model in the Results Views.
The following procedure provides instructions to view results in a Microsoft Access database. Procedures for other database types are dependent on the query formats, and so on. Refer to that database documentation for information on creating queries.
➤ To view results in a Microsoft Access database:
1. In Hyperion Business Modeling, open and calculate your model.
2. Select Project > Container Setup to create a new container.
The Container Setup window is displayed.
3. Click Add to add the new container.
The Add Container window is displayed.
4. Enter a name for the container in the Name text box.
5. Select MSAccess from the Type drop-down.
The Add Container window expands to show additional text boxes.
92 ■ Hyperion Business Modeling Database Tables Reference
Results Views Tables
6
6. Enter a database user name and password, if required.
7. Select a Driver Type and DSN from the drop-down lists.
8. Click Attempt to open connection automatically, if required.
9. Click Test Connection to ensure the connection is valid.
10. Click Create to create the new container.
11. On the Container Setup window, select the new container and click Connect, then Close to exit the window.
12. Select Project > Save As to save the model to the database format.
13. Select Results > Save to Database to save the results. You may choose to save the results with or without tags.
The Confirm Results Saved message is displayed when the save is complete.
■ 93Hyperion Business Modeling Database Tables Reference
Results Views Tables
14. Select Start > Programs > Microsoft Access to open the Access database.
The Microsoft Access window is displayed.
15. Click Open Existing File to open the database in which the results have been saved.
16. Select the database that contains the saved results from the list, then click OK.
The selected database tables are displayed.
94 ■ Hyperion Business Modeling Database Tables Reference
Results Views Tables
6
17. From the Objects list in the left pane, select Queries to display the available views.
18. Double-click the desired view (for example, HBM_totalModel) to display the results.
■ 95Hyperion Business Modeling Database Tables Reference
Results Views Tables
HABM_activityThis table contains the activity results calculated by the model for the selected project for all activity boxes.
For the purpose of generating the results of activity boxes, the boxes are treated as tagged boxes. On the schematic, if some costs flow from one activity box into another, these boxes are regarded as stacked boxes. To avoid double-counting, only the results for the first activity box are reported. If there are no costs between the activity boxes, the interim activity boxes are not reported.
Field Type Required Reference Description
model varchar (200) Yes HABM_models.modelid
Model given name.
For the Economic Profit view, (EP Result) appears at the end of the model name.
scenario varchar (1,000) Short description of the scenario
period varchar (200) Name assigned to period
resulttype numeric (1) Type of results, as follows:
0 - Regular View1 - Economic Profit View
category varchar (12) ID of the selected category
tobox varchar (32) ID of the destination (to) box on the schematic
frombox varchar (32) ID of the input (activity) box on the schematic
unit varchar (200) Name of the specified unit
type char (1) Total value of the revenue cost being calculated.
This figure may be fixed (f) or variable (v), depending on the type of box being calculated.
financialresult numeric (24,6) Total of financial calculations
operationalflow numeric (24,6) Value of the operational flow
96 ■ Hyperion Business Modeling Database Tables Reference
Results Views Tables
6
HABM_inventoryThis table contains the inventory results calculated for a selected scenario.
Field Type Required Reference Description
model varchar (200) Yes HABM_models.modelid
Model given name
For the Economic Profit view, “(EP Result)” appears at the end of the model name.
scenario varchar (1,000) Short description of the scenario
period varchar (200) Name assigned to period
resulttype numeric (1) Type of results, as follows:
0 - Regular View1 - Economic Profit View
tobox varchar (32) ID of the destination (to) box
openingcost numeric (24,6) Dollar value of inventory on hand
closingcost numeric (24,6) Dollar value of closing inventory
■ 97Hyperion Business Modeling Database Tables Reference
Results Views Tables
HABM_resourceThis table contains the resource results calculated for a selected scenario.
Field Type Required Reference Description
model varchar (200) Yes HABM_models.modelid
Model given name
For the Economic Profit view, (EP Result) appears at the end of the model name.
scenario varchar (1,000) Short description of the scenario
period varchar (200) Name assigned to period
resulttype numeric (1) Type of results, as follows:
0 - Regular View1 - Economic Profit View
frombox varchar (32) ID of the source (from) box
tobox varchar (32) ID of the destination (to) box
total varchar (16) Type of value being calculated
The type may be fixed or variable, depending on the type of box being calculated (financial results or operational flow).
unit varchar (200) Name of the specified unit
financialresource numeric (24,6) The proportion of the dollar value of the source (frombox) into the destination (tobox)
operationalflow numeric (24,6) The proportion of the operational value of the source (frombox) that flows into the destination (tobox)
98 ■ Hyperion Business Modeling Database Tables Reference
Results Views Tables
6
HABM_revenuecostThis table contains the revenue cost results calculated for a selected scenario.
Field Type Required Reference Description
model varchar (200) Yes HABM_models.modelid
Model given name
For the Economic Profit view, (EP Result) appears at the end of the model name.
scenario varchar (1,000) Short description of the scenario
period varchar (200) Name assigned to period
resulttype numeric (1) Type of results, as follows:
0 - Regular View
1 - Economic Profit View
category varchar (12) ID of the selected category
tobox varchar (32) ID of the destination (to) box
unit varchar (200) Name of the specified unit
total varchar (1) Type of value being calculated.
The type may be fixed or variable, depending on the type of box being calculated (financial results or operational flow).
financialresult numeric (24,6) Total of financial calculations
operationalflow numeric (24,6) Value of the operational flow
■ 99Hyperion Business Modeling Database Tables Reference
Results Views Tables
HABM_tagByBoxDetailedThis table contains the Box Tag Set Report - Flows and Financials by Category - Detail results, calculated for a selected project (using selected tag sets and boxes).
Field Type Required Reference Description
model varchar (200) Yes HABM_models.modelid
Model given name For the Economic Profit view,(EP Result) appears at the endof the model name.
scenario varchar (1,000) Short description of the scenario
period varchar (200) Name assigned to the period
resulttype numeric (1) Type of results, as follows:
0 - Regular View
1 - Economic Profit View
category varchar (12) ID of the selected category
fromtag varchar (32) ID of the input (from) tag
tobox varchar (32) ID of the destination (to) box
frombox varchar (32) ID of the tagged input (from) box
unit varchar (200) Name of the specified unit
type char (1) This figure may be fixed (f) orvariable (v), depending on thetype of box being calculated
resourcefinancial numeric (24,6) Value of the financials pertaining to the selected box
inputfinancial numeric (24,6) Financial value of inputs to the selected box
operationalflow numeric (24,6) Value of the operational flow
100 ■ Hyperion Business Modeling Database Tables Reference
Results Views Tables
6
HABM_tagByBoxSummaryThis table contains the Box Tag Set Report - Flows and Financials results, calculated for a selected project (using selected tag sets and boxes).
Field Type Required Reference Description
model varchar (200) Yes HABM_models.modelid
Model given name For the Economic Profit view, (EP Result) appears at the end of the model name.
scenario varchar (1,000) Short description of the scenario
period varchar (200) Name assigned to the period
resulttype numeric (1) Type of results, as follows:
0 - Regular View1 - Economic Profit View
fromtag varchar (32) ID of the input (from) tag
tobox varchar (32) ID of the destination (to) box
frombox varchar (32) ID of the tagged source (from) box
unit varchar (200) Name of the specified unit
type char (1) This figure may be fixed (f) or variable (v), depending on the type of box being calculated.
resourcefinancial numeric (24,6) Value of the financials pertaining to the selected box
inputfinancial numeric (24,6) Financial value of inputs to the selected box
operationalflow numeric (24,6) Value of the operational flow
■ 101Hyperion Business Modeling Database Tables Reference
Results Views Tables
HABM_tagsResourceThis table contains the Model Tag Set Report - Flows and Financials by Resource results, calculated for a selected project (using selected tag sets).
Field Type Required Reference Description
model varchar (200) Yes HABM_models.modelid
Model given name
For the Economic Profit view, (EP Result) appears at the end of the model name.
scenario varchar (1,000) Short description of the scenario
period varchar (200) Name assigned to the period
resulttype numeric (1) Type of results, as follows:
0 - Regular View1 - Economic Profit View
category varchar (12) ID of the selected category
totag varchar (32) ID of the destination (to) tag on the schematic
tobox varchar (32) ID of the tagged destination (to) box on the schematic
frombox varchar (32) ID of the input (from) box on the schematic
unit varchar (200) Name of the specified unit
type char (1) This figure may be fixed (f) or variable (v), depending on the type of box being calculated.
resourcefinancial numeric (24,6) Value of the financials pertaining to the selected box
operationalflow numeric (24,6) Value of the operational flow
102 ■ Hyperion Business Modeling Database Tables Reference
Results Views Tables
6
,
t
HABM_tagsTotalThis table contains the Model Tag Set Report - Flows and Financials by Category results, calculated for the selected project (by selected tag sets).
Field Type Required Reference Description
model varchar (200) Yes HABM_models.modelid
Model given name
For the Economic Profit view(EP Result) appears at the endof the model name.
scenario varchar (1,000) Short description of the scenario
period varchar (200) Name assigned to the period
resulttype numeric (1) Type of results, as follows:
0 - Regular View1 - Economic Profit View
category varchar (12) ID of the selected category
fromtag varchar (32) ID of the input tag on the schematic
frombox varchar (32) ID of the input (tagged) box on the schematic
unit varchar (200) Name of the specified unit
type char (1) Total value of the revenue cosbeing calculated. This figure may be fixed (f) or variable (v), depending on the type ofbox being calculated.
resourcefinancial numeric (24,6) Value of the financials pertaining to the selected box
inputfinancial numeric (24,6) Financial value of inputs to the selected box
operationalflow numeric (24,6) Value of the operational flow
■ 103Hyperion Business Modeling Database Tables Reference
Results Views Tables
HABM_utilizationThis table contains data about the utilization percentage results calculated for the selected period and box type.
Field Type Required Reference Description
model varchar (200) Yes HABM_models.modelid
Model given name
For the Economic Profit view, (EP Result) appears at the end of the model name.
scenario varchar (1,000) Short description of the scenario
period varchar (200) Name assigned to the period
resulttype numeric (1) Type of results, as follows:
0 - Regular View
1 - Economic Profit View
tobox varchar (32) ID of the selected box
utilization numeric (24,6) Utilization percentage for the selected box
operationalflow numeric (24,6) Value of the operational flow for the selected box
104 ■ Hyperion Business Modeling Database Tables Reference
Results Views Tables
6
HBM_entModelResThis table contains the financials and flow information between models within the enterprise model.
Field Type Required Reference Description
enterprisemodel
varchar (200) Yes HABM_models.modelid
Unique enterprise model name
tomodel varchar (200) Yes HABM_models.modelid
Model name of the destination (to) model
frommodel varchar (200) Yes HABM_models.modelid
Model name of the source (from) model
category numeric (12,0) Yes Category ID
unit varchar (200) Yes ID of the specified unit
type char (1) Yes The type of value being calculated. This figure may be Fixed (F) or Variable (V), depending on the type of box being calculated.
financial numeric (24,6) Yes Value of the financials being calculated.
flow numeric (24,6) Yes Value of the operational flow.
■ 105Hyperion Business Modeling Database Tables Reference
Results Views Tables
HBM_totalModelThis table contains the total results for a model in an enterprise model.
Field Type Required Reference Description
model varchar (200) Yes HABM_models.modelid
Unique model ID
type char (1) Total value of the revenue cost being calculated. This figure may be:
F - Fixed
V - Variable
T - Total (Fixed plus Variable)
revenue numeric (24,6) Total revenue for the model
cost numeric (24,6) Total cost for the model
profit numeric (24,6) Total profit for the model
openinginventory
numeric (24,6) The opening inventory for the model
closinginventory
numeric (24,6) The closing inventory for the model
totalinventory
numeric (24,6) The total inventory for the model
106 ■ Hyperion Business Modeling Database Tables Reference
Appendix
A
Hyperion Business Mod
History of Database Changes
This appendix provides an overview of database changes from Release 1.5 to Release 3.0 of Hyperion Business Modeling. If required, your queries must be updated to be compatible with the current database structure.
Database definitions that cannot have a null value are identified in bold type.
This section provides historical changes from Release 1.5 to Release 3.0 for the following tables:
● "Model Table Changes" on page 108
● "Enterprise Model Table" on page 116
● "Results Tables Changes" on page 126
● "Results Views Tables Changes" on page 131
■ 107eling Database Tables Reference
History of Database Changes
Model Table Changes
Release 1.5 Release 2.0 Release 3.0
HABM_boxes HABM_boxes HABM_boxes
boxid
modelid
scenarioid
periodid
operation
shortname
name
unitid
type
capacity
sqty
scost
policy_type
policy_qty
controlid
cpctyformlid
polcyformlid
boxid
modelid
scenarioid
periodid
operation
shortname
name
unitid
type
capacity
sqty
scost
policy_type
policy_qty
controlid
cpctyformlid
polcyformlid
boxid
modelid
scenarioid
periodid
operation
shortname
name
unitid
type
capacity
sqty
scost
policy_type
policy_qty
controlid
cpctyformlid
polcyformlid
108 ■ Hyperion Business Modeling Database Tables Reference
History of Database Changes
A
HABM_categories HABM_categories HABM_categories
categoryid
modelid
scenarioid
periodid
operation
categorynum
description
minval
maxval
type
parentid
categoryid
modelid
scenarioid
periodid
operation
categorynum
description
minval
maxval
type
parentid
categoryid
modelid
scenarioid
periodid
operation
categorynum
description
minval
maxval
type
parentid
HABM_financial HABM_financial HABM_financial
finid
modelid
scenarioid
periodid
operation
boxid
unitvalue
totalvalue
valtype
expval
range
minval
maxval
categoryid
variableid
finid
modelid
scenarioid
periodid
operation
boxid
unitvalue
totalvalue
valtype
expval
range
minval
maxval
categoryid
variableid
finid
modelid
scenarioid
periodid
operation
boxid
unitvalue
totalvalue
valtype
expval
range
minval
maxval
categoryid
variableid
Release 1.5 (cont’d) Release 2.0 (cont’d) Release 3.0 (cont’d)
■ 109Hyperion Business Modeling Database Tables Reference
History of Database Changes
HABM_groups HABM_groups HABM_groups
groupid
modelid
scenarioid
periodid
operation
shortname
groupname
visualone
groupid
modelid
scenarioid
periodid
operation
shortname
groupname
visualone
groupid
modelid
scenarioid
periodid
operation
shortname
groupname
visualone*
HABM_groupxref HABM_groupxref HABM_groupxref
modelid
groupid
scenarioid
periodid
operation
boxid
modelid
groupid
scenarioid
periodid
operation
boxid
modelid
groupid
scenarioid
periodid
operation
boxid
HABM_layout HABM_layout
modelid
scenarioid
periodid
boxid
xcoord
ycoord
boxwidth
boxheight
modelid
scenarioid
periodid
boxid
xcoord
ycoord
boxwidth
boxheight
viewlevel
Release 1.5 (cont’d) Release 2.0 (cont’d) Release 3.0 (cont’d)
110 ■ Hyperion Business Modeling Database Tables Reference
History of Database Changes
A
HABM_links HABM_links HABM_links
linkid
modelid
scenarioid
periodid
operation
srcbox
dstbox
unitvalue
totalvalue
valtype
expval
range
minval
maxval
priority
newpriority
variableid
linkid
modelid
scenarioid
periodid
operation
srcbox
dstbox
unitvalue
totalvalue
valtype
expval
range
minval
maxval
priority
newpriority
variableid
linkid
modelid
scenarioid
periodid
operation
srcbox
dstbox
unitvalue
totalvalue
valtype
expval
range
minval
maxval
priority
newpriority
variableid
Release 1.5 (cont’d) Release 2.0 (cont’d) Release 3.0 (cont’d)
■ 111Hyperion Business Modeling Database Tables Reference
History of Database Changes
HABM_models HABM_models HABM_models
modelid
name
title
owner
access_level
password
locker
userlock
crncy
extupdate
status
timelineid
lastupdate
prefs
modelid
name
title
owner
access_level
password
locker
userlock
crncy
extupdate
status
timelineid
lastupdate
prefs
modelid
name
title
owner
userlock
crncy
finmultiplier
modelversion
modeltype
extupdate
status
timelineid
lastupdate
HABM_notes HABM_notes HABM_notes
modelid
objid
scenarioid
periodid
operation
type
title
keywords
content
attachment
modelid
objid
scenarioid
periodid
operation
type
title
keywords
content
attachment
modelid
objid
scenarioid
periodid
operation
type
title
keywords*
content
attachment*
Release 1.5 (cont’d) Release 2.0 (cont’d) Release 3.0 (cont’d)
112 ■ Hyperion Business Modeling Database Tables Reference
History of Database Changes
A
HABM_periods HABM_periods HABM_periods
modelid
timelineid
periodid
periodalias
name
numunits
unit
modelid
timelineid
periodid
periodalias
name
numunits
unit
modelid
timelineid
periodid
periodalias
name
numunits*
unit*
HABM_scenarios HABM_scenarios HABM_scenarios
scenarioid
modelid
scenarioalias
timelineid
description
owner
carryover
locked
dirty
recalculate
loaded
ready
scenarioid
modelid
scenarioalias
timelineid
description
owner
carryover
locked
dirty
recalculate
loaded
ready
scenarioid
modelid
scenarioalias
timelineid
description
owner
HABM_timelines*
timelineid
modelid
timelinealias
name
startingdate
Release 1.5 (cont’d) Release 2.0 (cont’d) Release 3.0 (cont’d)
■ 113Hyperion Business Modeling Database Tables Reference
History of Database Changes
HABM_units HABM_units HABM_units
modelid
scenarioid
periodid
operation
unitid
description
modelid
scenarioid
periodid
operation
unitid
description
modelid
scenarioid
periodid
operation
unitid
description
HABM_variables HABM_variables HABM_variables
variableid
modelid
scenarioid
periodid
operation
vname
shortname
scope
vbody
variableid
modelid
scenarioid
periodid
operation
vname
shortname
scope
vbody
variableid
modelid
scenarioid
periodid
operation
vname
shortname
scope
vbody
calvalue
Release 1.5 (cont’d) Release 2.0 (cont’d) Release 3.0 (cont’d)
114 ■ Hyperion Business Modeling Database Tables Reference
History of Database Changes
A
HBM_modelPreferences
preferenceid
modelid
flowdecdigits
findecdigits
perunitdecdigits
costofcapid
costofcapname
taxrateid
taxratename
capchargesid
capchargesname
capchargesrangefrom
capchargesrangeto
autolink
HBM_users
userid
firstname
lastname
emailaddress
Release 1.5 (cont’d) Release 2.0 (cont’d) Release 3.0 (cont’d)
■ 115Hyperion Business Modeling Database Tables Reference
History of Database Changes
Enterprise Model Table The Enterprise Model database tables are new with Release 3.0 of Hyperion Business Modeling.
Release 3.0
HBM_boxIDChanges
boxid
modelid
oldshortname
newshortname
HBM_categoryIDChanges
categoryid
modelid
oldcategorynum
newcategorynum
HBM_containers
containerid
containername
type
servername
port
dbname
url
classpath
HBM_entBoxLinks
linkid
enterprisemodelid
srcboxid
srcmodelid
dstboxid
dstmodelid
linkfactor
116 ■ Hyperion Business Modeling Database Tables Reference
History of Database Changes
A
HBM_entErrors
enterprisemodelid
modelid
itemid
sourcetype
errortype
message
HBM_entEssDimensions
dimensionid
dimensionname
HBM_entExchangeRates
exrateid
name
reportingcrncy
srccrncy
conversionrate
lastupdate
HBM_entLinkFlowCosts
linkid
enterprisemodelid
flow
cost
revenue
HBM_entModelChanges
changeid
modelid
userid
enterprisemodelid
publishdate
status
Release 3.0 (cont’d)
■ 117Hyperion Business Modeling Database Tables Reference
History of Database Changes
HBM_entUDEssDatabaseTypes
id
name
dimselections
HBM_entModelLayout
enterprisemodelid
modelid
xcoord
ycoord
modelwidth
modelheight
viewlevel
HBM_entModelLinks
modellinkid
modellinkname
enterprisemodelid
srcmodelid
dstmodelid
HBM_entModels
enterprisemodelid
modelid
HBM_entModelUDEssDatabaseTypes
modelid
essdbtypeid
Release 3.0 (cont’d)
118 ■ Hyperion Business Modeling Database Tables Reference
History of Database Changes
A
HBM_entPublishedBoxes
boxid
modelid
scenarioid
periodid
changeid
operation
shortname
name
unitid
type
capacity
sqty
scost
policy_type
policy_qty
controlid
cpctyformlid
polcyformlid
HBM_entPublishedCategories
categoryid
modelid
scenarioid
periodid
changeid
operation
categorynum
description
minval
maxval
type
parentid
Release 3.0 (cont’d)
■ 119Hyperion Business Modeling Database Tables Reference
History of Database Changes
HBM_entPublishedFinancial
finid
modelid
scenarioid
periodid
changeid
operation
boxid
unitvalue
totalvalue
valtype
expval
range
minval
maxval
categoryid
variableid
HBM_entPublishedGroups
groupid
modelid
scenarioid
periodid
changeid
operation
shortname
groupname
visualone*
Release 3.0 (cont’d)
120 ■ Hyperion Business Modeling Database Tables Reference
History of Database Changes
A
HBM_entPublishedGroupxref
groupid
modelid
scenarioid
periodid
changeid
operation
boxid
HBM_entPublishedLinks
linkid
modelid
scenarioid
periodid
changeid
operation
srcbox
dstbox
unitvalue
totalvalue
valtype
expval
range
minval
maxval
priority
newpriority
variableid
Release 3.0 (cont’d)
■ 121Hyperion Business Modeling Database Tables Reference
History of Database Changes
HBM_entPublishedModelPref
preferenceid
modelid
changeid
operation
flowdecdigits
findecdigits
perunitdecdigits
costofcapid
costofcapname
taxrateid
taxratename
capchargesid
capchargesname
capchargesrangefrom
capchargesrangeto
HBM_entPublishedModels
modelid
name
title
changeid
operation
owner
userlock
crncy
finmultiplier
modelversion
modeltype
extupdate
status
timelineid
lastupdate
Release 3.0 (cont’d)
122 ■ Hyperion Business Modeling Database Tables Reference
History of Database Changes
A
HBM_entPublishedNotes
modelid
scenarioid
periodid
changeid
operation
objid
type
title
keywords*
content
attachment
HBM_entPublishedUnits
modelid
scenarioid
periodid
changeid
operation
unitid
description
Release 3.0 (cont’d)
■ 123Hyperion Business Modeling Database Tables Reference
History of Database Changes
HBM_entPublishedVariables
variableid
modelid
scenarioid
periodid
changeid
operation
vname
shortname
scope
vbody
calvalue
HBM_publishingContainers
modelid
containerid
publishdate
HBM_tagsetIDChanges
groupid
modelid
oldshortname
newshortname
Release 3.0 (cont’d)
124 ■ Hyperion Business Modeling Database Tables Reference
History of Database Changes
A
HBM_entUDEssDatabaseTypes
id
name
dimselections
HBM_unitNameChanges
unitid
modelid
oldunitname
newunitname
HBM_variableIDChanges
variableid
modelid
oldshortname
newshortname
Release 3.0 (cont’d)
■ 125Hyperion Business Modeling Database Tables Reference
History of Database Changes
Results Tables ChangesThe Results tables are are new with this release, and are only used to store the calculation results for the models.
To view these results, you should look in the Results Views Tables. For example, to view the results for HBM_activityResults, you should look at HABM_activity. For more information, refer to "Results Views Tables" on page 91.
Release 3.0
Table Fields
HBM_activityResults modelid
scenarioid
periodid
resulttype
categoryid
toboxid
fromboxid
unitid
type
financialresult
operationalflow
HBM_inventoryResults modelid
scenarioid
periodid
resulttype
toboxid
openingcost
closingcost
126 ■ Hyperion Business Modeling Database Tables Reference
History of Database Changes
A
HBM_resourceResults modelid
scenarioid
periodid
resulttype
fromboxid
toboxid
total
unitid
resource
operationalflow
HABM_resultupdate modelname
scenario
period
lastupdate
HBM_revenueCostResults modelid
scenarioid
periodid
resulttype
categoryid
toboxid
unitid
total
financialresult
operationalflow
Release 3.0 (cont’d)
Table Fields
■ 127Hyperion Business Modeling Database Tables Reference
History of Database Changes
HBM_tagByBoxDetResults modelid
scenarioid
periodid
resulttype
categoryid
fromtagid
toboxid
fromboxid
unitid
type
resourcefinancial
inputfinancial
operationalflow
HBM_tagByBoxSumResults modelid
scenarioid
periodid
resulttype
fromtagid
toboxid
fromboxid
unitid
type
resourcefinancial
inputfinancial
operationalflow
Release 3.0 (cont’d)
Table Fields
128 ■ Hyperion Business Modeling Database Tables Reference
History of Database Changes
A
HBM_tagsResourceResults modelid
scenarioid
periodid
resulttype
categoryid
totagid
toboxid
frombox
unitid
type
resourcefinancial
operationalflow
HBM_tagsTotalResults modelid
scenarioid
periodid
resulttype
categoryid
fromtagid
fromboxid
unitid
type
resourcefinancial
inputfinancial
operationalflow
HBM_utilizationResults modelid
scenarioid
periodid
resulttype
toboxid
utilization
operationalflow
Release 3.0 (cont’d)
Table Fields
■ 129Hyperion Business Modeling Database Tables Reference
History of Database Changes
HBM_boxCostFlows boxid
modelid
scenarioid
periodid
boxflow
boxcost
boxrevenue
HBM_boxLinkFlows linkid
modelid
scenarioid
periodid
linkflow
HBM_entModelResults enterprisemodelid
tomodelid
frommodelid
categoryid
unitid
type
cost
flow
HBM_totalModelResults modelid
type
revenue
cost
profit
opening inventory
closing inventory
total inventory
Release 3.0 (cont’d)
Table Fields
130 ■ Hyperion Business Modeling Database Tables Reference
History of Database Changes
A
Results Views Tables ChangesThe Results Views tables are used to view the calculation results that are stored in the Results tables.
Release 1.5 Release 2.0 Release 3.0
Table Fields Table Fields Table Fields
HABM_activity
model
scenario
period
category
tobox
frombox
unit
type
financialresult
operationalflow
HABM_activity
model
scenario
period
resulttype
category
tobox
frombox
unit
type
financialresult
operationalflow
HABM_inventory
model
scenario
period
tobox
openingcost
closingcost
HABM_inventory
model
scenario
period
tobox
openingcost
closingcost
HABM_inventory
model
scenario
period
resulttype
tobox
openingcost
closingcost
HABM_resource
model
scenario
period
frombox
tobox
total
unit
resource
operationalflow
HABM_resource
model
scenario
period
frombox
tobox
total
unit
resource
operationalflow
HABM_resource
model
scenario
period
resulttype
frombox
tobox
total
unit
resource
operationalflow
■ 131Hyperion Business Modeling Database Tables Reference
History of Database Changes
l
HABM_revenuecost
model
scenario
period
category
tobox
unit
total
financialresult
operationalflow
HABM_revenue cost
model
scenario
period
category
tobox
unit
total
financialresult
operationalflow
HABM_revenuecost
model
scenario
period
resulttype
category
tobox
unit
total
financialresult
operationalflow
HABM_tagByBox Detailed
model
scenario
period
category
fromtag
tobox
frombox
unit
type
resourcefinancial
inputfinancial
operationalflow
HABM_tagByBox Detailed
model
scenario
period
resulttype
category
fromtag
tobox
frombox
unit
type
resourcefinancia
inputfinancial
operationalflow
Release 1.5 (cont’d) Release 2.0 (cont’d) Release 3.0 (cont’d)
Table Fields Table Fields Table Fields
132 ■ Hyperion Business Modeling Database Tables Reference
History of Database Changes
A
l
l
HABM_tagByBox Summary
model
scenario
period
fromtag
tobox
frombox
unit
type
resourcefinancial
inputfinancial
operationalflow
HABM_tagByBox Summary
model
scenario
period
resulttype
fromtag
tobox
frombox
unit
type
resourcefinancia
inputfinancial
operationalflow
HABM_tagsResource
model
scenario
period
category
totag
tobox
frombox
unit
type
resourcefinancial
operationalflow
HABM_tagsResource
model
scenario
period
resulttype
category
totag
tobox
frombox
unit
type
resourcefinancia
operationalflow
Release 1.5 (cont’d) Release 2.0 (cont’d) Release 3.0 (cont’d)
Table Fields Table Fields Table Fields
■ 133Hyperion Business Modeling Database Tables Reference
History of Database Changes
l
HABM_tagsTotal
model
scenario
period
category
fromtag
frombox
unit
type
resourcefinancial
inputfinancial
operationalflow
HABM_tagsTotal
model
scenario
period
resulttype
category
fromtag
frombox
unit
type
resourcefinancia
inputfinancial
operationalflow
HABM_utilization
model
scenario
period
tobox
utilization
operationalflow
HABM_utilization
model
scenario
period
tobox
utilization
operationalflow
HABM_utilization
model
scenario
period
resulttype
tobox
utilization
operationalflow
HBM_entModelRes
enterprisemodel
tomodelid
frommodelid
category
unitid
type
financial
flow
Release 1.5 (cont’d) Release 2.0 (cont’d) Release 3.0 (cont’d)
Table Fields Table Fields Table Fields
134 ■ Hyperion Business Modeling Database Tables Reference
History of Database Changes
A
HBM_totalModel
model
type
revenue
cost
profit
opening inventory
closing inventory
total inventory
Release 1.5 (cont’d) Release 2.0 (cont’d) Release 3.0 (cont’d)
Table Fields Table Fields Table Fields
■ 135Hyperion Business Modeling Database Tables Reference
History of Database Changes
136 ■ Hyperion Business Modeling Database Tables Reference
Index
Ind
ex
AAccess 97/2000, 7, 8access privileges, 28activity, 96activityResults, 77autolink, 38
Bbolded fields, 16, 43box ID changes, 45box links, 26, 47
box link flows, 87boxCostsFlows table, 86boxes
activity, 96activityResults, 77capacity, 19, 56coordinates, 25cost and flow, 86notes, 31width and length, 25X-Y coordinates, 52
boxIDChanges table, 45boxLinkFlows table, 87broken constraints, 48
Ccalculated results, 75, 91calculation errors, 48capacity, 19, 56categories, 57categories table, 20
Hyperion Business Modeling Database Tables Re
categoryIDChanges table, 45changes, 74
database schema, 107unit name, 73variable ID, 74
containers, 46, 72controlid, 56conventions, 9coordinates, 25currency, 28
exchange rates, 49, 50
Ddatabase
changes, 107JDBC, 7master list, 11ODBC, 7schema, 15, 41, 107setting external update flag, 9supported, 46tested, 7
DB2 7.1, 7default timeline, 32dstbox, 26, 62
Eenterprise model
box link flows, 87boxCostsFlows, 86HBM_categoryIDChanges, 45HBM_enterpriseModels, 105HBM_entModel, 105
■ 137ference
Index
HBM_entModelChanges, 51HBM_entModelLayout, 52HBM_entModelLinks, 53HBM_entModelResults, 88HBM_entModels, 53HBM_entPublishedBoxes, 55HBM_entPublishedCategories, 57HBM_entPublishedFinancial, 58HBM_entPublishedGroups, 60HBM_entPublishedModelPref, 64HBM_entPublishedNotes, 69HBM_entPublishedUnits, 70HBM_entPublishedVariables, 71HBM_modelPreferences, 37HBM_publishingContainers, 72HBM_tagsetIDChanges, 72HBM_unitNameChanges, 73HBM_variableIDChanges, 74layout, 52publish date, 51published models, 66X-Y coordinates, 25
enterprise model results table, 88, 105enterprise model tables, 41
boxIDChanges, 45categoryIDChanges, 45enterpriseModelChanges, 51entModelLayout, 52entModelLinks, 53entPublishedBoxes, 55entPublishedCategories, 57entPublishedFinancial, 58entPublishedGroups, 60HBM_boxIDChanges, 45HBM_containers, 46HBM_entBoxLinks, 47HBM_entErrors, 48HBM_entExchange Rates, 49, 50HBM_entmodelChanges, 51HBM_entModelResults, 88HBM_entPublishedGroupxref, 61HBM_entPublishedLinks, 62HBM_entPublishedModelPref, 64, 69HBM_entPublishedModels, 66HBM_entPublishedUnits, 70HBM_entPublishedVariables, 71
138 ■ Hyperio
HBM_tagsetIDChanges, 72HBM_unitNameChanges, 73HBM_variableIDChanges, 74
enterpriseModelChanges table, 51entModelChanges table, 51errors, 48exchange rates, 49, 50external databases, 9, 28external update flag, 9, 28
Ffinancial table, 21flags, 9, 28flows for box link, 87
Ggroup cross-reference, 61groups table, 23, 60groupxref table, 24
HHABM_activity, 96HABM_categories, 20HABM_financial, 21HABM_groups, 23, 60HABM_groupxref, 24HABM_inventory, 97HABM_layout, 25HABM_links, 26HABM_notes, 31HABM_periods, 32HABM_resource, 98HABM_revenuecost, 99HABM_scenarios, 33HABM_tagByBoxDetailed, 100HABM_tagsResource, 102HABM_tagsTotal, 103HABM_timelines, 34HABM_units, 35HABM_utilization, 104HABM_variables, 36HBM_activityResults, 77HBM_boxIDChanges, 45HBM_boxLinkFlowsResults, 87
n Business Modeling Database Tables Reference
Index
HBM_categoryIDChanges, 45HBM_entBoxLinks, 47HBM_enterpriseModels, 105HBM_entErrors, 48HBM_entExchangeRates, 49, 50HBM_entModel, 105HBM_entModelChanges, 51HBM_entModelLayout, 52HBM_entModelLinks, 53HBM_entModelResults, 88, 105HBM_entModels, 53HBM_entPublishedBoxes, 55HBM_entPublishedCategories, 57HBM_entPublishedFinancial, 58HBM_entPublishedGroups, 60HBM_entPublishedGroupxref, 61HBM_entPublishedGroupxref table, 61HBM_entPublishedLinks, 62HBM_entPublishedLinksf, 62HBM_entPublishedModelPref, 64HBM_entPublishedModelPref table, 64, 69HBM_entPublishedModels, 66HBM_entPublishedModels table, 66HBM_entPublishedNotes, 69HBM_entPublishedUnits, 70HBM_entPublishedUnitsf table, 70HBM_entPublishedVariables table, 71HBM_entPublishedVariablesf, 71HBM_inventoryResults, 78HBM_modelPreferences, 37HBM_publishingContainers, 72HBM_publishingContainers table, 72HBM_resourceResults, 79HBM_resultupdate, 76HBM_revenuecosResults, 80HBM_tagByBoxDetailedResults, 81HBM_tagsetIDChanges, 72HBM_tagsetIDChanges table, 72HBM_tagsResourceResults, 83HBM_tagsTotalResults, 84HBM_totalModelResults, 89, 106HBM_unitNameChanges, 73HBM_utilizationResults, 85HBM_variableID, 74HBM_variableIDChanges, 74history of changes to database structure, 107
Hyperion Business Modeling Database Tables Re
Iindex files, 16, 43inventory results table, 78inventory table, 97
JJDBC (Java Database Conductivity) driver, 7
Llast modification, 76layout, 25
enterprise model, 52HABM_layout, 25
limitations of Access 97/2000, 8links, 26
between model and user, 51flow, 87table, 26virtual, 53
list of indexesenterprise model, 43model, 16
location of boxes in model, 25locking, 28
Mmaster list, 11MBCS compliance, 8Microsoft Access 97/2000, 8model
access privileges, 28currency, 28owner, 28password, 28settings, 37, 64timelines, 28
model locking, 28model tables
categories, 20financial, 21group cross-reference, 24groups, 23, 60groupxref, 24
■ 139ference
Index
layout, 25links, 26, 62master list, 11modelPreferences, 37notes, 31periods, 32scenarios, 33timelines, 34units, 35, 36variables, 36
model tag set, 84, 103Model Tag Set Report, 83, 102modelid, 15modelPreferences table, 37modifying data in external databases, 9, 28
Nnotes
published, 69table, 31
Oobject ID, 15objid, 31, 69ODBC (Open Database Conductivity), 7Oracle 7/8, 7, 8owner, 28
Ppassword, 28periodalias, 32periodid, 31, 32, 35, 69, 70periods, 32pointers in index files, 16
enterprise model, 43policy type, 56preferences, 37, 64published models, 66
box ID changes, 45boxes, 55categories, 57category ID changes, 45containers, 46, 72financial, 58
140 ■ Hyperio
group cross-reference, 61groups, 60links, 62notes, 69publish date, 51variables, 71
Rreference conventions, 9resource results table, 79resource table, 98result update table, 76results tables, 75
boxCostsFlows, 86boxLinkFlows, 87HBM_activityResults, 77HBM_boxLinkFlows, 87HBM_entModelResults, 88HBM_inventoryResults, 78HBM_resourceResults, 79HBM_resultupdate, 76HBM_revenuecostResults, 80HBM_tag by box (detailed) results, 81HBM_tagByBox SummaryResults, 82HBM_tagsResourceResults, 83HBM_tagsTotalResults, 84HBM_totalModelResults, 89HBM_utilizationResults, 85master list, 11
results views tables, 91enterprise model, 105enterpriseModels, 105HABM_activity, 96HABM_inventory, 97HABM_resource, 98HABM_revenuecost, 99HABM_tag by box (detailed), 100HABM_tagByBox Summary, 101HABM_tagsResource, 102HABM_tagsTotal, 103HABM_utilization, 104HBM_entModelResults, 105HBM_totalModelResults, 106
revenue cost results table, 80revenue cost table, 99
n Business Modeling Database Tables Reference
Index
Ssaving calculated results, 75, 91scenarioalias, 33scenarios table, 33schema, 15, 41, 107setting external update flag, 9, 28settings for model, 37, 64size of box, 25SQL Server 7/2000, 7srcbox, 26, 62status flag, 9, 28summary of changes, 107supported databases, 7, 46svariables, 71
Ttables
activity, 96activityResults, 77box ID changes, 45boxIDChanges, 45categories, 20categoryIDChanges, 45database schema, 15, 41enterprise model, 41enterpriseModels, 51, 88, 105entModelLayout, 52entModelLinks, 53entModels, 53entPublishedBoxes, 55entPublishedCategories, 57, 60entPublishedFinancial, 58financial, 21groups, 23, 60groupxref, 24, 61HBM_unitNameChanges, 73HBM_variableIDChanges, 74inventory, 97inventoryResults, 78modelChanges, 51modelPreferences, 37notes, 31periods, 32resource, 98resourceResults, 79
Hyperion Business Modeling Database Tables Re
resultsenterprise model, 88, 105total model, 89, 106
resultupdate, 76revenue cost, 99revenuecostResults, 80scenarios, 33Tag by Box (detailed), 100Tag by Box Results (detailed), 81Tag By Box Summary, 101Tag By Box SummaryResults, 82Tags by Category, 84, 103Tags by Category Total, 103Tags by Category Total Results, 84Tags by Resource, 102Tags by Resource Results, 83timelines, 34units, 35, 36utilization, 104utilizationResults, 85variables, 36
Tag by Box Results table (detailed), 81Tag by Box Summary table, 101Tag by Box SummaryResults table, 82Tag by Box table (detailed), 100Tag by Category Total table, 84, 103Tag by Resource Results table, 83Tag by Resource table, 102tag sets, 60, 75, 91
changes, 72time stamp, 76timelineid, 32, 34timelines, 28, 32timelines table, 34total model results table, 89, 106
Uunitid, 35, 70units, 70
name changes, 73table, 35
update flag, 9userlock, 28utilization results table, 85utilization table, 104
■ 141ference
Index
Vvariables
ID changes, 74variables table, 36verification errors and warnings, 48viewing calculated results, 91virtual links, 53
Xxcoord, 25X-Y coordinates, 25, 52
Yycoord, 25
142 ■ Hyperio
n Business Modeling Database Tables Reference