Tabelle 7-3 Java-API-Liste
API | Beschreibung |
---|---|
BigDecimal getPOVLocation(BigDecimal pLoadId) | Gibt den Partitionsschlüssel basierend auf der LOADID zurück. |
BigDecimal getPOVCategory(BigDecimal pLoadId) | Gibt den Kategorieschlüssel basierend auf der LOADID zurück. |
Date getPOVStartPeriod(BigDecimal pLoadId) | Gibt den Periodenschlüssel der Startperiode basierend auf der LOADID zurück. |
Date getPOVEndPeriod(BigDecimal pLoadId) | Gibt den Periodenschlüssel der Endperiode basierend auf der LOADID zurück, wenn eine einzelne Periode geladen wird sowie Start- und Endperiode identisch sind. |
executePLSQL |
Führt einen Procedural Language/Structured Query Language-(PL/SQL-)Codeblock aus. Für diese API gelten die folgenden drei Parameter:
Beispiel für die Ausführung des PL/SQL-Codes: fdmAPI.executePLSQL("BEGIN dbms_stats.gather_table_stats(user,?,estimate_percent=>dbms_stats.auto_sample_size,force=>TRUE); END;", ["tDataSeg_T"], True); |
getBatchJobDetails |
Die API "getBatchJobDetails" gibt für jeden vom Batch weitergeleiteten Job die folgenden Spalten zurück:
|
int executeDML(String query,Object[] parameters) | Führt eine beliebige DML-Anweisung aus. Geben Sie die Abfrage und den Parameter an. Der Parameter wird als Liste bereitgestellt. |
logDB(String pEntityType, String pEntityName, int pLogSequence, String pLogMessage) | Protokolliert Meldungen in der Datenbanktabelle AIF_PROCESS_LOGS. |
logFatal(String pLogMessage) | Protokolliert eine Meldung, wenn ein schwerwiegender Fehler auftritt. Diese Meldung wird auf allen Logebenen angezeigt. |
logError(String pLogMessage) | Protokolliert eine Meldung, wenn ein Fehler auftritt. Diese Meldung wird auf Logebene 2 oder höher angezeigt. |
logWarn(String pLogMessage) | Protokolliert eine Meldung, wenn ein Fehler mit einer Warnbedingung auftritt. Diese Meldung wird auf Logebene 3 oder höher angezeigt. |
logInfo(String pLogMessage) | Protokolliert eine Informationsmeldung. Diese Meldung wird auf Logebene 4 oder höher angezeigt. |
logDebug(String pLogMessage) | Protokolliert eine Debugmeldung. Diese Meldung wird auf Logebene 5 angezeigt. |
Map getProcessStates(BigDecimal pLoadId) |
Gibt den Status des Workflowprozesses zurück. Verfügbare Statusangaben:
|
Map getPeriodDetail(Date pPeriodKey,String pApplicationName) //gibt PERIODTARGET und YEARTARGET zurück | Gibt die Zielperiodenzuordnung für einen bestimmten Periodenschlüssel zurück. |
Object getCustomScriptParameterValue(BigDecimal pLoadId,String pParameterName) | Gibt den Wert für den Parameternamen und die Load-ID eines bestimmten benutzerdefinierten Skriptes zurück. |
Object getCustomScriptParameterValue(String pParameterName) | Gibt den Wert für den Parameternamen und die kontextinitialisierte Load-ID eines bestimmten benutzerdefinierten Skriptes zurück. |
ResultSet getBatchDetails() |
Gibt Batchdefinitionsinformationen aus der Tabelle AIF_BATCHES zurück. Von getBatchDetails() zurückgegebene Felder:
|
ResultSet getBatchJobDetails(BigDecimal pLoadId) | Ruft Fehlermeldungen ab, die für die angegebene Load-ID in der Datenbanktabelle AIF_PROCESS_LOGS protokolliert wurden. |
ResultSet getCategoryList() |
Gibt eine Liste der Kategorien in einer Ergebnisgruppe zurück. Von getCategoryList() zurückgegebene Felder:
|
ResultSet getCheckEntityGroupList(BigDecimal pApplicationId) | Gibt eine Liste der Prüfgruppen in einer Ergebnisgruppe zurück. |
ResultSet getCheckEntityForGroup(String pValGroupKey) | Gibt eine Liste der Entitys in einer Prüfgruppe in einer Ergebnisgruppe zurück. |
ResultSet getCheckEntityGroupList(BigDecimal pApplicationId) | Gibt eine Liste der Prüfregelgruppen in einer Ergebnisgruppe zurück. |
ResultSet getCheckEntityForGroup | Gibt eine Liste der Regeln einer Prüfregelgruppe in einer Ergebnisgruppe zurück. |
ResultSet getCustomDBLog() |
Ruft Fehlermeldungen ab, die für den aktuellen Prozess in der Datenbanktabelle AIF_PROCESS_LOGS protokolliert wurden. Von getCustomDBLog() zurückgegebene Felder:
|
ResultSet getCustomDBLog(BigDecimal pLoadId) | Gibt die Loganweisungen aus der Datenbank für eine angegebene Load-ID zurück. |
ResultSet getCustomScriptParameters() | Gibt die Liste der benutzerdefinierten Skriptparameter in einer Ergebnisgruppe für die kontextinitialisierte Load-ID zurück. |
ResultSet getCustomScriptParameters(BigDecimal pLoadId) | Gibt die Liste der benutzerdefinierten Skriptparameter in einer Ergebnisgruppe für die angegebene Load-ID zurück. |
ResultSet getPeriodList() |
Gibt eine Liste der Perioden in einer Ergebnisgruppe zurück. Von getPeriodList() zurückgegebene Felder:
|
ResultSet executeQuery(String query, Object[] parameters) | Führt eine beliebige SQL-Abfrageanweisung aus. Die Abfrageergebnisse werden in einer Ergebnisgruppe zurückgegeben. Geben Sie die Abfrage und den Parameter an. Der Parameter wird als Liste bereitgestellt. |
ResultSet getImportFormatDetails(String pImpGroupKey) |
Gibt die Importformatdetails in einer Ergebnisgruppe basierend auf dem Importformatschlüssel zurück. Von getImportFormatDetails(String pImpGroupKey) zurückgegebene Felder:
|
ResultSet getImportFormatMapDetails(String pImpGroupKey) |
Gibt die Details der Importformatzuordnung in einer Ergebnisgruppe für einen bestimmten Importformatschlüssel zurück. Dies unterstützt derzeit nur dateibasierte Importformate. Von getImportFormatMapDetails(String pImpGroupKey) zurückgegebene Felder:
|
ResultSet getLocationDetails(BigDecimal pPartitionKey) |
Gibt die Locationdetails in einer Ergebnisgruppe für einen bestimmten Locationschlüssel zurück. Von getLocationDetails zurückgegebene Felder:
Beispiel: Führen Sie das folgende Skript aus, um die von der API "getLocationDetails" zurückgegebenen Felder anzuzeigen: 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) |
Gibt die Datenregeldetails in einer Ergebnisgruppe für eine bestimmte Datenregel-ID zurück. Von getRuleDetails(BigDecimal pRuleId) zurückgegebene Felder:
|
showCustomDBLog() | Zeigt nach Abschluss eines Prozesses eine Liste benutzerdefinierter Meldungen in der Benutzeroberfläche an. Die Meldung kann am Ende eines Workflowschrittes im Dataload-Prozess (z.B. "Importieren", "Validieren", "Exportieren" oder "Prüfen") oder am Ende der Ausführung eines benutzerdefinierten Skriptes angezeigt werden. Hinweis: Meldungen werden nur angezeigt, wenn der Prozess im Onlinemodus ausgeführt wird. |
showCustomFile(String filePath) | Zeigt nach Abschluss eines Prozesses eine benutzerdefinierte Datei (Logdatei, Berichtsdatei) in der Benutzeroberfläche an. Die Meldung kann am Ende eines Workflowschrittes im Dataload-Prozess (z.B. "Importieren", "Validieren", "Exportieren" oder "Prüfen") oder am Ende der Ausführung eines benutzerdefinierten Skriptes angezeigt werden. Hinweis: Meldungen werden nur angezeigt, wenn der Prozess im Onlinemodus ausgeführt wird. |
showCustomMessage(String message) | Zeigt nach Abschluss eines Prozesses eine benutzerdefinierte Meldung in der Benutzeroberfläche an. Die Meldung kann am Ende eines Workflowschrittes im Dataload-Prozess (z.B. "Importieren", "Validieren", "Exportieren" oder "Prüfen") oder am Ende der Ausführung eines benutzerdefinierten Skriptes angezeigt werden. Hinweis: Meldungen werden nur angezeigt, wenn der Prozess im Onlinemodus ausgeführt wird. |
String getCategoryMap(BigDecimal pCatKey,String pApplicationName) | Gibt das Szenario für eine bestimmte Kategorie und einen bestimmten Anwendungsnamen zurück. |
String getCustomMessage() | Ruft die letzte für den aktuellen Prozess ausgegebene benutzerdefinierte Meldung ab. |
String getCustomMessage(BigDecimal pLoadId) | Ruft die letzte für die angegebene Load-ID ausgegebene benutzerdefinierte Meldung ab. |
String getCustomFile() | Ruft die für den aktuellen Prozess erstellte benutzerdefinierte Datei ab. |
String getCustomFile(BigDecimal pLoadId) | Ruft die für die angegebene Load-ID erstellte benutzerdefinierte Datei ab. |
String getPOVDataValue(BigDecimal pPartitionKey) | Gibt den Datenwert der Location zurück. |
String getDirTopLevel(BigDecimal pApplicationId) | Gibt das Verzeichnis der obersten Ebene basierend auf der Anwendung zurück. |
String getDirInbox(BigDecimal pApplicationId) | Gibt das Verzeichnis Inbox basierend auf der Anwendung zurück. |
String getDirOutbox(BigDecimal pApplicationId) | Gibt das Verzeichnis Outbox basierend auf der Anwendung zurück. |
String getDirScripts(BigDecimal pApplicationId) | Gibt das Verzeichnis Scripts basierend auf der Anwendung zurück. |
String getProfileOptionValue(String pProfileOptionName, BigDecimal pApplicationId, String pUserName) | Gibt das Werteset für eine Option zurück. Optionen können in den Systemeinstellungen, den Anwendungseinstellungen und den Benutzereinstellungen festgelegt werden. Die Prioritätenreihenfolge lautet: Benutzer, Anwendung, System. Die API ermittelt den jeweils anwendbaren Wert und gibt den Wert zurück. |
void writeToProcessLogsDB(BigDecimal pLoadId, String pEntityType, String pEntityName, int pLogSequence,String pLogMessage) | Schreibt die Loginformationen in die Tabelle AIF_PROCESS_LOGS. Verwenden Sie den Entitytyp und den Entitynamen zum Gruppieren der protokollierten Meldungen. Logs können nur aus einem Dataload-Workflowprozess erstellt werden. |
void writeToProcessLogsFile(BigDecimal pLoadId, String pLogMessage) |
Schreibt die Loginformationen in die Logdatei des Dataload-Prozesses. Das Log wird basierend auf der Prozesslogebene geschrieben. Logs können nur aus einem Dataload-Workflowprozess erstellt werden. Hinweis: Es wird empfohlen, die Protokollierungs-API (z.B. "logDebug" oder "logInfo API") anstelle der API "writeToProcessLogsFile" zu verwenden. |
void closeConnection() | Wird zum Schließen der Datenbankverbindung verwendet. |
void closeResultSet(ResultSet resultSet) | Wird zum Schließen des Ergebnisobjekts verwendet. |
void updateImportFormat(String pImpgroupKey,BigDecimal pLoadId) | Aktualisiert das Importformat für die aktuelle Ausführung. Dies gilt nur für dateibasierte Importformate. |