HFM Task Flows provides a way to automatize HFM tasks (consolidations, data extracts, etc…). JHAT tool is another way to automatize these tasks using a batch file and the HFM API. It is the former HAT updated to be compliant with the last HFM release. 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:
Drive:\Oracle\Middleware\EPMSystem11R1\products\FinancialManagement\Server\jhat.bat
The batch file embeds all libraries, paths and other references to execute HFM tasks:
- Home settings
- Library settings
- Java and JHAT execution settings
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()
For example:
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…
Some available functions from the HFM API:
- LoadSecurity
- ExtractSecurity
- LoadMetaData
- ExtractMetaData
- LoadData
- ExtractData
- LoadRules
- ExtractRules
- Allocate
- …
As the tool is based on batch file, it’s easy to schedule using Windows Task Scheduler or any other enterprise scheduling tool (Control M, Dollar U, etc…).
very interesting !
May I know as to which Hyperion versions that this will be compatible with?
Thanks!
Hi Nilesh,
This API is available in all HFM versions.
Regards
Hello,
Do we have any Oracle provided documentation on JHAT utility?
Thanks,
Abhishek
Hello,
Unfortunately Oracle doesn’t provide any documentation on jhat (or we are not aware of it).
Kind regards,
Cédric.
Hello,
Do we have any Oracle documentation to work with JHAT utility?
Thanks,
Abhishek
hi Nguyen, this looks interesting, but we are using HFM 11.1.2.3 and I couldnt find this JHAT tool in our installation folder, nor on Oracle support site. Do you have more information on this that how it can be installed or from where to get it? Thx
Tom
From Oracle support:
For versions prior to 11.1.2.4, there was a third party command line utility called HFMCmd (you can google it and find it for download). But it was written with the Windows HFM API which went away with 11.1.2.4. For 11.1.2.4, look into JHAT which is supported by HFM.
Nugyen/Cédric, very interesting. I didn’t know this existed, thanks for sharing!
With pleasure Guillaume!
Cheers
do you have an example on how to call the function ExtractData? I cant figure out the parameters
Hi Daniel,
Please find below an example for extract data:
ExtractData(“c:\\Voyager\\Data_Extract.dat”, “c:\\Voyager\\Data_Extract.log”, ”;”, ”YTD”, ”2000”, ”Actual”, “Entity”, ”All”, “1”);
The last “1” is for the “dynamic data”. Choose “1” to extract dynamic data and 0 if you don’t want to.
Kind regards,
Nizar
Hi Niza,
I called the function ExtractData by using this line ExtractData(“myfile.dat”, “mylog.log”, “;”, “YTD”, “2018”, “ACTUAL”, “MyEntity”, “All”, “1”, “True”) ;
I got a NumberFormatException error message on “MyEntity” parameter. Is it supposed to get Integer type value ?
I can’t figure out. Could you help me.
Regards,
Eric
Hi Nizar,
I called the function ExtractData by using below code.
Logon(“false”, “”, “username”,”password”);
OpenApplication(“cluster”, “application”);
SetPOV(“Actual”,”2016″,”Dec”,”YTD”,”My Entity”,”USD”,”My Account”,”[Icp None]”,”[None]”,”[None]”,”[None]”,”[None]”);
InitLists ();
AddItemToList(“1″,”Entity”,”My Entity”);
ExtractData(“c:\\Test\\Data_Extract.dat”,”c:\\Test\\Data_Extract.log”,”;”,”YTD”,”2016″,”Actual”,”1″,”All”,”1″”true”);
CloseApplication();
Logout();
But I am getting NullpointerException for ExtractData line.Could you please help me.
Thanks.
Hi,
for the Entity you must use lists.
Below an exemple for the Entity dimension:
InitLists ();
AddItemToList(“1″,”Entity”, “NEONN”);
then you must use “1” for the Entity field.
Best regards.
Hi,
This is great information.
I am able to run translations using below function for an entity, but when I am trying to run translation for a list of entities (member list) then it’s giving me an error “The POV selected for this function is invalid”.
Could you help me?
SetPov(“ACTUAL”,”2018″,”Oct”,”YTD”,”Entity_NonUSD_List”,”USD”,”BS”,”[ICP Top]”,”Cust1″,”Cust2″,”Cust3″,”Cust4″);
Translate();
Thanks.
Hi Bhuvaneswari,
You have to ask your HFM developer to give you the right POV to use for the translate.
It depends on the application structure.
Best regards.
Hi Nizar,
Thanks for the reply, it’s working!
Previous I have not used flower brackets for member list, after using the brackets it started working.
Thanks.
Hi Nizar,
Thank you, that’s very helpful.
Unfortunately there is no documentation about all function and how to use them.
Best regards,
Hi Nizar,
I called the function ExtractData by using below code.
Logon(“false”, “”, “username”,”password”);
OpenApplication(“cluster”, “application”);
SetPOV(“Actual”,”2016″,”Dec”,”YTD”,”My Entity”,”USD”,”My Account”,”[Icp None]”,”[None]”,”[None]”,”[None]”,”[None]”);
InitLists ();
AddItemToList(“1″,”Entity”,”My Entity”);
ExtractData(“c:\\Test\\Data_Extract.dat”,”c:\\Test\\Data_Extract.log”,”;”,”YTD”,”2016″,”Actual”,”1″,”All”,”1″”true”);
CloseApplication();
Logout();
But I am getting NullpointerException for ExtractData line.Could you please help me.
Thanks.
Were you able to get around the NullpointerException error?
I am getting the following error and it seems like the utility is not able to process the file at all.
java.lang.NullPointerException
at oracle.epm.fm.jhat.ProcessFile.readFileAndExecute(ProcessFile.java:75)
at oracle.epm.fm.jhat.JHATMain.main(JHATMain.java:30)
java.lang.NullPointerException
at oracle.epm.fm.jhat.ProcessFile.readFileAndExecute(ProcessFile.java:118)
at oracle.epm.fm.jhat.JHATMain.main(JHATMain.java:30)
Press any key to continue . . .
I am just trying to logon and open the application
Logon(“false”,””,”USERNAME”,”PASSWORD”);
OpenApplication(“CLUSTERNAME”,”APPLICATIONNAME”);
CloseApplication();
Logout();
Hi Samaresh, Hi Saurabh,
You have to use the Jhat.bat file directly from the server. if you copy paste it will not work unless you did many configuration steps.
Hi Nizar,
I have run it from the server. But getting the same error.
Thanks
Hi Nizar,
I have used jhat.bat file from the server without any modification. But still getting the same error.
Thanks,
Samaresh
Hi Sameresh,
Were you able to solve your java error?
Hi,
Did you initiate the EPM_ORACLE_INSTANCE_FOR_JHAT parameter ?
When you double click on JHAT.bat do you still have the error ?
Hi,
Is there a way to extract user and group only instead of extracting all (security class, security class access, …) by using the ExtractSecurity function.
Thank you.
Regards
Hi,
Using JHAT is not possible.
You can get those informations directly from the database.
Hi All,
Where can I find a list of the supported API functions?
Hi Ken,
You have to decompile the jar file to extract all the possible functions.
Hi Nizar,
I have used the Jhat.bat file directly from the server. But still I am getting the same error.
Thanks,
Samaresh
Hello,
Good Post.
Can this utility be used for all HFM functions like, Consolidation, Translate, Extract Journals?
Hi ABC,
Yes you can do all HFM tasks ( calculation, consolidation ..)
Thanks Nizar,
Can you please post how to write command for generating IC report using JHAT?
BR
ABC