Ouvrir des pages de l'Azumuta App depuis une autre application

Mis à jour

Note : Cet article est technique ; nous recommandons d'y associer une personne disposant des compétences techniques appropriées. Si vous avez des questions ou besoin d'aide pour la configuration, contactez support@azumuta.com.

Une autre application, comme un système ERP, un MES ou une application canvas Microsoft Power Apps, peut ouvrir une page de l'Azumuta App dans un navigateur. Par exemple, un bouton de votre application ouvre l'instruction de travail pour l'ordre en cours. La page connecte l'opérateur avec un jeton de session à usage unique.

Se connecter avec un jeton de session

  1. Votre intégration demande un jeton de session avec POST /api/v1/auth/sessionTokens. Elle envoie la clé API d'un appareil API disposant du scope Session tokens dans l'en-tête x-api-key. Le corps indique l'identifiant de l'opérateur (loginIdentifier) et l'appareil normal sur lequel la page s'exécute (deviceId).
  2. Votre application ouvre l'URL de la page avec le token dans le paramètre de requête sessionToken.
  3. La page connecte l'opérateur sur cet appareil et supprime le token de la barre d'adresse.

Un jeton de session ne fonctionne qu'une seule fois et expire au bout de 60 secondes. Demandez un nouveau jeton chaque fois que votre application ouvre une page. Ne mettez pas la clé API dans l'URL de la page.

La page utilise les paramètres de l'appareil normal, par exemple Instruction step list is closed by default et Automatically open on first instruction step. Pour les modifier, éditez l'appareil.

Pour un exemple complet avec la configuration de l'appareil, voir Connect Microsoft Power Apps to Azumuta with device API tokens. Pour la requête et la réponse, consultez la REST API documentation intégrée.

Pages

Page path Opens
/workinstruction/WORK_INSTRUCTION_ID Aperçu autonome d'une instruction de travail. Les réponses et la complétion ne sont pas sauvegardées comme enregistrement.
/view/WORK_INSTRUCTION_ID Une instruction de travail pour consultation. Crée normalement un enregistrement de consultation ; si l'enregistrement de consultation est désactivé pour l'instruction, ouvre plutôt un aperçu autonome.
/recording/RECORDING_ID Un enregistrement existant
/product/PRODUCT_ORDER_NUMBER Un ordre produit, identifié par son numéro de commande
/article/ARTICLE_NUMBER Aperçu d'un article, identifié par son numéro d'article
/article/default/ARTICLE_CATEGORY_ID Aperçu de l'article par défaut d'une catégorie d'articles
/spot?treeNodeId=TREE_NODE_ID Un spot, identifié par son tree node ID

Pour enregistrer l'exécution, ouvrez un enregistrement existant via /recording/RECORDING_ID, ou ouvrez l'ordre produit avec /product/PRODUCT_ORDER_NUMBER et sélectionnez son instruction de travail.

Mettez le chemin après l'hôte de votre workspace et remplacez les placeholders. Utilisez le Work instruction ID, pas le Tree node ID. Voir Using your data in the REST API pour trouver les IDs.

Ajoutez le session token et les options ci-dessous comme paramètres de requête. Commencez le premier paramètre par ? et chaque paramètre suivant par &. Encodez chaque valeur pour l'URL. Par exemple:

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

L'opérateur doit avoir accès au contenu que la page ouvre.

Options pour toutes les pages

Parameter Value Effect
sessionToken A session token Connecte l'opérateur. Requis.
virtualKeyboard true Affiche un clavier à l'écran quand l'opérateur sélectionne un champ de texte. À utiliser sur les écrans tactiles sans clavier.
bgColor A hex color, for example %23004080 Définit la couleur d'arrière-plan de la barre supérieure. Encodez # en %23.
fgColor A hex color, for example %23FFFFFF Définit la couleur du texte de la barre supérieure.
rightButtonsOffset A number of pixels Décale les boutons à droite de la barre supérieure vers la gauche. Utilisez ceci lorsque votre application affiche son propre contenu dans ce coin, par exemple un bouton de fermeture.
fastForward false Désactive le fast forward.

Options par page

Instruction de travail et consultation

Ces options s'appliquent à /workinstruction/... et /view/....

Parameter Value Effect
version A version index Ouvre cette version au lieu de la dernière version approuvée. L'index commence à 0, donc version=9 ouvre la version 10.
backButtonUrl An http or https URL Affiche un bouton retour dans la barre supérieure. Le bouton ouvre cette URL.
closeWindowOnFinish true Lorsque l'opérateur termine, la page ouvre backButtonUrl. Sans backButtonUrl, la page ferme son onglet du navigateur, mais seulement si un script a ouvert cet onglet.

Ces options s'appliquent uniquement à /workinstruction/... :

Parameter Value Effect
variants Variant codes, separated by commas Affiche l'instruction de travail pour ces variantes.
parameters A JSON object with parameter values Fournit des valeurs aux paramètres de l'instruction de travail, de la même manière que les paramètres d'un ordre produit.

Enregistrement

Parameter Value Effect
backButtonUrl An http or https URL Affiche un bouton retour dans la barre supérieure. Le bouton ouvre cette URL.
closeOnFinish true Lorsque l'opérateur termine, la page ouvre backButtonUrl. Sans backButtonUrl, la page ferme son onglet du navigateur si un script a ouvert cet onglet. Sinon, elle demande à l'opérateur de fermer l'onglet.
spotId A spot ID Lie les problèmes créés par l'opérateur pendant l'enregistrement à ce spot.

Spot

Parameter Value Effect
treeNodeId The tree node ID of a spot Ouvre ce spot. Requis.
defaultTab explore, audits, articles, products or asset-tasks Ouvre cet onglet en premier. L'onglet par défaut est explore.

La page de l'ordre produit et les pages d'article n'ont pas d'autres options.