Help Desk

Submit a ticket My Tickets
Welcome
Login

Oracle HFM Legacy Command Reference

BizApp for interacting with Oracle Hyperion Financial Management versions 9.3.1 - 11.1.2.3

Connections

Oracle HFM Legacy

Oracle HFM Legacy Versions (9.3.1 - 11.1.2.3)

Inputs

Input Type Detail Notes
Version DropdownField HFM Version. Note: If you do not see your patch level specified, use the closest previous version.
.NET Version DropdownField The version of the Microsoft .NET framework installed on the machine running HFM We require that, at minimum, .NET 3.5 be installed on your machine running HFM
User Name TextField HFM User Name
Password TextField HFM Password
Cluster Name TextField Name of the HFM Cluster on which the operations will be performed.
Custom Dimension Names ArrayField List of the custom dimensions defined in your application. It is important to list all custom dimensions or the BizApp may not be able to provide relevant error messaging.

Commands

Allocate

Invokes HFM allocation rules

Inputs

Input Type Detail Notes
Application Name TextField Name of the relevant HFM application
Scenario TextField Scenario member
Year TextField Year member
Periods ArrayField Period members
Entities ArrayField Entity members
Values ArrayField Value members

Outputs

None

Exit Codes

Code Type Detail
0 Success Indicates that the command completed successfully
1 Error General failure

Consolidate

Invokes HFM consolidation rules

Inputs

Input Type Detail Notes
Application Name TextField Name of the relevant HFM application
Consolidation Type DropdownField The type of consolidation to perform
Scenarios TextField Scenario members
Years TextField Year members
Periods ArrayField Period members
Entities ArrayField Entity members

Outputs

None

Exit Codes

Code Type Detail
0 Success Indicates that the command completed successfully
1 Error General failure

Delete Star Schema

Deletes a target star schema based upon the configured DSN and table prefix

Inputs

Input Type Detail Notes
Application Name TextField Name of the relevant HFM application
DSN TextField Data Source Name (DSN)
Table Prefix TextField The prefix that appears at the start of each table name

Outputs

None

Exit Codes

Code Type Detail
0 Success Indicates that the command completed successfully
1 Error General failure

Extract Data to Database

Extracts data to a star schema given a DSN

Inputs

Input Type Detail Notes
Application Name TextField Name of the relevant HFM application
Scenario ArrayField Scenario members
Year ArrayField Year members
Periods ArrayField Period members
Entities ArrayField Entity members
Accounts ArrayField Account members
Value ArrayField Value members
ICP ArrayField ICP members
View ArrayField View members
Custom Dimensions GroupField Custom dimensions along with their values. For each dimension, use a comma-separated list to select more than one member
Data Source Name (DSN) TextField Data source name (DSN)
Table Prefix TextField Table prefix for data to be extracted to database
Extract Type DropdownField Data extract type
Include Data BooleanField Whether to include data
Include Calculated Data BooleanField Include calculated data
Include Derived Data BooleanField Include derived data
Include Dynamic Accounts BooleanField Include dynamic accounts
Delete Existing BooleanField Delete existing data

Outputs

Output Output Type Notes
Extract to Database Log File Data Log File File

Exit Codes

Code Type Detail
0 Success Indicates that the command completed successfully
1 Error General failure

Extract Data to File

Extracts data to a flat file

Inputs

Input Type Detail Notes
Application Name TextField Name of the relevant HFM application
Scenario ArrayField Scenario members
Year ArrayField Year members
Periods ArrayField Period members
Entities ArrayField Entity members
Accounts ArrayField Account members
Value ArrayField Value members
ICP ArrayField ICP members
View ArrayField View members
Custom Dimensions GroupField Custom dimensions along with their values. For each dimension, use a comma-separated list to select more than one member
Delimiter DropdownField Delimiter of exported file
Line Items Detail DropdownField Detail to be included with each line item
Include Calculated Data BooleanField Include calculated data
Include Derived Data BooleanField Include derived data
Include Dynamic Accounts BooleanField Include dynamic accounts
Include Phased Groups BooleanField Include phased groups
Decompress BooleanField Decompress resulting data
Include Header BooleanField Include header in. resulting data file

