oracle.epm.fm.domainobject.loadextract

Class LoadExtractOM

java.lang.Object

oracle.epm.fm.domainobject.loadextract.LoadExtractOM

All Implemented Interfaces:

Serializable

public class LoadExtractOM
extends Object
implements Serializable

LoadExtractOM class contains load/extract related APIs.

 
 This class is having APIs for loading/extracting various artifacts listed below.

 1. Security.
 2. Metadata.
 3. MemberList.
 4. Rules.
 5. Module config.
 6. Data.

 The below code snippet explains how to load Data using loadData API.

   List<DataLoadOptions> dataLoadOptions = new ArrayList<DataLoadOptions>();
   DataLoadOptions dlOptions = new DataLoadOptions();
   dlOptions.setAccumulateWithinFile(false);
   dlOptions.setAppendToLogFile(false);
   dlOptions.setContainSharesData(true);
   dlOptions.setContainSubmissionPhaseData(false);
   dlOptions.setDecimalChar("");
   dlOptions.setDelimiter(";");
   dlOptions.setDuplicates(DATALOAD_DUPLICATE_HANDLING.DATALOAD_MERGE);
   dlOptions.setFileFormat(DATALOAD_FILE_FORMAT.DATALOAD_FILE_FORMAT_NATIVE);
   dlOptions.loadCalculated = false;
   dlOptions.setMode(LOAD_MODE.LOAD);
   dlOptions.setThousandsChar("");
   dlOptions.setUserFileName("C:\Data.dat");
   dataLoadOptions.add(dlOptions);

   String fileWithPath = new File("C:\Data.dat");
   ArrayList<String> files = new ArrayList<String>(1);
   files.add(fileWithPath);

   LoadExtractOM loadOM = new LoadExtractOM(session);
   List<Integer> taskIDs = loadOM.loadData(files, dataLoadOptions);
   //need to check the running task completion status..
   List<RunningTaskProgress> listStatus = new AdministrationOM(session).getCurrentTaskProgress(taskIDs);
 
 

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LoadExtractOM(SessionInfo sessionInfo) Creates an instance of the LoadExtractOM object.

Method Summary

