Table of Contents

Connections

Commands

Connections

Oracle Hyperion Financial Management

Connection to Oracle HFM

Inputs

Input

Type

Detail

Notes

User name

TextField

HFM user

Password

TextField

Password associated with user name

EPM Home

TextField

Path to the home directory for the EPM system

EPM Instance

TextField

Path to the EPM instance

HFM Cluster

TextField

HFM cluster

Commands

Allocate

Invokes HFM allocation rules

Inputs

Input

Type

Detail

Notes

Application

TextField

HFM application

Scenario

TextField

Scenario member

Year

TextField

Year member

Entity

TextField

Entity member

Start period

TextField

Start period member

End period

TextField

End period member

Value

TextField

Value member

Outputs

None

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

General failure

2

Error

Invalid credentials

3

Error

Invalid HFM application

4

Error

Invalid member

Build Journal File

Creates a journal file to be imported into HFM in the standard .jlf format

Inputs

Input

Type

Detail

Notes

Label

TextField

User-defined label for journal (20 character maximum)

Group Name

TextField

Optional: Name of the journal's group (30 character maximum)

Scenario

TextField

Scenario dimension member

Year

TextField

Year dimension member

Period

TextField

Period dimension member

Type

DropdownField

Journal type

Status

DropdownField

Status of journals

Balancing Attribute

DropdownField

Balancing attribute

Value Dimension

DropdownField

Value Dimension

Security Class

TextField

Optional: Valid security class that is associated with the journal. If you do not assign a security class, the journal assumes the Default security class. Only users who have access rights to this security class can access the journal.

Node

TextField

Optional: Valid Node that is used by all the line items in the journal. When you specify a single node pair for the entire journal, the Entity (parent.child) attribute is not used in the line items file. Also known as <singleparent.singleentity>

Description

TextField

Journal description, which can contain up to 255 characters.

Journal Entries File

FileField

File containing the journal entry values. The file must be a CSV with the following values (in order): Entity (parent.child), Account, ICP, Custom Dimension(s), Amount Type, Amount, Line Item Description. The column names do not need to match, but the values must be specified in order. Note that multiple custom dimensions can be specified in order.

The values required for this file match the Oracle documentation for a HFM journal entry: https://docs.oracle.com/cd/E57185_01/HFMAG/ch06s01s06.html

Journal File Header

BooleanField

Whether or not the Journal Entries File contains a header. A header is optional, as the columns are read in order

Delimiter

DropdownField

Delimiter for the Journal Entries File

Outputs

Output

Output Type

Notes

Journal File

File

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

General failure

Clear Slice

Clears a slice of data

Inputs

Input

Type

Detail

Notes

Application

TextField

HFM application

Config File

FileField

Path to the configuration file which must use the OneCloud HFM specification. This field is NOT required if you are using the Config Text field.

Config Text

TextField

Configuration in text format using the OneCloud HFM specification. This field is NOT required if you are using the Config File field.

Display members

BooleanField

Display all members from the configuration file in the output.

Expand only

BooleanField

Expand members without executing the command (useful for testing).

Clear rates and system data

BooleanField

Clear rates and system data

Enable detailed logging

BooleanField

Enable detailed logging

Outputs

Output

Output Type

Notes

Clear data log

File

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

General failure

2

Error

Invalid credentials

3

Error

Invalid HFM application

4

Error

Invalid member

5

Error

Invalid configuration file

Close Period

Closes a period in HFM

Inputs

Input

Type

Detail

Notes

Application

TextField

HFM application

Scenario

TextField

Scenario member

Year

TextField

Year member

Period

TextField

Period member

Outputs

None

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

General failure

2

Error

Invalid credentials

3

Error

Invalid HFM application

4

Error

Invalid member

Consolidate

Invokes HFM consolidation rules

Inputs

Input

Type

Detail

Notes

Application

TextField

HFM application

Consolidation type

DropdownField

Type of consolidation to perform

Scenario

TextField

Scenario member

Year

TextField

Year member

Entity

TextField

Entity member

Start period

TextField

Start period member

End period

TextField

End period member

Outputs

Output

Output Type

Notes

Consolidate log

File

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

General failure

2

Error

Invalid credentials

3

Error

Invalid HFM application

4

Error

Invalid member

Copy Data

Copies a slice of data in HFM

Inputs

Input

Type

Detail

Notes

Application

TextField

HFM application

Update mode

DropdownField

Update mode