Outputs

Output Output Type Notes
Extract Data File File
Extract Data Log File File

Exit Codes

Code Type Detail
0 Success Indicates that the command completed successfully
1 Error General failure

Extract Journals

Extracts HFM Journals based upon the combination of Scenario, Year and Period

Inputs

Input Type Detail Notes
Application Name TextField Name of the relevant HFM application
Scenario TextField Scenario member
Year TextField Year member
Period TextField Period member
Delimiter DropdownField Delimiter of the extract file
Extract Regular Journals BooleanField Extract regular journals
Extract Recurring Templates BooleanField Extract recurring journal templates
Extract Standard Templates BooleanField Extract standard journal templates

Outputs

Output Output Type Notes
Extract Journals File File
Extract Journals Log File File

Exit Codes

Code Type Detail
0 Success Indicates that the command completed successfully
1 Error General failure

Extract Member Lists

Extracts HFM Member Lists to a file

Inputs

Input Type Detail Notes
Application Name TextField Name of the relevant HFM application

Outputs

Output Output Type Notes
Extract Member Lists File File
Extract Member Lists Log File File

Exit Codes

Code Type Detail
0 Success Indicates that the command completed successfully
1 Error General failure

Extract Metadata

Extracts HFM metadata to a file

Inputs

Input Type Detail Notes
Application Name TextField Name of the relevant HFM application
Delimiter DropdownField Delimiter of the extract file
File Format DropdownField Metadata file format
Accounts BooleanField Extract accounts
App Settings BooleanField Extract app settings
Cell Text Labels BooleanField Extract cell text labels
Consolidation Methods BooleanField Extract consolidation methods
Currencies BooleanField Extract currencies
Entities BooleanField Extract Entity dimension
ICPS BooleanField Extract ICP dimension
Scenarios BooleanField Extract scenario dimension
System Accounts BooleanField Extract system accounts
System Members BooleanField Extract system members
Values BooleanField Extract value dimension

Outputs

Output Output Type Notes
Extract Metadata File File
Extract Metadata Log File File

Exit Codes

Code Type Detail
0 Success Indicates that the command completed successfully
1 Error General failure

Extract Rules

Extracts HFM business logic rules

Inputs

Input Type Detail Notes
Application Name TextField Name of the relevant HFM application
Rules Format DropdownField Format in which to extract rules

Outputs

Output Output Type Notes
Extract Rules File File
Extract Rules Log File File

Exit Codes

Code Type Detail
0 Success Indicates that the command completed successfully
1 Error General failure

Extract Security

Extracts HFM security in the HFM native format

Inputs

Input Type Detail Notes
Application Name TextField Name of the relevant HFM application
Delimiter DropdownField Delimiter of the extract file
Users BooleanField Extract users and groups
Role Access BooleanField Extract role access definitions
Security Class Access BooleanField Extract security class access definitions
Security Classes BooleanField Extract security class definitions

Outputs

Output Output Type Notes
Extract Security File File
Extract Security Log File File

Exit Codes

Code Type Detail
0 Success Indicates that the command completed successfully
1 Error General failure

Load Data

Loads data from a file

Inputs

Input Type Detail Notes
Application Name TextField Name of the relevant HFM application
Data File FileField File to load
Delimiter DropdownField Delimiter of exported file
Update Mode DropdownField Specifies how data loads affect existing values
Mode DropdownField Specifies how the data should be processed
Accumulate Within File BooleanField Accumulate within file
Append to Log BooleanField Append to log
Contains shares BooleanField Contains Shares
Contains Submission Phase BooleanField Contains submission phase
Decimal Character TextField Decimal character
Thousands Character TextField Thousands Character

Outputs

