Benutzerdefinierte Cloud-Loader erstellen

Grundlegende Schritte

Geben Sie Datenquelleneinstellungen ein.
Parameter definieren
Schreiben Sie JavaScript mit den CCDS-APIs in ai-Namespace.
Definieren Sie Geschäftsregeln.
Führen Sie den Loader aus oder planen Sie dessen Ausführung.

Voraussetzungen

Vergewissern Sie sich, dass Sie über die Berechtigung "Integrationsentwickler" verfügen.
Verifizieren Sie das
Adaptive Planning
-Plandaten, die Sie exportieren möchten, sind bereits in einer Staging-Tabelle vorhanden.
Erstellen Sie OAuth-Zugangsdaten für Ihr externes System oder verwenden Sie Zugangsdaten, die Sie explizit in Ihr JavaScript aufnehmen können.
Sie sollten wissen, welche Parameter Sie an Ihr externes System weitergeben müssen und welche Standardwerte das externe System erwartet.
Sie sollten das Verfahren kennen, wie Sie in den Endpunkt des externen Systems schreiben können.

Navigation

Wechseln Sie im Navigationsmenü zu

Integration

Integrationsdesign

.

Datenquelleneinstellungen eingeben

Neuen benutzerdefinierten Cloud-Loader erstellen

Öffnen Sie den Datendesigner über
Integration > Integrationsdesign
.
Wählen Sie im Ordner "Loaders" in der Komponentenbibliothek
Neuen Loader erstellen
.
Wählen Sie
Benutzerdefinierter Cloud-Loader
als Loader-Art und geben Sie einen Namen ein.
Wenn "Benutzerdefinierter Cloud-Loader" nicht als Option angezeigt wird, ist die Option für diese Instanz nicht aktiviert oder Sie verfügen nicht über die für den Zugriff erforderliche Berechtigung "Integrationsentwickler".
Wählen Sie
Erstellen
.

Quelltabelle, Zugangsdaten und Protokollebene auswählen

Geben Sie die Informationen zum benutzerdefinierten Cloud-Loader ein.
Quelltabelle:
Wählen Sie eine Staging-Tabelle aus, die Folgendes enthält
Adaptive Planning
Planning-Daten, die Sie exportieren möchten.
Erfordert Zugangsdaten:
Wählen Sie diese Option aus, wenn das externe System OAuth erfordert und ein Benutzer mit der Berechtigung "Integrationsoperator" die entsprechenden OAuth-Zugangsdaten auswählen muss.
Zugangsdaten:
Wählen Sie bereits vorhandene OAuth-Zugangsdaten aus.
Protokollebene:
Wählen Sie, wie viele Details während der Ausführung des Loaders protokolliert werden sollen:
Fehler
:
Protokolliert nur Fehler.
Info
:
Protokolliert alle Basisinformationen, z. B. wann die Datenquelle aktualisiert wurde.
Ausführlich
:
Stellt sehr detaillierte Informationen zu allen Phasen und Aktionen bereit. Wird hauptsächlich für Fehlerbehebung oder Auditing verwendet, da dadurch möglicherweise mehr Protokollinformationen geliefert werden, als für die normale Verwendung praktikabel ist
Klicken Sie im Menü "Aktionen" auf
Speichern
.

Parameter definieren

Wählen Sie
Designer-Einstellungen
.
Ziehen Sie parametrisierte oder statische Einstellungselemente aus dem Bereich
Einstellungen Komponente
in
Designer-Einstellungen
.
Hier eingegebene Parametrisierte Einstellungswerte werden zu Loader-Standardvorgaben, wenn Sie zur Laufzeit des Loaders keine anderen Werte angeben.
Statische Einstellungen, die Sie hier eingeben, werden bei jeder Ausführung des Loaders verwendet und erfordern keine Eingabe zur Laufzeit.
Boolesch: Ein Wert, der als 1 oder 0 dargestellt wird.
Dimension: Eine Dimension aus der Dimensionsverwaltung in
Adaptive Planning
.
Ganzzahl: Eine nicht negative ganze Zahl.
Kennwort: Ein Kennwort. Dieser Wert kann nach dem Speichern nicht mehr angezeigt werden.
Periodenbereich: Ein Zeitperiodenbereich in
Adaptive Planning
.
Text: Ein alphanumerischer Wert.
Doppelklicken Sie auf ein Parameterelement, um einen Namen einzugeben und seinen Wert zu ändern.
Ziehen Sie so viele Elemente hierher, wie Sie in Ihrem JavaScript referenzieren möchten.
Speichern Sie den Loader.
Verwenden Sie den Namen eines Parameters zur Referenzierung in Ihrem JavaScript.