Config File

FileField

Path to the configuration file which must use the OneCloud HFM specification. This field is NOT required if you are using the Config Text field.

Config Text

TextField

Configuration in text format using the OneCloud HFM specification. This field is NOT required if you are using the Config File field.

View

TextField

HFM View

Scale factor

TextField

Scale factor (must be a number with a decimal)

Display members

BooleanField

Expand members from configuration file and print them to the command's output log

Expand only

BooleanField

Expands members from the configuration file without executing the command (useful for testing).

Copy derived data

BooleanField

Copy derived data

Copy rates and system data

BooleanField

Copy rates and system data

Detailed logging

BooleanField

Enable detailed logging

Outputs

Output

Output Type

Notes

Copy data log

File

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

General failure

2

Error

Invalid credentials

3

Error

Invalid HFM application

4

Error

Invalid member

5

Error

Invalid configuration file

Delete Star Schema

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

Inputs

Input

Type

Detail

Notes

Application

TextField

HFM application

DSN

TextField

Data Source Name (DSN)

Table prefix

TextField

Table prefix

Database Type

DropdownField

Database type

Database Name

TextField

Name of the database

Database User

TextField

Database user

Database Password

TextField

Database password

Database host

TextField

Database host

Database port

NumberField

Database port

Outputs

None

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

General failure

2

Error

Invalid credentials

3

Error

Invalid HFM application

6

Error

Invalid DSN

Disable Connections

Disables non-administrators to login into HFM

Inputs

Input

Type

Detail

Notes

Application

TextField

HFM application

Outputs

None

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

General failure

2

Error

Invalid credentials

3

Error

Invalid HFM application

Enable Connections

Enables connections for all non-administrator HFM users

Inputs

Input

Type

Detail

Notes

Application

TextField

HFM application

Outputs

None

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

General failure

2

Error

Invalid credentials

3

Error

Invalid HFM application

Extract Data to Database

Extracts data from HFM based upon parameters that define a multidimensional space to a database

Inputs

Input

Type

Detail

Notes

Application

TextField

HFM application

Config File

FileField

Path to the configuration file which must use the OneCloud HFM specification. This field is NOT required if you are using the Config Text field.

Config Text

TextField

Configuration in text format using the OneCloud HFM specification. This field is NOT required if you are using the Config File field

Extract format

DropdownField

Format for extracting the data.

Line item option

DropdownField

Level of detail per line item

Display members

BooleanField

Outputs the members of each dimension during extraction

Expand only

BooleanField

When this option is selected, the members will be shown without performing the extraction (useful for testing)

Table prefix

TextField

Table prefix - must be provided regardless of where data is extracted

DSN

TextField

Destination DSN

Database type

DropdownField

Type of database used for the extraction

Database name

TextField

Database name to extract to

Database user

TextField

Database user

Database password

TextField

Database password

Database host

TextField

Database host

Database port

NumberField

Database port

Schema actions

DropdownField

Schema actions for extraction

Include phased group data

BooleanField

Include phased group data

Extract dynamic data

BooleanField

Extract dynamic data

Extract derived data

BooleanField

Extract derived data

Extract calculated data

BooleanField

Extract calculated data

Include cell description

BooleanField

Include cell description

Outputs

Output

Output Type

Notes

Extract to database log

File

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

General failure

2

Error

Invalid credentials

3

Error

Invalid HFM application

4

Error

Invalid member

5

Error

Invalid configuration

Extract Data to File

Extracts data from HFM based upon parameters that define a multidimensional space to a flat file.

Inputs

Input

Type

Detail

Notes

Application

TextField

HFM application

Config file

FileField

Path to the configuration file which must use the OneCloud HFM specification. This field is NOT required if you are using the Config Text field.

Config Text

TextField

Configuration in text format using the OneCloud HFM specification. This field is NOT required if you are using the Config File field.

Output file

TextField

(OPTIONAL) File to which the data will be extracted. Leave blank if intending to use the output file in subsequent commands.

File prefix

TextField

(OPTIONAL) Prefix to be used for the extract file. It will default to the name of the application.

Extract format

DropdownField

Format for extracting the data. Can choose to extract to a database or a flat file.

Delimiter

TextField

Delimiter of the data to extract.

Line item option

DropdownField

Level of detail per line item

Display members

BooleanField

Outputs the members of each dimension during extraction

Expand only

BooleanField

When this option is selected, the members will be shown without performing the extraction (useful for testing)

