Entwicklung von Prozessvorlagen für Jitterbit Integration Studio

Einführung

Die Prozessvorlagen des Integration Studio, die über den Jitterbit Marketplace verfügbar sind, sind vorgefertigte Integrationsanwendungsfälle, die einen bestimmten Geschäftsprozess unter Verwendung von Objekten über mehrere Anwendungen oder Systeme hinweg ausführen.

Eine Prozessvorlage besteht aus einem oder mehreren Projekten, die mehrere Endpunkte verwenden. Sie kann Anpassungsdateien enthalten und wird mit eigener Dokumentation im PDF-Format geliefert.

Integration Studio Prozessvorlage im Marketplace

Projektvorbereitung

Bevor ein Integration Studio-Projekt exportiert wird, überprüfen Sie das Projekt sorgfältig und stellen Sie sicher, dass keine Informationen enthalten sind, die dort nicht sein sollten. Überprüfen Sie alle Passwortfelder auf ihre Werte. Überprüfen Sie alle in den Transformationszuordnungen verwendeten Schemata auf das Vorhandensein von vertraulichen oder personenbezogenen Informationen (PII) oder geschützten Gesundheitsinformationen (PHI).

Sobald ein Projekt exportiert wurde, durchsuchen Sie die exportierte JSON-Datei, um zu bestätigen, dass keine Informationen vorhanden sind, die Sie nicht offenlegen möchten, wie z. B. E-Mail-Adressen. Zusätzliche Metadaten können in Projekten vorhanden sein, die aus früheren Versionen des Integration Studio erstellt und exportiert wurden.

Einreichungsanforderungen

Für jede Prozessvorlage sind folgende Elemente für die Einreichung erforderlich:

Eine oder mehrere exportierte Harmony Integration Studio-Projekte, die für die Prozessvorlage erforderlich sind.
Eine Metadaten-Manifestdatei im YAML-Format, die die Prozessvorlage beschreibt und die Details bereitstellt, die im Jitterbit Marketplace verwendet werden, wenn die Vorlage angezeigt wird. Der Name der Manifestdatei sollte der gleiche sein wie der der Prozessvorlage mit der Erweiterung yaml.
Eine PDF-Datei, die die Prozessvorlage, ihre Konfiguration, ihren Betrieb und Informationen dokumentiert, die erforderlich sind, um die Prozessvorlage zu verwenden. Diese Datei wird im Eintrag DOCUMENTATION im Manifest aufgeführt.
Alle Anpassungsdateien, die für die Konfiguration der Prozessvorlage erforderlich sind. Obwohl mehrere Anpassungsdateien im Marketplace unterstützt werden, empfehlen wir aus Gründen der Benutzerfreundlichkeit für alle (für Sie als Entwickler, für Jitterbit als Dienstanbieter und vor allem für den Benutzer der Prozessvorlage), dass die erforderlichen Anpassungen in einer einzigen ZIP-Datei zusammengefasst werden. Eine geeignete README-Datei mit Anweisungen sollte im Archiv mit den erforderlichen Anpassungen platziert werden.

Durch das Vorhandensein einer einzigen ZIP-Datei im Schritt Anpassungen herunterladen bei der Initialisierung einer Prozessvorlage hat der Benutzer nur einen Download-Artikel zu verwalten. Er kann diesen dann (mit dem oben beschriebenen Dokumentations-PDF) an die Partei weitergeben, die mit der Konfiguration des Endpunkts beauftragt ist.

Dieses Paket wird im PACKAGES-Eintrag im Manifest aufgeführt.

Manifestdatei

Eine Metadaten-Manifestdatei im YAML-Format ist erforderlich, um Details zur Prozessvorlage und ihren Bestandteilen bereitzustellen. Dieses Beispiel zeigt die auszufüllenden Felder:

# Process Template Manifest File

NAME: Salesforce-NetSuite CPQ-to-Billing Process Template

TYPE: template

# Description can be multi-line or multi-paragraph
# Indent each succeeding line or paragraph
DESCRIPTION: This process template automatically process your orders and
  invoices in Salesforce CPQ and Billing and NetSuite. Synchronizes contacts,
  products, price books, orders, and invoices between systems.

AUTHOR: Jitterbit, Inc.

# A list of the projects included in the process template
PROJECTS:
- Salesforce_NetSuite_Contacts_Accounts_Bidirectional.json
- Sync_NetSuite_Inventory-Items_to_Salesforce_Price-Book-Entry.json
- Sync_NetSuite_Inventory-Items_to_Salesforce_Products.json
- Sync_Salesforce_Invoices_to_NetSuite_Invoices.json
- Sync_Salesforce_Orders_to_NetSuite_Sales-Orders.json

# A list of all the documents in the process template
# Currently, a single PDF is supported
DOCUMENTATION:
- Jitterbit Salesforce-NetSuite CPQ-to-Billing Process Template.pdf

