To connect to Oracle® Hyperion Financial Management (HFM) versions 11.1.2.4.x or 11.2.x as part of a chain, such as to automate administrative functions, add a step that includes an Oracle Hyperion Financial Management connection command.
To enable these commands, an IT admin creates an Oracle Hyperion Financial Management connector.
Allocate
To invoke HFM allocation rules, add an Allocate command.
Properties
| Property |
Detail |
| Application |
Enter the HFM application. |
| Scenario |
Enter the scenario member. |
| Year |
Enter the year member. |
| Entity |
Enter the entity member. |
| Start period |
Enter the start period member. |
| End period |
Enter the end period member. |
| Value |
Enter the value member. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
General failure |
| 2 |
Error |
Invalid credentials |
| 3 |
Error |
Invalid HFM application |
| 4 |
Error |
Invalid member |
Clear slice
To clear a slice of data, add a Clear Slice command.
Properties
| Property |
Detail |
| Application |
Enter the HFM application. |
| Config file |
Enter configuration file, in accordance with the specifications below. |
| Display members |
To display all members from the config file in the output, check this box. |
| Expand only |
To expand members without executing the command, such as for testing, check this box. |
| Clear rates and system data |
To clear rates and system data, check this box. |
| Enable detailed logging |
To enable detailed logging, check this box. |
Configuration file
To set the focus area for the Clear Slice command, Config file requires an Oracle HFM Point-of-View (POV) that includes:
- Scenario
- Year
- Period
- Entity
- Account
Each line must be in this format: [DATA_SUBSET],<DIMENSION>,<ELEMENT >,<EXPANSION FUNCTION>. For example:
[DATA_SUBSET],SCENARIO,"Actual",[MEMBER]
[DATA_SUBSET],YEAR,"2005",[MEMBER]
[DATA_SUBSET],PERIOD,January,[MEMBER]
[DATA_SUBSET],ENTITY,"ItalySales",[MEMBER]
[DATA_SUBSET],ACCOUNT,"TotalRevenues",[BASE]
You can reference multiple elements per line, and use multiple lines per dimension. Any overlapping spaces are automatically combined and included in the focus area.
You can use these expansion functions, where I includes the referenced member:
| Expansion function |
Element |
| [DESCENDANTS] or [IDESCENDANTS] |
Member |
| [CHILDREN] or [ICHILDREN] |
Member |
| [ANCESTORS] or [IANCESTORS] |
Member |
| [PARENTS] or [IPARENTS] |
Member |
| [MEMBER] |
HFM member |
| [BASE] |
Not used |
| [MEMBERLIST] |
HFM member list |
| [ALLMEMBERS] |
Not used |
Outputs
| Output |
Output type |
| Clear data log |
File |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
General failure |
| 2 |
Error |
Invalid credentials |
| 3 |
Error |
Invalid HFM application |
| 4 |
Error |
Invalid member |
| 5 |
Error |
Invalid configuration file |
Close period
To close a period in HFM, add a Close Period command.
Properties
| Property |
Detail |
| Application |
Enter the HFM application. |
| Scenario |
Enter the scenario member. |
| Year |
Enter the year member. |
| Period |
Enter the period member. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
General failure |
| 2 |
Error |
Invalid credentials |
| 3 |
Error |
Invalid HFM application |
| 4 |
Error |
Invalid member |
Consolidate
To invoke HFM consolidation rules, add a Consolidate command.
Properties
| Property |
Detail |
| Application |
Enter the HFM application. |
| Consolidation type |
Select the type of consolidation to perform. |
| Scenario |
Enter the scenario member. |
| Year |
Enter the year member. |
| Entity |
Enter the entity member. |
| Start period |
Enter the start period member. |
| End period |
Enter the end period member. |
Outputs
| Output |
Output type |
| Consolidate log |
File |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
General failure |
| 2 |
Error |
Invalid credentials |
| 3 |
Error |
Invalid HFM application |
| 4 |
Error |
Invalid member |
Copy data
To copy a slice of data in HFM, add a Copy Data command.
Properties
| Property |
Detail |
| Application |
Enter the HFM application. |
| Update mode |
Select the update mode. |
| Config file |
Enter the configuration file to specify which data to copy, in accordance with the specifications below. |
| View |
Enter the HFM view. |
| Scale factor |
Enter the scale factor as a number with a decimal. |
| Display members |
To expand members from the configuration file and print them to the command's output log, check this box. |
| Expand only |
To expand members from the configuration file without executing the command, such as for testing, check this box. |
| Copy derived data |
To copy derived data, check this box. |
| Copy rates and system data |
To copy rates and system data, check this box. |
| Detailed logging |
To enable detailed logging, check this box. |
Configuration file
To set the focus area for the Copy Data command, Config file requires an Oracle HFM POV that includes at least one reference to these dimensions:
| Dimension |
Type |
| SCENARIO |
[SOURCE] or [TARGET] |
| YEAR |
[SOURCE] or [TARGET] |
| PERIOD |
[SOURCE] or [TARGET] |
| ACCOUNT |
[DATA_SUBSET] |
| ENTITY |
[DATA_SUBSET] |
For the SCENARIO, YEAR, and PERIOD dimensions, specify the [SOURCE] or [TARGET] POV, such as:
[SOURCE],<DIMENSION>,<ELEMENT>,[MEMBER]
[TARGET],<DIMENSION>,<ELEMENT>,[MEMBER]
The ENTITY and ACCOUNT dimensions must be in this format:
[DATA_SUBSET],<DIMENSION>,<ELEMENT>,<EXPANSION FUNCTION>
For example:
[SOURCE],SCENARIO,"Actual",[MEMBER]
[SOURCE],YEAR,"2005",[MEMBER]
[SOURCE],PERIOD,January,[MEMBER]
[TARGET],SCENARIO,"Actual",[MEMBER]
[TARGET],YEAR,"1999",[MEMBER]
[TARGET],PERIOD,January,[MEMBER]
[DATA_SUBSET],ENTITY,"ItalySales",[MEMBER]
[DATA_SUBSET],ACCOUNT,"TotalRevenues",[BASE]
You can reference multiple elements per line, and use multiple lines per dimension. Any overlapping spaces are automatically combined and included in the focus area.
You can use these expansion functions, where I includes the referenced member:
| Expansion function |
Dimension supported |
| [DESCENDANTS] or [IDESCENDANTS] |
Entity and Account |
| [CHILDREN] or [ICHILDREN] |
Entity and Account |
| [ANCESTORS] or [IANCESTORS] |
Entity and Account |
| [PARENTS] or [IPARENTS] |
Entity and Account |
| [MEMBER] |
All |
| [BASE] |
Entity and Account |
| [MEMBERLIST] |
Entity and Account |
| [ALLMEMBERS] |
Entity and Account |
Outputs
| Output |
Output type |
| Copy data log |
File |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 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
To delete a target star schema based on the DSN and table prefix, add a Delete Star Schema command.
Properties
| Property |
Detail |
| Application |
Enter the HFM application. |
| DSN |
Enter the data source name (DSN). |
| Table prefix |
Enter the table prefix. |
| Database type |
Select the type of database—Oracle, SQL Server®, or IBM DB2®. |
| Database name |
Enter the name of the database. |
| Database password |
Enter the password for the database. |
| Database host |
Enter the database host. |
| Database port |
Enter the database port. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
General failure |
| 2 |
Error |
Invalid credentials |
| 3 |
Error |
Invalid HFM application |
| 6 |
Error |
Invalid DSN |
Disable connections
To disable connections for all non-administrator HFM users, add a Disable Connections command.
Properties
| Property |
Detail |
| Application |
Enter the HFM application. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
General failure |
| 2 |
Error |
Invalid credentials |
| 3 |
Error |
Invalid HFM application |
Enable connections
To enable connections for all non-administrator HFM users, add an Enable Connections command.
Properties
| Property |
Detail |
| Application |
Enter the HFM application. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
General failure |
| 2 |
Error |
Invalid credentials |
| 3 |
Error |
Invalid HFM application |
Extract data to database
To extract data from HFM—based on parameters that define a multidimensional space—to a database, add an Extract Data to Database command.
Properties
| Property |
Detail |
| Application |
Enter the HFM application. |
| Config file |
Enter the path to the configuration file, in accordance with the specifications below. |
| Extract format |
Select the star schema format to extract:
- Standard, to extract the data as a standard Essbase schema, including a central
FACT table, one table per dimension, and separate dimension tables for ENTITY and PARENT. In a Standard extract, children repeat in a dimension's table each time they appear under a new parent in the source hierarchy.
Note: For base data and parent adjustment, join ParentID in the ENTITY table with ID in the PARENT table.
- All Metadata or Selected Metadata, to extract only metadata as a standard Essbase schema. For only metadata for selected dimension members, select Selected Metadata.
- SQL Aggregation, to extract aggregate data as a SQL and Essbase schema.
- Essbase, to extract data as a SQL and Essbase schema, including a central
FACT table, a PARENT table, and separate tables and second BASE table for each dimension. The BASE table lists the members under each parent in the dimension.
- Warehouse, to extract data as a warehouse-normalized hierarchy schema, including a central
FACT table and separate tables and second PARENT table for each dimension. A dimension's PARENT table contains its parent/child information.
Note: With a Warehouse extract, you can join the FACT table with a dimension table without creating duplicates as with a Standard extract.
|
| Line item option |
Select the level of detail per line item. |
| Display members |
To output the members of each dimension during extraction, check this box. |
| Expand only |
To show members without performing the extraction, such as for testing, check this box. |
| Table prefix |
Enter the table prefix. Required regardless of where data is extracted. |
| DSN |
Enter the destination DSN. |
| Database type |
Select the type of database used for the extraction—Oracle, SQL Server, or IBM DB2. |
| Database name |
Enter the name of database to extract to. |
| Database user |
Enter the database user. |
| Database password |
Enter the database password. |
| Database host |
Enter the database host. |
| Database port |
Enter the database port. |
| Schema actions |
Select the schema actions for extraction. |
| Include phased group data |
To include phased group data, check this box. |
| Extract dynamic data |
To extract dynamic data, check this box. |
| Extract derived data |
To extract derived data, check this box. |
| Extract calculated data |
To extract calculated data, check this box. |
| Include cell description |
To include cell descriptions, check this box. |
Configuration file
To set the focus area for the Extract Data to Database command, Config file requires a full Oracle HFM POV that includes all dimensional elements:
- SCENARIO
- YEAR
- PERIOD
- VIEW
- ENTITY
- ACCOUNT
- VALUE
- ICP
- ALL CUSTOM DIMENSIONS
Each line must be in the [DATA_SUBSET],<DIMENSION>,<ELEMENT>,<EXPANSION FUNCTION> format. For example:
[DATA_SUBSET],SCENARIO,"Actual",[MEMBER]
[DATA_SUBSET],YEAR,"2005",[MEMBER]
[DATA_SUBSET],PERIOD,January,[MEMBER]
[DATA_SUBSET],VIEW,Periodic,[MEMBER]
[DATA_SUBSET],ENTITY,"ItalySales",[MEMBER]
[DATA_SUBSET],ACCOUNT,"TotalRevenues",[BASE]
[DATA_SUBSET],ACCOUNT,"TotalAssets",[BASE]
[DATA_SUBSET],VALUE,"",[MEMBER]
[DATA_SUBSET],ICP,"[ICP None]",[MEMBER]
[DATA_SUBSET],Product,"TotalProducts",[BASE]
[DATA_SUBSET],Customers,"TotalCustomers",[BASE]
[DATA_SUBSET],Channel,"TotalC3",[BASE]
[DATA_SUBSET],UnitsFlows,"ClosingBalance",[BASE]
You can reference multiple elements per line, and use multiple lines per dimension. Any overlapping spaces are automatically combined and included in the focus area.
You can use these expansion functions, where I includes the referenced member:
| Expansion function |
Element |
| [DESCENDANTS] or [IDESCENDANTS] |
Member |
| [CHILDREN] or [ICHILDREN] |
Member |
| [ANCESTORS] or [IANCESTORS] |
Member |
| [PARENTS] or [IPARENTS] |
Member |
| [MEMBER] |
HFM member |
| [BASE] |
Not used |
| [MEMBERLIST] |
HFM member list |
| [ALLMEMBERS] |
Not used |
Outputs
| Output |
Output type |
| Extract to database log |
File |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 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
To extract data from HFM—based on parameters that define a multidimensional space—to a flat file, add an Extract Data to File command.
Properties
| Property |
Detail |
| Application |
Enter the HFM application. |
| Config file |
Enter the path to the configuration file, in accordance with the specifications below. |
| Output file |
Enter the file to extract the data to. To use the output file in subsequent commands, leave blank. |
| File prefix |
Enter the prefix to use for the extract file (optional). Defaults to the Application input. |
| Extract format |
Select whether to extract a header with the flat file. |
| Delimiter |
Enter the delimiter of the data to extract. |
| Line item option |
Select the level of detail per line item. |
| Display members |
To output the members of each dimension during extraction, check this box. |
| Expand only |
To show members without performing the extraction, such as for testing, check this box. |
| Extract calculated data |
To extract calculated data, check this box. |
| Extract derived data |
To extract derived data, check this box. |
| Extract dynamic data |
To extract dynamic data, check this box. |
| Include phased group data |
To include phased group data, check this box. |
| Include cell description |
To include cell descriptions, check this box. |
Configuration file
To set the focus for the Extract Data to File command, Config file requires a full Oracle HFM POV that includes at least one reference to these dimensions:
- SCENARIO
- YEAR
- PERIOD
- ACCOUNT
- ENTITY
- VALUE
- VIEW
- ICP
- ALL CUSTOM DIMENSION
Each line must be in the [DATA_SUBSET],<DIMENSION>,<ELEMENT>,<EXPANSION FUNCTION> format. For example:
[DATA_SUBSET],SCENARIO,"Actual",[MEMBER]
[DATA_SUBSET],YEAR,"2005",[MEMBER]
[DATA_SUBSET],PERIOD,January,[MEMBER]
[DATA_SUBSET],VIEW,Periodic,[MEMBER]
[DATA_SUBSET],ENTITY,"ItalySales",[MEMBER]
[DATA_SUBSET],ACCOUNT,"TotalRevenues",[BASE]
[DATA_SUBSET],ACCOUNT,"TotalAssets",[BASE]
[DATA_SUBSET],VALUE,"",[MEMBER]
[DATA_SUBSET],ICP,"[ICP None]",[MEMBER]
[DATA_SUBSET],Product,"TotalProducts",[BASE]
[DATA_SUBSET],Customers,"TotalCustomers",[BASE]
[DATA_SUBSET],Channel,"TotalC3",[BASE]
[DATA_SUBSET],UnitsFlows,"ClosingBalance",[BASE]
You can reference multiple elements per line, and use multiple lines per dimension. Any overlapping spaces are automatically combined and included in the focus area.
You can use these expansion functions, where I includes the referenced member:
| Expansion function |
Element |
| [DESCENDANTS] or [IDESCENDANTS] |
Member |
| [CHILDREN] or [ICHILDREN] |
Member |
| [ANCESTORS] or [IANCESTORS] |
Member |
| [PARENTS] or [IPARENTS] |
Member |
| [MEMBER] |
HFM member |
| [BASE] |
Not used |
| [MEMBERLIST] |
HFM member list |
| [ALLMEMBERS] |
Not used |
Outputs
| Output |
Output type |
| Extract data log |
File |
| Extract data file |
File |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
General failure |
| 2 |
Error |
Invalid credentials |
| 3 |
Error |
Invalid HFM application |
| 4 |
Error |
Invalid member |
| 5 |
Error |
Invalid configuration |
Extract journals
To extract HFM journals based on the combination of scenario, year, and period, add an Extract Journals command.
Properties
| Property |
Detail |
| Application |
Enter the HFM application. |
| Scenario |
Enter the scenario member. |
| Year |
Enter the year member. |
| Period |
Enter the period member. |
| File |
Enter the path to where to store the file (optional). |
| Delimiter |
Enter the delimiter for the export file. |
| Extract template |
To extract the template, check this box. |
| Extract recurring template |
To extract the recurring template, check this box. |
Outputs
| Output |
Output Type |
| Journals file |
File |
| Journals log file |
File |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 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
To extract HFM member lists to a file, add an Extract Member Lists command.
Properties
| Property |
Detail |
| Application |
Enter the HFM application. |
| File |
Enter the path to where to store the file (optional). |
Outputs
| Output |
Output type |
| Lists file |
File |
| Lists log file |
File |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
General failure |
| 2 |
Error |
Invalid credentials |
| 3 |
Error |
Invalid HFM application |
| 4 |
Error |
Invalid member |
| 7 |
Error |
Invalid file path |
Extract metadata
To extract HFM metadata controlled by dimension, add an Extract Metadata command.
Properties
| Property |
Detail |
| Application |
Enter the HFM application. |
| File |
Enter the path to where to store the file (optional). |
| Delimiter |
Enter the delimiter for the export file. |
| File format |
Select the export file format. |
| Extract system accounts |
To extract the system accounts, check this box. |
| Extract ICPs |
To extract intercompany partners (ICPs), check this box. |
| Extract values |
To extract values, check this box. |
| Extract currencies |
To extract currencies, check this box. |
| Extract accounts |
To extract accounts, check this box. |
| Extract entities |
To extract entities, check this box. |
| Extract scenarios |
To extract scenarios, check this box. |
| Extract application settings |
To extract application settings, check this box. |
| Extract consolidation methods |
To extract consolidation methods, check this box. |
| Extract custom dimensions |
List the custom dimensions to extract. |
Outputs
| Output |
Output type |
| Metadata file |
File |
| Metadata log file |
File |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
General failure |
| 2 |
Error |
Invalid credentials |
| 3 |
Error |
Invalid HFM application |
| 4 |
Error |
Invalid member |
| 7 |
Error |
Invalid file path |
Extract rules
To extract HFM business logic rules, add an Extract Rules command.
Properties
| Property |
Detail |
| Application |
Enter the HFM application. |
| File |
Enter the path to where to store the file (optional). |
| File format |
Select the format of the file to extract. |
Outputs
| Output |
Output type |
| Rules file |
File |
| Rules log file |
File |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
General failure |
| 2 |
Error |
Invalid credentials |
| 3 |
Error |
Invalid HFM application |
| 4 |
Error |
Invalid member |
| 7 |
Error |
Invalid file path |
Extract security
To extract HFM security in the HFM native format, add an Extract Security command.
Properties
| Property |
Detail |
| Application |
Enter the HFM application. |
| File |
Enter the path to where to store the file (optional). |
| Delimiter |
Enter the delimiter for the export file. |
| Extract users and groups |
To extract users and groups, check this box. |
| Extract security classes |
To extract security classes, check this box. |
| Extract role access |
To extract role access, check this box. |
| Extract security class access |
To extract security class access, check this box. |
Outputs
| Output |
Output type |
| Security file |
File |
| Security log file |
File |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
General failure |
| 2 |
Error |
Invalid credentials |
| 3 |
Error |
Invalid HFM application |
| 7 |
Error |
Invalid file path |
Load data
To load data to HFM, add a Load Data command.
Properties
| Property |
Detail |
| Application |
Enter the HFM application. |
| File |
Enter the data file to load to HFM. |
| File format |
Select the format of the file to load to HFM. |
| Load mode |
Select how to handle duplicate data in the file. |
| Delimiter |
Select the delimiter of the file used to load data. |
| Log append |
To append logs when loading data, check this box. |
| Scan only |
To perform scan only, without loading data, check this box. |
| Accumulated |
To accumulate within the file, check this box. |
| Contains shares data |
If the file includes shares data, check this box. |
Outputs
| Output |
Output type |
| Load data log |
File |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
General failure |
| 2 |
Error |
Invalid credentials |
| 3 |
Error |
Invalid HFM application |
| 7 |
Error |
Invalid file path |
Load journals
To load journals to HFM, add a Load Journals command.
Properties
| Property |
Detail |
| Application |
Enter the HFM application. |
| File |
Enter the data file to load to HFM. |
| File format |
Select the format of the file to load to HFM. |
| Delimiter |
Select the delimiter of the file used to load data. |
Outputs
| Output |
Output type |
| Load journals log |
File |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 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
To load member lists to HFM, add a Load Member Lists command.
Properties
| Property |
Detail |
| Application |
Enter the HFM application. |
| File |
Enter the data file to load to HFM. |
| Scan only |
To perform scan only, without loading data, check this box. |
Outputs
| Output |
Output type |
| Load member lists log |
File |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
General failure |
| 2 |
Error |
Invalid credentials |
| 3 |
Error |
Invalid HFM application |
| 7 |
Error |
Invalid file path |
Load metadata
To load metadata to HFM, add a Load Metadata command.
Properties
| Property |
Detail |
| Application |
Enter the HFM application. |
| File |
Enter the data file to load to HFM. |
| File format |
Select the format of the file to load to HFM. |
| Delimiter |
Enter the delimiter of the file used to load data. |
| Check integrity |
To check the integrity of the metadata, check this box. |
| Check before loading |
To clear metadata before loading, check this box. |
| Pre-scan |
To pre-scan the metadata, check this box. |
| Replace mode |
To replace mode, check this box. |
| Load system accounts |
To load system accounts, check this box. |
| Load ICPs |
To load intercompany partners (ICPs), check this box. |
| Load values |
To load values, check this box. |
| Load currencies |
To load currencies, check this box. |
| Load accounts |
To load accounts, check this box. |
| Load entities |
To load entities, check this box. |
| Load scenarios |
To load scenarios, check this box. |
| Load application settings |
To load application settings, check this box. |
| Load consolidation methods |
To load consolidation methods, check this box. |
| Load custom dimensions |
List the custom dimensions to load. |
Outputs
| Output |
Output type |
| Load metadata log file |
File |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
General failure |
| 2 |
Error |
Invalid credentials |
| 3 |
Error |
Invalid HFM application |
| 7 |
Error |
Invalid file path |
Load rules
To load rules to HFM, add a Load Rules command.
Properties
| Property |
Detail |
| Application |
Enter the HFM application. |
| File |
Enter the data file to load to HFM. |
| Scan only |
To perform scan only, without loading data, check this box. |
| Check integrity |
To check the integrity of rules file to upload, check this box. |
Outputs
| Output |
Output type |
| Load rules log file |
File |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
General failure |
| 2 |
Error |
Invalid credentials |
| 3 |
Error |
Invalid HFM application |
| 7 |
Error |
Invalid file path |
Load security
To load a security file to HFM, add a Load Security command.
Properties
| Property |
Detail |
| Application |
Enter the HFM application. |
| File |
Enter the data file to load to HFM. |
| Delimiter |
Enter the delimiter of the file to load. |
| Clear before loading |
To clear security before loading, check this box. |
| Load Users and Groups |
To load users and groups, check this box. |
| Load security classes |
To load security classes, check this box. |
| Load role access |
To load role access, check this box. |
| Load security class access |
To load security class access, check this box. |
| Validate users |
To validate users, check this box. |
Outputs
| Output |
Output type |
| Load security log |
File |
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
General failure |
| 2 |
Error |
Invalid credentials |
| 3 |
Error |
Invalid HFM application |
| 7 |
Error |
Invalid file path |
Logoff users
To log off all non-administrator HFM users, add a Logoff Users command.
Properties
| Property |
Detail |
| Application |
Enter the HFM application. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
General failure |
| 2 |
Error |
Invalid credentials |
| 3 |
Error |
Invalid HFM application |
Open period
To open a period in HFM, add an Open Period command.
Properties
| Property |
Detail |
| Application |
Enter the HFM application. |
| Scenario |
Enter the scenario member. |
| Year |
Enter the year member. |
| Period |
Enter the period member. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
General failure |
| 2 |
Error |
Invalid credentials |
| 3 |
Error |
Invalid HFM application |
| 4 |
Error |
Invalid member |
Stop task
To stop a running task based on its ID, add a Stop Task command.
Properties
| Property |
Detail |
| Application |
Enter the HFM application. |
| Task ID |
Enter ID of the running task. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
General failure |
| 2 |
Error |
Invalid credentials |
| 3 |
Error |
Invalid HFM application |
Translate
To invoke the HFM FX translation rules based on the options provided, add a Translate command.
Properties
| Property |
Detail |
| Application |
Enter the HFM application. |
| Scenario |
Enter the scenario member. |
| Year |
Enter the year member. |
| Entity |
Enter the entity member. |
| Start period |
Enter the start period member. |
| End period |
Enter the end period member. |
| Value |
Enter the value member. |
| Force |
To force translate, check this box. |
Outputs
None
Exit codes
| Code |
Type |
Detail |
| 0 |
Success |
Success |
| 1 |
Error |
General failure |
| 2 |
Error |
Invalid credentials |
| 3 |
Error |
Invalid HFM application |
| 4 |
Error |
Invalid member |
Related articles