Cloud-Trigger mit implementieren Loftware Cloud

Implementierungsphasen für Loftware Cloud

Um den lokalen Etikettendruck anhand des Loftware Cloud implementierten Cloud-Triggers zu ermöglichen, müssen Sie eine Zusammenarbeit zwischen Benutzern mit drei Rollen herstellen: ein Benutzer, der den Cloud-Trigger auf dem lokalen Automation Server konfiguriert (Entwickler), ein Benutzer, der den Cloud-Trigger in Loftware Cloud einrichtet und ein Benutzer, der das Abonnement im Entwicklerportal vornimmt.

1. Der Entwickler übernimmt die Konfiguration und Bereitstellung der Cloud-Trigger-Konfiguration auf dem lokalen Automation Server anhand von Automation Builder und Automation Manager.

   Hinweis

   Loftware Automation muss in der Loftware Cloud angemeldet sein.

2. Der Loftware Cloud Administrator gewährt dem externen Integrator Zugriff auf den Cloud-Trigger in Control Center. Nach Fertigstellung sendet der Loftware Cloud Administrator dem externen Integrator den entsprechenden Integratorschlüssel.

3. Der externe Integrator führt im Entwicklerportal das Geschäftssystem des Kunden und die Loftware Cloud zusammen.

   Hinweis

   Im Entwicklerportal wird die dafür erstellte API namens Cloud Trigger gehostet. Diese API fungiert als Schnittstelle zwischen den Ereignissen, die im Geschäftssystem des Kunden stattfinden, und der lokale ausgeführten Automation Konfiguration.

   Hinweis

   Der Begriff „extern“ bedeutet, dass die Rolle dieses Benutzers darin besteht, das Abonnement im Entwicklerportal vorzunehmen. Das erstellte Abonnement authentifiziert den Integrator. Externe Integratoren müssen nicht zwangsläufig Personen außerhalb des Unternehmens sein. Die Aufgaben können auch von internen Integratoren übernommen werden, die dem Entwicklungsteam des Unternehmens angehören.

   Der externe Integratoren führt folgende Aktionen im Entwicklerportal aus:

   1. Anmeldung im Entwicklerportal. Vor der ersten Anmeldung muss der Integrator außerdem den Registrierungsvorgang durchlaufen.

   2. Erstellen eines Abonnements für die Cloud Trigger API.

   3. Verknüpfung des Abonnements mit dem Integratorschlüssel. So erhält das Abonnement Zugriff auf die Cloud-Trigger des Kunden.

      Weitere Details finden Sie im Abschnitt Loftware Cloud API im Entwicklerportal einrichten.

Cloud-Trigger in Automation Builder konfigurieren

Dieser Abschnitt beschreibt, wie Sie den Cloud-Trigger in Automation konfigurieren, das auf Ihrem lokalen Server ausgeführt wird.

1. Öffnen Sie Ihren Automation Builder. Stellen Sie sicher, dass der Automation Builder bei der Loftware Cloud angemeldet ist. Gehen Sie auf Datei > Über > Loftware Cloud, um sich zu vergewissern, dass Sie angemeldet sind.

2. Die Registerkarte Konfigurationselemente wird geöffnet. Klicken Sie auf Cloud-Trigger, um eine neue Konfiguration für den Cloud-Trigger zu erstellen.

3. Stellen Sie Namen und Beschreibung ein, um Ihren Cloud-Trigger unter anderen Triggern leicht finden zu können.

