Elenco API Java

Tabella 7-3 Elenco API Java

API	Descrizione
BigDecimal getPOVLocation(BigDecimal pLoadId)	Restituisce la chiave di partizionamento in base a LOADID.
BigDecimal getPOVCategory(BigDecimal pLoadId)	Restituisce la chiave categoria in base a LOADID.
Date getPOVStartPeriod(BigDecimal pLoadId)	Restituisce la chiave periodo in base a LOADID.
Date getPOVEndPeriod(BigDecimal pLoadId)	Restituisce la chiave periodo del periodo finale in base a LOADID quando il caricamento riguarda un solo periodo e il periodo di inizio e fine coincidono.
executePLSQL	Esegue il blocco del codice PL/SQL (Procedural Language/Structured Query Language). Questa API supporta i tre parametri riportati di seguito. Stringa: un blocco valido del codice PL/SQL. Il blocco PL/SQL deve essere racchiuso tra virgolette. Array oggetto: un array di input degli oggetti Java (ad esempio, String, BigDecimal) che rappresenta i parametri di input per il blocco del codice. L'array oggetto deve essere inserito nel codice PL/SQL dove ci sono segnaposti (punti di domanda). Booleano: se eseguire o meno il commit Il valore booleano può essere True o False. Di seguito è fornito un esempio di come eseguire il codice PL/SQL: fdmAPI.executePLSQL("BEGIN dbms_stats.gather_table_stats(user,?,estimate_percent=>dbms_stats.auto_sample_size,force=>TRUE); END;", ["tDataSeg_T"], True);
getBatchJobDetails	getBatchJobDetails restituisce le colonne riportate di seguito per ogni job sottomesso dal batch. BATCH_ID BATCH_NAME APPLICATION_ID BATCH_TYPE BATCH_EXECUTION_MODE BATCH_WAIT_TIMEOUT USER_POV_PERIOD OPEN_BATCH_FOLDER PLAN_TYPE FILENAME_SEPARATOR BATCH_GROUP_ID BEF_PROCESS_BATCH_SCRIPT AFT_PROCESS_BATCH_SCRIPT EXECUTION_DATE EXECUTED_BY LOADID BATCH_LOADID PARENT_BATCH_LOADID PARTITIONKEY CATKEY START_PERIODKEY END_PERIODKEY IMPORT_FROM_SOURCE_FLAG EXPORT_TO_TARGET_FLAG RECALCULATE_FLAG CHECK_FLAG JOURNAL_FLAG IMPORT_MODE EXPORT_MODE IMPGROUPKEY PROCESS_NAME RULE_TYPE LOG_FILE OUTPUT_FILE EPM_ORACLE_INSTANCE ODI_SESSION_NUMBER STATUS
int executeDML(String query,Object[] parameters)	Esegue qualsiasi istruzione DML. Fornire la query e il parametro. Il parametro viene fornito sotto forma di elenco.
logDB(String pEntityType, String pEntityName, int pLogSequence, String pLogMessage)	Registra i messaggi nella tabella di database AIF_PROCESS_LOGS.
logFatal(String pLogMessage)	Registra un messaggio quando si verifica un errore irreversibile. Il messaggio viene visualizzato a tutti i livelli di log.
logError(String pLogMessage)	Registra un messaggio quando si verifica un errore. Il messaggio viene visualizzato al livello di log 2 o superiore.
logWarn(String pLogMessage)	Registra un messaggio quando si verifica un errore con condizione di avviso. Il messaggio viene visualizzato al livello di log 3 o superiore.
logInfo(String pLogMessage)	Registra un messaggio informativo. Il messaggio viene visualizzato al livello di log 4 o superiore.
logDebug(String pLogMessage)	Registra un messaggio di debug. Il messaggio viene visualizzato al livello di log 5.
Map getProcessStates(BigDecimal pLoadId)	Restituisce lo stato del processo del flusso di lavoro. Stati disponibili: IMPSTATUS: restituisce lo stato del processo di importazione. Lo stato 0 indica che il processo non è ancora stato avviato o che il processo non è riuscito. Lo stato 1 indica che il processo ha avuto esito positivo. VALSTATUS: restituisce lo stato del processo di convalida. Lo stato 0 indica che il processo non è ancora stato avviato o che il processo non è riuscito. Lo stato 1 indica che il processo ha avuto esito positivo. EXPSTATUS: restituisce lo stato del processo di esportazione. Lo stato 0 indica che il processo non è ancora stato avviato o che il processo non è riuscito. Lo stato 1 indica che il processo ha avuto esito positivo. CHKSTATUS: restituisce lo stato del processo di controllo. Lo stato 0 indica che il processo non è ancora stato avviato o che il processo non è riuscito. Lo stato 1 indica che il processo ha avuto esito positivo. PROCESSSTATUS: restituisce il codice esatto dell'errore. I dettagli relativi al codice di errore sono disponibili nella tabella tlogprocessstates.
Map getPeriodDetail(Date pPeriodKey,String pApplicationName) //restituisce PERIODTARGET e YEARTARGET	Restituisce il mapping del periodo target per una chiave periodo specificata.
Object getCustomScriptParameterValue(BigDecimal pLoadId,String pParameterName)	Restituisce il valore per il nome e l'ID caricamento di un determinato parametro dello script custom.
Object getCustomScriptParameterValue(String pParameterName)	Restituisce il valore per un dato nome parametro script custom e l'ID caricamento inizializzato a livello di contesto
ResultSet getBatchDetails()	Restituisce le informazioni sulla definizione del batch della tabella AIF_BATCHES. getBatchDetails() restituisce i campi riportati di seguito. BATCH_ID BATCH_NAME APPLICATION_ID BATCH_TYPE BATCH_EXECUTION_MOD
ResultSet getBatchJobDetails(BigDecimal pLoadId)	Recupera i messaggi di errore registrati nella tabella del database AIF_PROCESS_LOGS per un determinato ID caricamento.
ResultSet getCategoryList()	Restituisce l'elenco dei categorie in un set di risultati. getCategoryList() restituisce i campi riportati di seguito. CATKEY CATNAME
ResultSet getCheckEntityGroupList(BigDecimal pApplicationId)	Restituisce l'elenco dei gruppi di controllo in un set di risultati.
ResultSet getCheckEntityForGroup(String pValGroupKey)	Restituisce l'elenco delle entità di un gruppo di controllo in un set di risultati.
ResultSe tgetCheckEntityGroupList(BigDecimal pApplicationId)	Restituisce l'elenco dei gruppi di regole di controllo in un set di risultati.
ResultSet getCheckEntityForGroup	Restituisce l'elenco delle regole del gruppo di regole di controllo in un set di risultati.
ResultSet getCustomDBLog()	Recupera i messaggi di errore registrati nella tabella del database AIF_PROCESS_LOGS per il processo corrente. getCustomDBLog() restituisce i campi riportati di seguito. ENTITY_TYPE ENTITY_NAME LOG_SEQUENCE
ResultSet getCustomDBLog(BigDecimal pLoadId)	Restituisce le istruzioni di log del DB per un ID caricamento specificato.
ResultSet getCustomScriptParameters()	Restituisce l'elenco dei parametri dello script custom in un set di risultati per l'ID caricamento inizializzato a livello di contesto.
ResultSet getCustomScriptParameters(BigDecimal pLoadId)	Restituisce l'elenco dei parametri dello script custom in un set di risultati per l'ID caricamento specificato.
ResultSet getPeriodList()	Restituisce l'elenco dei periodi in un set di risultati. getPeriodList() restituisce i campi riportati di seguito. PERIODKEY PERIODDESC
ResultSet executeQuery(String query, Object[] parameters)	Esegue qualsiasi istruzione SQL Query. I risultati della query vengono restituiti in un set di risultati. Fornire la query e il parametro. Il parametro viene fornito sotto forma di elenco.
ResultSet getImportFormatDetails(String pImpGroupKey)	Restituisce i dettagli del formato di importazione in un set di risultati in base alla chiave del formato di importazione. getImportFormatDetails(String pImpGroupKey) restituisce i campi riportati di seguito. IMPGROUPKEY IMPGROUPDESC IMPGROUPFILETYPE IMPGROUPDELIMITER IMPGROUPTYPE IMPSOURCESYSTEMID IMPSOURCELEDGERID IMPSOURCECOAID IMPTARGETAPPLICATIONID IMPADAPTERID IMPDRILLURLID IMPODISCENARIO IMPREGENSCEN IMPDRILLREQUESTMETHOD IMPDRILLURL IMPTARGETSOURCESYSTEMID
ResultSet getImportFormatMapDetails(String pImpGroupKey)	Restituisce i dettagli del mapping del formato di importazione in un set di risultati per una chiave formato di importazione specificata. Al momento sono supportati solo i formati di importazione basati su file. getImportFormatMapDetails(String pImpGroupKey) restituisce i campi riportati di seguito. IMPSEQ IMPGROUPKEY IMPFLDFIELDNAME IMPFLDFIXEDTEXT IMPFLDSTARTPOS IMPFLDLENGTH IMPFLDSOURCECOLNAME
ResultSet getLocationDetails(BigDecimal pPartitionKey)	Restituisce i dettagli della posizione in un set di record per una chiave posizione specificata. getLocationDetails restituisce i campi riportati di seguito. PARTITIONKEY PARTNAME PARTDESC PARTNOTES PARTLASTIMPFILE PARTLASTEXPFILE PARTIMPGROUP PARTLOGICGROUP PARTVALGROUP PARTVALENTGROUP PARTCURRENCYKEY PARTPARENT PARTTYPE PARTSEQMAP PARTDATAVALUE PARTSEGMENTKEY PARTCONTROLSTYPE PARTCONTROLSGROUP1 PARTCONTROLSGROUP2 PARTCONTROLSAPPROVER PARTCONTROLSAPPROVERPROXY PARTCONTROLSREDFLAGLEVEL PARTCLOGICGROUP PARTINTGCONFIG1 PARTINTGCONFIG2 PARTINTGCONFIG3 PARTINTGCONFIG4 PARTADAPTOR PARTSOURCESYSTEMID PARTSOURCELEDGERID PARTTARGETAPPLICATIONID PARTPARENTKEY PARTSOURCEAPPLICATIONID PARTTARGETSOURCESYSTEMID Ad esempio, per sapere i campi restituiti da getLocationDetails API, eseguire lo script riportato di seguito. rs = fdmAPI.getLocationDetails(fdmContext["LOCKEY"]) i = 1 metaData = rs.getMetaData() while i <= metaData.getColumnCount(): fdmAPI.logDebug(metaData.getColumnLabel(i)) i +=1
ResultSet getRuleDetails(BigDecimal pRuleId)	Restituisce i dettagli della regola dati in un set di record per un ID regola dati specificato. getRuleDetails(BigDecimal pRuleId) restituisce i campi riportati di seguito. RULE_ID SOURCE_SYSTEM_ID SOURCE_LEDGER_ID APPLICATION_ID RULE_NAME RULE_DESCRIPTION PLAN_TYPE LEDGER_GROUP INCL_ZERO_BALANCE_FLAG BALANCE_SELECTION AMOUNT_TYPE BALANCE_METHOD_CODE BALANCE_TYPE BAL_SEG_VALUE_OPTION_CODE EXCHANGE_RATE_OPTION_CODE EXCHANGE_BEGIN_RATE_TYPE EXCHANGE_END_RATE_TYPE EXCHANGE_AVERAGE_RATE_TYPE DATA_SYNC_OBJECT DATA_SYNC_OBJECT_ID PARTCONTROLSAPPROVERPROXY PARTCONTROLSREDFLAGLEVEL STATUS PARTITIONKEY CATKEY INCLUDE_ADJ_PERIODS_FLAG BALANCE_AMOUNT_BS BALANCE_AMOUNT_IS AS_OF_DATE BLANK_PERIODKEY BR_MEMBER_NAME BR_MEMBER_DISP_NAME CALENDAR_ID CURRENCY_CODE DP_MEMBER_NAME FILE_NAME_DATE_FORMAT FILE_NAME_STATIC FILE_NAME_SUFFIX_TYPE FILE_PATH LEDGER_GROUP_ID PERIOD_MAPPING_TYPE VERSION SIGNAGE_METHOD DIRECT_FILE_LOAD_FLAG LOAD_OPTIONS RULE_ATTR1 RULE_ATTR2 RULE_ATTR3 RULE_ATTR4 ICP_LOAD MULTI_PERIOD_FILE_FLAG IMPGROUPKEY SOURCE_APP_PLAN_TYPE
showCustomDBLog()	Mostra un elenco di messaggi custom nell'interfaccia utente dopo il completamento di un processo. Il messaggio può essere visualizzato al termine di un passo del flusso di lavoro del caricamento dati, quali importazione, convalida, esportazione e controllo o al termine dell'esecuzione di uno script custom. Si noti che i messaggi vengono visualizzati solo se il processo viene eseguito in modalità in linea.
showCustomFile(String filePath)	Mostra un file custom (file di log, file di report) nell'interfaccia utente dopo il completamento di un processo. Il messaggio può essere visualizzato al termine di un passo del flusso di lavoro del caricamento dati, quali importazione, convalida, esportazione e controllo o al termine dell'esecuzione di uno script custom. Si noti che i messaggi vengono visualizzati solo se il processo viene eseguito in modalità in linea.
showCustomMessage(String message)	Mostra un messaggio custom nell'interfaccia utente dopo il completamento di un processo. Il messaggio può essere visualizzato al termine di un passo del flusso di lavoro del caricamento dati, quali importazione, convalida, esportazione e controllo o al termine dell'esecuzione di uno script custom. Si noti che i messaggi vengono visualizzati solo se il processo viene eseguito in modalità in linea.
String getCategoryMap(BigDecimal pCatKey,String pApplicationName)	Restituisce lo scenario per la categoria e il nome applicazione specificati.
String getCustomMessage()	Recupera l'ultimo messaggio custom generato per il processo corrente.
String getCustomMessage(BigDecimal pLoadId)	Recupera l'ultimo messaggio custom generato per l'ID caricamento specificato.
String getCustomFile()	Recupera il file custom creato per il processo corrente.
String getCustomFile(BigDecimal pLoadId)	Recupera il file custom creato per l'ID caricamento specificato.
String getPOVDataValue(BigDecimal pPartitionKey)	Restituisce il valore dati della posizione.
String getDirTopLevel(BigDecimal pApplicationId)	Restituisce la directory di primo livello in base all'applicazione.
String getDirInbox(BigDecimal pApplicationId)	Restituisce la directory `Inbox` in base all'applicazione.
String getDirOutbox(BigDecimal pApplicationId)	Restituisce la directory `Outbox` in base all'applicazione.
String getDirScripts(BigDecimal pApplicationId)	Restituisce la directory `Scripts` in base all'applicazione.
String getProfileOptionValue(String pProfileOptionName, BigDecimal pApplicationId, String pUserName)	Restituisce il set di valori per un'opzione. È possibile impostare le opzioni a livello di impostazioni di sistema, impostazioni applicazione e impostazioni utente. L'ordine di precedenza è: utente, applicazione e sistema. L'API determina il valore appropriato applicabile e restituisce il valore.
void writeToProcessLogsDB(BigDecimal pLoadId, String pEntityType, String pEntityName, int pLogSequence,String pLogMessage)	Scrive le informazioni di log nella tabella AIF_PROCESS_LOGS. Utilizza i valori di Tipo entità e Nome entità per raggruppare i messaggi registrati. I log possono essere creati solo da un processo del flusso di lavoro di caricamento dati.
void writeToProcessLogsFile(BigDecimal pLoadId, String pLogMessage)	Scrive le informazioni di log nel file di log del processo di caricamento dati. I log vengono scritti in base al livello di log del processo. I log possono essere creati solo da un processo del flusso di lavoro di caricamento dati. Nota: Si consiglia di utilizzare l'API di logging, ad esempio l'API logDebug o logInfo, invece di utilizzare l'API writeToProcessLogsFile.
void closeConnection()	Consente di chiudere la connessione al database.
void closeResultSet(ResultSet resultSet)	Consente di chiudere l'oggetto risultato.
void updateImportFormat(String pImpgroupKey,BigDecimal pLoadId)	Aggiorna il formato di importazione per l'esecuzione corrente. È applicabile solo per i formati di importazione basati su file.