HFM API - OpenApplication

We are trying to leverage HFM API for a custom program (a command line utility) to export data using EA process.
HsxClientlib.dll is referenced from /common directory and using OpenApplication method to connect to the application after login.
I am able to connect individual servers however not able use HFM cluster. Is there a way to connect using HFM Cluster instead of single server.
We are using HFM v11.1.2.2 patch 305.
Any help is greatly appreciated.
-vk

Hi,
I think you need to go through following documents available for download at : http://download.oracle.com/docs/cd/E12825_01/nav/portal_5.htm
1. hfm_websdk.pdf
2. hfm_objects.pdf
3. hfm_functions_library.pdf
Rgds
Payous999

Similar Messages

Conditional Mapping with script using BlOCKPROC to access the HFM API

Hello,
following problem. During the mapping/validation I need to map certain custom1 members to None if the Top Member is None and let it be if not None. This allocation depends on the account. Reading through the documentation I stumbled across conditional mapping.
So in the Custom1 map type Like I defined following:
Rule Name: C1_Script
Rule Definition: CXXX*
TargetCustom1: #Script
In the script I try to achieve to get the Custom1 Top member for the account! The HFM API offers this function(fGetCustomTopMember) and with varValue(14) I get my TargetAccount. So everything I need seems to be there.
Only problem is I need to use the BlOCKPROC to access the HFM API provided through the adapter, but either way won't work.
Trying "Set API.IntBlockMgr.IntegrationMgr.PobjIntegrate = BlOCKPROC.ActConnect("LookUP")" throws an object required error.
Trying
Dim BLOCKPROC
Set BLOCKPROC = CreateObject("upsWBlockProcessorDM.clsBlockProcessor")
BLOCKPROC.Initialize API, SCRIPTENG
throws me a type mismatch for "BLOCKPROC.Initialize".
I am kinda at my wits end. Any help/clue is much appreciated.
Ahh, yes the different writing BlOCKPROC and BLOCKPROC is correct!
Thanks!

Hello Tony,
Many thanks for your answer. Just one last question. The event AftProcMap(strLoc, strDim) gives me the Dimension? Just how do I get the account?
Can you point me to the right direction and I'll figure out the rest!
Thanks a lot!

Utility which uses HFM API

Hi,
I want to create a utility, using the HFM API, in C# which will run repetitive consolidation and extraction tasks.
I believe I need to install the entire HFM clilent as well apart from the SDK.
If yes, I'm now looking for 2 things
1. Where do i download the SDK from
2. Where do I download the HFM client from, and do I need anything else apart from these 2 to create and run my utility.
My machine is running *64 bit Windows 7 and our HFM server is version 11*.
An exact link would be appreciated, i'm looking on edeliver.oracle.com but i'm unable to find the right versions for both of them.
Thanks.