# A list of all the customization packages in the process template
PACKAGES:
- Salesforce-NetSuite CPQ-to-Billing Process Template Package.zip

# Endpoints
# Place each endpoint on its own line beginning with a hyphen
# in order of source to target
ENDPOINTS:
- Salesforce
- NetSuite

# Sources: A list of dictionaries, with each source by name
SOURCES:
- NAME: NetSuite
  OBJECTS:
  - Accounts
  - Contacts
  - Customers
  - Inventory Items
- NAME: Salesforce
  OBJECTS:
  - Accounts
  - Contacts
  - Invoices
  - Orders

# Target: A list of dictionaries, with each target by name
TARGETS:
- NAME: NetSuite
  OBJECTS:
  - Accounts
  - Customers
  - Invoices
  - Sales Orders
- NAME: Salesforce
  OBJECTS:
  - Contacts
  - Price Book Entry
  - Products

# Categories
# Place each category on a line beginning with a hyphen
CATEGORIES:
- ERP
- Finance
- Sales & CRM

Endpunkte

Die in einem Integrationsrezept oder einem Prozess-Template angegebenen Endpunkte werden verwendet, um die in dem Marketplace angezeigten Assets zu filtern. Die Liste der im Marketplace angezeigten Endpunkte ist nicht festgelegt, sondern wird aus den von den Assets im Marketplace verwendeten Endpunkten erstellt. Wir empfehlen, die vorhandenen Endpunkte wann immer möglich zu verwenden, obwohl Sie auch zusätzliche Endpunkte nach Bedarf oder Angemessenheit hinzufügen können.

Wenn Sie neue Endpunkte hinzufügen, beachten Sie bitte, dass ähnlich klingende oder abgeleitete Namen nicht aggregiert werden. Damit eine Sammlung von unterschiedlichen Assets unter demselben Endpunkt angezeigt wird, müssen sie alle denselben Endpunktnamen verwenden. Endpunkte werden in der Reihenfolge der Anzahl der Assets in jedem bestimmten Endpunkt aufgelistet. Da die fünf wichtigsten Endpunkte (bestimmt durch die Anzahl der Assets mit diesem Endpunkt) beim Laden des Marketplaces angezeigt werden, sind zusätzliche Endpunkte nicht sichtbar, bis der Benutzer auf die Schaltfläche Mehr anzeigen klickt.

Kategorien

Die an einem Integrationsrezept oder einem Prozess-Template angehängten Kategorien werden verwendet, um die im Marketplace angezeigten Assets zu filtern. Die Liste der im Marketplace angezeigten Kategorien ist nicht festgelegt, sondern wird aus den von den Assets im Marketplace verwendeten Kategorien erstellt. Wir empfehlen, die vorhandenen Kategorien wann immer möglich zu verwenden, obwohl Sie auch zusätzliche Kategorien nach Bedarf oder Angemessenheit hinzufügen können.

Kategorien werden in der Reihenfolge der Anzahl der Assets in jeder bestimmten Kategorie aufgelistet. Da die fünf wichtigsten Kategorien (bestimmt durch die Anzahl der Assets in einer Kategorie) beim Laden des Marketplaces angezeigt werden, sind zusätzliche Kategorien nicht sichtbar, bis der Benutzer auf die Schaltfläche Mehr anzeigen klickt.

Icons

Viele Standard-Endpunkt-Icons sind im Jitterbit Marketplace verfügbar und werden anhand der Namen im ENDPOINTS-Feld der Manifest-YAML-Datei zugeordnet. Um festzustellen, ob ein Icon verfügbar ist, verwenden Sie die Marketplace-Endpunktfilter um die verfügbaren Namen zu sehen.

Das Symbol sollte so gestaltet sein, dass es in kleiner Größe, wie 40 mal 40 Pixel, lesbar und erkennbar ist.

Wenn ein Endpunkt-Symbol derzeit nicht verfügbar ist, reichen Sie das Symbol als quadratisches SVG-Bild ein. Alle Symbole sind ein weißes Logo auf einem farbigen Verlaufshintergrund, der von der primären Markenfarbe oben zu einem dunkleren Farbton derselben Farbe unten verläuft. Wenn die primäre Markenfarbe so beschaffen ist, dass ein Verlauf nicht funktioniert oder nicht zulässig ist, verwenden Sie stattdessen eine einfarbige Darstellung der primären Markenfarbe.

Eine alternative Einreichung ist ein quadratisches weißes SVG-Bild mit einer Farbe, die entweder als eine einzige Farbe oder als ein Paar von Farben (oben und unten) für den Hintergrundverlauf angegeben ist.

Das eingereichte Symbol wird, sobald es als akzeptabel verifiziert und in einer Marktplatzversion installiert ist, zur Verwendung verfügbar sein. Bis dahin werden wir ein leeres Symbol an seiner Stelle einsetzen.