administration:dedu-koppling [Orbiq wiki]

Denna sida är skrivskyddad. Du kan titta på källkoden, men inte ändra den. Kontakta administratören om du anser att du bör kunna ändra sidan.
====== DeDU koppling ======

Orbiq går att koppla mot det tekniska förvaltningssystemet för att underlätta ärendehantering, tillsyn och skötsel av fastigheter. Om ni är nyfikna på vad DeDU är hittar ni mer om det systemet [[https://www.dedu.se/manual/|här]]. Genom att koppla Orbiq till DeDU’s API bryggar vi till DeDU’s ärendehantering och arbetsorder funktioner. När allvarigare larm triggas hos Orbiq kan vi därmed skapa ärenden för dessa larm automatiskt.

===== Börja med att sätta upp en DeDU koppling till ett företag i Orbiq. =====

Gå in på //Administration// -> //Användare// -> //Företag// och skapa ett företag genom att klicka på den gröna knappen längst ned till höger. Vi har lagt funktionen här eftersom vi ville möjliggöra för våra kunder att kunna skicka automatiska ärenden för larm till olika underleverantörer. Genom att klicka i ”DeDU”-checkboxen väljer ni att lägga till en DeDU koppling.
  - Under //DeDU API URL// fyller ni i URL:en. Det är vanligtvis https://api.dedu.se.
  - Under //DeDU API nyckel// fyller ni i API nyckeln, denna får ni från DeDU. Genom att klicka på "Ladda API" ska informationen fyllas i nedan.
  - //E-post för notifiering// - vid fel fylls i med den mail adress som ska notifieras om något går fel med DeDU kopplingen.

{{:administration:pasted:20230308-160354.png}}

Under //Objekt matchning// ställer du in hur kopplingen mellan DeDU och Orbiq fungerar. Om du redigerar en exterande DeDu profil och vissa fält är gråa, till exempel //DeDU Matchningsattribut//, kan det bero på att ni inte har tryckt på //Ladda API//.
  - //DeDU Matchningsattribut// - här väljer ni vilket fält hos DeDU som kommer att användas för matchning mellan fastigheter i Orbiq och DeDU. Dessa alternativ kommer direkt från DeDU.
  - //Orbiqs Matchningsattribut// här väljer ni vilket fält hos Orbiq som kommmer att användas för matchning mellan fastigheter i Orbiq och DeDu. Dessa alternativ kommer från Orbiq internt.
  - Om //Skicka e-post ifall matchning misslyckas// är ikryssad och en matchning mellan Orbiq och DeDU misslyckas kommer ett mail att skickas till samma mailadress som ni angett i //E-post för notifiering vid fel// tidigare i formuläret.  Om denna är urkryssad får ni tillgång till vidare alternativ.
  - //DeDU object för använding då matchning misslyckas// finns bara som alternativ om //Skicka e-post ifall matchning misslyckas// har blivit urkryssad. Här kan ni istället välja att lägga alla larm som inte kan matchas på en designerad fastighet. Det är viktigt att fastigheten i fråga finns inlagd både på DeDU och Orbiq för att detta ska fungera.

{{:administration:pasted:20230308-162901.png}}

===== DeDU profiler =====
Ni kan ha ett antal olika DeDU profiler där varje profil är kopplad till specifika utförare.
  - Under //Namn// döper du profilen.
  - Under //Utförare// väljer du vilken utförare ärenden ska skickas till.
  - Under //DeDU ärendetyp// väljer du vilken typ av ärendet ska ha. 
  - Under //DeDU prioritet// väljer du vilken prioritet ärendet ska ha.
  - Under //DeDU kategori// väljer du kategorin för ärendet. 
  - Genom att klicka i //Skapa ej ett nytt ärende ifall okvitterat ärende för larmet redan existerar// hindrar du Orbiq från att skicka flera ärenden på samma larm inom 30 dagar. Om det finns ett ärende som är äldre än 30 dagar kommer larmet fortfarande att skicka ett nytt ärende. Här har vi tänkt oss två olika scenarion:
    * Scenario 1: Ett akut larm har gått. Då vill vi att det skapas ett ärende oavsett huruvida det har skapats ett identiskt ärende inom 30 dagar så att det kan lösas så snart som möjligt. Ett exempel på detta är ett hiss-larm som gått.
    * Scenario 2: Ett lågprioriterat larm pågår och skickar nya larm var 10:e minut. Då vill vi inte att hundratals eller tusentals ärenden ska skapas, utan det är först efter 30 dagar som det skapas **ett** nytt ärende. Ett exempel på detta är om en sensor har tappat kontakten och det skickas ett heartbeat-larm.
  - Klicka på //Lägg till// för att skapa profilen.
  - Här kan ni skicka en testärende.
  - Här redigerar ni en existerande profil. Profilinformationen kommer då att synas i de överstående fälten och //Lägg till// byts ut mot //uppdatera//.
  - Här kan ni ta bort existerande profiler
  - Här kan ni se informationen för den existerande profilen.

{{:administration:pasted:20230308-163436.png}}

===== Aktivera larmprofilen =====
Gå in på //Administration// -> //Larmprofiler// och klicka på den gröna knappen längst ned till höger för att skapa en ny larmprofil. Ställ in //Tidsintervall// och //Filter// på respektive tabb och gå sedan till //Mottagare//.
  - Under //Tillgängliga mottagare// väljer ni det företag ni skapade.
  - Under //Kontaktalternativ// väljer ni den DeDU-profil ni skapade.

Om ni lägger till mail- eller SMS-utskick kan ni lägga till att något ska skickas via en annan kanal genom att klicka på plusset till höger, men med DeDU integrationen går detta inte att göra eftersom denna inställning görs under DeDU profilen. Ni kan däremot lägga till mail- eller SMS-utskick som paralell händelse till DeDU ärendet och när ni gör det skickas även en referens till DeDU ärende-ID:et med i utskicket för uppföljning av ärendet.

När detta är gjort kan ni spara larmprofilen högst upp till vänster.

===== Format och innehåll för ärenden som skapas i DeDU =====
Innehållet för ärende som skapas i DeDU är i formatet:

"larmpunktens beteckning" - "larmhändelsens text"

===== Uppsättning av API och behörigheter i DeDU =====
För att funktionen ska fungera, behöver ett API-konto sättas upp i DeDU med rätt behörigheter och tillhörande API-nyckel som kan användas av Orbiq. Följande DeDU-behörigheter bör räcka:

^Behörigheter^^^	
|Professions|Hämta utförare|GET|
|Regions|Hämta regioner|GET|
|Properties|Hämta fastigheter|GET|
|Structures|Hämta byggnader|GET|
|SpatiSystems|Hämta utrymmessystem (lokaler/lägenheter)|GET|
|Spaces|Hämta utrymmen|GET|
|Elements|Hämta elements (system/objekt)|GET|
|TaskTypes|Hämta ärendetyper|GET|
|TaskPriorities|Hämta prioritet ärenden|GET|
|TaskSources|Hämta ärendekällor|GET|
|Tasks|Skapa ärende|POST|
|Tasks|Uppdatera ärende|PATCH|
|Resources|Hämta valda resurser|GET|
|UploadFiles|Ladda upp fil|POST|
|DownloadFile|Ladda ner fil|GET|
|DisplayFile|Visa fil|GET|
|Billboards|Hämta anslagstavlan|GET|
|TaskCategories|Hämta kategorier/underkategorier|GET|
|TaskWaitLists|SKapa ärende i väntelista|POST|
|AcknowledgmentJournals|Skapa kvitteringsjournal|POST|
|Tasks|Hämta ärenden|GET|