The link is for a C# .NET app that will show you how to use the API. Even if you don't use it immediately, you can review the source code to clue you in on how to work with the API.
Personally, I think the non-3rd party rule is silly for something like this since the source code is included and you can modify/see exactly what it is doing. (Basically just calling the appropriate API's) I also understand that is probably not your rule, so that comment isn't aimed at you per se.
In regards to what you need to install, start here :
http://docs.oracle.com/cd/E17236_01/nav/portal_1.htm
Look at the Installation start here and the installation and configuration guides. (epm_insatll_start_here_11121.pdf and epm_install_11121.pdf respectively)
Cliff notes is that you need to make the installer package :
Oracle Hyperion Enterprise Performance Management System Installer, Fusion Edition Release 11.1.2.1.0 for PlatformName
Oracle Hyperion Foundation Services Release 11.1.2.1.0 for PlatformName Part 1 of 7
Oracle Hyperion Foundation Services Release 11.1.2.1.0 for PlatformName Part 2 of 7
Oracle Hyperion Foundation Services Release 11.1.2.1.0 for PlatformName Part 3 of 7
Oracle Hyperion Foundation Services Release 11.1.2.1.0 for PlatformName Part 4 of 7
Oracle Hyperion Foundation Services Release 11.1.2.1.0 Part 5 of 7
Oracle Hyperion Foundation Services Release 11.1.2.1.0 Part 6 of 7
Oracle Hyperion Foundation Services Release 11.1.2.1.0 Part 7 of 7
*NOTE : All files are on edelivery and where you see PlatformName you should replace that with the platform type (i.e. x86, x64, etc.)
Additionally, you need the following modules to install the Financial Management Client :
Financial Management Client
    Required Assemblies
        l commonComponents
        l hfm_client
        l hfm_common
    Required Download Files
      l Oracle Hyperion Foundation Services Release 11.1.2.1.0 for PlatformName Part 1 of 7
      l Oracle Hyperion Financial Management, Fusion Edition Release 11.1.2.1.0Hope that helps.
Edited by: beyerch2 on Apr 11, 2012 9:13 AM

HFM API Objects

Hi,
Does any one know which HFM API object can be used to trigger the HFM task flow ? I have browsed thru the HFm objects guide but did not find anything.
Any help would be appreciated.
Thanks

Taskflow definition Represents business processes in the taskflow management system. Consists of a network of stages and their relationships; criteria indicating the start and end of the taskflow; and information about individual stages, such as participants, associated applications, associated activities, and so on.
Considering the above definition, I can give you an example of what we have in a task list showing the closing process flow,
Step 1: Load data and we have a link to FDM
Step 2: Consolidate Data and we have a link to a Data Grid
Step 3: Verify Key Accounts and we have a link to a set of specific reports
Step 4: Promote your data to the next data review level and we have a link to the process management module
If this is not what you are after you could be refering to the Process Flow, for which the object methods are listed in page 88 of the hfm_Objects document.
The HsvProcessFlow type library contains one object, the HsvProcessFlow object. Use the HsvProcessFlow object to execute Process Management-related features such as taking actions for and getting histories of process units and submission phases. The HsvProcessFlow object is a child of the HsvSession object. Use HsvSession’s ProcessFlow property to assign HsvProcessFlow object references as shown in the following example:
Dim cHsvProcessFlow As HsvProcessFlow
Set cHsvProcessFlow = cHsvSession.ProcessFlow

Urgent: Where to write HFM API objects coding in consolidation?

Hi,
I want to write a code on HsvProcessFlow library object to make some customized changes. But wondering where should i write this code. Is rules editor is the place where i should write the code. Please help me on this.
Regards,
Arvind

Hi,
I want to write a code on HsvProcessFlow library object to make some customized changes. But wondering where should i write this code. Is rules editor is the place where i should write the code. Please help me on this.
Regards,
Arvind

Error trying to extract data via HFM objects

I've written a program to extract selected data from HFM (version 11.1.1.3.500) using the API objects. The program (shown at the bottom of this post) is failing on the 2nd of the following 2 lines:
oOption = oOptions.Item(HSV_DATAEXTRACT_OPT_SCENARIO_SUBSET)
oOption.CurrentValue = lBudgetScenario
where oOption is a data load/extract object previously initialized and lBudgetScenario is the long internal ID for our budget scenario.
The error is usually "COM Exception was unhandled" with a result code of "0x800456c7", but, mysteriously, even with no code changes, it sometimes throws the error "FileNotFoundException was not handled", where it says that it could not load "interop.HSXServerlib or one of its dependencies". The second error occurs even though HSXServer was previously initialized in the program and used in conjunction with the login.
I've carefully traced through the VB.NET 2010 code and find that all relevant objects are instantiated and variables correctly assigned. It also occurred to me that the data load DLLs might have been updated when the 11.1.1.3.50 and 500 patches were applied. For that reason, I removed the references to those DLLs, deleted the interop files in the debug and release folders and copied the server versions of those DLLs to my PC. I then restored the DLL references in Visual Studio which recreated the interops. However, the error still occurs.
The ID I'm using (changed to generic names in the code below) has appropriate security and, for example, can be used to manually extract data for the same POV via the HFM client.
I've removed irrelevant lines from the code and substituted a phony ID, password, server name and application name. The line with the error is preceded by the comment "THE LINE BELOW IS THE ONE THAT FAILS".
Imports HSVCDATALOADLib.HSV_DATAEXTRACT_OPTION
Module Module1
Public lActualScenario, lBudgetScenario As Long
Public oClient As HSXCLIENTLib.HsxClient
Public oDataLoad As HSVCDATALOADLib.HsvcDataLoad
Public oOptions As HSVCDATALOADLib.IHsvLoadExtractOptions
Public oOption As HSVCDATALOADLib.IHsvLoadExtractOption
Public oSession As HSVSESSIONLib.HsvSession
Public oServer As HSXSERVERLib.HsxServer
Sub Main()
'Create a client object instance, giving access to
'the methods to logon and create an HFM session
oClient = New HSXCLIENTLib.HsxClient
'Create a server object instance, giving access to
'all server-based methods and properties
oServer = oClient.GetServerOnCluster("SERVERNAME")
'Establish login credentials
oClient.SetLogonInfoSSO("", "MYID", "", "MYPASSWORD")
'Open the application, which will initialize the server
'and session instances as well.
oClient.OpenApplication("SERVERNAME", "Financial Management", "APPLICATION", oServer, oSession)
'Instantiate a data load object instance, which will be used to extract data from
'FRS.
oDataLoad = New HSVCDATALOADLib.HsvcDataLoad
oDataLoad.SetSession(oSession)
'Initialize the data load options interface.
oOptions = oDataLoad.ExtractOptions
'Find the internal ID numbers for various scenarios and years.
'These are required for HFM API function calls.
lActualScenario = GetMemberID(DIMENSIONSCENARIO, "Actual")
lBudgetScenario = GetMemberID(DIMENSIONSCENARIO, "Budget")
'Construct file names for open data.
strFileName = "c:\Temp\FEWND_BudgetData.dat"
strLogFileName = "c:\Temp\FEWND_BudgetData.log"
'Extract data for the current open cycle.
ExtractData("Budget", BudgetYear, "Dec", strFileName, strLogFileName)
End Sub
Sub ExtractData(ByVal strScenario As String, ByVal strYear As String, ByVal strPeriod As String, _
ByVal strFileName As String, ByVal strLogFileName As String)
'Populate the Scenario element.
oOption = oOptions.Item(HSV_DATAEXTRACT_OPT_SCENARIO_SUBSET)
If strScenario = "Actual" Then
oOption.CurrentValue = lActualScenario
Else
'THE LINE BELOW IS THE ONE THAT FAILS
oOption.CurrentValue = lBudgetScenario
End If
End Sub
Function GetMemberID(ByVal lDimID As Long, ByVal strMemLabel As String) As Long
Dim oMetaData As HSVMETADATALib.HsvMetadata
oMetaData = oSession.Metadata
oEntityTreeInfo = oMetaData.Dimension(lDimID)
GetMemberID = oEntityTreeInfo.GetItemID(strMemLabel)
End Function
End Module

I stumbled upon the solution to my problem. The documentation for extracting data via objects defines member ID variables as Longs. In fact, I've always defined such variables as longs in previous object programs and had no problems. It appears that the datal load/extract "option" property of "Currentvalue" is defined as integer. When I changed all of my member ID items (such as the "lBudgetScenario" variable that was the right-side of the failing assignment statement) to be integers, the program worked.

Extract Metadata from HFM

Goodmorning,
I'm looking for HFM API that could be used by FDM Event Script to extract Account Type (metadata, more generally). Precisely:
When I'm importing source account, I've to verify that target account has a specified type, cause I've to change sign manually (sob), but I'm not pretty sure where put this behaviour (I think BefValidate or After Mapping) and how can I determine target account. I've found something like:
Function isCurrencyRateType(sMem As String) As Boolean Dim cAccounts As HsvAccounts, cTreeInfo As IHsvTreeInfo Dim lAccount As Long, iAcctType As Integer 'g_cMetadata is an HsvMetadata object reference
Set cAccounts = g_cMetadata.Accounts Set cTreeInfo = g_cMetadata.Accounts lAccount = cTreeInfo.GetItemID(sMem) cAccounts.GetAccountType lAccount, iAcctType If iAcctType = ACCOUNTTYPE_CURRENCYRATE Then
isCurrencyRateType = True Else
isCurrencyRateType = False End If
End Function
on HFM Object Guide, is it the right way?
Thanks
Francesco

Where can I find Type Library?
In other similar threads I read about metadata extraction from custom general script (yet included), aren't they enough for target account type extraction?
Just asking to justify other software need.
Thanks
Francesco

API Help -- Extract method results in Catstrophic failure!

Hi all,
We're trying to implement the HFM api to pull data out into a CSV. When we run HsvData.Extract, the call returns an exception:
Catastrophic failure (Exception from HRESULT: 0x8000FFFF (E_UNEXPECTED))
I'm not sure what this means and I can't find any help on the 'net. Our extract call looks like:
hsvLoad.Extract(dataFilePath, logFilePath, settings);
settings is an object array that looks like this before we call Extract:
settings {object[20]}
[0] 2
[1] ";"
[2] "LogFile.log"
[3] false
[4] false
[5] false
[6] 1
[7] 2009
[8] int[12] //selected periods, 67108864 - 67108875 (Jan - Dec)
[9] int[2] // selected entities, 0 and 1
[10] int[1] //selected parents, 0
[11] int[4] //selected accounts 0 - 3
[12] int[0]
[13] int[0]
[14] int[0]
[15] int[0]
[16] int[0]
[17] int[0]
[18] false
[19] false
items 12 - 19 are default, we don't change them. The data file is empty and the log file says "0 records extracted". If I try to Extract from the UI selecting the same items (accounts, years, application, etc), I get the full results.
Can anyone tell me what the Catastrophic failure means? Are some of our settings mapped wrong? I can post additional code if that helps.
Thanks,
Shawn

Here's the method that just doesn't return data:
public bool TryExportDataFromHFM(string dataFilePath,string logFilePath, string scenLabel,int year, out string error)
bool retval = false;
error = string.Empty;
HSVCDATALOADLib.HsvcDataLoad oHsvcDataLoad = null;
HSVCDATALOADLib.IHsvLoadExtractOptions oHsvcDataLoadExtOptions = null;
HSVCDATALOADLib.IHsvLoadExtractOption oExtractOption = null;
try
if (string.IsNullOrEmpty(scenLabel))
error = NO_SCENARIOS_SPECIFIED_MSG;
return false;
if (year < 0)
error = NO_YEARS_SPECIFIED_MSG;
return false;
int currScenMemberId;
if (!TryGetMemberIdFromLabel((short)HFMCONSTANTSLib.tagHFMDIMENSIONS.DIMENSIONSCENARIO, scenLabel, out currScenMemberId, out error))
error = string.Format("Failed to find member Id for Scenario: {0}", scenLabel);
return false;
int currYearMemberId;
if (!TryGetMemberIdFromLabel((short)HFMCONSTANTSLib.tagHFMDIMENSIONS.DIMENSIONYEAR, year.ToString(), out currYearMemberId, out error))
error = string.Format("Failed to find member Id for Year: {0}", year.ToString());
return false;
oHsvcDataLoad = new HSVCDATALOADLib.HsvcDataLoad();
//set session
oHsvcDataLoad.SetSession(_oHsvSession);
//get extract options
oHsvcDataLoadExtOptions = oHsvcDataLoad.ExtractOptions;
//get extract option for scenario
oExtractOption = oHsvcDataLoadExtOptions.get_Item(
HSVCDATALOADLib.HSV_DATAEXTRACT_OPTION.HSV_DATAEXTRACT_OPT_SCENARIO_SUBSET);
//set scenarion member id
oExtractOption.CurrentValue = currScenMemberId;
//get extract option for year
oExtractOption = oHsvcDataLoadExtOptions.get_Item(
HSVCDATALOADLib.HSV_DATAEXTRACT_OPTION.HSV_DATAEXTRACT_OPT_YEAR_SUBSET);
oExtractOption.CurrentValue = currYearMemberId;
//get extract option for periods
oExtractOption = oHsvcDataLoadExtOptions.get_Item(
HSVCDATALOADLib.HSV_DATAEXTRACT_OPTION.HSV_DATAEXTRACT_OPT_PERIOD_SUBSET);
//COMMENTED OUT FOR TEST:
Dictionary<string, int> dictPerMemIds;
if (!TryGetAllPeriodLabelsMemberIds(out dictPerMemIds, out error))
error = string.Format("Failed to get member Ids for periods. Error:{0}", error);
return false;
//set currentValue with array of perion member ids
//int[] perArr = new int[] { dictPerMemIds["May"] };
//oExtractOption.CurrentValue = perArr; // periodMemberIds.ToArray();
//NEW TEST CODE
List<int> periods = new List<int>();
foreach (string key in dictPerMemIds.Keys)
if (key.Equals("[Year]") || key.StartsWith("Quarter"))
continue;
else
periods.Add(dictPerMemIds[key]);
oExtractOption.CurrentValue = periods.ToArray();
//get extract option for accounts
oExtractOption = oHsvcDataLoadExtOptions.get_Item(
HSVCDATALOADLib.HSV_DATAEXTRACT_OPTION.HSV_DATAEXTRACT_OPT_ACCOUNT_SUBSET);
Dictionary<string, int> dictAccntLabelMemberIds;
if (!TryGetAllAccountLabelsMemberIds(out dictAccntLabelMemberIds,out error))
error = string.Format("Failed to get member Ids for accounts. Error: {0}", error);
return false;
//int[] acctArr = new int[] { dictAccntLabelMemberIds["SalesRevenue"] };
//oExtractOption.CurrentValue = acctArr; // dictAccntLabelMemberIds.Values.ToArray();
oExtractOption.CurrentValue = dictAccntLabelMemberIds.Values.ToArray();
//Sets the entity children
oExtractOption = oHsvcDataLoadExtOptions.get_Item(
HSVCDATALOADLib.HSV_DATAEXTRACT_OPTION.HSV_DATAEXTRACT_OPT_ENTITY_SUBSET);
Dictionary<string, int> dictEntLblMemId;
if (!TryGetAllEntityLabelsMemberIds(out dictEntLblMemId,out error))
error = string.Format("Failed to get member Ids for entities. Error: {0}", error);
return false;
//int[] entArr = new int[] { dictEntLblMemId["Corporate"] };
//oExtractOption.CurrentValue = entArr; // dictEntLblMemId.Values.ToArray();
oExtractOption.CurrentValue = dictEntLblMemId.Values.ToArray();
oExtractOption = oHsvcDataLoadExtOptions.get_Item(
HSVCDATALOADLib.HSV_DATAEXTRACT_OPTION. HSV_DATAEXTRACT_OPT_VIEW);
oExtractOption.CurrentValue = HSVCDATALOADLib.HSV_DATA_VIEW.HSV_DATA_VIEW_YTD; //HSV_DATA_VIEW_PERIODIC; // HSV_DATA_VIEW_SCENARIO;
oExtractOption = oHsvcDataLoadExtOptions.get_Item(
HSVCDATALOADLib.HSV_DATAEXTRACT_OPTION.HSV_DATAEXTRACT_OPT_EXTRACT_CALC);
oExtractOption.CurrentValue = true;
//Sets the delimiter
oExtractOption = oHsvcDataLoadExtOptions.get_Item(HSVCDATALOADLib.HSV_DATAEXTRACT_OPTION.HSV_DATAEXTRACT_OPT_DELIMITER_CHAR);
oExtractOption.CurrentValue = ";";
oHsvcDataLoad.Extract(dataFilePath, logFilePath);
retval = true;
catch (Exception ex)
error = string.Format("Failed to export data to file from HFM. Error: {0}", ex.Message);
retval = false;
finally
ReleaseCOMObject(oHsvcDataLoad);
ReleaseCOMObject(oHsvcDataLoadExtOptions);
ReleaseCOMObject(oExtractOption);
return retval;
Thanks for the help

HFM Security Report Automation?

Is there a way to automate the running of the HFM (Hyperion Financial Management) Security Report in Shared Services.?
version: 11.1.2.0
Is this possible with using Task Automation? ---> If yes please provide details
If this possible using other reporting tools like HFR, web analysis..etc ---> This is not recommended
If any other way, Please provide details.
Thanks All!!
Regards,
AVSR

I think the best way to produce custom security files is using the HFM API. You can use this to report on group memberships and roles and class access. You can read all about it in the Web Developer's Guide Chapter 10. The chapter starts:
The HFMwSecurity type library contains the HFMwSecurity component. This component
provides methods that enumerate an application’s security classes, indicate whether a user has
rights to perform a given task, and return other types of security information.
I have seen these used to great effect.

Loading Metadata using API or VB scripting

Hi,
We are trying to explore the options for loading the Metadata in HFM Classic Application , is there any option to load the metadata using a HFM API or script ?
Please help !!!
Regards
Vkunda

Review the HsvMetadata object which is documented at http://docs.oracle.com/cd/E17236_01/epm.1112/hfm_objects.pdf
There is a load method for Classic applications.
Regards,
John A. Booth
http://www.metavero.com

Clearing Data In HFM

I need to force a clear for an entity/period. Is there a way to do that in FDM? I just don't see it in the documentation.
I have a situtation where I load a location with the "replace", then I have another load for the same location that should do both a "replace" for some of the rows, and an "accumulate" for other rows, due to some data hitting the same intersections as the first load, and some data going to completely different intersections. If a user loads Load1, then Load2 the first time using "replace" for load1 and "accumulate" for load2, then it works fine. However, if the user then needs to reload, loading load1 with "replace" is fine, then load2 with "accum" will accumulate the intersections that are not part of the first load1, meaning that it accumulates with what was previously loaded, thus doubling those values.
I would think there's a simple solution for this, but I haven't found it yet. Thanks!

Hello,
The first thing you need to understand is that FDM does not do the loading of the data into HFM. It is all done via public HFM API. What I mean by that is, FDM can only leverage the functionality that HFM has. Meaning you are only as strong as your weakest link.
What you need to do is take the .DAT files that FDM generates manually and see if there is a way (via HFM Win32 client) to do what you need. If you can not, then it isn't a limitation of FDM but a limitation of HFM.... and it isn't a product defect/limitation.
You can then probably go back to FDM and create some "scripting" to get around it .... but that is about it.
Hopefully this helps....

HFM - Process Control

Hi
Can anyone tell me if it is possible to get the process flow history details on Hyperion Smartview.
For example: Process Control - Entity promotes data to submitted - the date and time of this.
Regards

This is not possible using the "out of the box" features. Certainly the HFM API would allow you access to the process management details, but I don't personally know how this would be accessed from smart view. Likewise, Financial Reporting does not provide this detail either since the ADM driver for HFM does not support process management detail.
--Chris

HFM - Security refresh possible?

Hi all,
we are currently facing an issue at a client concerning HFM 11.1.2.0. We are using HFM API to load a new security file into an application. This works quite well – the only
problem is that logged-on users still have their old security permission until they re-logon. Do you know a way to enforce a security “refresh” in HFM without having the need for users to re-logon to
an application?
I really appreciate your help!
Regards Sebastian

Hi,
nope, a log off and log on is required. If you fear that your users don't log out, you can log them out centrally through administration --> Users on System

Can we run consolidation outside HFM

Hi All,
I would like to know i it's possible to run a consolidation (All, Impacted) outside HFM ? (HFM API ?)
It's for scheduling this task each night after input file.
Thanks in advance for your help.
Jean Daniel

Absolutely.
If you want to get a quickstart on this, download HFMBatch. Another user was kind enough to create a CLI that will let you do what you want. Source code is included as well if you want to use it to see how to make the proper API calls yourself.
https://github.com/agardiner/hfm-batch
Charles

Hyperion Strategic Finance problem with consolidation

Hi,
I'm currently working with HSF version 11.1.1.1 and i have encountered some problems with the consolidator. I have a group of entities, each one with a different structure (subaccounts, dimensions, etc.) and during the consolidation process there is one (and only one) that doesn't consolidate with the others.
The only difference between the mentioned entity and the others is that this entity use Debt Scheduler, but i have run tests using Debt Scheduler in the other entities and works perfectly.
Any ideas?
Greetings and thanks for your time

FDM has adapters for loading data to both HFM and HSF. It also gives you built in audit capabilities, a powerful intuitive mapping engine and out of the box validation against HFM. You could use flat file extracts from both HFM and HSF as the sources or certainly in the case of HFM-->HSF integrations you could provide a more seamless end to end process by executing an integration script that executes against the HFM API to integrate the extract step.
ODI certainly has HFM adapters for loading/extracting data, I'm not sure it has the smae for HSF. With ODI you will have to build the majority of the functionality, especially around mapping, it is definately more technical and not friendly enough if there is significant business community involvement in the BAU process.

HFM API - OpenApplication

Similar Messages

Maybe you are looking for