Zum Hauptinhalt wechseln
Dokumentation
Dokumentation
Adaptive Planning
Zuletzt aktualisiert: 2023-06-23
Planning-Daten mit Scripted Planning Exporter exportieren

Planning-Daten mit Scripted Planning Exporter exportieren

Mit dem Scripted Planning Exporter (SPE), einem benutzerdefinierten Pentaho-Plugin, können Sie Planning-Daten in externe Systeme exportieren. Weitere Informationen finden Sie unter
Adaptive Planning
 Die Verwendung von Pentaho finden Sie unter Skript-Datenquelle einrichten.

Informationen zu SPE

SPE ruft die auf
Adaptive Planning
 export die REST-API und speichert dann die Ergebnisse dieses API-Aufrufs in einer von Ihnen angegebenen Datei. SPE unterstützt die Ausgabe in CSV- und XML-Dateiformaten. Nicht alle Exportdaten können in das CSV-Format konvertiert werden.
SPE ist ein mit dem Datenagenten gebündeltes Plugin ab Version v51.17.0734. Sie können überprüfen, mit welcher Version von Data Agent Service Manager Sie arbeiten, indem Sie das Programm öffnen. Die Versionsnummer wird in den Informationen auf dem Register "Info" angezeigt. Informationen zur Installation des Datenagenten finden Sie unter Data Agent Service Manager installieren. Wenn SPE installiert ist, wird das Adaptive Planning-Plugin im Ordner "Input" auf dem Register "Design" von Spoon angezeigt.
Die Terminologie zum Scripted Planning Exporter Adapter kann etwas verwirrend sein. Da die Daten von Planning an das Skript und dann an ein externes Ziel weitergeleitet werden, handelt es sich um einen Datenexport aus Planning und einen Datenimport in das externe Ziel. Aus der Perspektive von Spoon ist SPE jedoch ein Eingabeschritt, da Eingaben für das Skript bereitgestellt werden. Aus diesem Grund wird der Schritt in Spoon als "Adaptive Planning Input" bezeichnet.
Sie können SPE direkt aus der Spoon-Umgebung heraus oder per Remote-Zugriff starten, indem Sie es in einen Skript-Loader aufnehmen. Der allgemeine Prozess für die Verwendung von SPE besteht darin, ein Skript zu schreiben, das eine XML-Anforderung in dem vom Planning-Server akzeptierten Format erstellt, sie an SPE weiterleitet und dann die Ergebnisse verarbeitet. Nachstehend finden Sie ein Beispielskript, das die Mindestanforderungen für ein SPE-Skript darstellt:

      Scripted Planning Exporter
-------------------------------------------
Input:
      requestXMLString: request in XML format
      targetResponseFormat: CSV or XML
      targetFolder: target folder to store result file generated by
         this plugin

Output: The type of output fields is String, except
    requestSuccess, which is boolean
      requestSuccess: Boolean, Y' or N'
      planningMsgs: concatenate Planning messages in a string,
    delimited by ###'
      responseFileName: complete path of the response file name
      fieldNames: column name in CSV header, or NULL if
    targetResponseFormat is XML
      numberRecReturned: String, number of records returned by
    Planning, or NULL if targetResponseFormat is XML
Best Practices für dieses Skript:
  • Bei allen Eingabefeldnamen wird zwischen Groß- und Kleinschreibung unterschieden. Definieren Sie sie entsprechend im Kettle-Skript.
  • requestXMLString:
    Jede Export-API hat ihr eigenes Request XML-Format. Siehe
    Adaptive Planning
     REST-API für weitere Informationen.
  • targetResponseFormat:
    Ab API v11 kann nur die Nutzlast der API "exportData" in das CSV-Format umgewandelt werden. Alle anderen Exporte müssen in XML vorliegen.
  • TargetFolder:
     Aktivieren Sie üblicherweise nicht das Kontrollkästchen "Restrict Runner Access to Files" im Agent Service Manager. Der Zielordner kann sich an einer beliebigen Stelle im Dateisystem befinden.
  • responseFileName:
    Der Name der Antwortdatei hat das folgende Format:
    <targetFolder>_ApiResponse_<exportMethod>_<UUID>.<targetFormat>;
     Beispiel:
    C:\pdiTemp\ApResponse_exportData_83980a17b3dc40c48282483cb9ea5e96.csv
  • requestSuccess:
     Wenn die Exportanforderung auf der Seite des Planning-Servers erfolgreich war, hat requestSuccess den Wert "true" ('Y'). Wenn die Exportanforderung für die Ergebnisse eines Aufrufs von Planning fehlschlägt, löst SPE eine Ausnahme mit den vom Planning-Server zurückgegebenen Fehlermeldungen aus.
