Open Azumuta App-pagina's vanuit een andere applicatie
Opmerking: Dit artikel is technisch; wij raden u aan iemand met de juiste technische expertise te betrekken. Als u vragen hebt of hulp nodig hebt bij de setup, neem contact op met support@azumuta.com.
Een andere applicatie, zoals een ERP-systeem, een MES of een Microsoft Power Apps canvas-app, kan een pagina van de Azumuta App in een browser openen. Bijvoorbeeld: een knop in uw applicatie opent de werkinstructie voor de huidige order. De pagina meldt de operator aan met eenmalig gebruikte sessietoken.
Aanmelden met een sessietoken
- Uw integratie vraagt een sessietoken aan met
POST /api/v1/auth/sessionTokens. Ze stuurt de API-sleutel van een API-apparaat met de Session tokens scope in dex-api-key-header. De body geeft de operator (loginIdentifier) en het normale apparaat waarop de pagina draait (deviceId) op. - Uw applicatie opent de paginanaam met het token in de
sessionTokenquery-parameter. - De pagina meldt de operator op dat apparaat aan en verwijdert het token uit de adresbalk.
Een sessietoken werkt slechts één keer en verloopt na 60 seconden. Vraag telkens een nieuw token aan wanneer uw applicatie een pagina opent. Plaats de API-sleutel niet in de URL van de pagina.
De pagina gebruikt de instellingen van het normale apparaat, bijvoorbeeld Instruction step list is closed by default en Automatically open on first instruction step. Wijzig deze instellingen door het apparaat te bewerken.
Voor een compleet voorbeeld met de apparaatsetup, zie Connect Microsoft Power Apps to Azumuta with device API tokens. Voor het request en de response, zie de in-app REST API documentation.
Pagina's
| Page path | Opens |
|---|---|
/workinstruction/WORK_INSTRUCTION_ID |
Een zelfstandige preview van een werkinstructie. Antwoorden en voltooiing worden niet opgeslagen als een opname. |
/view/WORK_INSTRUCTION_ID |
Een werkinstructie voor raadpleging. Normaal gesproken wordt een raadplegingsopname gemaakt; als raadplegingsopname is uitgeschakeld voor de instructie, opent de pagina in plaats daarvan een zelfstandige preview. |
/recording/RECORDING_ID |
Een bestaande opname |
/product/PRODUCT_ORDER_NUMBER |
Een productorder, geïdentificeerd door het ordernummer |
/article/ARTICLE_NUMBER |
Een preview van een artikel, geïdentificeerd door het artikelnummer |
/article/default/ARTICLE_CATEGORY_ID |
Een preview van het standaardartikel van een artikelcategorie |
/spot?treeNodeId=TREE_NODE_ID |
Een spot, geïdentificeerd door zijn tree node ID |
Om uitvoering te registreren, opent u een bestaande opname met /recording/RECORDING_ID, of opent u de productorder met /product/PRODUCT_ORDER_NUMBER en selecteert u de bijbehorende werkinstructie.
Plaats het pad achter de host van uw workspace en vervang de placeholders. Gebruik de Work instruction ID, niet de Tree node ID. Zie Using your data in the REST API om de ID's te vinden.
Voeg het sessietoken en de onderstaande opties toe als queryparameters. Begin de eerste parameter met ? en elke volgende parameter met &. URL-encodeer elke waarde. Bijvoorbeeld:
https://YOUR_AZUMUTA_HOST/recording/RECORDING_ID?sessionToken=SESSION_TOKEN
https://YOUR_AZUMUTA_HOST/spot?treeNodeId=TREE_NODE_ID&sessionToken=SESSION_TOKEN
De operator moet toegang hebben tot de inhoud die de pagina opent.
Opties voor alle pagina's
| Parameter | Waarde | Effect |
|---|---|---|
sessionToken |
A session token | Meldt de operator aan. Verplicht. |
virtualKeyboard |
true |
Toont een schermtoetsenbord wanneer de operator een tekstveld selecteert. Gebruik dit op touchscreens zonder fysiek toetsenbord. |
bgColor |
A hex color, for example %23004080 |
Stelt de achtergrondkleur van de bovenbalk in. Encodeer # als %23. |
fgColor |
A hex color, for example %23FFFFFF |
Stelt de tekstkleur van de bovenbalk in. |
rightButtonsOffset |
A number of pixels | Verschuift de knoppen rechts in de bovenbalk naar links. Gebruik dit wanneer uw applicatie eigen inhoud in die hoek toont, zoals een sluitknop. |
fastForward |
false |
Schakelt fast forward uit. |
Opties per pagina
Werkinstructie en raadpleging
Deze opties gelden voor /workinstruction/... en /view/....
| Parameter | Waarde | Effect |
|---|---|---|
version |
A version index | Opent die versie in plaats van de laatste goedgekeurde versie. De index begint bij 0, dus version=9 opent versie 10. |
backButtonUrl |
An http or https URL |
Toont een terugknop in de bovenbalk. De knop opent deze URL. |
closeWindowOnFinish |
true |
Wanneer de operator klaar is, opent de pagina backButtonUrl. Zonder backButtonUrl sluit de pagina het browsertabblad, maar alleen als een script dat tabblad heeft geopend. |
Deze opties gelden alleen voor /workinstruction/...:
| Parameter | Waarde | Effect |
|---|---|---|
variants |
Variant codes, separated by commas | Toont de werkinstructie voor deze varianten. |
parameters |
A JSON object with parameter values | Geeft waarden aan de parameters in de werkinstructie, hetzelfde als de parameters van een productorder. |
Opname
| Parameter | Waarde | Effect |
|---|---|---|
backButtonUrl |
An http or https URL |
Toont een terugknop in de bovenbalk. De knop opent deze URL. |
closeOnFinish |
true |
Wanneer de operator klaar is, opent de pagina backButtonUrl. Zonder backButtonUrl sluit de pagina het browsertabblad als een script dat tabblad heeft geopend. Anders wordt de operator gevraagd het tabblad te sluiten. |
spotId |
A spot ID | Koppelt issues die de operator tijdens de opname aanmaakt aan deze spot. |
Spot
| Parameter | Waarde | Effect |
|---|---|---|
treeNodeId |
The tree node ID of a spot | Opent deze spot. Verplicht. |
defaultTab |
explore, audits, articles, products or asset-tasks |
Opent deze tab als eerste. De standaard is explore. |
De productorderpagina en de artikelpagina's hebben geen andere opties.