Configuratiehandleiding voor de integratie van de Asset-app

• 1. Vereisten
  • 1.1 Functionele vereisten
  • 1.2 Toegang en inloggegevens
  • 1.3 Configuratie van het integratieplatform (alleen consultants van Spacewell)
• 2. Configuratie van de Asset-app
  • 2.1 Gebruikers toevoegen
  • 2.2 [Optioneel] Aangepast logo op formulier
  • 2.3 Webhook voor meldingen configureren
• 3. Configuratie van Asset
  • 3.1 Module activeren
  • 3.2 Toewijzingen configureren in External App
  • 3.3 Geheime sleutel weergeven
  • 3.4 Aanvullende configuratie
  • 3.5 Systeemgebruikers koppelen aan de External App
• 4. Configuratie van het integratieplatform
  • 4.1 Asset-appconnector maken
  • 4.2 Asset-connector maken
  • 4.3 Flows maken
    • 4.3.1 Asset naar Asset-app
    • 4.3.2 Asset-app naar Asset
• 5. Aan de slag
• 6. Aanvullende informatie, opties en gebruikershandleidingen

Deze pagina beschrijft de stappen voor het instellen van de integratie van de Asset-app aan de kant van de Asset-app, Asset en het integratieplatform.

Dit document is bedoeld voor consultants van Spacewell.

1. Vereisten

Controleer voordat u de integratie van de Asset-app instelt of aan de volgende vereisten is voldaan:

1.1 Functionele vereisten

• De module Corrective Work Orders en/of de module Preventive Maintenance Work Orders moet in Asset zijn geactiveerd.

1.2 Toegang en inloggegevens

• Geldige inloggegevens voor het klantaccount van de Asset-app

  • Deze moeten per e-mail worden aangevraagd bij en verstrekt door het Product Team van Asset.

1.3 Configuratie van het integratieplatform (alleen consultants van Spacewell)

⚠️ Deze sectie is alleen relevant voor consultants van Spacewell.
Voor partners worden de onderstaande stappen uitgevoerd door Spacewell.

De Asset-app communiceert via het integratieplatform met Asset. Daarom is de volgende configuratie vereist:

• Er moet een tenant van het integratieplatform bestaan

  • Als de tenant nog niet bestaat, kunt u het aanmaken ervan aanvragen bij het Product Team van Asset (per e-mail)

• Clientgegevens voor de tenant van het integratieplatform

  • Client-ID

  • Clientgeheim
    Voor een nieuwe tenant worden deze verstrekt wanneer de tenant wordt aangemaakt.
• Inloggegevens voor het integratieplatform (voor configuratiedoeleinden)

  • Vereist voor consultants van Spacewell om de integratie te configureren

    Voor een nieuwe tenant worden deze verstrekt wanneer de tenant wordt aangemaakt.

Neem bij het per e-mail aanvragen van een nieuwe tenant voor de Asset-app bij het Product Team van Asset ook een verzoek op om een tenant voor het integratieplatform aan te maken als die nog niet bestaat.

2. Configuratie van de Asset-app

2.1 Gebruikers toevoegen

Ga naar https://assetapp.spacewell.com/ en gebruik de inloggegevens die het Product Team voor de betreffende klant heeft verstrekt.

Ga naar Account → Users:

Voeg de gebruikers toe die werkorders via de Asset-app gaan afhandelen. Wijs de rol 'Company User (Mobile Only)' toe aan de toegevoegde gebruikers.

Controleer of het e-mailadres van de gebruiker overeenkomt met het e-mailadres van de betreffende gebruiker in Asset die aan de externe app van de Asset-app is toegevoegd (zie hieronder voor deze stappen).

Meer informatie over de beschikbare rollen vindt u in het Help Center van de Asset-app (GoCanvas): https://help.gocanvas.com/hc/en-us/articles/26312342524823-The-Seven-User-Roles