4. Nehmen Sie die Kommunikation-Einstellungen für den Trigger vor:

   • Legen Sie die Eindeutige Kennung fest. Nachdem Sie den Trigger bereitgestellt haben, ist diese eindeutige Kennung erforderlich, um den Trigger aufzurufen.

     Wenn Sie die Cloud-Trigger-Konfiguration auf mehreren Computern durchführen, müssen Sie sicherstellen, dass jeder Computer automatisch seine eigene eindeutige Kennung verwendet. Um unerwünschte Duplikate zu vermeiden, fügen Sie interne Variablen als Teil der Eindeutigen Kennung ein. Sie können zu diesem Zweck zwei interne Variablen verwenden:

     • ComputerName: Der Name des Computers, auf dem die Konfiguration ausgeführt wird.

     • SystemUserName: Der Windows-Benutzername des aktuell angemeldeten Benutzers.

     Um interne Variablen in die Eindeutige Kennung einzufügen, klicken Sie auf „Datenquelle einfügen“ und wählen Sie Ihre internen Variablen aus.

     

   • Warten, bis Trigger-Ausführung abgeschlossen ist: Das HTTP-Protokoll wartet darauf, dass der Empfänger (in diesem Fall Loftware Automation) eine numerische Antwort an den Absender übermittelt, die den Status der empfangenen Nachricht anzeigt. Standardmäßig antwortet Loftware Automation mit dem Code 200. Dies zeigt an, dass Automation die Daten erfolgreich empfangen hat, gibt aber keine Informationen über den Erfolg von Trigger-Aktionen.

     Diese Option legt fest, dass ein Trigger nicht sofort nach Empfang der Daten eine Antwort sendet, sondern wartet, bis alle Aktionen ausgeführt wurden. Danach sendet er den Antwort-Code, um das erfolgreiche Ausführen von Aktionen zu bestätigen. Wenn diese Option aktiviert ist, können Sie eine benutzerdefinierte Antwort und die entsprechenden Daten zurücksenden (z. B. ist die Antwort auf eine HTTP-Abfrage die Etikettenvorschau im PDF-Format).

     Beim Cloud-Trigger sind die relevanten, in Automation integrierten Standard-HTTP-Antwortcodes:

     HTTP-Antwortcode	Beschreibung
     200	Alle Aktionen erfolgreich ausgeführt.
     500	Beim Ausführen der Aktion sind Fehler aufgetreten.

     Hinweis

     Um Feedback zum Druckprozess an Automation zu senden, aktivieren Sie den synchronen Druckmodus. Weitere Informationen finden Sie im Abschnitt Synchroner Druckmodus.

   • Antworttyp: Gibt den Typ Ihrer Antwortnachricht an. Häufig verwendete Internet-Medientypen (auch MIME-Typen oder Content-Typen genannt) stehen in der Dropdown-Liste zur Verfügung. Falls Ihr Medientyp nicht in der Liste enthalten ist, geben Sie ihn selbst ein. Automation sendet die ausgehenden Antwortdaten im Format des festgelegten Medientyps als Feedback. Variable aktiviert variable Medientypen. Wählen Sie bei aktivierter Option eine Variable aus (oder erstellen Sie eine Variable), die den Medientyp enthält.

     Hinweis

     Wenn Sie keinen MIME-Typ angeben, verwendet Loftware Automation application/octet-stream als Standard.

   • Antwortdaten: Definiert den Inhalt Ihrer Antwortnachricht. Beispiele für Inhalte, die Sie in Form von HTTP-Antworten senden können: Benutzerdefinierte Fehlermeldungen, Etikettenvorschau, erzeugte PDF-Dateien, Druckstrom-(Spool-)Dateien, XML-Dateien mit Daten aus der Druck-Engine und der Etikettenvorschau (als Base64-Zeichenfolge codiert) usw.

     Wenn Ihre Ausgabe aus binären Inhalten besteht (z. B. Etikettenvorschau oder Druckstrom), müssen Sie einen unterstützten Medientyp auswählen, z. B. image/jpeg oder application/octet-stream.

   • Zusätzliche Kopfzeilen: Ermöglicht es Ihnen, benutzerdefinierte MIME-Header für die HTTP-Antwortnachricht zu definieren.

     Die Syntax für Antwortheader und Beispiele stehen im Abschnitt Aktion HTTP-Anfrage zur Verfügung.

     Tipp

     Sie können bei Antwortdaten und zusätzlichen Headern festen Inhalt, eine Mischung aus festem und variablem Inhalt oder ausschließlich variablen Inhalt verwenden. Um variablen Inhalt einzufügen, klicken Sie auf die Schaltfläche mit dem Pfeil rechts neben dem Datenbereich und fügen Sie Ihre Variable aus der Liste ein. Sie können auch eine neue Variable erstellen, die die Daten enthält, sie Sie verwenden möchten. Weitere Informationen finden Sie im Abschnitt Zusammengesetzte Werte verwenden .

5. Stellen Sie den Trigger in Automation Manager bereit und starten Sie ihn. Der Cloud-Trigger überwacht jetzt eingehende Anfragen.

Cloud-Trigger-Zugriff für den externen Integrator einrichten

1. Gehen Sie zu Ihrem Cloud-basierten Control Center. Öffnen Sie den Webbrowser und geben Sie https://<yourlabelcloudname>./dashboard ein:

   https://<yourlabelcloudname>.onnicelabel.com/dashboard.

2. Gehen Sie auf Integrationen > Cloud-Integrationen.

3. Klicken Sie auf Hinzufügen. Dadurch wird die Seite Neuen Integratorzugang hinzufügen geöffnet.

4. Geben Sie den Namen des Integrators ein, den Sie hinzufügen.
   
   

5. Kopieren Sie den Schlüssel.

6. Klicken Sie auf Speichern.

