Zum Inhalt springen

Best Practices für die Entwicklung von Integration Studio-Prozessvorlagen

Einführung

Diese Seite bietet Leitlinien und Empfehlungen für das Design von Integration 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

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 nachgeschlagen werden können. Zum Beispiel wird eine Projektvariable org_netsuite_auth_username zuerst mit org, dann mit netsuite usw. präfixiert, um sie effektiv in einer Liste unter anderen Projektvariablen zu organisieren.

  • Löschen Sie ungenutzte Komponenten aus dem Projekt.

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

Operationen

Dies sind allgemeine Richtlinien für Operationen:

Skripte

Dies sind allgemeine Richtlinien für Skripte:

  • Verwenden Sie, wo immer möglich, 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:

Komponente Muster Beispiel
Projekt <action> + <endpoint> + <object> zu <endpoint> + <object> Salesforce-Kontakte mit SAP-Kontakten synchronisieren
Operation <action> + <endpoint> + <object> Salesforce-Kontakte abrufen
Endpoint <endpoint> Salesforce
Endpoint-Aktivität <action> + <object> Kontakte upsertieren
Transformation <action> + <object> + Anfrage/Antwort Anfrage zum Upsertieren von Salesforce-Kontakten
Skript <action> + <object> Fehler-E-Mail senden
Projektvariablen <endpoint>_<element> Salesforce_Sicherheits_Token
Globale Variablen Verwenden Sie Camel Case errorMessage

In addition, the project name, description, and workflow should have matching names.

Hinweis

Ensure there are no spelling errors when naming projects and their components.

Process template structure

The following structure describes how each operation should function within a workflow's operation chain:

  • Operation 1: Die erste Operation wird verwendet, um gemeinsame Variablen für die Protokollierung von Informationen zu konfigurieren, wie z. B. Erfolgsanzahl, Fehlersanzahl, Erfolgssummary und Dateinamen. Mit gemeinsamen Variablen können Sie die Erfolgs- und Fehlermeldungen 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 E-Mail-Benachrichtigung konfigurieren, die diese Informationen an den von Ihnen definierten Empfänger sendet.

  • Operation 2: Die zweite Operation ruft Daten von dem 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 E-Mail-Benachrichtigung sendet, die eine Zusammenstellung von Fehlermeldungen (von einer der Operationen) an den von Ihnen definierten Empfänger liefert.