JHAT in HFM

Automation with JHAT

Overview

Adapted from: https://neonn.com/alwayson/using-jhat-automate-hfm-tasks/

The JHAT tool is another way to automatize tasks using a batch file and the HFM API. JHAT offers the opportunity to use any scheduler to launch HFM tasks and provide a better flexibility than Task Flows.

How does it work?

JHAT utility is present in the path hereunder:

E:\Oracle\Middleware\EPMSystem11R1\products\FinancialManagement\Server\jhat.bat

The batch file embeds all libraries, paths and other references to execute HFM tasks.

Before the first run, it’ mandatory to create setenv.cmd file and set the parameter EPM_ORACLE_INSTANCE_FOR_JHAT to point to the EPM instance:

JHAT usage

A text file provides the tasks to be executed against HFM. Basically, the structure of the file is as below:

Logon()
OpenApplication()
SetPOV()
Consolidate() '(or other HFM function)'
CloseApplication()
Logout()

Example:

In most cases, you will need to call the `Logon`, `OpenApplication`, `CloseApplication` and `Logout` commands as part of the script execution.

Certain commands will necessitate running the `SetPOV` command.

The JHAT API is not fully documented by Oracle. Commands used are based on examples from others.

You only have to provide the file previously create as argument and call the utility to run the task:

jhat.bat -I E:\JHAT\test.txt

Use jhat.bat -H command to explore the available options:

This utility can be used to launch consolidations, data load, data extraction, etc...

JHAT Commands: Administration

Overview

These JHAT Commands will deal with administration of HFM

Commands

DeleteFilteredDataAuditRecords

Delete Data Audit Records based on POV

Input

Parameter	Mandatory	Comment
User Name	✓	User Name
POV String	✓	POV String

Example

DeleteFilteredDataAuditRecords("User Name","POV String");

DeleteFilteredTaskAuditRecords

Delete Filtered Task Audit Records

Input

Parameter	Mandatory	Comment
UserName	✓	UserName
Task Name	✓	Task Name `Task` `ALL`

Example

DeleteFilteredTaskAuditRecords("UserName","Task|ALL");

GetLatestTaskAuditAttachment

Get the Last Audit Attachment

Input

Parameter	Mandatory	Comment
UserName	✓	UserName
Task Name	✓	Task Name `Task` `ALL`
Output File Path		Path to store the Audit Attachment

Example

GetLatestTaskAuditAttachment("UserName","Task|ALL","");

FilterTaskAudit

Filter the task audit and export to file

Input

Parameter	Mandatory	Comment
UserName	✓	UserName
Task Name	✓	Task Name `Task` `ALL`
Output File Path		Path to store the audit

Example

FilterTaskAudit("UserName","Task|ALL","");

GetTaskAudit

Get All Task Audit Records

Input

Parameter	Mandatory	Comment
Output File Path	✓	Path to store the audit

Example

GetTaskAudit("C:\TaskAudit\task.txt");

FilterDataAudit

Filter the Data Audit Records

Input

Parameter	Mandatory	Comment
User Name	✓	User Name
POV String	✓	POV String
Output File Path		Path to store the audit

Example

FilterDataAudit("User Name","POV String","<output>");</output>

GetDataAudit

Get the data audit records and store them in a file

Input

Parameter	Mandatory	Comment
Output File Path	✓	Path to store the audit

Example

GetDataAudit("<Output File Path>");

JHAT Commands: Application

Overview

These JHAT Commands will handle the application.

Commands

SetPOV / SetPOVName

Sets the Point of View (POV) for the commands to follow.

Input

Parameter	Mandatory	Comment
Scenario	✓	Scenario
Year	✓	Year
Period	✓	Period Should be a base
View	✓	View
Entity	✓	Entity Can use member lists
Value	✓	Value
Account	✓	Account
ICP	✓	Intercompany Partner
Custom 1	✓	Custom 1
Custom 2	✓	Custom 2
Custom 3	✓	Custom 3
Custom 4	✓	Custom 4

Example

SetPOV("ACTatACIFRS","2023","DEC","YTD","TGROUP","<Entity Currency>","TOTNI","[ICP Top]","TOTC1","TOTC2","TOTC3","TOTC4");

SetPOVExtDim

Sets the Point of View (POV) for the commands to follow.

Input

Parameter	Mandatory	Comment
POV	✓	Point of View in String Syntax e.g `S#ACTatACIFRS.E#TGROUPCONT.Y#2023.P#DEC`
Member Display Type	✓	Whether you are providing the ID of the member or the name. SHOWIDS SHOWNAMES

Example

SetPOVExtDim("S#ACTatACIFRS.Y#2023.P#DEC.W#YTD.E#TGROUP.V#<Entity Currency>.A#TOTNI.I#[ICP Top].C1#TOTC1.C2#TOTC2.C3#TOTC3.C4#TOTC4","SHOWNAMES");

Logon

Logs into HFM based on the environment you are in.

Input

Parameter	Mandatory	Comment
Unused		Does not appear to be used but should be True or False
Domain		Login Domain
Username	✓	Login User Name
Password	✓	Login Password

Example

Logon("false", "", "user", "password");

Logout

Logs out of HFM

Input

None

Example

Logout();

DeleteApplication

Deletes the Application from the Server

Be careful when running this command.

Input

Parameter	Mandatory	Comment
Server	✓	Server or Cluster to run the command
Application	✓	Application to be deleted.

Example

DeleteApplication("Server","Application");

CreateApplicationExtDim

Creates an Application on the Server

Be careful when running this command.

Input