Allgemeiner Workflow zum Extrahieren der Informationen aus Planning und Senden an eine Ausgabedatei:
  1. Request XML-Datei eingeben
  2. Dateiinhalt in Zeichenfolge konvertieren
  3. Zielformat (CSV/XML) und Ordner festlegen
  4. Adaptive Scripting Planning Exporter
  5. Blockierungsschritt
  6. Adapterausgabe protokollieren

Planning-Export-APIs im Kettle-Skript verwenden

Der SPE verwendet
Adaptive Planning
APIs v11 oder höher. Sie können die folgenden APIs mit SPE verwenden:
  • customReportValues:
    Gibt einen Datensatz für die angeforderten Berichtskriterien in der angeforderten Instanz zurück
  • exportData:
     Ruft einen Satz von Werten aus einer angegebenen Version ab
Siehe Informationen zu
Adaptive Planning
 API für weitere Informationen.

SPE-Kettle-Plugin konfigurieren

So konfigurieren Sie das SPE-Kettle-Plugin:
  1. Klicken Sie auf dem Register "Spoon Design" auf
    Adaptive Planning Input
    .
  2. Geben Sie die Informationen zu SPE ein:
    • Active Agent:
       Wird automatisch von SPE ausgefüllt.
    • Instance Host:
      Wird automatisch von SPE ausgefüllt.
    • Instance Code:
       Wird automatisch von SPE ausgefüllt.
    • Login:
       Wert des Anmeldekontextparameters.
    • Login Password:
      Wert des Kennwortkontextparameters.
    • Locale:
       Standard ist
      en_US
      .
  3. Klicken Sie auf
    OK
    .
Sie müssen ein Skript erstellen, das die Eingaben und Ausgaben für den SPE-Vorgang definiert. Weitere Informationen finden Sie im Beispielskript in diesem Artikel.

Konfigurieren Sie SPE in
Adaptive Planning
 Benutzeroberfläche der Integration-Cloud

Der allgemeine Prozess zum Erstellen eines Skript-Loaders mit der Cloud-UI von Integration lautet wie folgt:
  • Skript-Loader erstellen
  • Eingabepunkt auswählen
  • Erforderliche Parameter konfigurieren
Erstellen Sie zunächst einen neuen Skript-Loader. Weitere Informationen finden Sie unter Skript-Loader erstellen . Sie müssen auch einen Eingabepunkt im Dropdown "Eingabepunkt" auswählen. Der Eingabepunkt wird auf den Namen des Skripts festgelegt, das bei der Ausführung des Skript-Loaders ausgeführt werden soll.
Sie müssen die lokalen und gemeinsam genutzten, im Skript-Loader definierten Kontextparameter als Umgebungsvariablen in der Kettle/Spoon-Umgebung mappen und bereitstellen. Beispiel: Wenn ein Kontextparameter mit dem Namen "login" im Loader-Setup-Bildschirm im Abschnitt "Parameter" definiert ist, wird er in der Kettle-Umgebung als Variable "${login}" angezeigt. Die Definition von zwei Kontextparametern in einem Skript-Loader wird dann in SPE für die entsprechenden Kettle-Variablen verwendet.
Sie können die Kettle-Variablen zur Entwurfszeit mit den aktuellen Standard-Kontextparameterwerten aktualisieren, indem Sie den Adaptive Script Editor starten und durch Klicken auf
Refresh Configuration
 eine Aktualisierung triggern.