Creating an Extract Data To Database Job

This Job type triggers the execution of the extract data to database action in Hyperion FM and as a result writes the extracted data into a database. The file is on the host where the Agent is located.

Be aware that "Extract Data" influences "Line Item Option", "Extract Dynamic Accounts", "Calculated Data" and "Derived Data". When "Extract Data" is unchecked these controls are disabled and cannot be set.

EXTRACT_DATA_TO_DATABASE Job

  • Login Data

    • The RA Hyperion FM Agent Connection Object object.

  • Application

    • The Hyperion FM application to log into.

  • POV

    • The point of view (POV) which contains at least Scenario, Year, Period, Entity and Value.

    Format: S#<SCENARIO>.Y#<YEAR>.P#<PERIOD>.E#<ENTITY>.V#<VALUE>

  • Extract format

    • The Extract format. Allowed values:

    • Metadata only (default)
    • Selected metadata only
    • Standard
    • Essbase
    • Data Warehouse
  • Schema Actions

    • The schema actions. Allowed values:

    • Create star schema (default)
    • Update star schema
    • Delete star schema
  • Destination Database (DSN)

    • The Destination Database (DSN), which has to be predefined in Hyperion FM.

  • Relational Table Prefix

    • The prefix.

  • Extract Data

    • When checked, data is extracted.
    Default: Unchecked

  • Extract Dynamic Accounts

    • When checked, dynamic accounts are extracted.
    Default: Unchecked

  • Calculated Data

    • When checked, data is calculated.
    Default: Unchecked

  • Derived Data

    • When checked, data is derived.
    Default: Unchecked

  • Line Item Option

    • The line item option. Allowed values:

    • None (default)
    • Total summary for cell

Job Status

The Job status is "ENDED_NOT_OK - aborted" if an invalid POV is provided.

The status of the Job is "ENDED_OK - ended normally" otherwise.

Known issue: HFM API has issues with handling invalid DSNs as well as update and delete star schema.

Job Output

The Job report contains the Job parameters and the result of the extract action.

Log messages from Hyperion Financial Data Management Enterprise Edition can only be correctly translated/displayed in the Job reports if they are either Latin-9 or UTF-16 encoded.

All entries have a time stamp. The HFM log is transferred to the report directory of the Agent (typically "temp") and registered as output file.

The prefix of the file name is "Log" followed by the RunID of the Job.

The report type of the HFM log in the Automation Engine is "W1".

Special Case

When selecting "Delete star schema", Hyperion FM does not provide any taskID. Unfortunately the task then can not be monitored. We are working on a solution on that topic.