Introduktion og formål
Følgende er en introduktion til hvordan man gør brug af JSON i Emplys eksport funktionalitet.
Dataen der skal fremgå i en JSON eksport er brugerdefineret, det er derfor muligt at opsætte træk med præcis det data man har brug for, til andre systemer, uden at skulle arbejde rundt om data som ikke er nødvendigt.
Dataen i en JSON eksport skal ses som et "snapshot", taget af en profil ved sidste eksekvering af eksporten, man skal derfor sørge for at eksekvere sin eksport igen, hvis man ønsker opdateret data.
Eksekvering af en eksport kan ske manuelt, automatisk på et specifikt tidspunkt, eller automatisk ved ændringer - eller oprettelse af data på profiler. Dette opsættes og tilpasses af brugeren ved brug af Emply's automatiserings metoder.
Hvordan opretter jeg en JSON eksport?
Gå til Indstillinger > Integrationer > Eksportér > klik på '+ Ny eksport' > vælg 'JSON Package'.
Her giver man eksporten en intern beskrivelse, vælger om den skal bruges til 'Medarbejder' og/eller 'Kandidat'.
Nedenunder vælger man de flettefelter som skal udgøre de data man vil hente med ens JSON eksport.
Hvordan bruges en JSON eksport?
Når man har udfyldt med de ønskede flettefelter, kopierer man det unikke GUID i bunden af ens JSON Package:
Derefter skal man lave en eksport på de medarbejdere man ønsker at hente dataen på.
Gå til Medarbejdere > marker de ønskede medarbejdere > tryk på burger-ikonet og vælg 'Eksportér':
Vælg ønskede JSON eksport > tryk på 'Eksportér':
Test af JSON Package
Gå derefter til Emplys API. Her skal man have sin API key og JSON Package GUID klar.
For at teste i Emplys API skal man klikke på 'Authorize', udfylde sin API key under 'Value' og afslutte ved at klikke på 'Authorize':
Herefter vælger man endpointet 'Exports', og udfører først en GET request med endpointet /v1/{customer}/exports/{exportId}.
- exportId = GUID som kan findes i opsætningen af eksporten.
- customer = Den første del af platformens domæne f.eks: eksempel.emply.com vil have ordet 'eksempel' som customer.
- languageKey = Ikke nødvendig, bruges hvis eksporten er sat op på flere sprog, og man ønsker at trække en speficik oversættelse af dataen.
- from/to = Til og fra dato for eksportens udførsel.
Når dataen bliver indlæst vil man få en entity for hver medarbejder hvor eksporten er kørt inden for valgt tidsrum, en entity i dette træk består af 3 værdier:
- ID = Entity ID'et for den eksporterede profil, entity ID'et bliver oprettet ved første kørsel af eksporten og ændrer sig ikke, ved fremtidige kørsler af eksporten vil dataen tilhørende dette entity ID blive opdateret.
- Created = Dato og for sidste eksport af entity. Dette er dato og tiden som bliver læst i from/to parameteren.
- LanguageKey = Sproget som denne entity trækker data fra.
For at læse dataen i en entity skal der udføres en GET request med endpointet /v1/{customer}/exports/{exportId}/entities/{entityId}.
- exportId = GUID som kan findes i opsætningen af eksporten.
- entityId = 'ID' værdien for en entity som hentes i forrige kald.
- customer = Den første del af platformens domæne f.eks: eksempel.emply.com vil have ordet 'eksempel' som customer.
Herefter vil dataen som er sat op eksporten vises i JSON format, såfremt dataen er udfyldt på profilen hvor eksporten er kørt.
Sådan bruges din JSON Package med Emplys API
Når ønsket resultat er opnået efter testing kan programmering af trækkene laves, metoden ville fungere på samme måde som da man testede med dette flow:
- Træk liste af entities der er kørt i valgt tidsrum med endpointet: /v1/{customer}/exports/{exportId}.
- Brug entitiy ID og endpointet: /v1/{customer}/exports/{exportId}/entities/{entityId} for at se dataen i eksporten.
- Gem/behandl entity data som ønsket.
- Gentag step 2 og 3 for hver entity der fremgår i step 1.
Opsætning af automatisering til JSON
Når man har oprettet en JSON eksport er det muligt at opsætte en automatisering, så API kaldet foregår automatisk.
Gå til Indstillinger > Automatisering > klik på 'Nyt workflow':
I dette eksempel har vi valgt 'Medarbejder' som det automatiseringen skal omhandle, og at 'Oprettet' skal udløse automatiseringen. Når dette er sat op og gemt, klikker man på '+ Tilføj handling':
Her vælger vi 'Integration' som den handling der skal udløses:
Derefter vælger man den integration det skal omhandle. Her vælger vi den ønskede JSON Package vi har lavet:
Når automatiseringen er sat op skal man huske at switch fra 'Inaktiveret' til 'Aktiveret':
Brug af automatiserede eksports, giver mulighed for at have delta-lignende eksports som kun kører ved oprettelse/ændring af data, automatiserede eksports er ikke nødvendigt, da JSON eksports kan eksekveres manuelt hvis ønsket.