PlannerExternalCalendarService (2021-1)

Forretningsbeskrivelse

Servicen er udfaset!


Ekstern kalender service udstiller et API, så Planner kan modtage og gemme kalenderaftaler fra de enkelte vejledere/lokaler i de enkelte Jobcentre.

En privat kalender er defineret som vejlederens personlige kalender hos kommunen, hvor han/hun er ansat, eller som den kalender, der er knyttet til bookning af et lokale i et Jobcenter.

En vejleder eller et lokale er defineret som en ressource i Planner, og er unikt identificeret ved en tilknyttet mailadresse.

En ”Event” er defineret som en aftale, der spærrer tid i den personlige kalender sådan, at en Planner-aftale ikke er mulig at booke inden for dette tidsrum.

Formålet med at udstille dette API er, at de enkelte Jobcentre kan sørge for, at man ikke kan booke et møde i Planner, hvor en vejleder allerede har en aftale i sin personlige kalender, eller hvor et lokale allerede er booket til et andet møde. Det er vigtigt, at Planner afspejler de personlige aftaler og blokerer tiderne i mødebookingen, så der ikke opstår situationer, hvor en vejleder ikke er til stede og klar på grund af en personlig aftale, eller et lokale ikke er til rådighed, når en borger ankommer til et møde.

PlannerExternalCalendarService v1 d2


Formålet er også at imødekomme udfordringer, hvor Planner ønsker at hente private kalenderaftaler fra et Jobcenter. Udfordringen ligger i, at Planner ikke sikkerhedsmæssigt kan få lov at ”snakke til” et Jobcenter – kommunikationen kan kun foregå fra et Jobcenter til Planner, ikke den anden vej.

Inden afsendelse af kalenderaftaler til Planner, bør alle aftaler der ikke reelt blokerer tid i kalenderen sorteres fra (dvs. aftaler der ikke er ”Out of office”, ”Busy” eller ”Tentative” i Outlook-termer).

I Jobcenter Planner er det muligt at henholdsvis slå til eller fra, om man vil acceptere modtagelse af de personlige kalenderaftaler for et givent Jobcenter (eller en given vejleder eller et givent lokale).

Af hensyn til performance og netværkstrafik, anbefales det kun at sende aftaler, der ligger i det tidsrum vejlederen har defineret som rådighedstid. Dette tidsrum kan hentes for hver vejleder eller lokale, ved at kalde metoden ”GetResources”. Der returneres et tidsrum pr. dag pr. vejleder – dvs. opsætning for alle ugens 5 arbejdsdage returneres ved et enkelt kald.

I forhold til sikkerhed, skal der på alle kald til metoderne på webservicen, indlejres et af DFDG godkendt certifikat, til identifikation af hvilket Jobcenter der foretager kaldet. Det er til enhver tid DFDG, der definerer sikkerheden i forhold til webservicen.


Link til snitfladebeskrivelse

Link til forretningsbeskrivelser 

 

Found 2 search result(s) for PlannerExternalCalendarService.


Metoder

Rettigheder til at kalde metoderne

Jobcentre, kommuner og anden aktør

Metode
Alle borgere
Egne borgere
Mulighed for gæsteadgang
Beskrivelse
CreateEventsJC, AA


UpdateEventsJC, AA


DeleteEventsJC, AA


GetEventsJC, AA


GetResourcesJC, AA


A-kasser

Metode
Alle personer
Egne medlemmer
Tidligere medlemmer
Mulighed for gæsteadgang
Beskrivelse
CreateEvents




UpdateEvents




DeleteEvents




GetEvents




GetResources




CreateEvents

Denne metode understøtter modtagelse af nye personlige aftaler i Planner. Det kun er muligt, at modtage fremtidige aftaler, dvs. aftaler med startdato frem i tid.

Det er ikke muligt at tilknytte gentagelsesmønstre (recurrence). Gentagede aftaler skal udregnes og hver forekomst skal sendes som individuelle aftaler med eget unikt oprindelses-ID. Bemærk det er muligt, at sende flere aftaler afsted i ét kald.

Forretningsregler:

  • Startdato skal være frem i tid.
  • Slutdato skal være efter startdato og frem i tid.
  • Kilde-kalendersystemets interne ID for aftalen skal sendes med.
  • Emailadresse for ejeren af kalenderaftalen skal sendes med, da aftalen skal kunne bindes til en identificerbar vejleder eller et identificerbart lokale. Det anbefales af hensyn performance, at sende Planners interne ID for ejeren af kalenderaftalen hvis denne haves – det kan erstatte et kald i databasen.

