Best Practices für die Entwicklung von Studio-Prozessvorlagen

Einführung

Diese Seite bietet Leitlinien und Empfehlungen für das Design von Studio-Prozessvorlagen, die in den Jitterbit Marketplace hochgeladen werden sollen. Dieses Dokument ist nicht umfassend und deckt nicht alle Szenarien ab.

Für allgemeine Best Practices siehe Jitterbit iPaaS Best Practices.

Best Practices

Die folgenden Abschnitte bieten einen Überblick über die Best Practices für Prozessvorlagen:

• Projekte
• Operationen
• Skripte
• Benennung von Projekten und Komponenten
• Struktur der Prozessvorlage

Projekte

Dies sind allgemeine Richtlinien für Projekte:

• Verwenden Sie Projektvariablen für Werte, die von Benutzer zu Benutzer variieren, wie Benutzernamen und Passwörter. Darüber hinaus ist es eine Best Practice, Projektvariablen mit einem Präfix zu versehen, damit sie leicht zu finden sind. Zum Beispiel wird eine Projektvariable org_netsuite_auth_username zuerst mit org, dann netsuite usw. vorangestellt, um sie effektiv in einer Liste unter anderen Projektvariablen zu organisieren.

• Löschen Sie ungenutzte Komponenten aus dem Projekt.

• Entfernen Sie alle automatisch generierten Suffixe -Copy von Projektkomponenten und benennen Sie diese logisch um.

Operationen

Dies sind allgemeine Richtlinien für Operationen:

• Verwenden Sie einen Anwendungsconnector anstelle der HTTP oder HTTP v2 Connectoren, wenn möglich.

• Konfigurieren Sie alle Operationen für Fehlerbehandlung. Für bewährte Methoden zur Fehlerbehandlung siehe den Tech Talk zu bewährten Methoden der Fehlerbehandlung.

Skripte

Dies sind allgemeine Richtlinien für Skripte:

• Verwenden Sie nach Möglichkeit Funktionen aus der Box anstelle von Skripten.

• Vermeiden Sie es, Operationen innerhalb von Skripten aufzurufen.

• Vermeiden Sie es, Operationen aufzurufen oder Skripting-Logik innerhalb von Transformationen einzufügen.

Projekt- und Komponentenbenennung

Dies sind die Empfehlungen zur Benennung von Projekten und deren Komponenten:

Zusätzlich sollten der Projektname, die Beschreibung und der Workflow übereinstimmende Namen haben.

Prozessvorlagenstruktur

Die folgende Struktur beschreibt, wie jede Operation innerhalb der Operationskette in einem Workflow funktionieren sollte:

• Operation 1: Die erste Operation wird verwendet, um gemeinsame Variablen für das Protokollieren von Informationen zu konfigurieren, wie z. B. Erfolgsanzahl, Fehleranzahl, Erfolgssummary und Dateinamen. Mit gemeinsamen Variablen können Sie die Erfolgs- und Fehlermeldungsdateien schreiben und ein Protokoll mit einer Zusammenfassung drucken, das die Werte enthält, auf die die Variablen gesetzt sind. Sobald diese eingerichtet sind, können Sie eine Email-Benachrichtigung konfigurieren, die diese Informationen an den von Ihnen definierten Empfänger sendet.

• Operation 2: Die zweite Operation ruft Daten vom Quellendpunkt ab.

• Operation 3: Wenn ein Connector keine Paginierung unterstützt, wird die dritte Operation verwendet, um die Daten für Zielendpunkte zu paginieren, die nur eine begrenzte Anzahl von Datensätzen unterstützen.

• Operation 4: Die vierte Operation implementiert die verbleibende Logik, die erforderlich ist, um eine Aktion am Zielendpunkt auszuführen.

• Operation 5: Die letzte Operation ist so konfiguriert, dass sie eine einzelne Email-Benachrichtigung sendet, die eine Zusammenstellung von Fehlermeldungen (von einer der Operationen) an den von Ihnen definierten Empfänger liefert.