Öffnen Sie Seiten der Azumuta App aus einer anderen Anwendung

Aktualisiert

Hinweis: Dieser Artikel ist technisch; wir empfehlen, jemanden mit entsprechender technischer Expertise hinzuzuziehen. Wenn Sie Fragen haben oder Hilfe bei der Einrichtung benötigen, kontaktieren Sie support@azumuta.com.

Eine andere Anwendung, wie ein ERP-System, ein MES oder eine Microsoft Power Apps Canvas-App, kann eine Seite der Azumuta App im Browser öffnen. Zum Beispiel öffnet ein Button in Ihrer Anwendung die Arbeitsanweisung für den aktuellen Auftrag. Die Seite meldet den Bediener mit einem einmalig verwendeten Session-Token an.

Anmelden mit einem Session-Token

  1. Ihre Integration fordert ein Session-Token mit POST /api/v1/auth/sessionTokens an. Sie sendet den API-Schlüssel eines API-Geräts mit dem Session tokens-Scope im x-api-key Header. Der Request-Body nennt den Bediener (loginIdentifier) und das normale Gerät, auf dem die Seite läuft (deviceId).
  2. Ihre Anwendung öffnet die Seiten-URL mit dem Token im Query-Parameter sessionToken.
  3. Die Seite meldet den Bediener auf diesem Gerät an und entfernt das Token aus der Adressleiste.

Ein Session-Token ist nur einmal verwendbar und läuft nach 60 Sekunden ab. Fordern Sie jedes Mal ein neues Token an, wenn Ihre Anwendung eine Seite öffnet. Geben Sie den API-Schlüssel nicht in der Seiten-URL an.

Die Seite verwendet die Einstellungen des normalen Geräts, z. B. Instruction step list is closed by default und Automatically open on first instruction step. Um diese zu ändern, bearbeiten Sie das Gerät.

Ein vollständiges Beispiel mit der Geräteeinrichtung finden Sie unter Connect Microsoft Power Apps to Azumuta with device API tokens. Für Request und Response siehe die In-App REST API documentation.

Seiten

Seitenpfad Öffnet
/workinstruction/WORK_INSTRUCTION_ID Eine eigenständige Vorschau einer Arbeitsanweisung. Antworten und Abschluss werden nicht als Aufzeichnung gespeichert.
/view/WORK_INSTRUCTION_ID Eine Arbeitsanweisung zur Einsicht. Normalerweise wird eine Einsichts-Aufzeichnung erstellt; ist die Einsichts-Aufzeichnung für die Anweisung deaktiviert, öffnet die Seite stattdessen eine eigenständige Vorschau.
/recording/RECORDING_ID Eine vorhandene Aufzeichnung
/product/PRODUCT_ORDER_NUMBER Einen Produktauftrag, identifiziert durch seine Auftragsnummer
/article/ARTICLE_NUMBER Eine Artikelvorschau, identifiziert durch die Artikelnummer
/article/default/ARTICLE_CATEGORY_ID Eine Vorschau des Standardartikels einer Artikelkategorie
/spot?treeNodeId=TREE_NODE_ID Einen Spot, identifiziert durch seine Tree-Node-ID

Um eine Ausführung aufzuzeichnen, öffnen Sie eine vorhandene Aufzeichnung mit /recording/RECORDING_ID oder öffnen Sie den Produktauftrag mit /product/PRODUCT_ORDER_NUMBER und wählen Sie dessen Arbeitsanweisung aus.

Hängen Sie den Pfad an den Host Ihres Workspaces und ersetzen Sie die Platzhalter. Verwenden Sie die Work instruction ID, nicht die Tree node ID. Siehe Using your data in the REST API zur Ermittlung der IDs.

Fügen Sie das Session-Token und die untenstehenden Optionen als Query-Parameter hinzu. Beginnen Sie den ersten Parameter mit ? und jeden weiteren Parameter mit &. URL-kodieren Sie jeden Wert. Zum Beispiel:

https://YOUR_AZUMUTA_HOST/recording/RECORDING_ID?sessionToken=SESSION_TOKEN
https://YOUR_AZUMUTA_HOST/spot?treeNodeId=TREE_NODE_ID&sessionToken=SESSION_TOKEN

Der Bediener muss Zugriff auf die Inhalte haben, die die Seite öffnet.

Optionen für alle Seiten

Parameter Wert Wirkung
sessionToken Ein Session-Token Meldet den Bediener an. Erforderlich.
virtualKeyboard true Zeigt eine Bildschirmtastatur an, wenn der Bediener ein Textfeld auswählt. Verwenden Sie dies auf Touchscreens ohne Tastatur.
bgColor Eine Hex-Farbe, z. B. %23004080 Legt die Hintergrundfarbe der oberen Leiste fest. Kodieren Sie # als %23.
fgColor Eine Hex-Farbe, z. B. %23FFFFFF Legt die Textfarbe der oberen Leiste fest.
rightButtonsOffset Eine Anzahl Pixel Verschiebt die Schaltflächen rechts in der oberen Leiste nach links. Verwenden Sie dies, wenn Ihre Anwendung eigene Inhalte in dieser Ecke anzeigt, z. B. eine Schließen-Schaltfläche.
fastForward false Schaltet fast forward aus.

Optionen pro Seite

Arbeitsanweisung und Einsicht

Diese Optionen gelten für /workinstruction/... und /view/....

Parameter Wert Wirkung
version Ein Versionsindex Öffnet diese Version statt der zuletzt freigegebenen Version. Der Index beginnt bei 0; version=9 öffnet also Version 10.
backButtonUrl Eine http- oder https-URL Zeigt eine Zurück-Schaltfläche in der oberen Leiste. Die Schaltfläche öffnet diese URL.
closeWindowOnFinish true Wenn der Bediener fertig ist, öffnet die Seite backButtonUrl. Ohne backButtonUrl schließt die Seite ihren Browser-Tab, jedoch nur, wenn ein Skript diesen Tab geöffnet hat.

Diese Optionen gelten nur für /workinstruction/...:

Parameter Wert Wirkung
variants Variantencodes, durch Kommas getrennt Zeigt die Arbeitsanweisung für diese Varianten.
parameters Ein JSON-Objekt mit Parameterwerten Liefert Werte für die Parameter in der Arbeitsanweisung, genauso wie die Parameter eines Produktauftrags.

Aufzeichnung

Parameter Wert Wirkung
backButtonUrl Eine http- oder https-URL Zeigt eine Zurück-Schaltfläche in der oberen Leiste. Die Schaltfläche öffnet diese URL.
closeOnFinish true Wenn der Bediener fertig ist, öffnet die Seite backButtonUrl. Ohne backButtonUrl schließt die Seite ihren Browser-Tab, wenn ein Skript diesen Tab geöffnet hat. Andernfalls fordert sie den Bediener auf, den Tab zu schließen.
spotId Eine Spot-ID Verknüpft Probleme, die der Bediener während der Aufzeichnung erstellt, mit diesem Spot.

Spot

Parameter Wert Wirkung
treeNodeId Die Tree-Node-ID eines Spots Öffnet diesen Spot. Erforderlich.
defaultTab explore, audits, articles, products oder asset-tasks Öffnet diesen Tab zuerst. Standard ist explore.

Die Seite für den Produktauftrag und die Artikelseiten haben keine weiteren Optionen.