Parameter	Mandatory	Comment
Server	✓	Server or Cluster to run the command
Application	✓	Application to be created.
Application Description	✓	Description of the Application
Profile File	✓	Path to Profile File Creating a Profile File: [https://docs.oracle.com/cd/E57185\_01/HFMAD/ch02s04.html](https://docs.oracle.com/cd/E57185_01/HFMAD/ch02s04.html)
Local Storage	✓	Where the application should be stored
Project Name	✓	Project Name
Web URL	✓	URL to App
Application Type	✓	Type of Application: `STANDARD_CONSOL` (Consolidation app) `TAX_PROV` (Tax App)

Example

CreateApplicationExtDim("Server","Application","ApplicationDescription","ProfilePath","StorageFolder","ProjectName","http://myServer:80/HFM","6");

OpenApplication

Opens the specified application

Input

Parameter	Mandatory	Comment
Cluster	✓	Cluster or Server to Open Application On
Application	✓	Application to Open

Example

OpenApplication("Cluster","Application");

CloseApplication

Closes application that was opened in the session

Input

None

Example

CloseApplication();

shutdownApplication

Shuts down the application on all the Jhsxserver instances across all the clusters and servers.

Be careful when running this command.

Input

Parameter	Mandatory	Comment
Application	✓	Application to be shutdown.

Example

shutdownApplication("Application");

deleteAllApplications

Deletes all registered applications

Be careful when running this command.

Input

Parameter	Mandatory	Comment
Server	✓	Server to delete applications on

Example

DeleteAllApplications("Server");

CopyApplication

Copies one application to another

Be careful when running this command.

Input

Parameter	Mandatory	Comment
Source Application	✓	The application to copy from
Target Application	✓	The new application
Application Description	✓	New application description
Cluster	✓	Cluster to copy application on
Project Name	✓	Project Name
Copy Audit Tables	✓	Copy the audit tables? `true` `false`
Copy Data Tables	✓	Copy the data tables? `true` `false`

Example

CopyApplication("Original Application Name", "New Application Name", "Application Description", "Cluster","Project Name", "Copy Audit Tables", "Copy Data Tables");

SetPreferences

Sets Preferences of Application

Be careful when running this command.

Input

Parameter	Mandatory	Comment
Application	✓	Application to set preferences on
Cluster	✓	Cluster to set preferences on
Language	✓	Language Preference `English` `French` `German` `Italian` `Japanese`
Decimal Character	✓	Decimal Preference
Thousands Character	✓	Thousands delimiter
Save in Unicode Format	✓	Save in Unicode `true` `false`
Use Doc Manager as Default	✓	Open Document Manager by Default `true` `false`

Example

SetPreferences("Application Name", "Cluster","Language", "Decimal Character", "Thousands Character", "Save in Unicode format", "Use DocManager as default Page");

GetPreferences

Gets the preferences of an application and writes them to an output file

Be careful when running this command.

Input

Parameter	Mandatory	Comment
Application	✓	Application to set preferences on
Cluster	✓	Cluster to set preferences on
Output File Path	✓	Path to output file

Example

GetPreferences("Application Name", "Cluster","Output File Path");

ModifyApplication

[Modify the application](https://docs.oracle.com/cd/E57185_01/OHFMA/help_modifyapp.htm#OHFMA-applications_508)

Be careful when running this command.

Input

Parameter	Mandatory	Comment
Application	✓	Application to set preferences on
Cluster	✓	Cluster to set preferences on
Number of Years	✓	Number of years the application should have from beginning
Enable Process Control	✓	Enable Process Control `true` `false`
Enable Manage Ownership	✓	Enable Manage Ownership `true` `false`
Enable Journals	✓	Enable Journals `true` `false`
Enable Data Management	✓	Enable Data Management `true` `false`
Enable Task Audit	✓	Enable Task Audit `true` `false`
Enable Intercompany Transactions	✓	Enable Intercompany Transactions `true` `false`
Enable Equity Pickup	✓	Enable Equity Pickup `true` `false`

Example

ModifyApplication("Application Name","Cluster Name", "No Of Years", "EnableProcessControl", "EnableManageOwnership","EnableJournals", "EnableDataManagement", "EnableAuditTasks", "EnableIntercompanyTransactions", "EnableEquityPickUp");

JHAT Commands: Data Form

Overview

These commands are related to the Data Form

Commands

GetForm

Get the data form and save it to an output file in HTML format.

Input

Parameter	Mandatory	Comment
Path in document manager	✓	Path in Document Manager where Form is located
Form Name	✓	Form Name to Get
Output File	✓	Output file
Use the user POV	✓	Use the user POV `true` Use POV set by `SetPOV` `false` Use the POV defined in the form
Suppress Row Header Repeats	✓	Suppress Row Header Repeats `true` `false`
Suppress NoData Rows	✓	Suppress NoData Rows `true` `false`
Suppress Invalid Rows	✓	Suppress Invalid Rows `true` `false`
Suppress Column Header Repeats	✓	Suppress Column Header Repeats `true` `false`
Suppress NoData Column	✓	Suppress NoData Column `true` `false`
Suppress Invalid Column	✓	Suppress Invalid Column `true` `false`

Example

GetForm("Path in the document manager", "Form name", "Out file", "Use the user POV", "Supress row header repeats", "Supress NoData Rows", "Supress Zero Rows","Supress Invalid Rows", "Supress column header repeats", "Supress No data Columns", "Supress zero columns", "Supress Invalid Columns");

ExecuteOnDemandRule

Execute an On Demand Rule based on Set POV

Input

Parameter	Mandatory	Comment
Rule Name	✓	On Demand Rule to Execute Must be a valid Rule Uses POV set by `SetPOV`

Example

ExecuteOnDemandRule("RuleName");

JHAT Commands: Data Grid

Overview

These JHAT Commands relate to the data grid.

Data grids are a powerful feature in HFM (Hyperion Financial Management) that allow users to view and manipulate financial data in a flexible and dynamic manner. Essentially, a data grid is a spreadsheet-like interface that displays financial data organized by dimensions such as time, accounts, entities, and scenarios.

With data grids in HFM, users can perform a range of tasks such as entering, editing, and aggregating data, performing calculations and consolidations, and exporting data for analysis or reporting. They can also customize the appearance and behavior of the data grid by selecting columns, filtering data, and applying formatting options.

Data grids in HFM offer several benefits for financial reporting and analysis. They provide a highly interactive and user-friendly interface for accessing and manipulating financial data, which can improve efficiency and accuracy in financial reporting processes. They also allow for real-time data analysis and scenario planning, which can help organizations to make informed financial decisions and respond quickly to changes in the business environment.

Overall, data grids are an essential tool for any organization using HFM for financial management and reporting, providing a powerful and flexible way to manage financial data and support effective decision-making.

Commands

DefineGrid

The define Grid Command will set up a grid with a POV that can be used in later commands.

Should call `SetPOV` prior to running this function to set up the rest of the POV.

Input

Parameter	Mandatory	Comment
Row Dimension	✓	Row Dimension
Row List	✓	Row List
Row Top Member	✓	Row Top Member
Column Dimension	✓	Column Dimension
Column List	✓	Column List
Column Top Member	✓	Column Top Member

Example

DefineGrid("Row Dimension"," Row List"," Row Top Member"," Column Dimension"," Column List"," Column Top Member");
DefineGrid("Account","[Hierarchy]","","Period","[Hierarchy]","");

DefineGridExtDim / DefineDataRetrieval

Defines a Grid by passing in Rows and Dimensions. The grid can be used in later commands.

Both commands appear to call the same API codes.

Should call `SetPOV` prior to running this function to set up the rest of the POV.

Input

Parameter	Mandatory	Comment
Row Dimensions	✓	Row Dimensions
Column Dimensions	✓	Column Dimensions

Example

DefineGridExtDim("Account","ICP");
DefineDataRetrieval("Account","ICP");

GetGrid

Extract a previously defined grid to a flat file.

Must run `SetPOV` and `DefineGrid` prior to running this command.

Input

Parameter	Mandatory	Comment
Output File	✓	Location to store the output file
Type of Extract	✓	Type of Extract `VALUE` - Values in Grid `STATUS` - Calculation Status `NOTHING` - Returns how many rows would be retrieved. `DROID` - Unknown `CALCSTATUS` - Calculation Status `PROCESS` - Process Level `STATUSHEX` - Cell Status in Hex
Direction to Extract	✓	Direction of Extract `UP` - If number of rows to extract is set, it will start from the top. `DOWN` - If number of rows to extract is set, it will start from the bottom. `ALL` - Will start from the top.
Number of Rows To Extract	✓	Number of Rows To Extract

Example

GetGrid("Output File"," Type of Extract"," Direction to Extract"," Number of Rows To Extract");

GetGridExtDim / GetCellsExtDim

Extract a previously defined grid to a flat file.

Both commands call the same Java code.

Must run `SetPOV` and `DefineGrid` prior to running this command.

Input

Parameter	Mandatory	Comment
Output File	✓	Location to store the output file
Type of Extract	✓	Type of Extract `VALUE` - Values in Grid `STATUS` - Calculation Status `NOTHING` - Returns how many rows would be retrieved. `DROID` - Unknown `CALCSTATUS` - Calculation Status `PROCESS` - Process Level `STATUSHEX` - Cell Status in Hex

Example

GetGridExtDim("<Output File Path>", "<Type of Extract>");

SetCell

Sets the value of a Cell based on a POV. Cell will have to be inputable.

Must run `SetPOV` prior to running this command.

Input

Parameter	Mandatory	Comment
Value	✓	Value

Example

SetCell("999999");

GetCell

Gets the value of a Cell based on a POV.

Must run `SetPOV` prior to running this command.

Input

None

Example

GetCell();

Returns the following information to the log:

Displayed Data
Full Resolution data
Stored data
Calculation status
Cell status

GetCellInfo

Gets the Cell Info and Outputs it to the log.

Must run `SetPOV` prior to running this command.

Input

None

Example

GetCellInfo();

Returns the following information to the log:

---- Point of view ----
Process Unit
POV Detail
View
Phase
Account Calculation Attribute
---- Status ----
Calculation status
Process Level
Cell status
Cell security class
---- Data ----
Scale
Num Decimals
Displayed Data
Full Resolution data
Stored data

Lock

Runs the [Lock](https://docs.oracle.com/cd/E57185_01/HFMUR/ch04s09.html) command on the selected POV

Must run `SetPOV` prior to running this command.

Input

None

Example

Lock();

Unlock

Runs the [Unlock](https://docs.oracle.com/cd/E57185_01/HFMUR/ch04s10.html) command on the selected POV

Must run `SetPOV` prior to running this command.

Input

None

Example

Unlock();

Translate

Runs the [Translate](https://docs.oracle.com/cd/E57185_01/HFMUR/ch05s05.html) command on the selected POV

Must run `SetPOV` prior to running this command.

Input

None

Example

Translate();

Allocate

Runs the [Allocate](https://docs.oracle.com/cd/E57185_01/HFMUR/ch04s07.html) command on the selected POV

Must run `SetPOV` prior to running this command.

Input

None

Example

Allocate();

Consolidate

Runs the [Consolidate](https://docs.oracle.com/cd/E57185_01/HFMUR/ch05s07.html) command based on the `SetPOV`.

Must run `SetPOV` prior to running this command.

Input

Parameter	Mandatory	Comment
Consolidation Type	✓	The type of consolidation to run: `Impacted` `AllWithData` `All` `EntityOnly` (Calculate Contribution) `ForceEntityOnly` (Force Calculate Contribution)

Example

Consolidate("Impacted");

ChartLogic

Runs the [Calculate](https://docs.oracle.com/cd/E57185_01/HFMUR/ch05s04.html) command based on the `SetPOV`.

Must run `SetPOV` prior to running this command.

Input

Parameter	Mandatory	Comment
Force Calculate	✓	Force Calculate `true` `false`

Example

ChartLogic("true");

SetCellTextEnhanced

Sets the cell text for an intersection.

Must run `SetPOV` prior to running this command.

Input

Parameter	Mandatory	Comment
Cell label	✓	Cell label
Text for the label	✓	Text for the label

Example

SetCellTextEnhanced("Cell label"," Text for the label");

deleteCellTextEnhanced

Deletes Cell Text for an Intersection

Must run `SetPOV` prior to running this command.

Input

Parameter	Mandatory	Comment
Cell label	✓	Cell label
What to Delete	✓	What to Delete: `All` `Text` `Attachments`

Example

deleteCellTextEnhanced("Cell label"," All or Text or Attachments;");

DetachCellDocument

Removes a document from the Cell

Must run `SetPOV` prior to running this command.

Input

Parameter	Mandatory	Comment
Cell label	✓	Cell label
File Name	✓	File Name

Example

DetachCellDocument("Cell Text Label","File Name");

AttachCellDocumentEnhanced \\ AttachCellDocument

Attach a document to the Cell

Must run `SetPOV` prior to running this command.

Input

Parameter	Mandatory	Comment
Cell label	✓	Cell label
File Name	✓	File Name
Full Directory from Manage Documents	✓	Full Directory from Manage Documents

Example

AttachCellDocumentEnhanced("<Cell Text Label>", "<File name>", "<Full Directory from Manage Documents>");
AttachCellDocument("<Cell Text Label>", "<File name with Full Directory>");

GetCellTextAttachmentsEnhanced

Get Cell Text Attachments

Input

Parameter	Mandatory	Comment
Cell label	✓	Cell label
Full Path to File Name	✓	Full Path to File Name

Example

GetCellTextAttachmentsEnhanced("<Cell Text Label or All>", "<Full Path to File Name>");

GetCellTextEnhanced

Get Cell Text Attachments

Input

Parameter	Mandatory	Comment
Cell label	✓	Cell label
Full Path to File Name	✓	Full Path to File Name

Example

GetCellTextEnhanced("<Cell Text Label or All>", "<Full Path to File Name>");

LockICEntity

Locks an entity for a given scenario, year, and period.

Input

Parameter	Mandatory	Comment
Scenario	✓	Scenario
Year	✓	Year
Period	✓	Period
Entity	✓	Entity

Example

LockICEntity("Scenario"," Year"," Period"," Entity");

UnlockICEntity

Unlocks an entity for a given scenario, year, and period.

Input

Parameter	Mandatory	Comment
Scenario	✓	Scenario
Year	✓	Year
Period	✓	Period
Entity	✓	Entity

Example

UnlockICEntity("Scenario"," Year"," Period"," Entity");

GetCellHistory

Gets the history of an intersection.

Must run `SetPOV` prior to running this command.

Input

Parameter	Mandatory	Comment
File Path	✓	Output file path

Example

GetCellHistory("output file path");

GetCellEntityDetails

Gets the Cell Entity Details

Must run `SetPOV` prior to running this command.

Input

Parameter	Mandatory	Comment
File Path	✓	Output file path

Example

GetCellEntityDetails("output file path");

GetProcessControlGrid

Output the process control grid to a file.

Must run `SetPOV` prior to running this command.

Input

Parameter	Mandatory	Comment
Output File	✓	File to output the Grid to
Type of Extract	✓	Type of Extract `VALUE` - Values in Grid `STATUS` - Calculation Status `NOTHING` - Returns how many rows would be retrieved. `DROID` - Unknown `CALCSTATUS` - Calculation Status `PROCESS` - Process Level `STATUSHEX` - Cell Status in Hex
Direction to Extract	✓	Direction of Extract `UP` - If number of rows to extract is set, it will start from the top. `DOWN` - If number of rows to extract is set, it will start from the bottom. `ALL` - Will start from the top.
Number of Rows To Extract	✓	Number of Rows To Extract

Example

GetProcessControlGrid("Output File"," Type of Extract"," Direction to Extract"," Number of Rows To Extract");

GetSourceTransactions

Returns information on source transactions for a cell in a statutory application.

Must run `SetPOV` prior to running this command.

The following information is returned:

Header information, such as the dimension members that define the cell, the current username, the cell’s data, and so on. This information is returned in two arrays that have a one-to-one correspondence; one array contains labels for the header information, the other contains the values that correspond to the labels.
Detailed information on the transactions, such as the dimension members and data for the transactions. This information is contained in several arrays; the arrays contain one item per transaction, and have a one-to-one correspondence.
The sums of the cell’s source and destination transaction amounts.

Input

Parameter	Mandatory	Comment
Output File Path	✓	Output File Path

Example

GetSourceTransactions("Output File Path");

GetDestinationTransactions

Returns information on destination transactions for a cell in a statutory application.

Must run `SetPOV` prior to running this command.

The following information is returned:

Header information, such as the dimension members that define the cell, the current username, the cell’s data, and so on. This information is returned in two arrays that have a one-to-one correspondence; one array contains labels for the header information, the other contains the values that correspond to the labels.
Detailed information on the transactions, such as the dimension members and data for the transactions. This information is contained in several arrays; the arrays contain one item per transaction and have a one-to-one correspondence.
The sums of the cell’s source and destination transaction amounts.

Input

Parameter	Mandatory	Comment
Output File Path	✓	Output File Path

Example

GetDestinationTransactions("Output File Path");

GetLineItemDetail

In the Entity Detail Report, the option to display line item detail is only applicable for the scenario and account defined to use line item detail. Line item detail information is available only for the Entity Currency Value dimension.

Must run `SetPOV` prior to running this command.

Input

Parameter	Mandatory	Comment
Output File Path	✓	Output File Path

Example

GetLineItemDetail("Output File Path");

SetLineItemDetail

Line item detail enables you to collect detailed information about accounts. This function sets the detail

Input

Parameter	Mandatory	Comment
POV Item List Number	✓	POV Item List Number
Cell Values Item List Number	✓	Cell Values Item List Number
Description	✓	Description

Example

SetLineItemDetail("POV ITem List Number","Cell Values Item List Number","Description");

FilterProcessControlGrid

Export Process Control Grid based on a Filter

Input

Parameter	Mandatory	Comment
Output File Name	✓	Output File Name
Type of Extract	✓	Type of Extract `VALUE` - Values in Grid `STATUS` - Calculation Status `NOTHING` - Returns how many rows would be retrieved. `DROID` - Unknown `CALCSTATUS` - Calculation Status `PROCESS` - Process Level `STATUSHEX` - Cell Status in Hex
Direction to Extract	✓	Direction of Extract `UP` - If number of rows to extract is set, it will start from the top. `DOWN` - If number of rows to extract is set, it will start from the bottom. `ALL` - Will start from the top.
Number of Rows To Extract	✓	Number of Rows To Extract
Phase	✓	Phase to filter on All 1 2 3 etc
Review Level	✓	Review Level to filter on `ALL` `NOT STARTED` `FIRST PASS` `LEVEL 1` `LEVEL 2` `LEVEL 3` `LEVEL 4` `LEVEL 5` `LEVEL 6` `LEVEL 7` `LEVEL 8` `LEVEL 9` `LEVEL 10` `SUBMITTED` `APPROVED` `PUBLISHED`
Range	✓	Range `ALL` `AND ABOVE` `AND BELOW` `ONLY`
Show Pass/Fail	✓	Show Pass/Fail `PASS AND FAIL` `PASS ONLY` `FAIL ONLY`
Status	✓	Status `NODATA` `OK` `OK SC` `CH` `CN` `TR` `OK ND` `CH ND` `CN ND` `TR ND` `LOCKED` `ALL`
Data View	✓	Data View `Value` `Translation` `Contribution`
SORT	✓	SORT `Ascending` `Descending`

Example

FilterProcessControlGrid("Output File Name"," Type of Extract"," Direction to Extract"," Number of Rows To Extract"," Phase"," Review Level","Range"," Show Pass/Fail"," Status"," Data View"," SORT");

DisplayProcessControlGrid

Output the Process Control Grid

Input

Parameter	Mandatory	Comment
Output File Name	✓	Output File Name
Type of Extract	✓	Type of Extract `VALUE` - Values in Grid `STATUS` - Calculation Status `NOTHING` - Returns how many rows would be retrieved. `DROID` - Unknown `CALCSTATUS` - Calculation Status `PROCESS` - Process Level `STATUSHEX` - Cell Status in Hex
Direction to Extract	✓	Direction of Extract `UP` - If number of rows to extract is set, it will start from the top. `DOWN` - If number of rows to extract is set, it will start from the bottom. `ALL` - Will start from the top.
Number of Rows To Extract	✓	Number of Rows To Extract
Data View	✓	Data View `Value` `Translation` `Contribution`
Style	✓	Style `Tree` `<Blank>` (Default)
Entity View	✓	Entity View `Label` `Description` `Both`
Active	✓	Active `Y` `N`
Period View	✓	Period View `All` Single
Review Level Columns	✓	Review Level Columns. Multiple selections can be comma delimited. `REVIEW` `PASS` `VALIDATION`
Status Columns	✓	Status Columns `CALC` `JOURNAL`
PhasesALL \| Phase Number	✓	Phases Multiple selections can be comma delimited. `ALL` `1` `2` `3`

Example

DisplayProcessControlGrid("File Name"," Type of Extract"," Direction to Extract"," Number of Rows To Extract"," Data View"," Style"," Entity View"," ActiveY|N"," Period View "," Review Level Columns"," Status Columns"," PhasesALL | Phase Number");

GetReviewLevelSummary

Output the Review Level Summary to a file.

Must run `SetPOV` and `DefineGrid` prior to running this command.

Input

Parameter	Mandatory	Comment
Output File Name	✓	Output File Name

Example

GetReviewLevelSummary("File Name");

GetCalcStatusSummary

Output Calculation Status Summary which shows the number of entities at each status.

Must run `SetPOV` and `DefineGrid` prior to running this command.

Input

Parameter	Mandatory	Comment
Output File Name	✓	Output File Name
DATA VIEW	✓	Data View `Value` `Translation` `Contribution`

Example

GetCalcStatusSummary("File Name","DATA VIEW");

GetValidationAccountInfo

Get information on Validation Account

Input

Parameter	Mandatory	Comment
POV	✓	Point of View
Phase	✓	Phase Number
Data View	✓	Data View `Value` `Translation` `Contribution`
Suppress Zero	✓	Suppress Zero `true` `false`
Suppress NODATA	✓	Suppress NODATA `true` `false`
Formatted Data	✓	Formatted Data `true` `false`
OUTPUT file path	✓	OUTPUT file path

Example

GetValidationAccountInfo("POV"," PHASE NO."," DATA VIEW"," Suppress ZEROs"," Suppress NODATA"," Formatted Data"," OUTPUT file path");

GetCellStatus

Get the Cell Status

Input

None

Example

GetCellStatus("");

JHAT Commands: Documents

Overview

These JHAT Commands are related to document management

Commands

EnumDocuments

Get a list of all the documents in a defined path

Input

Parameter	Mandatory	Comment
Path	✓	Path
Document Type	✓	Document Type
Document File type	✓	Document File type
Show Private	✓	Show Private
Output File Path	✓	Output File Path

Example

EnumDocuments(" Path"," Document Type"," Document File type"," Show Private"," Output File Path");

EnumTasksUnderTaskList

Get a List of all tasks under a task list

Input

Parameter	Mandatory	Comment
Path	✓	Path
TaskList Name	✓	TaskList Name
OutFile	✓	OutFile

Example

EnumTasksUnderTaskList("Path"," TaskList Name"," OutFile");

DeleteDocument

Delete a document

Input

Parameter	Mandatory	Comment
Doc name	✓	Doc name
Doc Type	✓	Doc Type
File Type	✓	File Type
Folder	✓	Folder

Example

DeleteDocument("Doc name"," Doc Type"," File Type"," Folder");

CreateTaskList

Create a Task List

Input

Parameter	Mandatory	Comment
name	✓	name
Description	✓	Description
Security Class	✓	Security Class
isPrivate	✓	isPrivate
Overwrite	✓	Overwrite
Location	✓	Location

Example

CreateTaskList("name"," Description"," Security Class"," isPrivate"," Overwrite"," Location");

AddTaskToTaskList

Add Task to a Task List

Input

Parameter	Mandatory	Comment
task list name	✓	task list name
task list path	✓	task list path
doc name	✓	doc name
doc path	✓	doc path
doc type	✓	doc type
file type	✓	file type
overWrite	✓	overWrite

Example

AddTaskToTaskList("task list name "," task list path"," doc name"," doc path"," doc type"," file type"," overWrite");

DeleteTaskFromTaskList

Delete a task from the task list

Input

Parameter	Mandatory	Comment
task list name	✓	task list name
task list path	✓	task list path
doc name	✓	doc name
doc path	✓	doc path
doc type	✓	doc type
file type	✓	file type
overWrite	✓	overWrite

Example

DeleteTaskFromTaskList("task list name "," task list path"," doc name"," doc path"," doc type"," file type"," overWrite");

JHAT Commands: EPU

Overview

These JHAT commands are related to Equity Pickup

Equity pickup (EPU) functionality enables you to revaluate the investments owned by a holding company. The purpose of the reevaluation is to adjust the investments in the Balance Sheet of the holding company to reflect the current value of the corresponding share in the equity of the subsidiary. The underlying principle of the equity pickup adjustment is to provide a fair picture of the value of the portfolio owned by the holding company.

Like most assets, investments are presented in the Balance Sheet at their historical cost. Investment amounts reflect acquisition prices. However, due to profit or loss incurred in the subsidiary since the acquisition, historical cost may differ from the actual value of the investment owned. In the case of a subsidiary in a foreign country, exchange currency fluctuations may also affect the value of the investment when translated into the holding company's currency. Equity pickup adjustments account for this difference.

An equity pickup adjustment replaces the historical cost with the actual value of the equity owned. In this respect, equity pickup is similar to the equity method in statutory consolidation.

Equity pickup adjustments are made in the local currency of the holding company, before any consolidation of this holding into the group. These adjustments belong to the holding company, independently from any ultimate parent entity.

For each company owned, the adjustment is expressed as follows:

Direct Ownership Percentage * Equity of Owned Entity
= Current Equity Value
- Investment
= Equity Pickup Adjustment

Commands

FilterEPUGrid

Filter an EPU Grid

Input

Parameter	Mandatory	Comment
“Scenario”	✓	“Scenario”
”Year”	✓	”Year”
“Period”	✓	“Period”
“Owner”	✓	“Owner”
“Owned”	✓	“Owned”
“Circular Ownership”	✓	“Circular Ownership”
“Status”	✓	“Status”
“ShowCombination”	✓	“ShowCombination”
“Column Display Type”	✓	“Column Display Type”
“No of decimals”	✓	“No of decimals”
“%EPU comparator”	✓	“%EPU comparator”
“%EPU”	✓	“%EPU”
“Min Level”	✓	“Min Level”
“Max Level”	✓	“Max Level”
“OutputFilePath”	✓	“OutputFilePath”

Example

FilterEPUGrid("“Scenario”","”Year”","“Period”","“Owner”","“Owned”","“Circular Ownership”","“Status”","“ShowCombination”","“Column Display Type”","“No of decimals”","“%EPU comparator”","“%EPU”","“Min Level”","“Max Level”","“OutputFilePath”");

CalcEPU

Calculate an EPU Grid

Input

Parameter	Mandatory	Comment
Run/Force for type of EPU;	✓	Run/Force for type of EPU;

Example

CalcEPU("Run/Force for type of EPU;"," ");

GenerateEPUReport

Generate an EPU Report

Input

Parameter	Mandatory	Comment
“POV”	✓	“POV”
”HFM\_FORMAT”	✓	”HFM\_FORMAT”
“OutputFilePath”	✓	“OutputFilePath”

Example

GenerateEPUReport("“POV”","”HFM_FORMAT”","“OutputFilePath”");

GenerateFilteredEPUReport

Generate a Filtered EPU Report

Input

Parameter	Mandatory	Comment
“POV”	✓	“POV”
”HFM\_FORMAT”	✓	”HFM\_FORMAT”
“Owner”	✓	“Owner”
“Owned”	✓	“Owned”
“Circular Ownership”	✓	“Circular Ownership”
“Status”	✓	“Status”
“ShowCombination”	✓	“ShowCombination”
“OutputFilePath”	✓	“OutputFilePath”

Example

GenerateFilteredEPUReport("“POV”","”HFM_FORMAT”","“Owner”","“Owned”","“Circular Ownership”","“Status”","“ShowCombination”","“OutputFilePath”");

JHAT Commands: Extracts

Overview

These JHAT commands are related to extracting data from HFM

Commands

InitLists

Initializes a list that can be attached to an extract

Input

Parameter	Mandatory	Comment
InitLists	✓	InitLists

Example

InitLists();

ClearList

Clear List

Input

Parameter	Mandatory	Comment
List to Clear	✓	Select Which List to Clear

Example

ClearList("List to Clear");

AddItemsToListFromMemberlist

Add Item to List from Member List

Input

Parameter	Mandatory	Comment
List	✓	Numeric Value of the List
Dimension	✓	Which Dimension
List	✓	List
Parent Name	✓	Parent Name

Example

AddItemsToListFromMemberlist("9","Entity"," [Descendants]"," Regional; ");

AddItemToList

Add item to a list

Input

Parameter	Mandatory	Comment
List	✓	Numeric Value of the List
Value	✓	Value
List	✓	List

Example

AddItemToList("1","Value"," [elimination]");

ExtractMetaData

Extract Metadata from HFM

Input

Parameter	Mandatory	Comment
Output File Name	✓	Output File Name
Output Log	✓	Output Log
Delimiter	✓	Delimiter `;` `,`
Extract Currencies	✓	Extract Currencies `true` `false`
Extract Scenarios	✓	Extract Scenarios `true` `false`
Extract Entities	✓	Extract Entities `true` `false`
Extract Accounts	✓	Extract Accounts `true` `false`
Extract Custom 1	✓	Extract Custom 1 `true` `false`
Extract Custom 2	✓	Extract Custom 2 `true` `false`
Extract Custom 3	✓	Extract Custom 3 `true` `false`
Extract Custom 4	✓	Extract Custom 4 `true` `false`
Extract Consolidation Methods	✓	Extract Consolidation Methods `true` `false`
Extract App Settings	✓	Extract App Settings `true` `false`
Extract System Accounts	✓	Extract System Accounts `true` `false`
Extract Values	✓	Extract Values `true` `false`
Extract ICPs	✓	Extract ICPs `true` `false`
Extract Cell Text Labels	✓	Extract Cell Text Labels `true` `false`

Example

ExtractMetaData("C:hfmoutboxMetadata__HFM2.04.app"," C:hfmoutboxMetadataExtract.log"," ;"," true"," true"," false"," false"," false"," false"," true"," false"," false"," true","true","true","true"," true");

ExtractMetaDataExtDim

Extracting Metadata from HFM

Input

Parameter	Mandatory	Comment
File Name	✓	Extract File Name
Log File Name	✓	Log File Name
Delimiter	✓	Delimiter
Dimensions to Extract	✓	Dimensions to Extract delimited by period
Extract Currencies	✓	Extract Currencies `true` `false`
Extract Application Settings	✓	Extract Application Settings `true` `false`
Extract Consolidation Methods	✓	Extract Consolidation Methods `true` `false`
Extract System Accounts	✓	Extract System Accounts `true` `false`
Extract Cell Label Texts	✓	Extract Cell Label Texts `true` `false`

Example

ExtractMetaDataExtDim("<Extract filename>", "<Log filename>", "<Delimiter>", "<DimensionsToExtract>", "<ExtractCurrencies>", "<Extract AppSettings>", "<ExtractConsolMethods>", "<Extract SystemAccounts>", "<cell text labels>");

ExtractData

Extracting Data from HFM

Input

Parameter	Mandatory	Comment
File Name	✓	Extract File Name
Log	✓	Log File
Delimiter	✓	Delimiter `,` `;`
View	✓	View
Year	✓	Year
Scenario	✓	Scenario
Period	✓	Period `All` Use Add item to List
Entity	✓	Entity `All` Use Add item to List
Account	✓	Account `All` Use Add item to List
Inclue Calculated Data	✓	Include Calculated Data `true` `false`

Example

ExtractData("d:\\Data_Extract.txt", "d:\\Data_Extract.log", ";", "YTD", "2021", "Actual", "6", "7", "8", "true");

EAExtract

Extended Analytics (to table) Extract

Input

DSN Name	✓	DSN Name
Table Prefix	✓	Table Prefix
Aggregate Option	✓	Aggregate Option
Filter Dynamic Accounts	✓	Filter Dynamic Accounts
Scenario	✓	Scenario
Year	✓	Year
Period List	✓	Period List
View List	✓	View List
Entity List	✓	Entity List
Value List	✓	Value List
Account List	✓	Account List
ICP List	✓	ICP List
Custom 1	✓	Custom 1
Custom 2	✓	Custom 2
Custom 3	✓	Custom 3
Custom 4	✓	Custom 4

Example

EAExtract("DSN Name","Table prefix","Aggregate option","Filter dynamic accoutns", "Scenario","Year", "Period list", "View List","Entity list", "Value list", "Account list", "ICP list", "custom 1", "Cusom 2", "Custom 3", "Custom 4");

ExtractPhaseInfo

Extract information about the Phases

Input

Parameter	Mandatory	Comment
Export File	✓	Export File Path
Log File	✓	Log File Path
Delimiter	✓	Delmiter

Example

ExtractPhaseInfo("c:VoyagerData_Extract.dat"," c:VoyagerData_Extract.log","; ");

ExtractSecurity

Extract Security Information

Input

Parameter	Mandatory	Comment
Security File	✓	Path to Security File
Log File	✓	Path to Log File

Example

ExtractSecurity("c:VoyagerSecurity_Extract.sec","c:VoyagerSecurity_Extract.log");

ExtractSecurityExpanded

Extract Security

Input

Parameter	Mandatory	Comment
Security File	✓	Path to Security File
Log File	✓	Path to Log File

Example

ExtractSecurityExpanded("c:VoyagerSecurity_Extract.sec","c:VoyagerSecurity_Extract.log");

ExtractJournal

Extract Journal Entries

Input

Parameter	Mandatory	Comment
Export File	✓	Path to Export File
Log File	✓	Path to Log File
Extract Standard	✓	Extract Standard `true` `false`
Extract Recurring	✓	Extract Recurring `true` `false`
Extract Regular	✓	Extract Regular `true` `false`
Scenario	✓	Scenario
Year	✓	Year
Period	✓	Period
Delimiter	✓	Delimiter

Example

ExtractJournal("Journal File"," Log File","Extract Standard","Extract Recurring", "Extract Regular","Scenario","Year","Period","Delmiter");

ExtractJournalPlus

Extract Journals Plus

Must Use `AddItemsToListFromMemberlist` function for Dimension parameters.

Input

Parameter	Mandatory	Comment
File Name	✓	Path to Export File
Log File	✓	Path to Log File
Extract Standard	✓	Extract Standard `true` `false`
Extract Recurring	✓	Extract Recurring `true` `false`
Extract Regular	✓	Extract Regular `true` `false`
Scenario	✓	Scenario
Year	✓	Year
Period	✓	Periods `All` `JAN` `FEB` `MAR` etc
Entity	✓	Entity `All` Valid Member List
Value	✓	Value `All` Valid Member List
Labels	✓	Labels Multiple can be delmited by `;`
Groups	✓	Groups Multiple can be delmited by `;`
Include `Working` Status?	✓	Include `Working` Status? `true` `false`
Include `Submitted` Status?	✓	Include `Submitted` Status? `true` `false`
Include `Approved` Status?	✓	Include `Approved` Status? `true` `false`
Include `Rejected` Status?	✓	Include `Rejected` Status? `true` `false`
Include `Posted` Status?	✓	Include `Posted` Status? `true` `false`
Include `Regular`?	✓	Include `Regular`? `true` `false`
Include `Auto Reversing`?	✓	Include `Auto Reversing`? `true` `false`
Include `Auto Reversed`?	✓	Include `Auto Reversed`? `true` `false`
Include `Balanced`?	✓	Include `Balance`? `true` `false`
Include `Unbalanced`?	✓	Include `Unbalanced`? `true` `false`
Include `Balanced by Entity`?	✓	Include `Balanced by Entity`? `true` `false`
Delimiter	✓	Delimiter

Example

ExtractJournalPlus("File Name","Log File","Extract Standard","Extract Recurring","Extract Regular","Scenario","Year","Period","Entity","Value","Labels","Groups","Include Working Status?","Include Submitted Status?","Include Approved Status?","Include Rejected Status? ","Include Posted Status?","Include Regular?","Include Auto Reversing?","Include Auto Reversed?","Include Balanced?","Include Unbalanced?","Include Balanced by Entity?","Delimiter");

ExtractICTransactions

Extract Intercompany Transactions

Must Use `AddItemsToListFromMemberlist` function for Dimension parameters.

Input

Parameter	Mandatory	Comment
Extract File	✓	Path to Extract File
Scenario	✓	Scenario
Year	✓	Year
Period	✓	Period
Entity List	✓	Entity `All` Valid Member List
ICP List	✓	ICP `All` Valid Member List
Include `Unmatched` Transactions?	✓	Include `Unmatched` Transactions? `YES` `NO`
Include `Matched` Transactions?	✓	Include `Matched` Transactions? `YES` `NO`
Include `Mismatched` Transactions?	✓	Include `Mismatched` Transactions? `YES` `NO`
Include `Posted` Transactions?	✓	Include `Posted` Transactions? `YES` `NO`
Include `Unposted` Transactions?	✓	Include `Unposted` Transactions? `YES` `NO`
Include `Unmatched` Transactions?	✓	Include `Unmatched` Transactions? `YES` `NO`
Include `Reason Code`?	✓	Include `Reason Code`? `YES` `NO`
Transaction Currency	✓	Transaction Currency
Match Code	✓	Match Code

Example

ExtractICTransactions("Extract File","Scenario","Year","Period","Entity List","ICP List","Include Unmatched Transactions?","Include Matched Transactions?","Include Mismatched Transactions?","Include Posted Transactions?","Include Unposted Transactions?","Include Unmatched Transactions?","Include Reason Code?","Transaction Currency","Match Code");

ExtractRules

Extract Rules from HFM

Input

Parameter	Mandatory	Comment
Rule File Format	✓	Rule File Format `RLE` `XML`
Output File Path	✓	Output File Path
Log File Path	✓	Log File Path

Example

ExtractRules("Rule File Format","Output File","Log File");

ExtractMemberlists

Extract Member Lists from HFM

Input

Parameter	Mandatory	Comment
Output File	✓	Output File
Log File	✓	Log File

Example

ExtractMemberlists("Output File","Log File");

ExtractDataExtDim

Extract Data Extended

Input

Parameter	Mandatory	Comment
POV	✓	POV
Include `Header`?	✓	Include `Header`? `true` `false`
Include `Data`?	✓	Include `Data`? `true` `false`
Include `Dynamic Accounts`?	✓	Include `Dynamic Accounts`? `true` `false`
Include `Calc Data`?	✓	Include `Calc Data`? `true` `false`
Include `Derived Data`?	✓	Include `Derived Data`? `true` `false`
Line Item Details	✓	Line Item Details `<Blank>` (Exclude) `Individual` `Detail`
Include `Cell Text`?	✓	Include `Cell Text`? `true` `false`
Include `Phase Data`?	✓	Include `Phase Data`? `true` `false`
Delimiter	✓	Delimiter
Output File	✓	Output File
Log File	✓	Log File

Example

ExtractDataExtDim("POV","Include Header?","Include Data?","Include Dynamic Accounts?","Include Calc Data?","Include Derived Data?","Line Item Details","Include Cell Text?","Include Phase Data?","Delimiter","Output File","Log File");

ExtractDocument

Extract a Document from HFM

Input

Parameter	Mandatory	Comment
Document Name	✓	Document Name
Extract File	✓	Extract File
Document Type	✓	Document Type
File Type	✓	File Type
Folder	✓	Folder

Example

ExtractDocument("Document Name","Extract File","Document Type","File Type","Folder");

ExtractModuleConfiguration

Extract Module Configuration

Input

Parameter	Mandatory	Comment
Output File Path	✓	Output File Path
Log File Path	✓	Log File Path

Example

ExtractModuleConfiguration("Output File Path","Log File Path");

JHAT Commands: InterCompany

Overview

These JHAT commands will perform intercompany tasks

Commands

InitICTransactionList

Initialize Intercompany Transactions List

Input

None

Example

InitICTransactionList("");

AddICTransactionToList

Add Intercompany Transaction to List

Input

Parameter	Mandatory	Comment
POV	✓	Point of View
Transaction ID	✓	Transaction ID
Transaction Sub ID	✓	Transaction Sub ID

Example

AddICTransactionToList("S#ActMon.Y#2004.P#January.E#C.I#A.A#PayltIC.C1#Increases.C2#[None].C3#[None].C4#[None]","X785","S01");

OpenICPeriod

Open Intercompany Period

Input

Parameter	Mandatory	Comment
Scenario	✓	Scenario
Year	✓	Year
Label	✓	Label
MVPB	✓	MVPB `No` `Yes`
Account Tolerance	✓	Account Tolerance
Manual Tolerance	✓	Manual Tolerance
Tid Tolerance	✓	Tid Tolerance
Tid Percent	✓	Tid Percent

Example

OpenICPeriod("Actual","2000"," Quarter2"," “yes”","","","","");

UpdateICPeriod

Update Intercompany Period

Input

Parameter	Mandatory	Comment
Scenario	✓	Scenario
Year	✓	Year
Label	✓	Label
MVPB	✓	MVPB `No` `Yes`
Account Tolerance	✓	Account Tolerance
Manual Tolerance	✓	Manual Tolerance
Tid Tolerance	✓	Tid Tolerance
Tid Percent	✓	Tid Percent

Example

UpdateICPeriod("Actual","2000"," Quarter2"," “yes”","","","","");

ProcessAllICTransactions

Process All Intercompany Transactions

Input

Parameter	Mandatory	Comment
Process Action	✓	Action to perform on IC Transactions `Post` `UnPost` `Delete` `UnMatch`
Scenario	✓	Scenario
Year	✓	Year
Period	✓	Period

Example

ProcessAllICTransactions("Delete","ActMon","2004","January");

ProcessICTransaction

Process Intercompany Transaction

Input

Parameter	Mandatory	Comment
Process Action	✓	Action to perform on IC Transactions `Post` `UnPost` `Delete` `UnMatch`
Scenario	✓	Scenario
Year	✓	Year
Period	✓	Period

Example

ProcessICTransaction("Delete","Scenario","Year","Period");

ProcessICTransactions

Process Intercompany Transactions

Input

Parameter	Mandatory	Comment
Process Action	✓	Action to perform on IC Transactions `Post` `UnPost` `Delete` `UnMatch`
POV	✓	Point of View
Transaction ID	✓	Transaction ID
Transaction Sub ID	✓	Transaction Sub ID

Example

ProcessICTransactions("Delete","S#ActMon.Y#2004.P#January.E#C.I#A.A#PayltIC.C1#Increases.C2#[None].C3#[None].C4#[None]","X785","S01"," ");

CreateICTransaction

Create IC Transaction

Input

Parameter	Mandatory	Comment
POV	✓	Point of View
Transaction ID	✓	Transaction ID
Sub ID	✓	Sub ID
Reference ID	✓	Reference ID
Transaction Date	✓	Transaction Date
Transaction Currency	✓	Transaction Currency
Transaction Amount	✓	Transaction Amount
Entity Currency Amount	✓	Entity Currency Amount
Comment 1	✓	Comment 1
Comment 2	✓	Comment 2
Reason code	✓	Reason code
Conversion Rate	✓	Conversion Rate

Example

CreateICTransaction("S#ActMon.Y#2004.P#January.E#C.I#A.A#PayltIC.C1#Increases.C2#[None].C3#[None].C4#[None]","Trans id","Sub id"," Ref id","trans date"," trans currency"," trans amount"," entity currency amount"," commnet1 "," comment2","Reason code","Conversion Rate");

ICAutoMatchByID

Intercompany Auto Match by ID

Must Call `AddICTransactionToList` prior to calling this

Input

Parameter	Mandatory	Comment
Scenario	✓	Scenario
Year	✓	Year
Period	✓	Period
Entity List	✓	Entity List `All` Valid Entity List
ICP List	✓	ICP List `All` Valid ICP List
Transaction Currency	✓	no
Trans	✓	no
no	✓	no
Transaction	✓	Transaction
S12	✓	S12
Is Transaction Id	✓	Is Transaction Id
Transaction IDs	✓	Transaction IDs

Example

ICAutoMatchByID("ActMon","2004","January","1","2","no","no","no","Transaction","S12","S13","S15");

CloseICPeriod

Close Intercompany Period

Input

Parameter	Mandatory	Comment
Scenario	✓	Scenario
Year	✓	Year
Label	✓	Label

Example

CloseICPeriod("Actual","2000"," Quarter2");

ICAutoMatchByAccount

Intercompany Auto match by Account

Input

Parameter	Mandatory	Comment
Scenario	✓	Scenario
Year	✓	Year
Period	✓	Period
Entity List	✓	Entity List
ICP List	✓	ICP List
Transaction Currency	✓	Transaction Currency
no	✓	no
no	✓	no
Entity Accounts	✓	Entity Accounts
Parent Accounts	✓	Parent Accounts

Example

ICAutoMatchByAccount("ActMon","2004","January","1","2","no","no","no","","");

CreateReasonCode

Create Reason Code

Input

Parameter	Mandatory	Comment
Label	✓	Label
Description	✓	Description

Example

CreateReasonCode("Label","Description");

DeleteReasonCode

Delete Reason Code

Input

Parameter	Mandatory	Comment
Label	✓	Label

Example

DeleteReasonCode("Label");

DeleteAllReasonCodes

Delete All Reason Codes

Input

None

Example

DeleteAllReasonCodes("");

ListReasonCodes

List Reason Codes

Input

Parameter	Mandatory	Comment
File Path	✓	Output file path

Example

ListReasonCodes("File Path");

ListICPeriods

List Intercompany Periods

Input

Parameter	Mandatory	Comment
Scenario	✓	Scenario
Year	✓	Year
Output File	✓	Output File Path

Example

ListICPeriods("Scenario","Year","Output File");

GetICTransactions

Get Inter Company Transactions

Input

Parameter	Mandatory	Comment
Scenario	✓	Scenario
Year	✓	Year
Period	✓	Period
Output File	✓	Output File

Example

GetICTransactions("Scenario","Year","Period","Output File");

FilterICTransactions

Filter Intercompany Transactions

Input

Parameter	Mandatory	Comment
Scenario	✓	Scenario
Year	✓	Year
Period	✓	Period
Entity	✓	Entity
ICP	✓	ICP
Entity Account List	✓	Entity Account List
Partner Account	✓	Partner Account
Transaction ID	✓	Transaction ID
Transaction Sub ID	✓	Transaction Sub ID
Reference ID	✓	Reference ID
Amount From	✓	Amount From
Amount To	✓	Amount To
Reason Code	✓	Reason Code
Match Code	✓	Match Code
Transaction Currency	✓	Transaction Currency
Start Date	✓	Start Date
End Date	✓	End Date
Display Entity Transaction	✓	Display Entity Transaction
Display Partner Transaction	✓	Display Partner Transaction
Include Matched?	✓	Include Matched? `true` `false`
Include Unmatched?	✓	Include Unmatched? `true` `false`
Include Mismatched?	✓	Include Mismatched? `true` `false`
Include Posted?	✓	Include Posted? `true` `false`
Include Unposted?	✓	Include Unposted? `true` `false`
Output File	✓	Output File

Example

FilterICTransactions("ActMon","2012","January","Entity","ICP","Entity Account List","Partner Account","Trans ID","Trans SUB ID","Reference ID","Amount From","Amount to","Reason Code","Match Code","Trans Currency","Start date", "End Date", "Display entity trans", "Display partner trans", "include matched", "inlucded unmatched", "include mismatched", "include posted", "include unposted", "C:SourceJhatreportsgetICTTransactions.txt");

DisplayICTransactions

Display Intercompany Transactions

Input

Parameter	Mandatory	Comment
Scenario	✓	Scenario
Year	✓	Year
Period	✓	Period
Scale Factor	✓	Scale Factor
Decimal Override	✓	Decimal Override
Common Currency	✓	Common Currency
Display Option	✓	Display Option `Label` `Description` `Both`
Output File	✓	Output File

Example

DisplayICTransactions("Scenario","Year","Period","Scale Factor","Decimal Override","Common Currency","Display Option","Output File");

LockICEntity

Lock Intercompany Entity

Input

Parameter	Mandatory	Comment
Scenario	✓	Scenario
Year	✓	Year
Label	✓	Label
Entity String	✓	Entity String delimited by `,`

Example

LockICEntity("Actual","2000"," Quarter2","EastSales,China");

UnLockICEntity

Unlock Intercompany Entity

Input

Parameter	Mandatory	Comment
Scenario	✓	Scenario
Year	✓	Year
Label	✓	Label
Entity String	✓	Entity String delimited by `,`

Example

UnLockICEntity("Actual","2000"," Quarter2"," EastSales,China");

EditICTransaction

Edit Intercompany Transaction

Input

Parameter	Mandatory	Comment
POV	✓	POV
Transaction ID	✓	TID
Transaction SUB ID	✓	T Sub ID
List number which has field name to update	✓	List number which has field name to update
List number of which has corresponding values	✓	List number of which has corresponding values

Example

EditICTransaction("POV","TID"," T Sub ID"," List number wihcih has filed name to update"," List number of which has corresponding values");

CreateAutoMatchByIDTemplate

Create Auto Match By ID Template

Input

Parameter	Mandatory	Comment
name	✓	name
Description	✓	Description
Security Class	✓	Security Class
isPrivate	✓	isPrivate
Overwrite	✓	Overwrite
Location	✓	Location
POV	✓	POV
Entity	✓	Entity
ICP	✓	ICP
Currency	✓	Currency
ID Type	✓	ID Type
IDs	✓	IDs

Example

CreateAutoMatchByIDTemplate("name"," Description"," Security Class"," isPrivate"," Overwrite"," Location","POV","  Entity"," ICP"," Currency"," ID Type"," IDs");

CreateAutoMatchByAccountTemplate

Create Auto Match by Account Template

Input

Parameter	Mandatory	Comment
name	✓	name
Description	✓	Description
Security Class	✓	Security Class
isPrivate	✓	isPrivate
Overwrite	✓	Overwrite
Location	✓	Location
POV	✓	POV
Entity	✓	Entity
ICP	✓	ICP
Currency	✓	Currency
Accounts	✓	Accounts
Matching Accounts	✓	Matching Accounts

Example

CreateAutoMatchByAccountTemplate("name"," Description"," Security Class"," isPrivate"," Overwrite"," Location","POV","  Entity"," ICP"," Currency"," Accounts"," Matching Accounts");

ListMonitorIntercompany

List Monitor Intercompany

Input

Parameter	Mandatory	Comment
Scenario	✓	Scenario
Year	✓	Year
Label	✓	Label
Output File	✓	Output File

Example

ListMonitorIntercompany("Actual","2010"," Quarter1","C:SourceJhatreportsgetMonitorIntercompanyTranscations.txt");

ListMonitorIntercompanySummary

List Monitor Intercompany Cummary

Input

Parameter	Mandatory	Comment
Scenario	✓	Scenario
Year	✓	Year
Label	✓	Label
Output File	✓	Output File

Example

ListMonitorIntercompanySummary("Actual","2010"," Quarter1","C:SourceJhatreportsgetMonitorIntercompanyTranscations.txt");

FilterMonitorIntercompany

Filter Monitor Intercompany

Input

Parameter	Mandatory	Comment
Scenario	✓	Scenario
Year	✓	Year
Period	✓	Period
Entities	✓	String of Entities delimited by `;`
Output File	✓	Output File
Active	✓	Active `true` `false`
Process Status	✓	Process Status `Started` `Not Started`
Lock Status	✓	Lock Status `Lockable` `Not Lockable` `Locked`

Example

FilterMonitorIntercompany("Actual","2010"," Quarter1","","A;B;C;","C:SourceJhatreportsgetMonitorIntercompanyTranscations.txt"," ActiveTrue/false"," ProcessStatus"," LockStatus","");

JHAT Commands: Journals

Overview

These JHAT commands are related to Journal Entries

Commands

SubmitJournal

Submit Journal

Input

Parameter	Mandatory	Comment
Scenario	✓	Scenario
Year	✓	Year
Period	✓	Period
Journal Label	✓	Journal Label

Example

SubmitJournal("Scenario"," Year"," Period"," Journal Label");

ApproveJournal

Approve Journal

Input

Parameter	Mandatory	Comment
Scenario	✓	Scenario
Year	✓	Year
Period	✓	Period
Journal Label	✓	Journal Label

Example

ApproveJournal("Scenario"," Year"," Period"," Journal Label");

GetAdjustments

Get Adjustments

Input

None

Example

GetAdjustments("");

OpenPeriod

Open Period

Input

Parameter	Mandatory	Comment
Scenario	✓	Scenario
Year	✓	Year
Period	✓	Period

Example

OpenPeriod("Scenario"," Year"," Period");

ClosePeriod

Close Period

Input

Parameter	Mandatory	Comment
Scenario	✓	Scenario
Year	✓	Year
Period	✓	Period

Example

ClosePeriod("Scenario"," Year"," Period");

PostJournal

Post Journal

Input

Parameter	Mandatory	Comment
Scenario	✓	Scenario
Year	✓	Year
Period	✓	Period
Journal Label	✓	Journal Label

Example

PostJournal("Scenario"," Year"," Period"," Journal Label");

UnPostJournal

UnPost Journal

Input

Parameter	Mandatory	Comment
Scenario	✓	Scenario
Year	✓	Year
Period	✓	Period
Journal Label	✓	Journal Label

Example

UnPostJournal("Scenario"," Year"," Period"," Journal Label");

UnSubmitJournal

UnSubmit Journal

Input

Parameter	Mandatory	Comment
Scenario	✓	Scenario
Year	✓	Year
Period	✓	Period
Journal Label	✓	Journal Label

Example

UnSubmitJournal("Scenario"," Year"," Period"," Journal Label");

RejectJournal

Reject Journal

Input

Parameter	Mandatory	Comment
Scenario	✓	Scenario
Year	✓	Year
Period	✓	Period
Journal Label	✓	Journal Label

Example

RejectJournal("Scenario"," Year"," Period"," Journal Label");

DeleteJournal

Delete Journal

Input

Parameter	Mandatory	Comment
Scenario	✓	Scenario
Year	✓	Year
Period	✓	Period
Journal Label	✓	Journal Label

Example

DeleteJournal("Scenario"," Year"," Period"," Journal Label");

GetJournal

Get Journal

Input

Parameter	Mandatory	Comment
Scenario	✓	Scenario
Year	✓	Year
Period	✓	Period
Journal Label	✓	Journal Label

Example

GetJournal("Scenario"," Year"," Period"," Journal Label");

ScanJournal

Scan Journal

Input

Parameter	Mandatory	Comment
Scenario	✓	Scenario
Year	✓	Year
Period	✓	Period
Journal Label	✓	Journal Label

Example

ScanJournal("Scenario"," Year"," Period"," Journal Label");

ValidateJournalTemplatePOV

Validate Journal Template POV

Input

Parameter	Mandatory	Comment
POV String	✓	POV String

Example

ValidateJournalTemplatePOV("POV String");

GetTemplate

Get Template

Input

Parameter	Mandatory	Comment
Template Label	✓	Template Label

Example

GetTemplate("Template Label");

DeleteTemplate

Delete Template

Input

Parameter	Mandatory	Comment
Template Label	✓	Template Label

Example

DeleteTemplate("Template Label");

GenerateRecurringJournal

Generate Recurring Journal

Input

Parameter	Mandatory	Comment
POV	✓	POV
Type	✓	Type
BalanceType	✓	BalanceType
Label	✓	Label
Description	✓	Description
Group	✓	Group
SecurityClass	✓	SecurityClass
Single or Multi	✓	Single or Multi

Example

GenerateRecurringJournal("POV","Type"," BalanceType"," Label"," Description"," Group"," SecurityClass"," Single or Multi");

CreateJournal

Create Journal

Input

Parameter	Mandatory	Comment
POV	✓	POV
Type	✓	Type `AutoReversing` `AutoReversal` `Unit` `Regular`
Balance Type	✓	Balance Type `Balanced` `UnBalanced` `BalancedByEntity`
Label	✓	Label
Description	✓	Description
Group	✓	Group
Security Class	✓	Security Class
Single or Multi	✓	Single or Multi

Example

CreateJournal("POV","Type"," BalanceType"," Label"," Description"," Group"," SecurityClass"," Single or Multi");

CreateTemplate

Create Journal Template Template

Input

Parameter	Mandatory	Comment
POV	✓	POV
Balance Type	✓	Balance Type `Balanced` `UnBalanced` `BalancedByEntity`
Label	✓	Label
Description	✓	Description
Group	✓	Group
Standard or Recurring	✓	Standard or Recurring
Single Or Multi	✓	Single Or Multi
SecurityClass	✓	SecurityClass

Example

CreateTemplate("POV","Balance Type"," Label"," Description"," Group"," Standard or Recurring"," Single Or Multi"," SecurityClass");

FilterJournals

Filter Journals

Input

Parameter	Mandatory	Comment
Output file	✓	output file
Sort type	✓	Sort type
Scenario	✓	Scenario
Year	✓	Year
Period	✓	Period
Value	✓	Value
Columns	✓	Columns Jnl_Label (Label) Jnl_Status (Journal Status) Jnl_Type (Journal Type) Jnl_LastActedOn (Last Acted On) Jnl_BalanceAttribute (Balance Attribute) Jnl_Group (Journal Group) Jnl_Description (Description) Jnl_SecurityClass (Secutiry Class) Jnl_TruncatedDescription (Truncated Description) Jnl_CreatedBy (Created By) Jnl_CreatedOn (Created On) Jnl_LineItemEntity (Line Item Entity) Jnl_ApprovedBy (Journal Approved By) Jnl_ApprovedOn (Journal Approved On) Jnl_LastActedBy (Journal Last Acted By) Jnl_LineItemParent (Journal Line Item Parent)
Entity Filter	✓	Entity Filter Can be blank
Group Filter	✓	Group Filter Can be blank
Label Filter	✓	Label Filter Can be blank
Journal Types	✓	Journal Types (delimited by `;`) `Reversing` `Auto Reversal` `Unit` `Regular`
Balance Types	✓	Balance types (delimited by `;`) `Balanced` `Unbalanced` `Balanced by Entity`
Status types	✓	Status types (delimited by `;`) `Approved` `Posted` `Rejected` `Submitted` `Working`

Example

FilterJournals("output file"," Sort type"," Scenario"," Year"," Period"," Value"," Columns"," Entity Filter","Group Filter","Label Filter","Journal Types"," Balance Types"," Status types");

AddLineItemToJournal

Add Line Item To Journal

Input

Parameter	Mandatory	Comment
POV	✓	POV
Journal Label	✓	Journal Label
Type	✓	Type `Debit` `Credit` `Unit`
Amount	✓	Amount
Description	✓	Description

Example

AddLineItemToJournal("POV","Journal Label","Type"," Amount"," Description");

GenerateRecurring

Generate Recurring

Input

Parameter	Mandatory	Comment
POV	✓	POV
template Label	✓	template Label

Example

GenerateRecurring("POV","template Label");

AddLineToTemplate

Add Line To Template

Input

Parameter	Mandatory	Comment
POV	✓	POV
Template Label	✓	Template Label
Type	✓	Type `Debit` `Credit` `Unit`
Amount	✓	Amount
Description	✓	Description

Example

AddLineToTemplate("POV","Teplate Label","Type"," Amount"," Description");

CreateJournalFromTemplate

Create Journal From Template

Input

Parameter	Mandatory	Comment
POV	✓	POV
Label	✓	Label
NewLabel	✓	NewLabel
Type	✓	Type
Balance Type	✓	Balance Type `Balanced` `UnBalanced` `BalancedByEntity`
Description	✓	Description
Group	✓	Group
SecurityClass	✓	SecurityClass

Example

CreateJournalFromTemplate("POV","Label"," NewLabel"," Type"," Balance Type"," Description"," Group"," SecurityClass");

AddRegKey

Add Reg Key

Input

Parameter	Mandatory	Comment
key	✓	key

Example

AddRegKey("key");

DeleteRegKey

Delete Reg Key

Input

Parameter	Mandatory	Comment
key	✓	key

Example

DeleteRegKey("key");

CreateJournalGroup

Create Journa lGroup

Input

Parameter	Mandatory	Comment
Name	✓	Name
Description	✓	Description

Example

CreateJournalGroup("Name","Description");

GetJournalGroups

Get Journal Groups

Input

None

Example

GetJournalGroups("");

ListJournalPeriods

List Journal Periods

Input

Parameter	Mandatory	Comment
Scenario	✓	Scenario
Year	✓	Year

Example

ListJournalPeriods("Scenario","Year");

DeleteJournalGroup

Delete Journal Group

Input

Parameter	Mandatory	Comment
Label	✓	Label

Example

DeleteJournalGroup("Label");

DeleteAllJournalGroups

Delete All Journal Groups

Input

None

Example

DeleteAllJournalGroups("");

FilterTemplates

Filter Templates

Input

Parameter	Mandatory	Comment
Output File	✓	Output File
Sort	✓	Sort `A` (Ascending) `D` (Descending)
Columns	✓	Columns to Return in the Filter `Tmp_Label` (Label) `Tmp_BalanceAttribute` (Balance Attribute) `Tmp_Group` (Journal Group) `Tmp_Description` (Template Description) `Tmp_TruncatedDescription` (Template Truncated Description `Tmp_Type` (Journal Template Type) `Tmp_LineItemEntity` (Line Item Entity) `Tmp_LineItemParent` (Line Item Parent) `Tmp_SecurityClass` (Template Security Class) `Tmp_ValueDimension` (Template Value Dimension)
Entity Filter	✓	Entity Filter Can be blank
Group Filter	✓	Group Filter Can be blank
Label Filter	✓	Label Filter Can be blank
Description	✓	Description Can be blank
Template Type	✓	Template Type (delimited by `;`) `None` `Standard` `Recurring`
Balance types	✓	Balance types (delimited by `;`) `Balanced` `Unbalanced` `Balanced by Entity`

Example

FilterTemplates("output file"," SORTA|D"," Columns"," Entity Filter","Group Filter","Label Filter","Description   "," Template Type"," Balance types");

JHAT Commands: Load

Overview

These JHAT Commands have to do with Loading Data, Journals, etc.

Commands

LoadSecurity

Load Security Into HFM

Input

Parameter	Mandatory	Comment
Security File	✓	Security File
Log	✓	Log
Delmiter	✓	Delmiter
Clear before Load	✓	Clear before Load `true` `false`
Validate Users	✓	Validate Users `true` `false`
Load Users	✓	Load Users `true` `false`
Load Classes	✓	Load Classes `true` `false`
Load Roles	✓	Load Roles `true` `false`
Load Accesses	✓	Load Accesses `true` `false`

Example

LoadSecurity("C:HfmSecurityLoadFile.sec"," C:HfmSecurityLoad.log",";"," True/False Clear before Load"," True/False Validate Users"," True/False Load Users"," True/False Load Classes"," True/False Load Roles"," True/False Load Accesses");

LoadSecurityExpanded

Load Security Expanded

Input

Parameter	Mandatory	Comment
Security File	✓	Security File
Log File	✓	Log File
Delimiter	✓	Delimiter
Clear All?	✓	Clear All? `true` `false`
Validate Users?	✓	Validate Users? `true` `false`
Filter Users?	✓	Filter Users? `true` `false`
Filter Security Class?	✓	Filter Security Class? `true` `false`
Filter Role Access?	✓	Filter Role Access? `true` `false`
Filter Security Class Access?	✓	Filter Security Class Access? `true` `false`

Example

LoadSecurityExpanded("Security File","Log File","Delimiter","Clear All?","Validate Users?","Filter Users?","Filter Security Class?","Filter Role Access?","Filter Security Class Access?");

LoadMetaData

Load MetaData

Can have 3, 17 or 18 parameters

Input

Parameter	Mandatory	Comment
Load File	✓	Load File
Log File	✓	Log File
Delimiter	✓	Delimiter
Mode	✓	Mode `Merge` `Replace` `Clear`
Load Currencies?	✓	Load Currencies `true` `false`
Load Scenarios?	✓	Load Scenarios `true` `false`
Load Entities?	✓	Load Entities `true` `false`
Load Accounts?	✓	Load Accounts `true` `false`
Load Custom1?	✓	Load Custom1 `true` `false`
Load Custom2?	✓	Load Custom2 `true` `false`
Load Custom3?	✓	Load Custom3 `true` `false`
Load Custom4?	✓	Load Custom4 `true` `false`
Load Consolidation Methods?	✓	Load Consolidation Methods `true` `false`
Load App Settings?	✓	Load App Settings `true` `false`
System Accounts?	✓	System Accounts `true` `false`
Load Value Dimension?	✓	Load Value Dimension `true` `false`
Load ICP?	✓	Load ICP `true` `false`
Integrity Check?	✓	Integrity Check `true` `false`

Example

LoadMetaData("C:HfmMetadataLoadFile.xml"," C:HfmMetadataLoad.log",";","Merge, Replace or Clear Mode"," True or False Load Currencies"," True or FalseLoad Scenarios"," True or False Load Entities"," True or False Load Accounts"," True or False Load Custom1"," True or False Load Custom2"," True or False Load Custom3"," True or False Load Custom4"," True or False Load Consolidation Methods"," True or False Load App Settings","True or False System Accounts","True or False Load Value Dimension","True or False Load ICP","True or False Integrity Check");

LoadMetaDataExtDim

Load MetaData Extended

Input

Parameter	Mandatory	Comment
Load File	✓	Load File
Log File	✓	Log File
Delimiter	✓	Delimiter
Mode	✓	Mode `Merge` `Replace` `Clear`
Check Integrity	✓	Check Integrity `true` `false`
Dimensions to Load	✓	Dimensions to Load
Load Currencies	✓	Load Currencies `true` `false`
Load App Settings	✓	Load App Settings `true` `false`
Load Consolidation Methods	✓	Load Consolidation Methods `true` `false`
Load System Accounts	✓	Load System Accounts `true` `false`

Example

LoadMetaDataExtDim("Load Filename", "Log Filename", "Delimiter", "ReplaceMode", "CheckIntegrity", "DimensionsToLoad","Load Currencies", "LoadAppSettings", "Load Consol Methods", "LoadSystemAccounts");

LoadICTransactions

Load Intercompany Transactions

Input

Parameter	Mandatory	Comment
Load File	✓	c:HFMICTrans.trn
Log File	✓	c:HFMICtrans.log
Mode	✓	Mode `Load` `Scan`
Load Option	✓	Load Option `Merge` `Replace`
Delimiter	✓	Delimiter

Example

LoadICTransactions("c:HFMICTrans.trn"," c:HFMICtrans.log"," Load","Merge",";");

LoadDocument

Load Document

Input

Parameter	Mandatory	Comment
File Name	✓	File Name
File Description	✓	File Description
Path to Document	✓	Path to Document on Local Machine
Security Class	✓	Security Class
Overwrite	✓	Overwrite `true` `false`
Document Type	✓	Document Type `WEBFORM` `JOURNAL` `INTERCOMPANY` `ICTRANSACTION` `ICMATCHACCOUNT` `ICMATCHID` `ICMATCHTEMPLATE` `DATAEXPLORER` `WEBGRID` `WORKSPACE` `CUSTOM` `TASK` `FOLDER` `All`
File Type	✓	File Type `FORM` `REPORT` `XML` `HTML` `REPORTXML` `CUSTOM` `FOLDER` `All`
Is Private?	✓	Is Private? `true` `false`
Path in HFM	✓	Path in HFM

Example

LoadDocument("FormTest","Test Description"," C:inputdirCalc2col.wdf"," US"," true","WebForm","FORM","true","/RootFolder/Test");

LoadRules

Load Rules

Input

Parameter	Mandatory	Comment
Rule File	✓	Path to Rule File
Log File	✓	Path to Log File
Scan Only?	✓	Scan Only `true` `false` Optional

Example

LoadRules("C:HfmRuleLoadFile.rul"," C:HfmRulesLoad.log"," Optional True or False Scan Only");

LoadMemberLists

Load Member Lists

Input

Parameter	Mandatory	Comment
Member List File	✓	Member List File
Log File	✓	Path to Log File
Scan Only?	✓	Scan Only `true` `false` Optional

Example

LoadMemberLists("C:HfmMemberListsLoadFile.lst"," C:HfmMemberListsLoad.log"," Optional True or False Scan Only");

LoadData

Load Data

Input

Parameter	Mandatory	Comment
Load Mode	✓	Load Mode `Merge` `Replace` `Accumulate` `ReplaceBySecurity`
Data File	✓	Data File
Log File	✓	Log File
Accumulate withing File?	✓	Accumulate withing File? `true` `false`
Contains Ownership?	✓	Contains Ownership? `true` `false`

Example

LoadData("Merge"," C:HfmDataLoadFile.dat"," C:HfmDataLoad.log"," True or False Accumulate in File"," True or False contains ownership data"," ");

StartLoadData

Start Load Data

Calls the same API as `LoadData`

Input

Parameter	Mandatory	Comment
Load Mode	✓	Load Mode `Merge` `Replace` `Accumulate` `ReplaceBySecurity`
Data File	✓	Data File
Log File	✓	Log File
Accumulate withing File?	✓	Accumulate withing File? `true` `false`
Contains Ownership?	✓	Contains Ownership? `true` `false`

Example

StartLoadData("Merge"," C:HfmDataLoadFile.dat"," C:HfmDataLoad.log"," True or False Accumulate in File"," True or False contains ownership data"," ");

LoadPhaseInfo

Load Phase Info

Input

Parameter	Mandatory	Comment
Load Mode	✓	Load Mode `Merge` `Replace`
Data File	✓	Data File
Log File	✓	Log File
Delmiter	✓	Delimiter

Example

LoadPhaseInfo("Merge or Replace"," C:HfmDataLoadFile.dat"," C:HfmDataLoad.log"," ");

LoadJournal

Load Journal

Input

Parameter	Mandatory	Comment
Data File	✓	Data File
Log File	✓	Log File
Delmiter	✓	Delimiter

Example

LoadJournal("C:HfmDataLoadFile.dat"," C:HfmDataLoad.log"," ");

LoadModuleConfiguration

Load Module Configuration

Input

Parameter	Mandatory	Comment
Data File	✓	Data File
Log File	✓	Log File

Example

LoadModuleConfiguration("C:HfmModuleConfiguration.XML"," C:HfmModuleConfiguration.log");

JHAT Command: Macros

Overview

These JHAT Commands are related to Macros

Commands

SubstituteMacro

Substitute Macro

Input

Parameter	Mandatory	Comment
Macro Name	✓	Macro Name

Example

SubstituteMacro("__MacroName__");

DefineMacro

Define Macro

Input

Parameter	Mandatory	Comment
Macro Name	✓	Macro Name
Macro Replacement Text	✓	Macro Replacement Text

Example

DefineMacro("__MacroName__"," MacroRecplacmentText");

DefineMacroEx

Define Macro Ex

Input

Parameter	Mandatory	Comment
\_\_ExMacroName\_\_	✓	\_\_ExMacroName\_\_
\_\_MacroName\_\_/MacroRecplacmentText	✓	\_\_MacroName\_\_/MacroRecplacmentText
\_\_MacroName\_\_/MacroRecplacmentText ...	✓	\_\_MacroName\_\_/MacroRecplacmentText ...

Example

DefineMacroEx("__ExMacroName__","__MacroName__/MacroRecplacmentText"," __MacroName__/MacroRecplacmentText ...");

RemoveMacro

Remove Macro

Input

Parameter	Mandatory	Comment
Macro Name	✓	Macro Name

Example

RemoveMacro("__MacroName__");

ShowMacros

Input

None

Example

ShowMacros("");

Comment

Input

Parameter	Mandatory	Comment
Comment Text	✓	Comment Text

Example

Comment("comment text");

LoadMacros

Load Macros

Input

Parameter	Mandatory	Comment
Macro File Name	✓	Macro File Name

Example

LoadMacros("macro file name");

JHAT Commands: Configuration

Overview

These JHAT Commands are related to configuration actions

Commands

DisableEnableModule

Input

Parameter	Mandatory	Comment
Module Name	✓	Module Name
Enable/Disable	✓	Enable/Disable

Example

DisableEnableModule("Module Name"," Enable/Disable");

JHAT Commands: Miscellaneous Actions

Overview

These JHAT Commands are related to miscellaneous actions

Commands

CalculateOwnership

Calculate Ownership

Must add periods to list.

Input

Parameter	Mandatory	Comment
Scenario	✓	Scenario
Year	✓	Year
Period List	✓	Period List `All` Valid Period List
Parent	✓	Parent
Shares Calculation Control?	✓	Shares Calculation Control? `true` `false`
Shares Calculation Method?	✓	Shares Calculation Method? `true` `false`
Shares Calculation Ownership?	✓	Shares Calculation Ownership? `true` `false`
Shares Percent Control?	✓	Shares Percent Control? `true` `false`
Shared Direct Ownership	✓	Shared Direct Ownership? `true` `false`
Mode	✓	Mode `Current Entity` `Descendants` `All Entities`

Example

CalculateOwnership("Scenario","2001","1","Parent","TRUE","TRUE","TRUE","TRUE"," TRUE"," All Entities");

CopyData

Copy Data

Input

Parameter	Mandatory	Comment
Source Scenario	✓	Source Scenario
Target Scenario	✓	Target Scenario
Source Year	✓	Source Year
Target Year	✓	Target Year
Source Period List	✓	Source Period List `All` Valid Period List
Target Period List	✓	Target Period List `All` Valid Period List
Entity List	✓	Entity List `All` Valid Entity List
Account List	✓	Account List `All` Valid Account List
Log File	✓	Log File
Factor to Multiply	✓	Factor to Multiply
Copy Cell Text?	✓	Copy Cell Text? `true` `false`
Copy Derived Data?	✓	Copy Derived Data? `true` `false`
Copy Mode	✓	Copy Mode `MERGE` `REPLACE` `ACCUMULATE`
View	✓	View
Copy Data?	✓	Copy Data? `true` `false`
Copy Rates?	✓	Copy Rates? `true` `false`
Enable Logging	✓	Enable Logging `true` `false`

Example

CopyData("Actual"," Budget"," 2000"," 2005"," 1"," 2"," 1"," 1"," C:hfmoutboxDataCopy.log"," 1.5"," true"," true"," merge"," YTD"," Entity Curr Data"," Rates Sys Data"," Enable Logging");

ClearData

Clear Data

Input

Parameter	Mandatory	Comment
Scenario	✓	Scenario
Year	✓	Year
Period List	✓	Period List `All` Valid Period List
Entity List	✓	Entity List `All` Valid Entity List
Account List	✓	Account List `All` Valid Account List
Clear Rates and System Data?	✓	Clear Rates and System Data?
Enable Detailed Logging	✓	Enable Detailed Logging `true` `false`
Clear Data	✓	Clear Data `true` `false`
Log File	✓	Log File `true` `false`

Example

ClearData("Actual"," 2005"," 1"," 2"," 1"," true"," true","true","C:hfmoutboxcleardata.log");

DeleteInvalidRecords

Delete Invalid Records

Input

Parameter	Mandatory	Comment
Clear Invalid Records?	✓	Clear Invalid Records? `true` `false`
Log File	✓	Log File

Example

DeleteInvalidRecords("false","C:hfmoutboxInvalidRecords.log");

exit

Input

None

Example

exit();

UpdateParameter

Update Parameter

Updates the `XFM_PARAMETERS` table

Input

Parameter	Mandatory	Comment
Parameter Name	✓	Parameter Name
Parameter Value	✓	Parameter Value

Example

UpdateParameter(""," ");

GetMemberProperties

Get Member Properties

Input

Parameter	Mandatory	Comment
Dimension Name	✓	Dimension Name
Dimension Members	✓	Dimension Members
File Path	✓	File Path

Example

GetMemberProperties("Dimension Name","Dimension Members","File Path");

JHAT Commands: Process Management

Overview

These JHAT Commands are related to Process Management actions

Commands

ProcessFlowGetHistory

Process Flow Get History

Must Call `SetPOV` prior to calling this.

Input

Parameter	Mandatory	Comment
Log File	✓	Log File
Suppress Time?	✓	Suppress Time? `true` `false`
Suppress User?	✓	Suppress User? `true` `false`

Example

ProcessFlowGetHistory("C:hfmhistoryfile.log"," true|false"," true|false");

ProcessFlowChangeIncludeDescendants

Process Flow Change Include Descendants

Must Call `SetPOV` prior to calling this.

Input

Parameter	Mandatory	Comment
Action	✓	Action `START` `PROMOTE` `SIGNOFF` `SUBMIT` `APPROVE` `PUBLISH` `REJECT`
Not Applicable	✓	Not Applicable
Phases	✓	Phases (can be comma Delimited)

Example

ProcessFlowChangeIncludeDescendants("Start","NA"," 1");

ProcessFlowStart

Process Flow Start

Must Call `SetPOV` prior to calling this.

Input

Parameter	Mandatory	Comment
Comment	✓	Comment
Use All Member Values	✓	Use All Member Values
Output File	✓	Output File
Suppress Timestamp	✓	Suppress Timestamp `true` `false`
Suppress User ID	✓	Suppress User ID `true` `false`

Example

ProcessFlowStart("Comment"," Use all members values true or false"," Filename to put history in"," Supress timestamp true||false "," Supress user idtrue||false");

ProcessFlowPromote

Process Flow Promote

Must Call `SetPOV` prior to calling this.

Input

Parameter	Mandatory	Comment
Comment	✓	Comment
Use All Member Values	✓	Use All Member Values
Output File	✓	Output File
Review Level to Promote to RL#	✓	Review Level to Promote to RL# `RL1` `RL2` `RL3` etc
Suppress Timestamp	✓	Suppress Timestamp `true` `false`
Suppress User ID	✓	Suppress User ID `true` `false`

Example

ProcessFlowPromote("Comment"," Use all members values true or false"," Filename to put history in"," Review Level to Promote to RL#"," Supress timestamp true||false "," Supress user idtrue||false");

ProcessFlowSubmit

Process Flow Submit

Must Call `SetPOV` prior to calling this.

Input

Parameter	Mandatory	Comment
Comment	✓	Comment
Use All Member Values	✓	Use All Member Values
Output File	✓	Output File
Suppress Timestamp	✓	Suppress Timestamp `true` `false`
Suppress User ID	✓	Suppress User ID `true` `false`

Example

ProcessFlowSubmit("Comment"," Use all members values true or false"," Filename to put history in"," Supress timestamp true||false "," Supress user idtrue||false");

ProcessFlowApprove

Process Flow Approve

Must Call `SetPOV` prior to calling this.

Input

Parameter	Mandatory	Comment
Comment	✓	Comment
Use All Member Values	✓	Use All Member Values
Output File	✓	Output File
Suppress Timestamp	✓	Suppress Timestamp `true` `false`
Suppress User ID	✓	Suppress User ID `true` `false`

Example

ProcessFlowApprove("Comment"," Use all members values true or false"," Filename to put history in"," Supress timestamp true||false "," Supress user idtrue||false");

ProcessFlowPublish

Process Flow Publish

Must Call `SetPOV` prior to calling this.

Input

Parameter	Mandatory	Comment
Comment	✓	Comment
Use All Member Values	✓	Use All Member Values
Output File	✓	Output File
Suppress Timestamp	✓	Suppress Timestamp `true` `false`
Suppress User ID	✓	Suppress User ID `true` `false`

Example

ProcessFlowPublish("Comment"," Use all members values true or false"," Filename to put history in"," Supress timestamp true||false "," Supress user idtrue||false");

ProcessFlowSignOff

Process Flow Sign Off

Must Call `SetPOV` prior to calling this.

Input

Parameter	Mandatory	Comment
Comment	✓	Comment
Use All Member Values	✓	Use All Member Values
Output File	✓	Output File
Suppress Timestamp	✓	Suppress Timestamp `true` `false`
Suppress User ID	✓	Suppress User ID `true` `false`

Example

ProcessFlowSignOff("Comment"," Use all members values true or false"," Filename to put history in"," Supress timestamp true||false "," Supress user idtrue||false");

ProcessFlowReject

Process Flow Reject

Must Call `SetPOV` prior to calling this.

Input

Parameter	Mandatory	Comment
Comment	✓	Comment
Use All Member Values	✓	Use All Member Values
Output File	✓	Output File
Suppress Timestamp	✓	Suppress Timestamp `true` `false`
Suppress User ID	✓	Suppress User ID `true` `false`

Example

ProcessFlowReject("Comment"," Use all members values true or false"," Filename to put history in"," Supress timestamp true||false "," Supress user idtrue||false");

GetPhaseSubmissionGrid

Must Call `SetPOV` prior to calling this.

Input

Parameter	Mandatory	Comment
Scenario	✓	Scenario
Phase	✓	Phase `All` `1` `2` `3` etc
Output File Path	✓	Output File Path

Example

GetPhaseSubmissionGrid("Scenario"," All | Phase number"," Output File Path");

ViewUnassignedGroups

View Unassigned Groups

Input

Parameter	Mandatory	Comment
Scenario	✓	Scenario
Period	✓	Period
Output File Path	✓	Output File Path

Example

ViewUnassignedGroups("Scenario"," Period"," Output File Path");

SetSubmissionGroup

Set Submission Group

Input

Parameter	Mandatory	Comment
Scenario	✓	Scenario
Period	✓	Period
Phase	✓	Phase
Group Value	✓	Group Value

Example

SetSubmissionGroup("Scenario"," Period"," Phase"," Group Value");

JHAT Commands: Journal Reports

Overview

These JHAT Commands are related to Journal Report actions

Commands

GetAutoJournalReportWithFilter

Export an Auto Journal Report with Entity and Group filters to a flat file

Input

Parameter	Mandatory	Comment
POV	✓	POV
Output File Path	✓	Output File Path
Entity Filter	✓	Entity Filter
Group Filter	✓	Group Filter

Example

GetAutoJournalReportWithFilter("POV","Output File Path","Entity Filter","Group Filter");

GetAutoJournalReport

Export an Auto Journal Report to a flat file

Input

Parameter	Mandatory	Comment
POV	✓	POV
Output File Path	✓	Output File Path

Example

GetAutoJournalReport("POV","Output File Path");

GenerateReport

Run a Journal Report and Save the File

Input

Parameter	Mandatory	Comment
Path		Path to Report in Documents
Report Name	✓	Report Name
Report Type	✓	Report Type: `JOURNAL_REPORT` `SYSTEM_MATCHING_REPORT` `EPU_REPORT` `SECURITY_ACCESS_CLASS_BY_USER_REPORT` `SECURITY_ACCESS_ROLES_BY_USER_REPORT` `SECURITY_ACCESS_CLASS_AND_ROLES_BY_USER_REPORT` `SECURITY_ACCESS_USERS_BY_GROUP_REPORT` `ICP_REPORT_TYPE_ID` `ICM_REPORT_TYPE_ACCOUNT` `ICM_REPORT_TYPE_TRANSACTION`
Report Format	✓	Format of Export Report: `HFM_FORMAT` - HFM format `PDF_FORMAT` - PDF format `RTF_FORMAT` - Rich Text File format `HTML_FORMAT` - HTML Format `XLS_FORMAT` - Excel 2010 and prior format `XLSX_FORMAT` - Excel 2013 and newer format
Output File Path	✓	File Path to Export the Report
POV Override	✓	Enter a POV to override any prior defined POVs by `SetPOV`

Example

GenerateReport("","C1detail","ReportType","HFM_FORMAT","OutputFilePath","Overridden POVSlice");

JHAT Commands: Runtime Actions

Overview

These JHAT Commands are related to Runtime actions

Commands

Delay

Input

Parameter	Mandatory	Comment
interval	✓	Interval in miliseconds

Example

Delay("interval");

ReplaceLineInTextFile

Replace Line In Text File

Input

Parameter	Mandatory	Comment
File Name	✓	“\_\_@SCRIPTDIR\_\_Rules.rle”
Text to Find	✓	“Const BuildandTieFolder =”
Replacement Text	✓	“Const BuildandTieFolder = \_\_@DQUOTECHAR\_\_\_\_@BASEDIR\_\_\_\_@DQUOTECHAR\_\_

Example

ReplaceLineInTextFile("“__@SCRIPTDIR__Rules.rle”"," “Const BuildandTieFolder =”"," “Const BuildandTieFolder = __@DQUOTECHAR____@BASEDIR____@DQUOTECHAR__ ");

BeginLoop

Begin Loop

Input

Parameter	Mandatory	Comment
Repeat count	✓	Repeat count

Example

BeginLoop("Repeat count");

EndLoop

End Loop

Input

None

Example

EndLoop();

StartTimer

Input

Parameter	Mandatory	Comment
Timer ID	✓	Timer ID
Timer Name	✓	Timer Name

Example

StartTimer("3","Time to Load Metadata");

StopTimer

Stop Timer

Must Run `StartTimer` first

Input

Parameter	Mandatory	Comment
Timer ID	✓	1

Example

StopTimer("1");

AbortOnError

Abort On Error

Input

Parameter	Mandatory	Comment
Abort on Error	✓	Abort on Error `true` `false`

Example

AbortOnError("true");

SetNegativeTestingFlag

Input

Parameter	Mandatory	Comment
Set Negative Testing Flag	✓	Set Negative Testing Flag `true` `false`

Example

SetNegativeTestingFlag("true");

CallOtherProcess

Call Other Process

Can have up to 100 arguments

JHAT will add double quotes around each argument.

Input

Parameter	Mandatory	Comment
Executable	✓	Executable
Argument 1	✓	Argument 1
Argument 2	✓	Argument 2

Example

CallOtherProcess("Wscript.exe","C:hfmconsolidate.wsf","");

CompareFiles

Compare Files

Input

Parameter	Mandatory	Comment
File 1	✓	File 1
File 2	✓	File 2
Mode	✓	Mode
Diff File	✓	Diff File
Exclusion Rules	✓	Exclusion Rules

Example

CompareFiles("file1"," file2"," mode"," diffFile"," exclusion_rules");

CompareFilesContentNotOrdered

Compare Files Content Not Ordered

Input

Parameter	Mandatory	Comment
File 1	✓	File 1
File 2	✓	File 2
Diff File	✓	Diff File

Example

CompareFilesContentNotOrdered("file1"," file2"," diffFile");

CompareMultipleFiles

Compare Multiple Files

Input

Parameter	Mandatory	Comment
File Spec	✓	File Spec
Directory	✓	Directory
Mode	✓	Mode `TEXT`
Exclusion Rules	✓	Exclusion Rules
Difference Directory	✓	Difference Directory

Example

CompareMultipleFiles("filenamespec"," directory"," mode"," rules","  diffDirectory;"," ");

Files

jhat-in-hfm.md

Latest commit

History

jhat-in-hfm.md

File metadata and controls

JHAT in HFM

Automation with JHAT

Overview

How does it work?

JHAT usage

JHAT Commands: Administration

Overview

Commands

JHAT Commands: Application

Overview

Commands

JHAT Commands: Data Form

Overview

Commands

JHAT Commands: Data Grid

Overview

Commands

JHAT Commands: Documents

Overview

Commands

JHAT Commands: EPU

Overview

Commands

JHAT Commands: Extracts

Overview

Commands

JHAT Commands: InterCompany

Overview

Commands

JHAT Commands: Journals

Overview

Commands

JHAT Commands: Load

Overview

Commands

JHAT Command: Macros

Overview

Commands

JHAT Commands: Configuration

Overview

Commands

JHAT Commands: Miscellaneous Actions

Overview

Commands

JHAT Commands: Process Management

Overview

Commands

JHAT Commands: Journal Reports

Overview

Commands

JHAT Commands: Runtime Actions

Overview

Commands