Skip to Main Content

Analytics Software

Announcement

For appeals, questions and feedback, please email oracle-forums_moderators_us@oracle.com

HFM Java API - the Development Interface Description Document of DataExtractOptions

go gocNov 20 2023

Hi all!I want to extract data from the HFM interface to the Oracle database. I saw that someone used "import oracle. epm. fm. common. datatype. transport. DataExtractOptions;" to encapsulate request parameters, but I don't know the specific meaning of these parameters and how to set them. Below is the previous code. Can someone help me explain the meaning of the parameters or provide documentation on such interfaces, I would greatly appreciate it if you could provide me with information on where to obtain such documents.

import java.util.Locale; 

import oracle.epm.fm.common.datatype.transport.DATA_EXTRACT_TYPE_FLAG; 

import oracle.epm.fm.common.datatype.transport.DATA_LINEITEM_OPTION; 

import oracle.epm.fm.common.datatype.transport.DATA_PUSH_OPTION; 

import oracle.epm.fm.common.datatype.transport.DataExtractOptions; 

import oracle.epm.fm.common.datatype.transport.SessionInfo; 

import oracle.epm.fm.common.exception.HFMException; 

import oracle.epm.fm.domainobject.application.SessionOM; 

import oracle.epm.fm.domainobject.loadextract.LoadExtractOM; 

import oracle.epm.fm.hssservice.HSSUtilManager; 

public class HFM_Extract { 

public static void main(String[] args) throws HFMException { 

String ssoToken = null; 

SessionOM sessionOM = null; 

SessionInfo sessionInfo = null; 

try { 

System.setProperty("EPM_ORACLE_HOME", "//localhost/d$/Oracle/Middleware/EPMSystem11R1"); 

System.setProperty("EPM_ORACLE_INSTANCE", 

"//localhost/d$/Oracle/Middleware/user_projects/epmsystem1"); 

ssoToken = HSSUtilManager.getSecurityManager().authenticateUser("admin", "hyperion"); 

sessionOM = new SessionOM(); 

sessionInfo = sessionOM.createSession(ssoToken, Locale.ENGLISH, "HFM_DEV", "FINCAPP"); 

LoadExtractOM loadExtractOM = new LoadExtractOM(sessionInfo); 

DataExtractOptions dataExtractOptions = new DataExtractOptions(); 

dataExtractOptions.setDatabaseOption(DATA_PUSH_OPTION.STARSCHEMA_CREATE); 

dataExtractOptions.setDelimiter(";"); 

dataExtractOptions.setDSN("HFM_ETL_DEV"); 

dataExtractOptions.setExtractFormat(DATA_EXTRACT_TYPE_FLAG.EA_EXTRACT_TYPE_STANDARD); 

dataExtractOptions.setIncludeCalculatedData(true); 

dataExtractOptions.setIncludeCellDesc(false); 

dataExtractOptions.setIncludeData(true); 

dataExtractOptions.setIncludeDerivedData(true); 

dataExtractOptions.setIncludeDynamicAccounts(true); 

dataExtractOptions.setIncludePhaseGroup(false); 

dataExtractOptions.setLineItemOption(DATA_LINEITEM_OPTION.EA_LINEITEM_EXCLUDE); 

String metadataSlice = "S#ACTUAL_USD.Y#2014.P#Sep.W#YTD.E{[Base]}.V#<Entity Currency>.A{[Base]}.I{[Base]}.C1{[Base]}.C2{[Base]}.C3{[Base]}.C4{[Base]}"; 

dataExtractOptions.setMetadataSlice(metadataSlice); 

dataExtractOptions.setTablePrefix("TIEOUT"); 

int sessionID = loadExtractOM.extractData(dataExtractOptions); 

System.out.println(sessionID); 

} catch (Exception e) { 

// TODO Auto-generated catch block 

e.printStackTrace(); 

} finally { 

if (sessionOM != null && sessionInfo != null) 

sessionOM.closeSession(sessionInfo); 

} 

} 

}
Comments
Post Details
Added on Nov 20 2023
0 comments
118 views