Understanding HFM System Tables
- 1. Understanding HFM System Tables Keith Berry The Hackett Group kberry@thehackettgroup.com keith.berry@gmail.com
- 2. 3© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. XKCD
- 3. 4© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. Things to keep in mind #1 This is not officially supported by Oracle
- 4. 5© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. Things to keep in mind #2 I don’t know what I am talking about
- 5. 6© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. Things to keep in mind #3 HFM is not ROLAP
- 6. 7© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. Agenda ▪ Overview ▪ Dimension member tables ▪ Dimension hierarchy tables ▪ Data tables ▪ Journal tables ▪ Audit tables
- 7. 8© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. System level tables HFM • HFM_ERRORLOG • HFM_PROPERTIES HSV • HSV_USERS_ON_SYSTEM • HSV_ACTIVITY_NO_ACCESS • HSV_ACTIVITY_USERS • HSV_ACTIVITY_SESSIONS • HSV_ACTIVITY_KILL_USERS
- 8. 9© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. System level tables HSX • HSX_DATASOURCES • HSX_MD_CC_LOCKS • HSX_ADMIN_TASKS • HSX_DSN_DETAILS XFM • XFM_PARAMETERS_DEFAULTS • XFM_PARAMETERS
- 9. 10© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. Application tables APPNAME_TABLE • About 60 unique metadata tables • About 15 data table types
- 10. 11© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. Data table format COMMA_SCENARIO_ITEM Actual 2007 Variance 1999 BudgetActualRate 1999
- 11. 12© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. Data table types
- 12. 13© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. Agenda ▪ Overview ▪ Dimension member tables ▪ Dimension hierarchy tables ▪ Data tables ▪ Journal tables ▪ Audit tables
- 13. 14© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. Dimension tables
- 14. 15© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. Dimension header table COMMA_VALUE_HEADER Boring...
- 15. 16© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. Dates in the HFM database • Serial value • 1900 Date System Date: Number of days elapsed since January 1, 1900 Time: Fractional part of day
- 16. 17© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. Date conversion Oracle SQL Server See Oracle KB Doc ID 584491.1
- 17. 18© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. Date conversion Database Excel
- 18. 19© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. Dimension properties COMMA_ENTITY_ITEM
- 19. 20© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. Property fields For the most part.... • There are a handful of system fields you can ignore, e.g. FirstChild, LastChild • Properties referencing other members hold the ItemID of that member. Example: DefaultParentID is ItemID of parent • Yes or No fields hold ‘0’ or ‘1’
- 20. 21© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. Default Currency (DefaultValueID) Example: Administration Default Currency is USD DefaultValueID is 83 COMMA_ENTITY_ITEM
- 21. 22© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. ValueID Lookup COMMA_VALUE_ITEM COMMA_CURRENCIES ?
- 22. 23© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. Derived Value Dimension (SQL View) From COMMA_VALUE_ITEM Calculated from COMMA_CURRENCIES Currency Total = 15 + (3 x ItemID) Currency Adjs = 15 + (3 x ItemID) + 1 Currency = 15 + (3 x ItemID) + 2
- 23. 24© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. Let’s look at that a little more closely... USD now works...
- 24. 25© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. Intercompany partner + = COMMA_ICP_ITEM COMMA_ENTITY_ITEM Derived ICP Item (SQL View)
- 25. 26© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. Custom dimensions COMMA_CUSTOM_ITEM
- 26. 27© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. Account custom attributes COMMA_ACCOUNT_CUSTATTR
- 27. 28© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. Agenda ▪ Overview ▪ Dimension member tables ▪ Dimension hierarchy tables ▪ Data tables ▪ Journal tables ▪ Audit tables
- 28. 29© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. Dimension Layout table COMMA_ACCOUNT_LAYOUT
- 29. 30© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. SQL Recursion • Recursion: repeatedly re-run query based on results of previous query • For hierarchies, identify children based on parents returned in last query • Allows us to return parent-child in Layout table in correct order for dimension building Oracle CONNECT BY or Common Table Expression SQL Server Common Table Expression
- 30. 31© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. Oracle CONNECT BY Starting point: all top level members (ones with no parent) Next level: all members which have members in previous query as parent Level keyword counts recursion level
- 31. 32© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. Close, but not quite....
- 32. 33© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. Sort order within level • Starting point is where PrevSiblingID = -1 • Follow NextSiblingID until = -1
- 33. 34© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. Preliminary CONNECT BY
- 34. 35© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. Two-level sort Sort by LEVEL1 and then by LEVEL2 to get the correct result
- 35. 36© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. XKCD
- 36. 37© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. Agenda ▪ Overview ▪ Dimension member tables ▪ Dimension hierarchy tables ▪ Data tables ▪ Journal tables ▪ Audit tables
- 37. 38© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. Data Table COMMA_DCE_1_XXXX
- 38. 39© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. InputTransType
- 39. 40© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. Data Table COMMA_DCE_1_XXXX
- 40. 41© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. Custom columns with unlimited dimensions • Minimum of two dimensions for an application • Always two dimension columns in data tables • First two dimensions are always coded in the first column • Remaining dimensions are coded in the second column
- 41. 42© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. Dimension sizes • Can select three dimension sizes, Small, Medium and Large (Small = 1 byte, Medium = 2 bytes, Large = 4 bytes) • Size of first two dimensions is always Large • Size of remaining dimensions may be chosen when the application is created • Can have more, smaller dimensions or fewer, larger dimensions • Dimension sizes influence how dimensions are coded in the dimension columns
- 42. 43© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. Calculating the new custom field
- 43. 44© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. Unpacking the field
- 44. 45© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. Adding extra dimensions
- 45. 46© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. Length and offset Offset = Where the dimension starts Length = How many places the dimension occupies 1,000 x 1,000
- 46. 47© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. Step by step Offset Length OffsetLength
- 47. 48© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. Custom Map table in HFM COMMA_CUSTOM_MAP
- 48. 49© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. Convert bytes to decimal 255 = 1 byte
- 49. 50© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. Implementation in SQL (FLOOR = QUOTIENT in Oracle SQL)
- 50. 51© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. XKCD
- 51. 52© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. Agenda ▪ Overview ▪ Dimension member tables ▪ Dimension hierarchy tables ▪ Data tables ▪ Journal tables ▪ Audit tables
- 52. 53© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. Journal tables
- 53. 54© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. Journal tables COMMA_JLENT_1_2007 COMMA_JL_1_2007
- 54. 55© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. Agenda ▪ Overview ▪ Dimension member tables ▪ Dimension hierarchy tables ▪ Data tables ▪ Journal tables ▪ Audit tables
- 55. 56© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. Task audit table
- 56. 57© 2016 The Hackett Group, Inc. All rights reserved. Reproduction of this document or any portion thereof without prior written consent is prohibited. Task audit table query • Join TASK AUDIT to HSV ACTIVITY USERS on UserID • ActivityCode values come from HFMAuditExtractSchemaDefs,xml in Financial Management/Utilities folder • Sample code provided