Modifier and Type	Method and Description
void	deleteTemplate(String templateName) Deletes a specific template from the user params table.
List<String>	enumDataExtractTemplates() Gets templates registered with extended analytics.
int	extractData(DataExtractOptions dataOptions) This method will extract data using the Extended Analytics extract engine.
LoadExtractInfo	extractDrillableRegions1(List<String> regionNames) extractDrillableRegions extracts Drillable Regions for an application.
LoadExtractStatus	extractDrillableRegionsInternal(List<String> regionNames) Internal Use Only extractDrillableRegions extracts Drillable Regions for an application.
LoadExtractInfo	extractICTransactions(ICTransactionsExtractOptions ICTOptions) extractICTransactions extract ICTransaction for an Application.
LoadExtractStatus	extractICTransactionsInternal(ICTransactionsExtractOptions ICTOptions) Internal Use Only extractICTransactions extract ICTransaction for an Application.
LoadExtractInfo	extractJournals(JournalExtractOptions journalOptions) extractJournals extract Journals for an Application.
LoadExtractStatus	extractJournalsInternal(JournalExtractOptions journalOptions) Internal Use Only extractMetadata extract Metadata for an Application.
LoadExtractInfo	extractMemberLists() extractMemberLists extract MemberList for an Application.
LoadExtractStatus	extractMemberListsInternal() Internal Use Only extractMemberLists extract MemberList for an Application.
LoadExtractInfo	extractMetadata(MetadataExtractOptions metadataOptions) extractMetadata extract Metadata for an Application.
LoadExtractStatus	extractMetadataInternal(MetadataExtractOptions metadataOptions) Internal Use Only extractMetadata extract Metadata for an Application.
LoadExtractInfo	extractModuleConfig() extractModuleConfig extract ModuleConfig for an Application.
LoadExtractStatus	extractModuleConfigInternal() Internal Use Only extractModuleConfig extract ModuleConfig for an Application.
LoadExtractInfo	extractRules(RULESEXTRACT_FILE_FORMAT fileFormat) extractRules extract rules for an Application.
LoadExtractStatus	extractRulesInternal(RULESEXTRACT_FILE_FORMAT fileFormat) Internal Use Only extractRules extract rules for an Application.
LoadExtractInfo	extractSecurity(SecurityExtractOptions securityOptions) extractSecurity extract Security for an Application.
LoadExtractStatus	extractSecurityInternal(SecurityExtractOptions securityOptions) Internal Use Only extractSecurity extract Security for an Application.
List<String>	getDSNs() Get list of DSNs.
ExtractTemplate	getTemplate(String templateName) Gets a specific template from the user params table.
List<Integer>	loadData(List<String> filePaths, List<DataLoadOptions> dataOptions) loadData loads Data for an Application.
void	loadDataAsynch(List<String> filePaths, List<DataLoadOptions> dataOptions) loadDataAsynch loads Data for an Application ,This is an asynchronous task, and the status can be tracked using Running task ID.
List<LoadExtractInfo>	loadDocuments(List<File> files, List<DocumentLoadOptions> documentOptions) loadDocuments loads documents for an application.
List<LoadExtractStatus>	loadDocumentsInternal(List<String> filePaths, List<DocumentLoadOptions> documentOptions) Internal Use Only loadDocuments loads documents for an Application.
LoadExtractInfo	loadDrillableRegions(File file, DRILL_REGIONS_LOAD_MODE loadMode) loadDrillableRegions loads ERPI Drillable Regions.
LoadExtractStatus	loadDrillableRegionsInternal(String filePath, DRILL_REGIONS_LOAD_MODE loadMode) Internal Use Only loadDrillableRegions loads ERPI Drillable Regions.
List<Integer>	loadICTransactions(List<String> filePaths, List<ICTransactionsLoadOptions> ICTOptions) loadICTransactions loads ICTransactions for an Application.
void	loadICTransactionsAsynch(List<String> filePaths, List<ICTransactionsLoadOptions> ICTOptions) loadICTransactionsAsynch loads ICTransactions for an Application Asynchronously.
List<LoadExtractInfo>	loadJournals(List<File> files, List<JournalLoadOptions> journalOptions) loadJournals loads Journals for an Application.
List<LoadExtractStatus>	loadJournalsInternal(List<String> filePaths, List<JournalLoadOptions> journalOptions) Internal Use Only loadJournals loads Journals for an Application.
LoadExtractInfo	loadMemberList(File file, boolean scanOnly) loadMemberList loads MemberList for an Application.
LoadExtractStatus	loadMemberListInternal(String filePath, boolean scanOnly) Internal Use Only loadMemberLists loads MemberLists for an Application.
LoadExtractInfo	loadMetadata(File file, MetadataLoadOptions metadataOptions) LoadMetadata loads Metadata for an Application.
LoadExtractStatus	loadMetadataInternal(String filePath, MetadataLoadOptions metadataOptions) Internal Use Only LoadMetadata loads Metadata for an Application.
LoadExtractInfo	loadModuleConfig(File file) loadModuleConfig loads ModuleConfig for an Application.
LoadExtractStatus	loadModuleConfigInternal(String filePath) Internal Use Only loadModuleConfig loads ModuleConfig for an Application.
LoadExtractInfo	loadRule(File file, RulesLoadOptions ruleOptions) loadRule loads rule for an Application.
LoadExtractStatus	loadRuleInternal(String filePath, RulesLoadOptions ruleOptions) Internal Use Only loadRule loads rule for an Application.
LoadExtractInfo	loadSecurity(File file, SecurityLoadOptions securityOptions) LoadSecurity loads Security for an Application.
LoadExtractStatus	loadSecurityInternal(String filePath, SecurityLoadOptions securityOptions) Internal Use Only LoadSecurity loads Security for an Application.
void	saveTemplate(ExtractTemplate eTemplate) Saves a template to the user parameters table.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LoadExtractOM

public LoadExtractOM(SessionInfo sessionInfo)
              throws HFMException

Creates an instance of the LoadExtractOM object.

Parameters:

sessionInfo - session information

Throws:

HFMException

Method Detail

getDSNs

public List<String> getDSNs()
                     throws HFMException

Get list of DSNs.

Returns:

list of DSN.

Throws:

HFMException

loadSecurityInternal

public LoadExtractStatus loadSecurityInternal(String filePath,
                                              SecurityLoadOptions securityOptions)
                                       throws HFMException

Internal Use Only LoadSecurity loads Security for an Application.

Parameters:

filePath - The full filepath

securityOptions - The SecurityLoadOptions object

Returns:

LoadExtractStatus that contains logfile and success/ failure status

Throws:

HFMException

loadRuleInternal

public LoadExtractStatus loadRuleInternal(String filePath,
                                          RulesLoadOptions ruleOptions)
                                   throws HFMException

Internal Use Only loadRule loads rule for an Application.

Parameters:

filePath - The file path to be loaded

ruleOptions - The ruleLoadOptions object

Returns:

LoadExtractStatus that contains logfile and success/ failure status

Throws:

HFMException