Wijs de nieuwe gebruiker rechtstreeks aan de beschikbare formulieren toe door deze te selecteren:

Informatie

Wanneer een nieuwe gebruiker wordt aangemaakt, kan de beheerder bepalen of de gebruiker een wachtwoord moet invoeren of dat het wachtwoord al door de beheerder wordt ingesteld. In beide gevallen ontvangt het opgegeven e-mailadres een e-mail.

E-mail (wachtwoord vooraf ingesteld door de beheerder):

E-mail (wachtwoord door de gebruiker te bepalen):

2.2 [Optioneel] Aangepast logo op formulier

Ga naar Forms:

Standaard wordt het standaardwerkorderformulier in het Nederlands, Engels, Duits of Frans (de consultant heeft het Product Team geïnformeerd over de gewenste taal) beschikbaar gesteld voor het nieuwe account van de Asset-app. Dit formulier bevat het logo van Spacewell.

Klik op het tandwielpictogram om de instellingen van het betreffende formulier te openen.

Wijzig het pictogram in een klantspecifiek pictogram. Dit pictogram wordt gebruikt wanneer een PDF wordt gegenereerd nadat een gebruiker een werkorder heeft ingediend.

2.3 Webhook voor meldingen configureren

Om ervoor te zorgen dat de Asset-app ook een melding naar Asset verzendt nadat een dispatch op een formulier is voltooid, moet op elk formulier een integratie-URL worden geconfigureerd. De integratie-URL bevat de tenantnaam die in het integratieplatform is ingesteld (hoofdstuk 4.1 Tenant maken).

Ga naar Forms → Edit om de integratieopties weer te geven:

Voeg /show_integration_options toe aan de URL en druk op Enter:

https://assetapp.spacewell.com/forms/5702497 -> https://assetapp.spacewell.com/forms/5702497/show_integration_options

 Het scherm met integratieopties wordt zichtbaar. Klik op 'Activate Submission Creation Webhook.':

Voer de volgende URL in het URL-veld in (vergeet de tenantnaam aan het einde van de URL niet):

• ‘Format’ moet worden gewijzigd van ‘JSON’ in 'XML (Deprecated)
• Het veld Tag moet leeg blijven

Klik op Save om de configuratie te bevestigen.

3. Configuratie van Asset

3.1 Module activeren

Activeer de integratie van de Asset-app via de moduleactivering: Moduleactivering en informatie over de integratie van de Asset-app

3.2 Toewijzingen configureren in External App

Ga naar het tabblad Module settings → Integrations (alleen zichtbaar als meerdere integraties zijn geactiveerd; anders wordt het tabblad van de Asset-app rechtstreeks weergegeven) → tabblad Asset app → Asset app external apps:

Selecteer de External app van de Asset-app en ga naar Mappings :

Alle toepasselijke toewijzingen worden door de moduleactivering automatisch aan de externe app toegevoegd. Controleer of alle toewijzingen zijn geconfigureerd op basis van de onderstaande lijst. Sommige waarden worden automatisch ingevuld en andere moeten handmatig worden geconfigureerd:

• base_url: deze waarde wordt automatisch ingevuld → 'integration.spacewell.com'
• client_id: voer de waarde 'Client ID' in die per e-mail is verstrekt
• client_secret: voer de waarde 'Client Secret' in die per e-mail is verstrekt
• default_form*: de ID van het standaardformulier moet worden opgegeven om ervoor te zorgen dat de werkorder vanuit Axxerion in de backend van de Asset-app voor het juiste formulier wordt aangemaakt. De ID van het standaardformulier (het Nederlandse, Engelse, Duitse of Franse formulier) kan worden verkregen door het formulier in de backend van de Asset-app te openen en de ID uit het laatste deel van de URL te kopiëren (https://assetapp.spacewell.com/forms/5567321)
• grant_type: deze waarde wordt automatisch ingevuld → 'client_credentials'
• tenant_id: voer de tenantnaam in die per e-mail is verstrekt
• token_url: deze waarde wordt automatisch ingevuld → 'https://integration.spacewell.com/api/v2/oauth/urlencoded/token'
• webhook: deze waarde wordt automatisch ingevuld, maar moet worden aangevuld met de klantreferentie van Asset → 'https://integration.spacewell.com/api/v2/push/axxerion/<client reference>'

3.3 Geheime sleutel weergeven

Ga naar het tabblad Module settings → Integrations (alleen zichtbaar als meerdere integraties zijn geactiveerd) → tabblad Asset app → Asset app external apps.

Selecteer de External app van de Asset-app, controleer of ‘Commission' is ingesteld op ‘active’ en selecteer de relatie Trust relation . Klik vervolgens op de hyperlink 'Key':

Klik op 'Reveal key' als er al een geheime sleutel is gegenereerd.

Klik op 'Generate key' als er nog geen geheime sleutel is.

Kopieer de geheime sleutel en noteer deze. Deze geheime sleutel is later in deze handleiding nodig voor de configuratie van de Asset-connector.

3.4 Aanvullende configuratie

Controleer of de volgende configuratie in Asset is voltooid:

• De module Requests is geactiveerd en geconfigureerd
• De module voor correctieve en/of preventieve onderhoudswerkorders is geactiveerd en geconfigureerd
• Er zijn gebruikersprofielen gemaakt voor de servicemedewerker en de interne opdrachtnemers
• Er zijn gebruikers gemaakt en het juiste gebruikersprofiel is toegewezen

3.5 Systeemgebruikers koppelen aan de External App

Alle gebruikers in Asset die de Asset-app gaan gebruiken voor het afhandelen van correctieve en/of preventieve onderhoudswerkorders, moeten aan de externe app worden gekoppeld.

Ga naar het tabblad Module settings → Integrations (alleen zichtbaar als meerdere integraties zijn geactiveerd) → tabblad Asset app → Asset app external apps.

Selecteer de External app van de Asset-app en ga naar System user :

Klik op Search om de al gekoppelde systeemgebruikers weer te geven.

Klik op Assign om nieuwe systeemgebruikers te koppelen:

Zoek en selecteer alle toepasselijke gebruikers en klik op Ok om ze aan de externe app te koppelen:

4. Configuratie van het integratieplatform

Met het integratieplatform kunnen gegevens tussen de externe app en Asset worden gesynchroniseerd. U kunt de flows tussen de app en Asset configureren in het integratieplatform.

Log in op het integratieplatform met de verstrekte inloggegevens via https://integration.spacewell.com/

4.1 Asset-appconnector maken

Selecteer de toepasselijke tenant in het vervolgkeuzemenu rechtsboven.

Ga naar Asset App Sync > Connectors. Selecteer in Actions “Add” om een nieuwe connector te maken:

Selecteer het type GOCANVAS en voer de volgende gegevens in:

Klik op Add om te bevestigen.

4.2 Asset-connector maken

Ga naar Reservation Sync > Connectors > Actions en selecteer “Add” om een nieuwe connector te maken.

Selecteer het type AXXERION en voer de volgende gegevens in:

Klik op Add om te bevestigen.

4.3 Flows maken

4.3.1 Asset naar Asset-app

1. Ga naar Asset App Sync > Flows. Selecteer in Actions “Add” om een nieuwe flow te maken:

2. Voer de naam van de flow in (gebruik: ‘Asset to Asset App’) en selecteer het flowtype 'Axxerion work order to Gocanvas':

3. Klik op Add om de nieuwe flow te bevestigen.
4. Beweeg de muis over de flow van Asset naar de Asset-app en selecteer … > Edit :

5. Selecteer het tabblad Mappings en ga naar Manage mappings:

6. Selecteer Add mapping om de velden van Asset toe te wijzen aan de formulier velden van de Asset-app

7. Voeg alle toepasselijke toewijzingen toe die beschikbaar zijn in het standaardformulier:

8. Selecteer Confirm en Save.

4.3.2 Asset-app naar Asset

Volg dezelfde stappen als hierboven, waar de flow “Asset to Asset app” is gedefinieerd:

1. Ga naar Asset App Sync > Flows. Selecteer in Actions “Add” om een nieuwe flow te maken.
2. Voer de naam van de flow in (gebruik: ‘Asset App to Asset’) en selecteer het flowtype 'Gocanvas to Axxerion Workorder'.
3. Klik op Add om de nieuwe flow te bevestigen.
4. Beweeg de muis over de flow van de Asset-app naar Asset en selecteer … > Edit .
5. Selecteer het tabblad Mappings en ga naar Manage mappings.
6. Selecteer Add mapping om de velden van Asset toe te wijzen aan de formulier velden van de Asset-app.
7. De volgende toewijzing is van toepassing op het standaardformulier in de Asset-app:

8. Klik op Confirm.
9. Ga nog steeds op het tabblad Mappings naar Transition rules:

10. Voeg een regel toe om de volgende overgangsregels toe te voegen:

• Work has to be rescheduled heeft waardetype Empty ; wijzig vervolgens de bestemming in End work
• Work has to be rescheduled heeft waardetype Not empty ; wijzig vervolgens de bestemming in Reschedule

Of, afhankelijk van de taal van het standaardwerkorderformulier in de backend van de Asset-app, in een andere taal (bijvoorbeeld in het Nederlands: ‘Werk moet opnieuw worden gepland' of in het Duits: “die Arbeiten müssen neu geplant werden“).

11. Klik op Save om de overgangsregels op te slaan en klik nogmaals op Save om de flow op te slaan.

5. Aan de slag

Zodra alle bovenstaande stappen zijn voltooid, is de integratie actief en kan de Asset-app worden gebruikt om werkorders af te handelen.

Voer eerst een volledige end-to-endtest uit (stuur de werkorder door, laat deze via de Asset-app opnieuw plannen, stuur deze opnieuw door en voltooi het werk). Controleer daarbij of de werkorder correct wordt verwerkt in Asset en of het resultaat en het ondertekende werkorderformulier ook in Asset worden bijgewerkt. Hiermee controleert u of alle bovenstaande stappen correct zijn uitgevoerd en of de integratie naar verwachting werkt.

Gebruikers moeten de Spacewell Asset-app downloaden (zoek naar “Spacewell Asset”) en de inloggegevens gebruiken die beschikbaar zijn via:
Configuratiehandleiding voor de integratie van de Asset-app

Houd er rekening mee dat de e-mail die elke gebruiker automatisch ontvangt wanneer de gebruiker in de backend van de Asset-app wordt aangemaakt, een link bevat om de standaard GoCanvas-app te downloaden. Dit is niet de Spacewell Asset-app, die in feite een versie van de standaard GoCanvas-app met een eigen merknaam is (functioneel zijn ze hetzelfde en kan deze ook worden gebruikt).

Het enige wat nog moet gebeuren, is een werkorder in Asset toewijzen aan een gebruiker wiens e-mailadres overeenkomt met dat van een gebruiker in de backend van de Asset-app en die in Asset aan de externe app is gekoppeld. Deze gebruiker ontvangt dan een dispatch in de Asset-app en kan de werkorder afhandelen.

6. Aanvullende informatie, opties en gebruikershandleidingen

Raadpleeg de officiële GoCanvas-documentatie voor meer informatie over de beheerdersopties in de backend van de Asset-app, waaronder het maken van aangepaste formulieren*, het aanpassen van de standaard-PDF, het beheren van gebruikers en het begrijpen van de werking van de Asset-app voor gebruikers die dispatches afhandelen:

https://help.gocanvas.com/hc/en-us

*Houd rekening met het advies over het maken van aangepaste formulieren zoals beschreven in Asset App