7. Verweisen Sie den externen Integrator auf das Entwicklerportal. Senden Sie die folgenden Informationen an den externen Integrator:

   • Link zur Loftware Cloud API: https://developerportal.onnicelabel.com/

   • Den Integrator-Schlüssel (siehe Schritt 5).

   • Die eindeutige Kennung des Triggers. Sie finden diese Eindeutige Kennung in den -Konfigurationseinstellungen für Automation (siehe Schritt 4 im AbschnittCloud-Trigger in Automation Builder konfigurieren.

   Hinweis

   Externe Integratoren benötigen den Schlüssel, um sich zum Aufrufen des Cloud-Triggers des Kunden zu authentifizieren.

Ein Abonnement im Entwicklerportal erstellen

Nach Erhalt der erforderlichen Informationen vom Loftware Cloud-Administrator muss sich der externe Integrator zuerst im Entwicklerportal registrieren und Abonnements (für jeden Kunden) zum Aufrufen der Trigger erstellen. Diese Triggeraufrufe stammen aus den Cloud-basierten Informationssystemen der Kunden.

Um Ihr Konto für das Entwicklerportal einzurichten und Abonnements zu erstellen, befolgen Sie die Schritte unter Cloud-Integrationen.

Aufrufen Ihres Cloud-Triggers (Loftware Cloud Implementierung)

Mit diesem Schritt stellen Sie sicher, dass die Ausgaben der externen Geschäftssysteme lokal gehostete Cloud-Trigger erfolgreich ausführen. Dies ist der Zweck der CloudTriggerOperation. Geben Sie in der URL für den Aufruf den Namen des Triggers an, den Sie aufrufen.

Um eine Trigger mit der eindeutigen KennungMyCloudTrigger aufzurufen, verwenden Sie die folgende URL:

https://labelcloudapi.onnicelabel.com/TriggerApi/CloudTrigger/MyCloudTrigger

Rufen Sie die URL für jedes Ereignis (Ausgabe) im externen Geschäftssystem wie im Beispiel gezeigt auf. Jeder Aufruf führt den Cloud-Trigger aus, der auf dem lokalen Automation Server gehostet wird.

Alle API-Aufrufe müssen die beiden folgenden Header enthalten:

• Api-Version ist die Version der API, die Sie verwenden. Aktuell ist v1 die einzig verfügbare API-Version.

• Ocp-Apim-Subscription-Key ist der Schlüssel, der Ihr Abonnement identifiziert.

CloudTrigger-Aufrufe testen

Um sich mit der Funktion von CloudTrigger-Aufrufen vertraut zu machen, können Sie solche Aufrufe im Entwicklerportal testen.

Bevor Sie diesen Aufruf testen, müssen Sie eine funktionierende Automation Konfiguration einrichten.

1. Öffnen Sie das Development Portal, öffnen Sie die Registerkarte Products und klicken Sie auf Label Cloud.

2. Wählen Sie Cloud Trigger API v1.

3. Erstellen Sie ein Beispiel für GET- oder PUT-Methoden. Klicken Sie auf den entsprechenden Link.

   • Klicken Sie nach Auswahl der Methode auf Try it. Eine neue Seite wird geöffnet. Die triggerID wird bereits unter den Query parameters aufgeführt.

   • Geben Sie im Feld Value per Kopieren und Einfügen die triggerID ein, die Sie vom Entwickler der Automation -Konfiguration erhalten haben. Dies ist die Eindeutige Kennung des Triggers. Die Eindeutige Kennung steht unter Automation Builder> > Allgemein zur Verfügung.

     

4. Wählen Sie unter Authorization den Abonnementschlüssel aus. Da Sie bereits mindestens ein Abonnement definiert haben, enthält die Dropdown-Liste bereits den Schlüssel für das definierte Abonnement. Wählen Sie diesen (primären oder sekundären) Schlüssel aus.

5. Klicken Sie auf Send.

   • Der Antwortstatus (Response status) lautet „200 OK“.

Schnelle Überprüfung Ihres Cloud-Triggers

Wenn Sie Ihre Loftware Cloud-API im Entwicklerportal eingerichtet haben, können Sie eine einfache Konfiguration in Automation Builder vornehmen, um zu testen, ob der Cloud-Trigger funktioniert. Ist dies der Fall, erhalten Sie die Meldung „Trigger works ok.“ auf der Seite „Cloud Trigger API“, nachdem Sie auf „Try it“ geklickt haben.

1. Öffnen Sie den Automation Builder erstellen Sie eine neue Konfiguration. Stellen Sie sicher, dass Ihr Automation Manager mit der Loftware Cloud verbunden ist.

2. Fügen Sie einen neuen Cloud-Trigger hinzu.

3. Legen Sie den Namen und die Beschreibung sowie die Eindeutige Kennung fest. In diesem Fall verwenden wir als eindeutige Kennung.

4. Aktivieren Sie Warten, bis Trigger-Ausführung abgeschlossen ist. So können Sie Trigger-Antworten zurückverfolgen.

   • Wählen Sie text/plain als Antworttyp.

   • Definieren Sie die Antwortdaten. Dies sind die Daten, die Sie empfangen werden, wenn der Trigger funktioniert. Wir verwenden für dieses Beispiel die folgende Zeichenfolge: „Trigger works ok."

   • Definieren Sie die zusätzlichen Kopfzeilen. Verwenden Sie das Heading:Value -Format.

5. Implementieren Sie die Konfiguration.

6. Öffnen Sie Ihr Entwicklerportal und gehen Sie zu Ihrer Seite Cloud Trigger API v1.

7. Klicken Sie auf Try it.

8. Fügen Sie TestCloudTrigger in das Feld triggerID ein. Klicken Sie auf Send.

   • Die Antwortinhalte enthalten die Bestätigung: „Trigger works ok."