Extract calculated data

BooleanField

Extract calculated data

Extract derived data

BooleanField

Extract derived data

Extract dynamic data

BooleanField

Extract dynamic data

Include phased group data

BooleanField

Include phased group data

Include cell description

BooleanField

Include cell description

Outputs

Output

Output Type

Notes

Extract data log

File

Extract data file

File

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

General failure

2

Error

Invalid credentials

3

Error

Invalid HFM application

4

Error

Invalid member

5

Error

Invalid configuration

Extract Journals

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

Inputs

Input

Type

Detail

Notes

Application

TextField

HFM application

Scenario

TextField

Scenario member

Year

TextField

Year member

Period

TextField

Period member

File

TextField

Path where the file will be stored (optional)

Delimiter

TextField

Delimiter in exported file

Extract Template

BooleanField

Extract template

Extract Recurring Template

BooleanField

Extract recurring template

Outputs

Output

Output Type

Notes

Journals file

File

Journals log file

File

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

General failure

2

Error

Invalid credentials

3

Error

Invalid HFM application

4

Error

Invalid member

7

Error

Invalid file path

Extract Member Lists

Extracts HFM Member Lists to a file

Inputs

Input

Type

Detail

Notes

Application

TextField

HFM application

File

TextField

Path where the file will be stored (optional)

Outputs

Output

Output Type

Notes

Lists file

File

Lists log file

File

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

General failure

2

Error

Invalid credentials

3

Error

Invalid HFM application

7

Error

Invalid file path

Extract Metadata

Extracts HFM metadata controlled by dimension

Inputs

Input

Type

Detail

Notes

Application

TextField

HFM application

File

TextField

Path where the file will be stored (optional)

Delimiter

TextField

Delimiter in exported file

File format

DropdownField

Export file format

Extract system accounts

BooleanField

Extract system accounts

Extract ICPs

BooleanField

Extract ICPs

Extract values

BooleanField

Extract values

Extract currencies

BooleanField

Extract currencies

Extract accounts

BooleanField

Extract accounts

Extract entities

BooleanField

Extract entities

Extract scenarios

BooleanField

Extract scenarios

Extract application settings

BooleanField

Extract application settings

Extract consolidation methods

BooleanField

Extract consolidation methods

Extract custom dimensions

ArrayField

Specify a list of custom dimensions to extract

Outputs

Output

Output Type

Notes

Metadata file

File

Metadata log file

File

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

General failure

2

Error

Invalid credentials

3

Error

Invalid HFM application

7

Error

Invalid file path

Extract Rules

Extracts HFM business logic rules

Inputs

Input

Type

Detail

Notes

Application

TextField

HFM application

File

TextField

Path where the file will be stored (optional)

File format

DropdownField

Format of the file to extract

Outputs

Output

Output Type

Notes

Rules file

File

Rules log file

File

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

General failure

2

Error

Invalid credentials

3

Error

Invalid HFM application

7

Error

Invalid file path

Extract Security

Extracts HFM security in the HFM native format

Inputs

Input

Type

Detail

Notes

Application

TextField

HFM application

File

TextField

Path where the file will be stored (optional)

Delimiter

TextField

Delimiter for exported file

Extract users and groups

BooleanField

Extract users and groups

Extract security classes

BooleanField

Extract security classes

Extract role access

BooleanField

Extract role access

Extract security class access

BooleanField

Extract security class access

Outputs

Output

Output Type

Notes

Security file

File

Security log file

File

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

General failure

2

Error

Invalid credentials

3

Error

Invalid HFM application

7

Error

Invalid file path

Load Data

Loads data to HFM

Inputs

Input

Type

Detail

Notes

Application

TextField

HFM application

File

FileField

Data file to load to HFM

File format

DropdownField

Format of the file to be loaded

Load mode

DropdownField

Data load mode (how to handle duplicate data)

Delimiter

DropdownField

Delimiter of the file used for loading data

Log append

BooleanField

Append logs when loading data

Scan only

BooleanField

Performs scan only without loading data

Accumulated

BooleanField

Accumulated within file

Contains shares data

BooleanField

Contains shares data

Outputs

Output

Output Type

Notes

Load data log

File

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

General failure

2

Error

Invalid credentials

3

Error

Invalid HFM application

7

Error

Invalid file path

Load Journals

Loads journals to HFM

Inputs

Input

Type

Detail

Notes

Application

TextField