loadMetadataInternal

public LoadExtractStatus loadMetadataInternal(String filePath,
                                              MetadataLoadOptions metadataOptions)
                                       throws HFMException

Internal Use Only LoadMetadata loads Metadata for an Application.

Parameters:

filePath - The file path to be loaded

metadataOptions - The MetadataLoadOptions object

Returns:

LoadExtractStatus that contains logfile and success/ failure status

Throws:

HFMException

loadMemberListInternal

public LoadExtractStatus loadMemberListInternal(String filePath,
                                                boolean scanOnly)
                                         throws HFMException

Internal Use Only loadMemberLists loads MemberLists for an Application.

Parameters:

filePath - The file path to be loaded

scanOnly - The Load or Scan Option

Returns:

LoadExtractStatus that contains logfile and success/ failure status

Throws:

HFMException

loadModuleConfigInternal

public LoadExtractStatus loadModuleConfigInternal(String filePath)
                                           throws HFMException

Internal Use Only loadModuleConfig loads ModuleConfig for an Application.

Parameters:

filePath - The file path to be loaded.

Returns:

LoadExtractStatus that contains logfile and success/ failure status.

Throws:

HFMException

loadData

public List<Integer> loadData(List<String> filePaths,
                              List<DataLoadOptions> dataOptions)
                       throws HFMException

loadData loads Data for an Application.

Parameters:

filePaths - the full file paths to be loaded

dataOptions - The list of DataLoadOptions object , one each corresponding to the input file

Returns:

The list of running task Ids, one each corresponding to the input file

Throws:

HFMException

loadDataAsynch

public void loadDataAsynch(List<String> filePaths,
                           List<DataLoadOptions> dataOptions)
                    throws HFMException

loadDataAsynch loads Data for an Application ,This is an asynchronous task, and the status can be tracked using Running task ID.

Parameters:

filePaths - the file paths to be loaded

dataOptions - The list of DataLoadOptions object , one each corresponding to the input file

Throws:

HFMException

loadICTransactionsAsynch

public void loadICTransactionsAsynch(List<String> filePaths,
                                     List<ICTransactionsLoadOptions> ICTOptions)
                              throws HFMException

loadICTransactionsAsynch loads ICTransactions for an Application Asynchronously.

Parameters:

filePaths - the list of file path to be loaded

ICTOptions - list of ICTransactionsLoadOptions object , one each corresponding to the input file

Throws:

HFMException

loadICTransactions

public List<Integer> loadICTransactions(List<String> filePaths,
                                        List<ICTransactionsLoadOptions> ICTOptions)
                                 throws HFMException

loadICTransactions loads ICTransactions for an Application.

Parameters:

filePaths - the list of file path to be loaded

ICTOptions - list of ICTransactionsLoadOptions object , one each corresponding to the input file

Returns:

list of taskId

Throws:

HFMException

loadDrillableRegionsInternal

public LoadExtractStatus loadDrillableRegionsInternal(String filePath,
                                                      DRILL_REGIONS_LOAD_MODE loadMode)
                                               throws HFMException

Internal Use Only loadDrillableRegions loads ERPI Drillable Regions.

Parameters:

filePath - the full file paths to be loaded

loadMode - DRILL_REGIONS_LOAD_MODE

Returns:

LoadExtractStatus that contains logfile and success/ failure status

Throws:

HFMException

loadJournalsInternal

public List<LoadExtractStatus> loadJournalsInternal(List<String> filePaths,
                                                    List<JournalLoadOptions> journalOptions)
                                             throws HFMException

Internal Use Only loadJournals loads Journals for an Application.

Parameters:

filePaths - the list of file paths to be loaded

journalOptions - list of JournalLoadOptions object , one each corresponding to the input file

Returns:

list of LoadExtractStatus , one each corresponding to the input file

Throws:

HFMException

loadDocumentsInternal

public List<LoadExtractStatus> loadDocumentsInternal(List<String> filePaths,
                                                     List<DocumentLoadOptions> documentOptions)
                                              throws HFMException

Internal Use Only loadDocuments loads documents for an Application.

Parameters:

filePaths - the list of file paths to be loaded

documentOptions - The list of DocumentLoadOptions object , one each corresponding to the input file

Returns:

list of LoadExtractStatus , one each corresponding to the input file

Throws:

HFMException

extractMetadataInternal

public LoadExtractStatus extractMetadataInternal(MetadataExtractOptions metadataOptions)
                                          throws HFMException

Internal Use Only extractMetadata extract Metadata for an Application.

Parameters:

metadataOptions - The MetadataExtractOptions object

Returns:

LoadExtractStatus that contains file name and success/ failure status

