Creating a Load Metadata Job

This Job type triggers an action within Hyperion FM that loads metadata into Hyperion FM. The metadata is contained in a file that needs to be located on the host of the Agent.

LOAD_METADATA Job

  • Login Data

    • The RA Hyperion FM Agent Connection Object object.

  • Application

    • The Hyperion FM application to log into.

  • File Name

    • The name of the file to load (with an .xml extension). To browse the Agent file system (which is also the Hyperion FM file system) for the file, use the Browse button. If there is no connection to the Agent, the Browse button is disabled.

  • Delimiter character

    • The delimiter character. Allowed values:

    • ; (default)
    • ,
    • ~
    • @
    • #
    • $
    • %
    • ^
    • &
    • |
    • :
    • ?
    • \
  • Scan Only

    • When checked, a scan is done, but the list is not loaded.


    Default: Unchecked
  • Clear Metadata and Data

    • When checked, metadata and data are cleared and the following check boxes get disabled and checked:

    • Application Settings
    • Consolidation Methods
    • Cell Text Labels
    • Scenarios
    • Entities
    • Accounts
    • Currencies

    Additionally, the Mode is forced to "Merge".
    Default: Unchecked

  • Mode

    • Allows you to select the load mode: 

    • Merge
    • Replace
  • System Accounts

    • When checked, system accounts are loaded.
    Default: Unchecked

  • Application Settings

    • When checked, application settings are loaded.
    Default: Unchecked

  • Consolidation Methods

    • When checked, consolidation methods are loaded.
    Default: Unchecked

  • Cell Text Labels

    • When checked, cell text labels are loaded.
    Default: Unchecked

  • Values

    • When checked, values are loaded.
    Default: Unchecked

  • Scenarios

    • When checked, scenarios are loaded.
    Default: Unchecked

  • Entities

    • When checked, entities are loaded.
    Default: Unchecked

  • Accounts

    • When checked, accounts are loaded.
    Default: Unchecked

  • ICPs

    • When checked, ICPs are loaded.
    Default: Unchecked

  • Currencies

    • When checked, currencies are loaded.
    Default: Unchecked

  • Custom Dimensions

    • The custom dimensions to include. To define custom dimensions write the name(s) in this field. Use ';' to separate various dimensions. Blank characters between dimensions are allowed. When this field is left empty, no metadata for any custom dimension is loaded.

Periods, Views, Years are always selected.

Job Status

The status of the Job is "ENDED_OK - ended normally" if the status is COMPLETED_SUCCESSFULLY or COMPLETED_WITH_WARNINGS.The Job status is "ENDED_NOT_OK - aborted" if the load status is FAILED.

Job Output

The Job report contains the Job parameters and the result of the load 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".