Liste des API Java

Tableau 7-3 Liste des API Java

API	Description
BigDecimal getPOVLocation(BigDecimal pLoadId)	Renvoie la clé de partition en fonction de l'élément LOADID.
BigDecimal getPOVCategory(BigDecimal pLoadId)	Renvoie la clé de catégorie en fonction de l'élément LOADID.
Date getPOVStartPeriod(BigDecimal pLoadId)	Renvoie la clé de la période de début en fonction de l'élément LOADID.
Date getPOVEndPeriod(BigDecimal pLoadId)	Renvoie la clé de la période de fin en fonction de l'élément LOADID en cas de chargement d'une seule période, les périodes de début et de fin étant identiques.
executePLSQL	Exécute un bloc de code PL/SQL (Procedural Language/Structured Query Language). Cette API utilise les trois paramètres suivants : String : bloc de code PL/SQL valide. Le bloc PL/SQL doit être entre guillemets. Object array : liste d'entrée d'objets Java (par ex., String, BigDecimal) représentant des paramètres d'entrée dans le bloc de code. La liste d'objets sert à effectuer une insertion dans le bloc PL/SQL au niveau des espaces réservés (points d'interrogation). Boolean : indique si une validation est à effectuer ou non La valeur booléenne peut être True ou False. Exemple d'exécution de code 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	L'API getBatchJobDetails renvoie la colonne suivante pour chaque job soumis par le lot : 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)	Exécute n'importe quelle instruction DML. Fournit la requête et le paramètre. Le paramètre est fourni sous la forme d'une liste.
logDB(String pEntityType, String pEntityName, int pLogSequence, String pLogMessage)	Consigne les messages dans une table de base de données AIF_PROCESS_LOGS.
logFatal(String pLogMessage)	Consigne un message lorsqu'une erreur fatale se produit. Ce message s'affiche à tous les niveaux de consignation.
logError(String pLogMessage)	Consigne un message lorsqu'une erreur se produit. Ce message s'affiche au niveau de consignation 2 ou plus.
logWarn(String pLogMessage)	Consigne un message lorsqu'une erreur de condition d'avertissement se produit. Ce message s'affiche au niveau de consignation 3 ou plus
logInfo(String pLogMessage)	Consigne un message d'information. Ce message s'affiche au niveau de consignation 4 ou plus.
logDebug(String pLogMessage)	Consigne un message de débogage. Ce message s'affiche au niveau de consignation 5.
Map getProcessStates(BigDecimal pLoadId)	Renvoie le statut du processus de workflow. Statuts disponibles : IMPSTATUS : renvoie le statut du processus d'import. Le statut 0 indique que le processus n'a pas encore commencé ou qu'il a échoué. Le statut 1 indique le succès du processus. VALSTATUS : renvoie le statut du processus de validation. Le statut 0 indique que le processus n'a pas encore commencé ou qu'il a échoué. Le statut 1 indique le succès du processus. EXPSTATUS : renvoie le statut du processus d'export. Le statut 0 indique que le processus n'a pas encore commencé ou qu'il a échoué. Le statut 1 indique le succès du processus. CHKSTATUS : renvoie le statut du processus de vérification. Le statut 0 indique que le processus n'a pas encore commencé ou qu'il a échoué. Le statut 1 indique le succès du processus. PROCESSSTATUS : renvoie le code d'erreur exact. Le détail du code d'erreur est disponible dans la table tlogprocessstates.
Map getPeriodDetail(Date pPeriodKey,String pApplicationName) //returns PERIODTARGET and YEARTARGET	Renvoie le mapping de période cible pour une clé de période donnée.
Object getCustomScriptParameterValue(BigDecimal pLoadId,String pParameterName)	Renvoie la valeur correspondant au nom de paramètre de script personnalisé et à l'élément loadID indiqués.
Object getCustomScriptParameterValue(String pParameterName)	Renvoie la valeur du nom de paramètre de script personnalisé donné et le contexte initialisé chargé.
ResultSet getBatchDetails()	Renvoie les informations de définition de lot de la table AIF_BATCHES. Champs renvoyés par getBatchDetails() : BATCH_ID BATCH_NAME APPLICATION_ID BATCH_TYPE BATCH_EXECUTION_MOD
ResultSet getBatchJobDetails(BigDecimal pLoadId)	Extrait les messages d'erreur consignés dans la table de base de données AIF_PROCESS_LOGS pour l'élément loadid indiqué.
ResultSet getCategoryList()	Renvoie la liste des catégories dans un ensemble de résultats. Champs renvoyés par getCategoryList() : CATKEY CATNAME
ResultSet getCheckEntityGroupList(BigDecimal pApplicationId)	Renvoie la liste des groupes de vérifications dans un ensemble de résultats.
ResultSet getCheckEntityForGroup(String pValGroupKey)	Renvoie la liste des entités d'un groupe de vérifications dans un ensemble de résultats.
ResultSet getCheckEntityGroupList(BigDecimal pApplicationId)	Renvoie la liste des groupes de règles de vérification dans un ensemble de résultats.
ResultSet getCheckEntityForGroup	Renvoie la liste des règles de groupe de règles de vérification dans un ensemble de résultats.
ResultSet getCustomDBLog()	Extrait les messages d'erreur consignés dans la table de base de données AIF_PROCESS_LOGS pour le processus en cours. Champs renvoyés par getCustomDBLog() : ENTITY_TYPE ENTITY_NAME LOG_SEQUENCE
ResultSet getCustomDBLog(BigDecimal pLoadId)	Renvoie les instructions de consignation de la base de données pour un élément loadID donné.
ResultSet getCustomScriptParameters()	Renvoie la liste des paramètres de script personnalisé dans un ensemble de résultats pour l'élément loadID initialisé de contexte.
ResultSet getCustomScriptParameters(BigDecimal pLoadId)	Renvoie la liste des paramètres de script personnalisé dans un ensemble de résultats pour l'élément loadID indiqué.
ResultSet getPeriodList()	Renvoie la liste des périodes dans un ensemble de résultats. Champs renvoyés par getPeriodList() : PERIODKEY PERIODDESC
ResultSet executeQuery(String query, Object[] parameters)	Exécute n'importe quelle instruction de requête SQL. Les résultats de la requête sont renvoyés dans un ensemble de résultats. Fournit la requête et le paramètre. Le paramètre est fourni sous la forme d'une liste.
ResultSet getImportFormatDetails(String pImpGroupKey)	Renvoie les détails du format d'import dans un ensemble de résultats en fonction de la clé du format d'import. Champs renvoyés par getImportFormatDetails(String pImpGroupKey) : IMPGROUPKEY IMPGROUPDESC IMPGROUPFILETYPE IMPGROUPDELIMITER IMPGROUPTYPE IMPSOURCESYSTEMID IMPSOURCELEDGERID IMPSOURCECOAID IMPTARGETAPPLICATIONID IMPADAPTERID IMPDRILLURLID IMPODISCENARIO IMPREGENSCEN IMPDRILLREQUESTMETHOD IMPDRILLURL IMPTARGETSOURCESYSTEMID
ResultSet getImportFormatMapDetails(String pImpGroupKey)	Renvoie les détails du mapping du format d'import dans un ensemble de résultats pour une clé de format d'import donnée. Ne prend actuellement en charge que les formats d'import basés sur des fichiers. Champs renvoyés par getImportFormatMapDetails(String pImpGroupKey) : IMPSEQ IMPGROUPKEY IMPFLDFIELDNAME IMPFLDFIXEDTEXT IMPFLDSTARTPOS IMPFLDLENGTH IMPFLDSOURCECOLNAME
ResultSet getLocationDetails(BigDecimal pPartitionKey)	Renvoie les détails de l'emplacement dans un ensemble d'enregistrements pour une clé d'emplacement donnée. Champs renvoyés par getLocationDetails : 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 Par exemple, si vous souhaitez connaître les champs renvoyés par l'API getLocationDetails, exécutez le script suivant : 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)	Renvoie les détails de la règle de données dans un ensemble d'enregistrements pour un ID de règle de données donné. Champs renvoyés par getRuleDetails(BigDecimal pRuleId) : 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()	Affiche la liste des messages personnalisés dans l'interface utilisateur après exécution d'un processus. Le message peut être affiché à la fin d'une étape de workflow de chargement de données telle que l'import, la validation, l'export ou la vérification, ou à la fin de l'exécution d'un script personnalisé. Les messages s'affichent uniquement si les processus sont exécutés en mode en ligne.
showCustomFile(String filePath)	Affiche un fichier personnalisé (fichier journal, fichier de rapport) dans l'interface utilisateur après exécution d'un processus. Le message peut être affiché à la fin d'une étape de workflow de chargement de données telle que l'import, la validation, l'export ou la vérification, ou à la fin de l'exécution d'un script personnalisé. Les messages s'affichent uniquement si les processus sont exécutés en mode en ligne.
showCustomMessage(String message)	Affiche un message personnalisé dans l'interface utilisateur après exécution d'un processus. Le message peut être affiché à la fin d'une étape de workflow de chargement de données telle que l'import, la validation, l'export ou la vérification, ou à la fin de l'exécution d'un script personnalisé. Les messages s'affichent uniquement si les processus sont exécutés en mode en ligne.
String getCategoryMap(BigDecimal pCatKey,String pApplicationName)	Renvoie le scénario pour une catégorie et un nom d'application donnés.
String getCustomMessage()	Extrait le dernier message personnalisé émis pour le processus en cours.
String getCustomMessage(BigDecimal pLoadId)	Extrait le dernier message personnalisé émis pour l'élément loadid indiqué.
String getCustomFile()	Extrait le fichier personnalisé créé pour le processus en cours.
String getCustomFile(BigDecimal pLoadId)	Extrait le fichier personnalisé créé pour l'élément loadid indiqué.
String getPOVDataValue(BigDecimal pPartitionKey)	Renvoie la valeur de données de l'emplacement.
String getDirTopLevel(BigDecimal pApplicationId)	Renvoie le répertoire de niveau supérieur en fonction de l'application.
String getDirInbox(BigDecimal pApplicationId)	Renvoie le répertoire `Inbox` en fonction de l'application.
String getDirOutbox(BigDecimal pApplicationId)	Renvoie le répertoire `Outbox` en fonction de l'application.
String getDirScripts(BigDecimal pApplicationId)	Renvoie le répertoire `Scripts` en fonction de l'application.
String getProfileOptionValue(String pProfileOptionName, BigDecimal pApplicationId, String pUserName)	Renvoie la valeur définie pour une option. Les options peuvent être définies au niveau du paramètre système, du paramètre d'application et du paramètre utilisateur. L'ordre de priorité est le suivant : utilisateur, application, puis système. L'API détermine la valeur applicable appropriée et la renvoie.
void writeToProcessLogsDB(BigDecimal pLoadId, String pEntityType, String pEntityName, int pLogSequence,String pLogMessage)	Ecrit les informations de journal dans la table AIF_PROCESS_LOGS. Utilise le type et le nom d'entité pour regrouper les messages consignés. Les journaux peuvent uniquement être créés à partir d'un processus de workflow de chargement de données.
void writeToProcessLogsFile(BigDecimal pLoadId, String pLogMessage)	Ecrit les informations de journal dans le fichier journal du processus de chargement de données. Les journaux sont écrits en fonction du niveau de consignation du processus. Les journaux peuvent uniquement être créés à partir d'un processus de workflow de chargement de données. Remarque : Il est recommandé d'utiliser l'API de journalisation (par exemple, logDebug ou logInfo) plutôt que l'API writeToProcessLogsFile.
void closeConnection()	Sert à fermer la connexion à la base de données.
void closeResultSet(ResultSet resultSet)	Sert à fermer l'objet de résultat.
void updateImportFormat(String pImpgroupKey,BigDecimal pLoadId)	Met à jour le format d'import pour l'exécution en cours. S'applique uniquement aux formats d'import basés sur des fichiers.