Throws:

HFMException

extractJournalsInternal

public LoadExtractStatus extractJournalsInternal(JournalExtractOptions journalOptions)
                                          throws HFMException

Internal Use Only extractMetadata extract Metadata for an Application.

Parameters:

journalOptions - The JournalExtractOptions object

Returns:

LoadExtractStatus that contains file name and success/ failure status

Throws:

HFMException

extractSecurityInternal

public LoadExtractStatus extractSecurityInternal(SecurityExtractOptions securityOptions)
                                          throws HFMException

Internal Use Only extractSecurity extract Security for an Application.

Parameters:

securityOptions - The SecurityExtractOptions object

Returns:

LoadExtractStatus that contains file name and success/ failure status

Throws:

HFMException

extractICTransactionsInternal

public LoadExtractStatus extractICTransactionsInternal(ICTransactionsExtractOptions ICTOptions)
                                                throws HFMException

Internal Use Only extractICTransactions extract ICTransaction for an Application.

Parameters:

ICTOptions - The ICTransactionsExtractOptions object

Returns:

LoadExtractStatus that contains file name and success/ failure status

Throws:

HFMException

extractRulesInternal

public LoadExtractStatus extractRulesInternal(RULESEXTRACT_FILE_FORMAT fileFormat)
                                       throws HFMException

Internal Use Only extractRules extract rules for an Application.

Parameters:

fileFormat - - RULESEXTRACT_FILE_FORMAT

Returns:

LoadExtractStatus that contains file name and success/ failure status

Throws:

HFMException

extractMemberListsInternal

public LoadExtractStatus extractMemberListsInternal()
                                             throws HFMException

Internal Use Only extractMemberLists extract MemberList for an Application.

Returns:

LoadExtractStatus that contains file name and success/ failure status

Throws:

HFMException

extractModuleConfigInternal

public LoadExtractStatus extractModuleConfigInternal()
                                              throws HFMException

Internal Use Only extractModuleConfig extract ModuleConfig for an Application.

Returns:

LoadExtractStatus that contains file name and success/ failure status

Throws:

HFMException

extractData

public int extractData(DataExtractOptions dataOptions)
                throws HFMException

This method will extract data using the Extended Analytics extract engine.

Parameters:

dataOptions - The DataExtractOptions object

Returns:

The running task Id

Throws:

HFMException

extractDrillableRegionsInternal

public LoadExtractStatus extractDrillableRegionsInternal(List<String> regionNames)
                                                  throws HFMException

Internal Use Only extractDrillableRegions extracts Drillable Regions for an application.

Parameters:

regionNames - (urlNames)that need to extract

Returns:

LoadExtractStatus that contains file name and success/ failure status

Throws:

HFMException

enumDataExtractTemplates

public List<String> enumDataExtractTemplates()
                                      throws HFMException

Gets templates registered with extended analytics.

Returns:

list of template names.

Throws:

HFMException

getTemplate

public ExtractTemplate getTemplate(String templateName)
                            throws HFMException

Gets a specific template from the user params table.

Parameters:

templateName - the name of the template to retrive from user params.

Returns:

template

Throws:

HFMException

deleteTemplate

public void deleteTemplate(String templateName)
                    throws HFMException

Deletes a specific template from the user params table.

Parameters:

templateName - the name of the template to delete from user params.

Throws:

HFMException

saveTemplate

public void saveTemplate(ExtractTemplate eTemplate)
                  throws HFMException

Saves a template to the user parameters table.

Parameters:

eTemplate - the template to save

Throws:

HFMException

loadSecurity

public LoadExtractInfo loadSecurity(File file,
                                    SecurityLoadOptions securityOptions)
                             throws HFMException

LoadSecurity loads Security for an Application.

Parameters:

file - The security file to be loaded.

securityOptions - The SecurityLoadOptions object

Returns:

LoadExtractInfo that contains File Objects logFile,dataFile and success/ failure status.

Throws:

HFMException

loadRule

public LoadExtractInfo loadRule(File file,
                                RulesLoadOptions ruleOptions)
                         throws HFMException

loadRule loads rule for an Application.

Parameters:

file - The Rule file to be loaded

ruleOptions - The ruleLoadOptions object

Returns:

LoadExtractStatus that contains File objects logFile,dataFile and success/ failure status

Throws:

HFMException

loadMetadata

public LoadExtractInfo loadMetadata(File file,
                                    MetadataLoadOptions metadataOptions)
                             throws HFMException

LoadMetadata loads Metadata for an Application.

Parameters:

file - The Metadata file path to be loaded

metadataOptions - The MetadataLoadOptions object

