The basis for every EPM application is the metadata. As you build Hyperion applications and add them to your suite, its important to have a strong foundation for the applications, as well as consistency between them. Utilizing the same Chart of Accounts, Entity structure, or any other custom dimension is crucial to tie-outs, forecasting, and overall reporting.

Unfortunately, Planning, HFM, and Essbase all have specific considerations for Member Names and Description/Aliases. I see this a lot as I help clients create metadata for their applications; even if a specific character is acceptable in one type of application, it can create some headaches down the line if another type of application is added to your Hyperion footprint.

For example, the comma (,) is a totally acceptable character within Planning Member Names – however, a comma would error out if used in a Member Name in HFM.

For this reason, I’ve collected a list of the unacceptable characters and other considerations between two common application types, HFM and Planning (and by association, Essbase). Even if you are just starting out with one of the application type now; later down the line, if your organization decides to implement another other, you will be able to leverage the metadata across applications with no rework.

Please note, these considerations are from the 11.1.2.3 admin guides, so things may be slightly different if you are in a different release. Please check the Oracle admin guides for your release if not on 11.1.2.3!

Member Names

  • 80 Characters
  • Cannot start with a space, or end with a space
  • Member Name must be unique to entire application (all dimensions) – [Planning Restriction]
  • Any Essbase calculation commands or function names (can be found here)
  • Report Writer Commands (can be found here)
  • If using Dynamic Time Series in Planning, do not use History, Year, Season, Period, Quarter, Month, Week, or Day
  • Any of these words (from Planning Admin guide)Image
  • Not recommended characters for Member Names:

o   Single Quotes ( ‘ ) – [Planning Restriction]
o   Double Quotes ( “ ) – [Planning Restriction] & [HFM Restriction]
o   Brackets ( [ ] ) – [Planning Restriction] (BSO Cubes)
o   Curly brackets ( { } ) – [HFM Restriction]
o   Backslashes ( \ ) – [Planning Restriction]
o   Forward Slashes ( / ) – [Planning Restriction] & [HFM Restriction]
o   Tab – [Planning Restriction]
o   At sign (@) – [HFM Restriction]
o   Commas (,) – [HFM Restriction]
o   Period ( . ) – [HFM Restriction]
o   Asterisk ( * ) – [HFM Restriction]
o   Dash, hyphen, minus (-) – [HFM Restriction]
o   Number sign ( # ) – [HFM Restriction]
o   Plus sign ( + ) – [HFM Restriction]
o   Semicolon ( ; ) – [HFM Restriction]
o   Less than and greater than signs ( < > ) – [Planning Restriction]
o   HTML Tags ( </font> ) – [Planning Restriction]
o   Equals signs ( = ) – [HFM Restriction]

  • Non-Recommended ‘acceptable’ characters

o   Ampersand ( & )

Not advised because it is used as a bitwise operator in Java and sometimes crashes planning forms if in the form name. And its not allowed in HFM cell text labels.

o   Vertical Bar ( | ) – [HFM Restriction] (

Not advised, because typically used as delimiter in ADS/APP files for HFM/EPMA metadata loads

  • Also note:

o   Even though Underscores are acceptable in Member Names, do not start a Member Name with an Underscore (_)

 

Planning Aliases/HFM Description

  • 80 Characters, including spaces
  • Alias/Description must be unique to entire application (all dimensions) – [Planning Restriction]
  • Not recommended characters for HFM Description/Planning Alias:

o   HTML Tags ( </font> ) – [Planning Restriction]
o   Double Quotes ( “ ) – [Planning Restriction] – (used for Alias ad Formula delimiting)
o   Single Quotes (‘) – [Planning Restriction]
o   Brackets [ ] – [Planning Restriction]
o   Curly Brackets { } – [Planning Restriction]
o   Back slashes ( \ ) – [Planning Restriction] & [HFM Restriction] (HFM Account Dimension Only)
o   Tab – [Planning Restriction]
o   Ampersand (&) – [HFM Restriction] (HFM Account Dimension Only)

  • Not recommended “acceptable” characters:

o   Vertical Bar ( | ) – [HFM Restriction]

Not advised, because typically used as delimiter in ADS/APP files for HFM/EPMA metadata loads

  • Even though these are acceptable characters, do not start the Alias/Description with:

o   At sign (@) – [Planning Restriction]
o   Comma ( , ) – [Planning Restriction]
o   Dash, hyphen, minus ( – ) – [Planning Restriction]
o   Equals ( = ) – [Planning Restriction]
o   Less than or greater than sign ( < > ) – [Planning Restriction]
o   Parenthesis ( ) – [Planning Restriction]
o   Period ( . ) – [Planning Restriction]
o   Plus sign ( + ) – [Planning Restriction]
o   Underscore ( _ ) – [Planning Restriction]
o   Vertical Bar ( | ) – [Planning Restriction]

 

There you have it! Watch for another post coming soon on best practices with metadata creation – I’ll talk about prefixes, descriptions, and other ways on getting the best format for your organization’s metadata.