HFM application

File

FileField

File to be loaded to HFM

Delimiter

DropdownField

Delimiter of the file used for loading data

Outputs

Output

Output Type

Notes

Load journals log

File

Errors

File

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

General failure

2

Error

Invalid credentials

3

Error

Invalid HFM application

4

Error

Invalid member

7

Error

Invalid file path

Load Member Lists

Loads member lists to HFM

Inputs

Input

Type

Detail

Notes

Application

TextField

HFM application

File

FileField

File to load to HFM

Scan only

BooleanField

Scan only

Outputs

Output

Output Type

Notes

Load member lists log

File

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

General failure

2

Error

Invalid credentials

3

Error

Invalid HFM application

7

Error

Invalid file path

Load Metadata

Loads metadata to HFM

Inputs

Input

Type

Detail

Notes

Application

TextField

HFM application

File

FileField

File to be loaded to HFM

File format

DropdownField

Load file format

Delimiter

TextField

Delimiter in file to load

Check integrity

BooleanField

Check integrity of metadata

Clear before loading

BooleanField

Clear metadata before loading

Replace mode

BooleanField

Replace mode

Load system accounts

BooleanField

Load system accounts

Load ICPs

BooleanField

Load ICPs

Load values

BooleanField

Load values

Load currencies

BooleanField

Load currencies

Load accounts

BooleanField

Load accounts

Load entities

BooleanField

Load entities

Load scenarios

BooleanField

Load scenarios

Load application settings

BooleanField

Load application settings

Load consolidation methods

BooleanField

Load consolidation methods

Load custom dimensions

ArrayField

Specify a list of custom dimensions to load.

Scan only

BooleanField

Scan the metadata file without loading it into the application

Outputs

Output

Output Type

Notes

Load metadata log file

File

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

General failure

2

Error

Invalid credentials

3

Error

Invalid HFM application

7

Error

Invalid file path

Load Rules

Loads rules to HFM

Inputs

Input

Type

Detail

Notes

Application

TextField

HFM application

File

FileField

File to load to HFM

Scan only

BooleanField

Scan only

Check integrity

BooleanField

Check integrity of rules file to be uploaed

Outputs

Output

Output Type

Notes

Load rules log

File

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

General failure

2

Error

Invalid credentials

3

Error

Invalid HFM application

7

Error

Invalid file path

Load Security

Loads security file to HFM

Inputs

Input

Type

Detail

Notes

Application

TextField

HFM application

File

FileField

File to. load to HFM

Delimiter

TextField

Delimiter of the file to be loaded

Clear before loading

BooleanField

Clears security before loading

Load users and groups

BooleanField

Load users and groups

Load security classes

BooleanField

Load security classes

Load role access

BooleanField

Load role access

Load security class access

BooleanField

Load security class access

Validate users

BooleanField

Validate users

Outputs

Output

Output Type

Notes

Load security log

File

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

General failure

2

Error

Invalid credentials

3

Error

Invalid HFM application

7

Error

Invalid file path

Logoff Users

Logs off all non-administrator HFM users

Inputs

Input

Type

Detail

Notes

Application

TextField

HFM application

Outputs

None

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

General failure

2

Error

Invalid credentials

3

Error

Invalid HFM application

Open Period

Opens a period in HFM

Inputs

Input

Type

Detail

Notes

Application

TextField

HFM application

Scenario

TextField

Scenario member

Year

TextField

Year member

Period

TextField

Period member

Outputs

None

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

General failure

2

Error

Invalid credentials

3

Error

Invalid HFM application

4

Error

Invalid member

Stop Task

Stops a running task given a task ID

Inputs

Input

Type

Detail

Notes

Application

TextField

HFM application

Task ID

TextField

ID of running task

Outputs

None

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

General failure

2

Error

Invalid credentials

3

Error

Invalid HFM application

Translate

Invokes the HFM FX translation rules based upon the options provided

Inputs

Input

Type

Detail

Notes

Application

TextField

HFM application

Scenario

TextField

Scenario member

Year

TextField

Year member

Entity

TextField

Entity member

Start period

TextField

Start period member

End period

TextField

End period member

Value

TextField

Value member

Force

BooleanField

Forces translate

Outputs

None

Exit Codes

Code

Type

Detail

0

Success

Command completed successfully

1

Error

General failure

2

Error

Invalid credentials

3

Error

Invalid HFM application

4

Error

Invalid member

Did this answer your question?