Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The HFM Express Adapter is a universal adapter for all versions of Oracle (Hyperion) Financial Management until version 11.1.2.4. The main difference with the existing HFM Adapter is that the HFM Express Adapter does not rely on the Data Extraction module of Financial Management (also known as Extended Analytics). Instead it extracts data and metadata by directly connecting to the relational database underlying HFM (SQL Server or Oracle). Also, the configuration and execution of the data extraction process has been simplified.

The Adapter can be started from the (non-web based) Design Studio tool.

Prerequisites

If the relational database underlying HFM is an Oracle database, then ODAC must be installed on the CXO Cockpit Application Server. We tested version 11.2 Release 5 (11.2.0.3.20), but newer versions will also work.

...

  • Select 'Use Backend System Adapter'
  • Select Adapter 'Hfm Express'
  • Enter a name (usually the name of the underlying HFM application), then press Next
  • If SQL Server Analysis Services runs on another server than the SQL Server used for the CXO Databases, then in the next screen you can override this:
    Image Added
    This option is rarely used 
  • Press Next / Next / Finish

...

Also an Analysis Services OLAP Database will have been created (name = <name>), initially containing sample data. Image Removed

Image Added

 

...

Connecting to HFM

Open You can open the Source Sysem System adapter console as follows (select the right adapter):Image Removedby pressing the button Integration Settings in the above window.

 In the first tab, enter the connectivity details to the HFM database:

...

  • DB Type: We support 2 Database Types: SQL Server and Oracle.

    Settings for SQL Server:

  • SQL Server: The SQL Server is the SQL Server instance where the HFM data are stored. Note: as a rule this is not the same database-server as used for the CXO-Cockpit databases.Consult your HFM System Administator to get these specs.
  • Database: The name of the HFM database (usually something like FM, HFM, HYPPROD, ...)
  • Application: The name of the HFM application from which we want to extract.
  • Windows Authentication:
    • Check the box if you want to access the HFM database by Windows AutheticationAuthentication: Note that not only the user of the Design Studio ('you') should be authenticated, but also the Windows account that is used as a Service account for the CXO-Cockpit services. Data extractions are carried out by our Agent Service:



      The Windows account(s) must have read-rights on the HFM database.

    • If you want to use a SQL Server account: enter a  username / password. Also this account can be a read-only user.

    Settings for Oracle:



    For an Oracle connection a TSN configuration is required on the CXO Cockpit application server:



    Consult your Oracle DBA for more details.

...

  • Extract ICP Details: check this box if you want to report on ICP transactions. Note that this may result in a lot more data records and will slow down the extraction and transformation process.
  • Aggregate ICP Entities: this is a reflection of a setting within HFM named ICPEntitiesAggregationWeight. Checking the box is equivalent to an a weight of 1.0 (this is most widely used). Un-checking means 0.0.

...

  1. Never change any cell of the av_name column
  2. Do not change any of the grey-marked cells at all
  3. Strictly follow the description below

 

NameDescription and optionsPossible values
DeleteZeroRecordsWhen set to 1, all records in the HFM database with Data = 0 will be skipped (and hence becomes NULL / Empty in the CXO reports). When set to 0, also records with Data = 0 will be extracted. Only do this if there are not too many zeros in the HFM database (e.g., as a result of automatic load of data) and you really want to distinguish between 0 and NULL.

1 = True

0 = False

FilterSourceDataTo get the raw data from HFM, queries are constructed that get the data and dimension information from the right tables of the HFM database. If FilterSourceData is set to 0, we only apply a simple filter for including or excluding ICP details, but no filter for the Entities. Entities are then filtered once the raw data is stored in the CXO staging database. When FilterSourceData = 1 then we explicitly filter by Entity already within the raw-data query (WHERE EntityId in ....). In general, if more than ~30% of the entities is selected for inclusion ion CXO it is better to set FilterSourceData = 0 because the huge WHERE clause will slow-down the query. If less than ~30% is to be included then set FilterSourceData = 1.

1 = True

0 = False

 

IncludeInputValues

When set to 0, the Value-dimension (stored in the CXO GAP dimension will be flat:
Image Modified 

When set to 1, the original hierarchy will be retained:

Image Modified

Only set IncludeInputValues = 1 if you need the Adjs detail

1 = True

0 = False

PreAggregateAccounts

As explained earlier, selections from the Account Dimension are usually done on a high level (the root node, or a few levels lower). All descendants of a selected node are then selected as well. A potential danger of this approach is that complete substructures might be repeated while you don't see them in your selection. For example, a node like NetProfit can have a lot of descendants and each time this node is used in other KPI's potentially all these descendants are duplicated as well, resulting in a lot of duplicate fact records in the cube:

Image Modified 

By setting PreAggregateAccounts = 1 we will pre-aggregate the 2nd occurrence of NetProfit and give it the name ...NetProfit:

Image Modified 

From a data point of view, NetProfit and ...NetProfit are 100% equal. However, drilling into the Descendants of ...NetProfit is not possible.

The advantage of this approach is that it keeps the Account dimension smal(ler) and it generates less records in the cube. The disadvantage is that if you drill into e.g. OtherInfo you will never reach members like InterestInc(Exp).

1 = True

0 = False

StoreParentEntity

When set to 1 the entity-names will always be stored as a combination of parent.child:

Image Modified

This variable must be set to 1 when the value [Contribution Total] is selected and the Entity selection contains duplicates. Note that if you change this setting, entity lists already created in CXO might get invalid.

1 = True

0 = False

UseCustomRollupForAccountsTechnical setting. Set to 0. 
UseCustomRollupForCustomDimensionsTechnical setting. Set to 0. 
WYSIWYGModeForCustomDimensions

As mentioned above, Custom dimensions (A01, A02, ... in CXO Cockpit) can be generated in two ways.

  1. WYSIWYG mode: WYSIWYG stands for What You See Is What You Get. It means that the A0# dimension will exactly follow the expand and collapse actions in the Dimension Member selection screen. In other words, if the selection and expansion is as follows:
    Image Modified  then the resulting CXO dimension looks like: Image Modified

  2. Dynamic mode (if in this mode, as of 5.4 patch 6, you will see the selected members in red): if you select a member, you automatically select all the descendants, unless you explicitly deselect some of them. In this mode the same selection and resulting CXO dimension is:

    Image Modified  Image Modified

 

0 = do not apply to any custom dimension

Comma separated list of Custom dimensions you want to see in WYSIWYG mode (e.g., 1,3,4,7)

 

Technical preparations

-- create CC_PERIOD table

...