Output Output Type Notes
Load Data Log File File

Exit Codes

Code Type Detail
0 Success Indicates that the command completed successfully
1 Error General failure

Load Journals

Loads HFM journals from a file

Inputs

Input Type Detail Notes
Application Name TextField Name of the relevant HFM application
Delimiter DropdownField Delimiter of the file to be loaded
Journals File FileField File from which journals will be loaded

Outputs

Output Output Type Notes
Load Journals Log File File

Exit Codes

Code Type Detail
0 Success Indicates that the command completed successfully
1 Error General failure

Load Member Lists

Load HFM Member Lists from a file

Inputs

Input Type Detail Notes
Application Name TextField Name of the relevant HFM application
Member Lists File FileField File from which lists are loaded
Scan Only BooleanField Scan without performing member list load

Outputs

Output Output Type Notes
Load Member Lists Log File File

Exit Codes

Code Type Detail
0 Success Indicates that the command completed successfully
1 Error General failure

Load Metadata

Load HFM metadata from a file

Inputs

Input Type Detail Notes
Application Name TextField Name of the relevant HFM application
Metadata File FileField File with HFM metadata
Delimiter DropdownField Delimiter of the extract file
File Format DropdownField Metadata file format
Check Integrity BooleanField Check integrity before loading
Scan Only BooleanField Scan only - do not perform load operation
Use Replace Mode BooleanField Use replace mode when loading metadata
Clear All BooleanField Clear all dimensions
Clear Accounts BooleanField Clear accounts dimension
Clear Consolidation Methods BooleanField Clear consolidation methods
Clear Currencies BooleanField Clear currencies
Clear Entities BooleanField Clear entity dimension before load
Clear Scenarios BooleanField Clear scenario dimension before load
Load Accounts BooleanField Load accounts dimension
Load App Settings BooleanField Load app settings
Load Text Labels BooleanField Load cell text labels
Load Currencies BooleanField Load currencies
Load Entities BooleanField Load entity dimension
Load ICPs BooleanField Load ICP dimension
Load Scenarios BooleanField Load scenario dimension
System Accounts BooleanField Load system accounts
System Members BooleanField Load system members
Load Values BooleanField Load value dimension

Outputs

Output Output Type Notes
Load Metadata Log File File

Exit Codes

Code Type Detail
0 Success Indicates that the command completed successfully
1 Error General failure

Load Rules

Load HFM business logic rules

Inputs

Input Type Detail Notes
Application Name TextField Name of the relevant HFM application
Rules File FileField File from which rules are loaded
Scan Only BooleanField Scan without performing load
Check Integrity BooleanField Check application integrity against current application before loading

Outputs

Output Output Type Notes
Load Rules Log File File

Exit Codes

Code Type Detail
0 Success Indicates that the command completed successfully
1 Error General failure

Load Security

Load HFM security from file

Inputs

Input Type Detail Notes
Application Name TextField Name of the relevant HFM application
Delimiter DropdownField Delimiter of the file to be loaded
Security File FileField Security file to load
Clear All BooleanField Clear all security rules before loading
Validate Users BooleanField Validate users before loading security rules
Role Access BooleanField Load role access definitions
Security Class Access BooleanField Load security class access definitions
Security Classes BooleanField Load security class definitions
Users BooleanField Load users and groups

Outputs

Output Output Type Notes
Load Security Log File File

Exit Codes

Code Type Detail
0 Success Indicates that the command completed successfully
1 Error General failure

Translate

Invokes the HFM FX translation rules based upon the options provided

Inputs

Input Type Detail Notes
Application Name TextField Name of the relevant HFM application
Scenario TextField Scenario members
Year TextField Year members
Periods ArrayField Period members
Entities ArrayField Entity members
Values ArrayField Value members
Force Translate BooleanField Force translate

Outputs

None

Exit Codes

Code Type Detail
0 Success Indicates that the command completed successfully
1 Error General failure
B
Brian is the author of this solution article.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.