Returns:

LoadExtractInfo that contains File Objects logFile,dataFile and success/ failure status

Throws:

HFMException

loadMemberList

public LoadExtractInfo loadMemberList(File file,
                                      boolean scanOnly)
                               throws HFMException

loadMemberList loads MemberList for an Application.

Parameters:

file - The Member list file to be loaded

scanOnly - The Load or Scan Option

Returns:

LoadExtractInfo that contains File Objects logfile,dataFile and success/ failure status

Throws:

HFMException

loadModuleConfig

public LoadExtractInfo loadModuleConfig(File file)
                                 throws HFMException

loadModuleConfig loads ModuleConfig for an Application.

Parameters:

file - The file to be loaded

Returns:

LoadExtractInfo that contains File Objects logFile,dataFile and success/ failure status

Throws:

HFMException

loadDrillableRegions

public LoadExtractInfo loadDrillableRegions(File file,
                                            DRILL_REGIONS_LOAD_MODE loadMode)
                                     throws HFMException

loadDrillableRegions loads ERPI Drillable Regions.

Parameters:

file - , The File to be loaded.

loadMode - DRILL_REGIONS_LOAD_MODE

Returns:

LoadExtractInfo that contains File Objects logFile,DataFile and success/ failure status

Throws:

HFMException

loadJournals

public List<LoadExtractInfo> loadJournals(List<File> files,
                                          List<JournalLoadOptions> journalOptions)
                                   throws HFMException

loadJournals loads Journals for an Application.

Parameters:

files - the list of Files to be loaded

journalOptions - list of JournalLoadOptions object , one each corresponding to the input file

Returns:

list of LoadExtractInfo , one each corresponding to the input file

Throws:

HFMException

loadDocuments

public List<LoadExtractInfo> loadDocuments(List<File> files,
                                           List<DocumentLoadOptions> documentOptions)
                                    throws HFMException

loadDocuments loads documents for an application.

Parameters:

files - list of Document Files to load.

documentOptions - options.

Returns:

list of LoadExtractInfo , one each corresponding to the input file

Throws:

HFMException

extractSecurity

public LoadExtractInfo extractSecurity(SecurityExtractOptions securityOptions)
                                throws HFMException

extractSecurity extract Security for an Application.

Parameters:

securityOptions - The SecurityExtractOptions object

Returns:

LoadExtractInfo that contains File objects and success/ failure status

Throws:

HFMException

extractRules

public LoadExtractInfo extractRules(RULESEXTRACT_FILE_FORMAT fileFormat)
                             throws HFMException

extractRules extract rules for an Application.

Parameters:

fileFormat - - RULESEXTRACT_FILE_FORMAT

Returns:

LoadExtractInfo that contains File objects and success/ failure status

Throws:

HFMException

extractMetadata

public LoadExtractInfo extractMetadata(MetadataExtractOptions metadataOptions)
                                throws HFMException

extractMetadata extract Metadata for an Application.

Parameters:

metadataOptions - The MetadataExtractOptions object

Returns:

LoadExtractInfo that contains File objects ande success/ failure status

Throws:

HFMException

extractMemberLists

public LoadExtractInfo extractMemberLists()
                                   throws HFMException

extractMemberLists extract MemberList for an Application.

Returns:

LoadExtractInfo that contains File objects and success/ failure status

Throws:

HFMException

extractModuleConfig

public LoadExtractInfo extractModuleConfig()
                                    throws HFMException

extractModuleConfig extract ModuleConfig for an Application.

Returns:

LoadExtractInfo that contains file name and success/ failure status

Throws:

HFMException

extractJournals

public LoadExtractInfo extractJournals(JournalExtractOptions journalOptions)
                                throws HFMException

extractJournals extract Journals for an Application.

Parameters:

journalOptions - The JournalExtractOptions object

Returns:

LoadExtractInfo that contains File Objects and success/ failure status

Throws:

HFMException

extractICTransactions

public LoadExtractInfo extractICTransactions(ICTransactionsExtractOptions ICTOptions)
                                      throws HFMException

extractICTransactions extract ICTransaction for an Application.

Parameters:

ICTOptions - The ICTransactionsExtractOptions object

Returns:

LoadExtractInfo that contains File Objects and success/ failure status

Throws:

HFMException

extractDrillableRegions1

public LoadExtractInfo extractDrillableRegions1(List<String> regionNames)
                                         throws HFMException

extractDrillableRegions extracts Drillable Regions for an application.

Parameters:

regionNames - (urlNames)that need to extract

Returns:

LoadExtractInfo that contains File Object and success/ failure status

Throws:

HFMException