JavaScript schreiben

Wählen Sie
Skript
.
Wählen Sie die vorhandene Vorlage aus und ändern Sie sie oder wählen Sie
Neues Skript
, um eine eigene Vorlage zu erstellen.
Schreiben Sie das JavaScript, das vom Loader mithilfe der CCDS-APIs in ausgeführt werden soll ai-Namespace.
Vergewissern Sie sich, dass das Skript Folgendes enthält:
testConnection
-Funktion, um eine https-Anforderung zur Übermittlung an Ihr externes System zu erstellen
exportData
-Funktion, aus der Daten exportiert werden sollen
Adaptive Planning
. Siehe Funktion zum Exportieren von Daten (nur benutzerdefinierter Cloud-Loader) im Thema "Funktionen von Adaptive Planning".
Referenzieren Sie alle Parameter, die Sie in den Designer-Einstellungen erstellt haben, anhand ihres Namens.
Speichern Sie das Skript.

OAuth in benutzerdefinierten Cloud-Loader-Skripten verwenden

Wählen Sie
Autorisierung anfordern
, bevor Sie den Loader ausführen.
Geben Sie alle zusätzlichen Autorisierungsdetails an, z. B. den Bereich, die für den externen Systemendpunkt benötigt werden.
Wählen Sie
Verbindung testen
, um zu prüfen, ob die OAuth-Zugangsdaten erfolgreich an den Endpunkt übergeben wurden.
Notieren Sie sich das Autorisierungsdatum und die Benutzer-ID unter "Autorisierungsstatus". Das Ablaufdatum der Autorisierung variiert je nach externem System. Wählen Sie "Autorisierung zurücksetzen" im Bereich "Aktionen", um bei Bedarf eine erneute Autorisierung durchzuführen.

Geschäftsregeln definieren

Wählen Sie das Register
Geschäftsregeln
.
Wählen Sie
Bearbeiten
.
Geben Sie einen SQL-Ausdruck ein. Sie können auf ein Element in "Verfügbare Spalten" klicken, um diese Spalte in den SQL-Ausdruck zu übernehmen, anstatt sie einzugeben.
Wählen Sie
Anwenden
, um Ihre Syntax zu prüfen. Bei Fehlern wird der Rahmen um den Ausdruck rot angezeigt. Bewegen Sie den Cursor über den Ausdruck, um Informationen zu Syntaxfehlern anzuzeigen.
Korrigieren Sie alle Fehler in Ihrer Syntax und wählen Sie
Anwenden
. Nur Staging-Zeilen, die mit dem SQL-Ausdruck übereinstimmen, werden geladen.

Benutzerdefinierten Cloud-Loader in eine Integrationsaufgabe einschließen

CCL-Beispielskript

Richten Sie eine Tabellendatenquelle ein.
Erstellen Sie im Bereich
Loader
einen neuen benutzerdefinierten Cloud-Loader.
Navigieren Sie zum Register
Datenquelleneinstellungen
und wählen Sie Ihre Tabellendatenquelle im Feld
Quelltabelle
aus.
Kopieren Sie das folgende Beispielskript auf dem Register
Skripte
.
 // Manually invoke this method via 'Test connection'
function testConnection(context) {
    return true;
}
// Manually invoke this method via 'Run manually'
function exportData(context) {
   //"xxx" is the name of your Amazon S3 bucket. 
    var bucketName = 'xxx';
    //Name of the sample CSV file to which data from your spreadsheet data source is exported
    var key = 'exampleTest.csv';
    //"xxxx" is the access key for your AWS S3 bucket.
    var awsAccessKey = 'xxxx';
    //"xxxx" is the secret key of your AWS S3 bucket. 
    var awsSecretKey = 'xxxx';
    var region = 'us-west-1';
    // Step 1: Get the data
    var reader = context.createTableReader();
    // Step 2: Process and export the data
    var result = "Column,Heading,Names\n";
    var row = null;
    while ((row = reader.readRow()) !== null) {
       // remove meta columns we don't need
       row.length = row.length - 2;
       result += row.join() + '\n';
   }
    ai.awss3.putFile(bucketName, key, result, region, awsAccessKey, awsSecretKey);
} 
Klicken Sie im Bereich
Aktionen
auf
Speichern
.
Um das Skript auszuführen, wählen Sie
Manuell ausführen
im Bereich
Aktionen
.