UpdateEvents

Denne metode understøtter modtagelse af opdateringer til personlige aftaler i Planner – bemærk det kun er muligt, at modtage fremtidige aftaler, dvs. aftaler med startdato frem i tid.

Det er ikke muligt at tilknytte gentagelsesmønstre (recurrence). Gentagede aftaler skal udregnes og hver forekomst skal sendes som individuelle aftaler med eget unikt oprindelses-ID.

Bemærk det er muligt, at sende flere aftaler afsted i ét kald.

  • Startdato skal være frem i tid.
  • Slutdato skal være efter startdato og frem i tid.
  • Det er en fordel, men ikke et krav, at medsende Planners ID for kalenderaftalen (modtages retur ved kald til ”CreateEvents”). Hvis ikke Planners ID for kalenderaftalen sendes med, skal kilde-kalendersystemets interne ID for aftalen sendes med.
  • Emailadresse for ejeren af kalenderaftalen skal sendes med, da aftalen skal kunne bindes til en identificerbar vejleder eller et identificerbart lokale. Det anbefales af hensyn performance, at sende Planners interne ID for ejeren af kalenderaftalen hvis denne haves – det kan erstatte et kald i databasen.

DeleteEvents

Denne metode understøtter modtagelse af sletninger af personlige aftaler i Planner. Bemærk det er muligt, at sende flere aftaler afsted i ét kald.

Forretningsregler:

  • Det er en fordel, men ikke et krav, at medsende Planners ID for kalenderaftalen (modtages retur ved kald til ”CreateEvents”). Hvis ikke Planners ID for kalenderaftalen sendes med, skal kilde-kalendersystemets interne ID for aftalen sendes med.
  • Emailadresse for ejeren af kalenderaftalen skal sendes med, da aftalen skal kunne bindes til en identificerbar vejleder eller et identificerbart lokale. Det anbefales af hensyn performance, at sende Planners interne ID for ejeren af kalenderaftalen hvis denne haves – det kan erstatte et kald i databasen.

GetEvents

Denne metode benyttes til at hente en liste af oprettede og aktive kommunale kalenderaftaler, der er oprettet i Planner. Listen kan afgrænses ved at levere User-objekter for de vejledere eller lokaler, man specifikt ønsker en liste af aftaler for.

Metoden kan ses som en alternativ fuld synkronisering, da man får en kopi retur af alle aftalerne, og kan derved selv afgøre, om en yderligere opdatering af kalenderaftalerne i Planner er nødvendig.

Forretningsregler:

  • En eller flere emailadresser eller unikke Planner vejleder/lokale ID’er kan sendes med for at begrænse forespørgslen.
  • Medsendes ikke nogen emailadresser eller Planner ID’er, returneres en samlet liste med alle aktive fremtidige kommunale kalenderaftaler for det Jobcenter, der har udført forespørgslen.


Perioden for GetEvents er afgrænset efter samme indstilling i Planner som aflevering af kalenderaftaler (Create-/UpdateEvents). Per default er denne indstilling 3 måneder for alle Jobcentre. Men den kan, efter aftale med STAR, ændres per Jobcenter til f.eks. 6 måneder.

Indstillingen er pt. både i Planner (så den kan administreres) og i Kommuneklienten (og sikkert også Intravisions implementering). Der kunne laves en ændring, hvor Kommuneklienten spørger Planner om disse indstillinger, og derefter arbejder med dem. Men det er et udviklingsønske til Planner, og skal prioriteres derefter.

Det er lavet på denne måde, for ikke at utilsigtet (eller tilsigtet) komme til at overbelaste Planner med store kald til kalenderservicen.

GetResources

Denne metode benyttes til at hente oplysninger om en eller flere vejledere og / eller en eller flere lokaler. Dette kan bruges til, bl.a., at hente Planner ID for en vejleder eller et lokale og hvilket interval vejlederen har indstillet for rådighed i Planner.

Det anbefales at cache Planners ID’er i for en given periode, så det ikke er nødvendigt, at foretage kald til denne metode, hver gang en aftale sendes til Planner.

Forretningsregler:

  • En eller flere emailadresser kan sendes med for at begrænse forespørgslen.
  • Medsendes ikke nogen emailadresser, returneres en samlet liste med vejledere for det Jobcenter, der har udført forespørgslen.