API-Methoden für EPM Integration Agent

EPM Integration Agent enthält zahlreiche Methoden, die in Skripten zum Ausführen von Aktionen verwendet werden können, z.B. für die Spezifikation von Texten in der Logdatei, für Aktualisierungen an Bind-Variablen und Abfragen sowie Aktionen, die EPM Integration Agent zum Überspringen des SQL-Verarbeitungsschritts für den Fall veranlassen, in dem eine spezielle Abfrage oder eine Nicht-SQL-Datenquelle verwendet wird.

Die folgenden API-Methoden für EPM Integration Agent sind verfügbar:

API-Methode	Beschreibung	Beispiel
`logInfo()`	Informationsmeldung für das Agent-Verarbeitungslog erstellen. Dieser Eintrag wird im Prozesslog im Ordner `EPM_APP_DATA_HOME\logs`, im Joblog in Oracle Enterprise Performance Management Cloud, aber nicht im lokalen Log "epmagent.log" protokolliert. Der Logeintrag wird auf INFO-Logebene erstellt.	`agentAPI.logInfo("SAMPLE: INFO log message from script")`
`logError()`	Fehlermeldung für das Agent-Verarbeitungslog erstellen. Dieser Eintrag wird im Prozesslog im Ordner `EPM_APP_DATA_HOME\logs`, im Joblog in EPM Cloud sowie im Log "epmagent.log" protokolliert. Der Logeintrag wird auf SERVER-Logebene erstellt.	`agentAPI.logError("SAMPLE: SEVER log message from script")`
`setBindVariables()`	Verwenden Sie die Methode `setBindVariables()` , um die Bind-Variablen der Extraktionsabfrage zu aktualisieren. Diese Methode kann nur im `befExtract`-Skript verwendet werden. Die Bind-Variablen müssen als Java-Zuordnung für die einzelnen Variablen mit der Variable `NAME` als Schlüssel und `VALUE` übergeben werden.	`newBindVar = dict({'PERIOD':'Feb-05', 'LEDGER':'Vision Operations (USA)'})` `jmap = java.util.HashMap()` für Schlüssel in `newBindVar.keys(): jmap[key] = newBindVar[key]` `agentAPI.setBindVariables(jmap)`
`getBindVariables()`	Verwenden Sie die Methode `getBindVariables()` , um die Bind-Variablen für die Extraktionsabfrage abzurufen. Jede Bind-Variable wird in einer Zuordnung gespeichert, die die Schlüssel `NAME` und `VALUE` zum Definieren der Bind-Variable verwendet.	`bindVariables = agentAPI.getBindVariables()` für Eintrag in `bindVariables.entrySet(): print entry.key, entry.value`
`updateQuery()`	Verwenden Sie die Methode `updateQuery()` , um die Extraktionsabfrage zu aktualisieren. Diese Methode kann nur im `befExtract`-Skript verwendet werden.	`agentAPI.updateQuery("SELECT * FROM TDATASEG")`
`getQuery()`	Verwenden Sie die Methode `getQuery()`, um die Abfrage abzurufen, die beim Ausführen des Extraktionsaufrufs von EPM Cloud an EPM Integration Agent übergeben wird.	`print "Printing Query: " + agentAPI.getQuery()`
`skipAction()`	Verwenden Sie die Methode `skipAction()`, um den Datenextraktionsschritt zu überspringen, wenn eine benutzerdefinierte Extraktionsroutine von EPM Integration Agent verwendet wird. Beachten Sie, dass die Extraktionsausführung nur während der Ausführung des `befExtract`-Skripts übersprungen werden kann. Wenn Sie zum Hochladen in EPM Cloud eine Datendatei zur Verfügung stellen und nicht die gespeicherte Abfrage ausführen möchten, muss im Ordner `MyData/data` rechtzeitig eine Datei mit dem Namen `<process ID>.dat` gespeichert werden, damit sie in EPM Cloud hochgeladen werden kann. Dies bedeutet, dass die Datei in diesem Ordner in den Skripten `befExtract`, `aftExtract` oder `befUpload` gespeichert werden muss.	`agentAPI.skipAction('true')`
`getConnectionDetails()`	Verwenden Sie die Methode `getConnectionDetails()`, um das Zugangsdatenobjekt der Verbindung aus der Cloud abzurufen, das beim Aufrufen der Extraktionsausführung von EPM Cloud an EPM Integration Agent übergeben wird.	cred = agentAPI.getConnectionDetails() url = cred.getJDBCUrl() user = cred.getUserName() password = cred.getPassword() agentAPI.logInfo ("Connection Details: ") agentAPI.logInfo("URL: " + url) agentAPI.logInfo('User: ' + user)
`setCustomConnection(conn)`	Verwenden Sie die Methode `setCustomConnection(conn)`, um die benutzerdefinierte erstellte Verbindung beim Aufrufen der Extraktionsausführung für EPM Integration Agent festzulegen. Der Agent verwendet diese Verbindung für die Ausführung. Das Verbindungsobjekt muss eine JDBC 4-Verbindung und eine Implementierung der Schnittstelle `java.sql.Connection` sein. Diese Methode kann nur in den Skripten `befExtract` und `befExport` verwendet werden. Weitere Einzelheiten zur Verwendung finden Sie im Beispielskript `BefExtract.py` sowie in den Java-Beispielen `CustomEventSample` und `CustomWribackEvent`.	So erstellen Sie eine benutzerdefinierte Verbindung zu einer Oracle-Datenbank: java.lang.Class.forName("oracle.jdbc.driver.OracleDriver") conn = java.sql.DriverManager.getConnection('jdbc:oracle:thin:@<host>:<port>:<sid>', '<user/schema name>', '<password>') agentAPI.setCustomConnection(conn)