IA-systemets Windows Communication Foundation tjänster

Transkript

1 IA-systemets Windows Communication Foundation tjänster Senast uppdaterad 3 oktober 2016

2 Sida 2 av 32 INNEHÅLL 1. INLEDNING ÖVERSIKT KONFIGURATION Servicekonto Roller Lösenord för nya användare HÄMTA DATA FRÅN IA-SYSTEMET Exportera senaste händelse Exportera antal händelser Exportera åtgärder Exportera händelser Appendix Exportera Flaggade händelser SKICKA DATA TILL IA-SYSTEMET Importera organisationen Importera användare Hierarkisk datastruktur Importera användare Flat datastruktur Importera åtgärder... 30

3 Sida 3 av INLEDNING I IA-systemet finns olika tjänster som kan användas för integrationer med externa system. Importtjänster syftar till att automatisera och förenkla administrationen av organisationer i IAsystemet, exporttjänster används för att presentera information som finns i IA-systemet i ett externt system. Tjänsterna möjliggör även integration med ett arbetsordersystem, där arbetsorder kan hämtas från IA-systemet och uppdateras i IA-systemet. Alla tjänster är byggda på WCF (Windows Communication Foundation) och kan anropas av externa system oberoende av vilken plattform eller vilket programmeringsspråk som används. I listan nedan visas adressen till WCF för varje servermiljö. På dessa platser finns även en länk till WSDL för tjänsterna samt kodexempel. WSDL står för Web Services Description Language och är en XML-baserad standard för webbtjänster. WSDL anger hur tjänsten ska anropas samt beskriver detaljerat vilka datatyper, parametrar och objekt som används vid kommunikation med tjänsten. Servermiljö Acceptanstestmiljö Produktion URL Alla anrop till tjänsterna ska ske med HTTPS. Vid utveckling av funktionalitet för att kunna anropa tjänsterna ska acceptanstestmiljön används som testserver. Certifikaten kan laddas ner via adresserna ovan.

4 Sida 4 av ÖVERSIKT Service IsAlive IsAliveWithDependencies GetLatestOccurrence GetOccurrenceCountByOrganizationalUnit GetAction SaveOrganizationalUnitsWithLogin SaveUsers SaveUsersFlat SaveAction GetOccurrenceExcelData GetFlaggedOccurrence Beskrivning Testar att tjänsten är aktiv. Anropas utan parametrar och returnerar ett svarsobjekt som innehåller ett booleskt värde. Testar att tjänsten är aktiv och har koppling till databas. Anropas utan parametrar och returnerar ett svarsobjekt som innehåller ett booleskt värde. Hämtar senaste händelse i organisationen eller i en specifik enhet. Detta gäller för alla händelser förutom arbetssjukdom. Hämtar antalet händelser i organisationen eller i en specifik enhet för vald period. Hämtar åtgärder för vald period. Importerar organisationsstrukturen. Importerar användare med en hierarkisk datastruktur. Importerar användare med en flat datastruktur. Importerar åtgärder. Hämtar ett Exceldokument med händelser för vald period. Hämtar flaggade händelser i organisationen eller för en specifik enhet

5 Sida 5 av KONFIGURATION 3.1. SERVICEKONTO För att kunna använda WCF tjänsterna behövs en användare med rollen Servicekonto i er organisation. Denna användare skickas med i anropen av tjänsterna och identifierar vilken organisation som anropar dem. Den skapas av er superanvändare enligt instruktionerna nedan, och måste skapas både i acceptanstestmiljön och i produktionsmiljön. 1. Klicka på knappen Admin och fliken Roller. 2. Välj Servicekonto i vallistan Välj roll. 3. Klicka på knappen Spara längst ner på sidan för att aktivera rollen. Så fort rollen Servicekonto är aktiverad kan man skapa en användare med den rollen enligt följande steg: 1. Klicka på knappen Admin och fliken Användare. 2. Fyll i fälten Förnamn och Efternamn. Använd något allmänt namn som t.ex. Vårt Servicekonto. 3. Ange Användarnamn och Lösenord.

6 Sida 6 av Fälten Anställningsenhet, Telefon och E-post samt kryssrutan Extern kontaktperson lämnar du tom. 5. Välj rollen Servicekonto. IA-systemet väljer automatiskt att rollen ska gälla för hela organisationen. 6. Bestäm, med hjälp av vallistan till höger om rollen, vilka händelsetyper som ska kunna hanteras av servicekontot Klicka på Skapa. 1 Vill du markera flera händelsetyper håller du ner tangenten Ctrl.

7 Sida 7 av ROLLER För att kunna importera användare till IA-systemet måste de roller som berörs av importen ha minst en händelsetyp förvald. De roller man kan importera är Chef, Händelseansvarig och Skyddsombud samt Utredare och åtgärdsutförare 2. Er superanvändare anger förvalda händelsetyper för dessa roller enligt följande steg: 1. Klicka på knappen Admin och fliken Roller. 2. Välj i vallistan under Välj roll en av rollerna Chef, Händelseansvarig, Skyddsombud och Utredare och åtgärdsutförare. 3. Markera de händelsetyper som ska vara förvalda i listan Händelsetyper Vill du att dessa händelsetyper ska vara förvalda när du skapar nya användare med den rollen, klickar du på den gröna knappen med två pilar. 5. Vill du lägga till dessa händelsetyper för samtliga användare som har rollen, klickar du på den gröna knappen med tre pilar. 6. Dina val flyttas till den högra listan, och de nya inställningarna sparas direkt utan att du behöver klicka på Spara. 7. Upprepa steg 2 till 6 för de andra rollerna som ni vill hantera genom importen. 2 Det är inte möjligt att importera rollen Utredare och rollen Åtgärdsutförare. 3 Vill du markera flera alternativ samtidigt håller du ner tangenten Ctrl och vill du markera flera alternativ i rad håller du ner tangenten Shift.

8 Sida 8 av LÖSENORD FÖR NYA ANVÄNDARE För att kunna importera användare till IA-systemet måste ni ha angett ett standardlösenord för er organisation. Er superanvändare kan ange ett standardlösenord enligt följande steg: 1. Klicka på knappen Admin och fliken Användare. 2. Expandera rutan för Generella lösenordsinställningar 3. Fyll i det lösenord som ska gälla alla nya användare i rutan Lösenord. 4. Klicka på Spara.

9 Sida 9 av HÄMTA DATA FRÅN IA-SYSTEMET 4.1. EXPORTERA SENASTE HÄNDELSE Metod: GetLatestOccurrence Denna tjänst hämtar den senast registrerade händelsen av angiven händelsetyp. Händelsen kan hämtas från hela organisationen eller en specifik enhet. Tjänsten kan användas för alla händelsetyper förutom arbetssjukdom. Webbservicen anropas med ett XML-objekt som innehåller följande element: IncludeContractors: Anger om entreprenörer ska inkluderas i sökningen. IncludeLight: Anger om händelser som har statusen Rapporterad ska inkluderas. IncludeSubUnits: Anger om den valda enhetens underenheter ska inkluderas. OccurrenceType: Typ av händelse som ska hämtas. OrganizationalUnitName: Namnet på enheten där händelsen ska hämtas. Blank = hela organisationen. OrganizationalUnitType: Anger hur inskickad enhet ska hanteras i sökningen o o o Employment: enheten används som anställningsenhet Occurrence: enheten används som händelseenhet Both: enheten används som antingen händelseenhet eller anställningsenhet User: Servicekontots namn och lösenord. Exempeldata: <GetLatestOccurrence> <req> <IncludeContractors>true</IncludeContractors> <IncludeLight>true</IncludeLight> <IncludeSubUnits>true</IncludeSubUnits> <OccurrenceType>Accident</OccurrenceType> <OrganizationalUnitName>Enhet ABC</OrganizationalUnitName> <OrganizationalUnitType>Both</OrganizationalUnitType> <User> <Name>Servicekontots användarnamn</name> <PassWord>Servicekontots lösenord</password> </User> </req> </GetLatestOccurrence>

10 Sida 10 av 32 Webbservicen skickar ett XML-svarsobjekt som innehåller resultatet för anropet. Följande element finns i svarsobjektet: ErrorText: Feltext, blank = OK. CourseOfEvent: Beskrivning av händelsen. OccurrenceId: Händelsens ID i IA-systemet. OccurrencePeriod: Datum och klockslag när händelsen inträffade. OccurrenceType: Händelsetyp i klartext. OrganizationalUnitName: Namnet på enheten där händelsen inträffade. Exempeldata: <GetLatestOccurrenceResponse> <GetLatestOccurrenceResult> <ErrorText /> <CourseOfEvent>Klämde fingret på nedtagningsbordet</courseofevent> <OccurrenceId> </OccurrenceId> <OccurrencePeriod> T04:00:00</OccurrencePeriod> <OccurrenceType>ZeroAccident</OccurrenceType> <OrganizationalUnitName>Enhet ABC</OrganizationalUnitName> </GetLatestOccurrenceResult> </GetLatestOccurrenceResponse>

11 Sida 11 av EXPORTERA ANTAL HÄNDELSER Metod: GetOccurrenceCountByOrganizationalUnit Hämtar antalet händelser som har registrerats i organisationen eller i en specifik enhet under angiven tidsperiod. Webbservicen anropas med ett XML-objekt som innehåller följande element: IncludeContractors: Anger om entreprenörer ska inkluderas i sökningen. IncludeLight: Anger om händelser som har statusen Rapporterad ska inkluderas. IncludeSubUnits: Anger om den valda enhetens underenheter ska inkluderas. OrganizationalUnitName: Namnet på enheten där händelserna ska hämtas. Blank = hela organisationen. OrganizationalUnitType: Anger hur inskickad enhet ska hanteras i sökningen o o o Employment: enheten används som anställningsenhet Occurrence: enheten används som händelseenhet Both: enheten används som antingen händelseenhet eller anställningsenhet PeriodEnd: Slutdatum, blank = PeriodStart: Startdatum, blank = PeriodType: Anger om man vill söka på händelse- eller rapporteringsdatum. User: Servicekontots namn och lösenord. Exempeldata: <GetOccurrenceCountByOrganizationalUnit> <req> <IncludeContractors>true</IncludeContractors> <IncludeLight>true</IncludeLight> <IncludeSubUnits>true</IncludeSubUnits> <OrganizationalUnitName /> <PeriodEnd> </PeriodEnd> <PeriodStart> </PeriodStart> <PeriodType>Occurrence</PeriodType> <User> <Name>Servicekontots användarnamn</name> <PassWord>Servicekontots lösenord</password> </User> </req> </GetOccurrenceCountByOrganizationalUnit>

12 Sida 12 av 32 Webbservicen skickar ett XML-svarsobjekt som innehåller resultatet för anropet. Följande element finns i svarsobjektet: ErrorText: Feltext, blank = OK. Count: Antalet händelser. OccurrenceType: Typ av händelse. OrganizationalUnitName: Namnet på enheten där händelserna inträffat. Blank = hela organisationen. Exempeldata: <GetOccurrenceCountByOrganizationalUnitResponse> <GetOccurrenceCountByOrganizationalUnitResult> <ErrorText /> <OccurrenceCount> <Count>10</Count> <OccurrenceType>Accident</OccurrenceType> </OccurrenceCount> <OccurrenceCount> <Count>7</Count> <OccurrenceType>CommutingAccident</OccurrenceType> </OccurrenceCount> <OrganizationalUnitName /> </GetOccurrenceCountByOrganizationalUnitResult> </GetOccurrenceCountByOrganizationalUnitResponse>

13 Sida 13 av EXPORTERA ÅTGÄRDER Metod: GetAction Denna tjänst används för att hämta en eller flera åtgärder från IA-systemet. Tjänsten kan användas för att integrera med ett arbetsordersystem. Åtgärder som har skapats eller ändrats i IA-systemet under en specificerad tidsperiod, men som inte har klarmarkerats, kan exporteras till ett externt system. För att använda denna tjänst måste ni själva bygga en tjänst som schemaläggs hos er, t.ex. för att köras varje natt. Er tjänst kommer att anropa IA-systemet via ert servicekonto för att säkerställa att rätt uppgifter exponeras. Webbservicen anropas med ett XML-objekt som innehåller följande element: OccurrencePeriodEnd: Inkluderar alla åtgärder som är skapade eller ändrade innan detta datum. Blank = OccurrencePeriodStart: Inkluderar alla åtgärder som är skapade eller ändrade efter detta datum. Blank = User: Servicekontots namn och lösenord. Exempeldata: <GetAction> <Req> <OccurrencePeriodEnd> </OccurrencePeriodEnd> <OccurrencePeriodStart> </OccurrencePeriodStart> <User> <Name>Servicekontots användarnamn</name> <PassWord>Servicekontots lösenord</password> </User> </Req> </GetAction> Webbservicen skickar ett XML-svarsobjekt som innehåller resultatet för anropet. Varje åtgärd (Action) beskrivs med följande element: ActionId: ÅtgärdsID, ett unikt referensnummer för åtgärden i IA-systemet. ActionNo: Arbetsordernummer. ActionOwnerExternalId: ExternID, ett unikt ID för den användare i IA-systemet som står som utförare av åtgärden. ActionOwnerOther: Annan utförare, om en sådan har angetts i IA-systemet. ActionStep: Åtgärdssteg. ActionText: Åtgärdstext. ActionTitle: Åtgärdsrubrik.

14 Sida 14 av 32 EstimatedCompletionDate: Datum då åtgärden är beräknad att vara klar. Om åtgärden är klar anger EstimatedCompletionDate i stället datumet då åtgärden blev klar. OccurrenceNo: En unik referens till händelsen i IA. OrganizationalUnitExternalId: ExternID, ett unikt ID för den enhet i IA-systemet där åtgärden registrerades. OrganizationalUnitName: Namnet på den enhet i IA-systemet där åtgärden registrerades. ResponsibleExternalId: ExternID, ett unikt ID för den användare i IA-systemet som är ansvarig för händelsen som åtgärden tillhör. ResponsibleName: Namnet på den användare i IA-systemet som är ansvarig för händelsen som åtgärden tillhör. Exempeldata: <GetAction> <Actions> <ActionId>800200</ActionId> <ActionNo>ABC3828-Y162</ActionNo> <ActionOwnerExternalId>PelleJohansson</ActionOwnerExternalId> <ActionOwnerOther>Pelle Johansson</ActionOwnerOther> <ActionStep>Elimination</ActionStep> <ActionText>Beskrivning</ActionText> <EstimatedCompletionDate> </EstimatedCompletionDate> <OccurrenceNo> </OccurrenceNo> <OrganizationalUnitExternalId> </OrganizationalUnitExternalId> <OrganizationalUnitName>1234</OrganizationalUnitName> <ResponsibleExternalId>5678</ResponsibleExternalId> <ResponsibleName>Hans Johansson</ResponsibleName> </Actions> </GetAction>

15 Sida 15 av EXPORTERA HÄNDELSER Metod: GetOccurrenceExcelData Denna tjänst används för att hämta en Excelfil med händelser. Filen ska sparas till disk som en XLS-fil. Data kan hämtas för maximalt ett år. Excelfilen är samma fil som kan hämtas i IA-systemet under Analys - Exportera data. För att använda denna tjänst måste ni själva bygga en tjänst som schemaläggs hos er, t.ex. för att köras varje natt. Er tjänst kommer att anropa IA-systemet via ert servicekonto för att säkerställa att rätt uppgifter exponeras. Observera! Händelser som har markerats med Begränsad åtkomst kommer inte med i exporten. Användare kan byta händelsetypen för redan registrerade händelser. Det betyder att en händelse kan registreras som tillbud och senare klassas om som olycksfall. Händelsen kan därför ena dagen ligga på fliken för tillbud i Excelfilen och nästa dag på fliken för olycksfall. Webbservicen anropas med ett XML-objekt som har följande element: PeriodStart: Startdatum. PeriodEnd: Slutdatum. Kan vara högst ett år efter PeriodStart. PeriodType: Anger om perioden avser händelsedatum (Occurrence), ändringsdatum (Change) eller rapporteringsdatum (Registration). HideEmptyColumns: Om det sätts till sant, döljs alla kolumner som inte innehåller data. ShowStaticColumns: Om det sätts till sant, visas flik- och kolumnnamn med fasta namn. ExportDataVersion: Anger version av tjänst. User: Servicekontots namn och lösenord. Exempeldata: <GetOccurrenceExcelData> <Req> <PeriodStart> </PeriodStart> <PeriodEnd> </PeriodEnd> <PeriodType>Registration</PeriodType> <HideEmptyColumns>false</HideEmptyColumns> <ShowStaticColumns>true</ShowStaticColumns>

16 Sida 16 av 32 <ExportDataVersion>1</ExportDataVersion> <User> <Name>Servicekontots användarnamn</name> <PassWord>Servicekontots lösenord</password> </User> </Req> </GetOccurrenceExcelData> Webbservicen skickar ett XML-svarsobjekt som innehåller resultatet för anropet. FileContent: Byte-array som innehåller Excelfilen (XLS-fil). ErrorText: Feltext, blank = OK. Exempeldata: <GetOccurrenceExcelDataResponse> <ErrorText></ErrorTtext> <FileContent> </FileContent> </GetOccurrenceExcelDataResponse> Appendix Om du vill se en sammanställning över Excelexporten kan du titta på dokumentet Appendix till dokument Webbtjänster.

17 Sida 17 av EXPORTERA FLAGGADE HÄNDELSER Metod: GetFlaggedOccurrences Hämtar flaggade händelser som har registrerats i organisationen eller i en specifik enhet under angiven tidsperiod. Webbservicen anropas med ett XML-objekt som innehåller följande element: OccurrencePeriodEnd: Slutdatum, blank = OccurrencePeriodStart: Startdatum, blank = IncludeSubUnits: Anger om den valda enhetens underenheter ska inkluderas. OrganizationalUnitName: Namnet på enheten där händelserna ska hämtas. Blank = hela organisationen. User: Servicekontots namn och lösenord. Exempeldata: <GetFlaggedOccurrences> <req> <OccurrencePeriodEnd> </OccurrencePeriodEnd> <OccurrencePeriodStart> </OccurrencePeriodStart> <IncludeSubUnits>true</IncludeSubUnits> <OrganizationalUnitName /> <User> <Name>Servicekontots användarnamn</name> <PassWord>Servicekontots lösenord</password> </User> </req> </GetFlaggedOccurrences> Webbservicen skickar ett XML-svarsobjekt som innehåller resultatet för anropet. Följande element finns i svarsobjektet: ErrorText: Feltext, blank = OK. FlagText: Flaggningstexten. FlagTitle: Flaggningens rubrik. OccurrenceDate: Händelsedatum. OccurrenceDescription: Händelseförloppet. OccurrenceID: Händelsens interna ID. OccurrenceNumber: Händelsens löpnummer. OccurrenceTitle: Händelserubriken. OrganizationalUnitName: Namnet på enheten där händelsen inträffat.

18 Sida 18 av 32 Exempeldata: <GetFlaggedOccurrencesResponse> <GetFlaggedOccurrencesUnitResult> <ErrorText /> <FlaggedOccurence> <FlagText>Idag inträffade en allvarlig händelse med </FlagText > <FlagTitle>Allvarlig händelse</flagtitle> <OccurrenceDate> </OccurrenceDate> <OccurrenceDescription>Skulle ta loss en </OccurrenceDescription> <OccurrenceID>1</OccurrenceID> <OccurrenceNumber>123</OccurrenceNumber> <OccurrenceTitle>Skada då </OccurrenceTitle> <OrganizationalUnitName>Enhet 1</OrganizationalUnitName> </FlaggedOccurence> </GetFlaggedOccurrencesResult> </GetFlaggedOccurrencesResponse>

19 Sida 19 av SKICKA DATA TILL IA-SYSTEMET 5.1. IMPORTERA ORGANISATIONEN Metod: SaveOrganizationalUnitsWithLogin Organisationen består av hierarkisk information om enheter. En enhet kan vara en anställningsenhet, en händelseenhet eller både anställnings- och händelseenhet. En enhet kan ha enheter hierarkiskt över och under sig. En organisation importeras på något av följande sätt: Förändring (Change): De enheter som finns i anropet uppdateras eller läggs till i IAsystemet. De enheter som finns i IA-systemet men som inte finns i anropet påverkas inte av importen. Förkommer det enheter som valideras fel kommer dessa enheter inte att importeras. Total (Total): De enheter som finns i anropet uppdateras eller läggs till i IA-systemet. De enheter som finns i IA-systemet men som inte finns i anropet tas bort. Har de händelser, riskhanteringar eller användare kopplade till sig inaktiveras dem i stället. Förekommer det en eller flera enheter som valideras fel kommer ingen enhet att importeras. Det måste finnas minst en enhet i anropet som har en referens till rotnoden, d.v.s. den högsta nivån i organisationsträdet, genom att ExternalIdParent sätts till 0. Vid en organisationsimport så får det inte förekomma: Fler än 99 nivåer i trädet för att förhindra evig loop. Anställningsenhet under en händelseenhet och vice versa. Aktiv enhet under en inaktiv enhet. Aktiv enhet eller inaktiv enhet under en raderad enhet. Webbservicen anropas med ett XML-objekt som innehåller följande element: User: Servicekontots namn och lösenord. ImportType: Typ av import, antingen Total eller Change. OrganizationalUnits: Anger en eller flera enheter som ska importeras. Varje enhet (OrganizationalUnit) beskrivs med följande element: ExternalId: ExternID, ett unikt ID för enheten. Det är en textsträng som är 1-50 tecken lång. Name: En textsträng som är tecken och som anger enhetens namn. Namnet måste vara unikt i hela organisationen. ExternalIdParent: Ett unikt ID för den enhet som ligger över den aktuella enheten. o Anges 0 ska den aktuella enheten ligga under den högsta noden i trädet.

20 Sida 20 av 32 o o ExternalIdParent får inte vara detsamma som den aktuella enhetens ExternalId. ExternalIdParent måste vara ett ExternalId för en annan enhet som finns i trädet eller 0 för att peka på översta nivån i trädet. Type: Anger om enheten är en händelseenhet, anställningsenhet eller båda. CFarNr: Enhetens CFAR-nummer. Det är en textsträng med 7 siffror. Det är valfritt men behövs för anmälningar till Försäkringskassan. Om du inte vet ert/era CFAR-nummer kan du söka upp dem på Status: Enhetens status. För totalimport ska status anges som Active, för förändringsimport anges någon av följande: o o o Active: Skapar en ny eller uppdaterar en befintlig enhet, och sätter den som aktiv. Inactive: Skapar en ny eller uppdaterar en befintlig enhet, och sätter den som inaktiv. Deleted: Raderar enheten. Har enheten händelser, användare eller riskhanteringar kopplat till sig, inaktiveras den i stället för att tas bort. Exempeldata: <SaveOrganizationalUnitsWithLogin> <User> </User> <Name>Servicekontots användarnamn</name> <PassWord>Servicekontots lösenord</password> <ImportType>Total</ImportType> <OrganizationalUnits> <OrganizationalUnit> <ExternalId>1</ExternalId> <Name>Enhet 1</Name> <CfarNr> </CfarNr> <ExternalIdParent>0</ExternalIdParent> <Type>Both</Type> <Status>Active</Status> </OrganizationalUnit> <OrganizationalUnit> <ExternalId>1.1</ExternalId> <Name>Enhet 1.1</Name> <ExternalIdParent>1</ExternalIdParent> <Type>Employment</Type> <Status>Active</Status> </OrganizationalUnit> <OrganizationalUnit> <ExternalId>1.2</ExternalId> <Name>Enhet 1.2</Name> <ExternalIdParent>1</ExternalIdParent>

21 Sida 21 av 32 <Type>Occurrence</Type> <Status>Active</Status> </OrganizationalUnit> </OrganizationalUnits> </SaveOrganizationalUnitsWithLogin> Webbservicen skickar ett XML-svarsobjekt som innehåller ett eller flera resultat för varje enhet i organisationsimporten. Följande element finns i svarsobjektet: ErrorText: Feltext, blank = OK. ExternalId: Enhetens ExternID. Message: Ett meddelande eller felmeddelande för varje enhet. Status: OK eller Error för enheten. Exempeldata: <SaveOrganizationalUnitsResponse> <ErrorText /> <Result> <ImportResult> <ExternalId>1</ExternalId> <Message>Changed</Message> <Status>Ok</Status> </ImportResult> <ImportResult> <ExternalId>1.1</ExternalId> <Message>No change</message> <Status>Ok</Status> </ImportResult> <ImportResult> <ExternalId>1.2</ExternalId> <Message>No change</message> <Status>Ok</Status> </ImportResult> </Result> </SaveOrganizationalUnitsResponse>

22 Sida 22 av IMPORTERA ANVÄNDARE HIERARKISK DATASTRUKTUR Metod: SaveUsers Denna import används om ni har informationen om era användare i en hierarkisk datastruktur, till exempel i ert personalsystem. Ni kan skapa, radera eller uppdatera användarkonton i IAsystemet genom denna tjänst. Ni måste ha angett ett förvalt lösenord för hela organisationen för att kunna importera användare. 4 Alla nya användare måste byta lösenordet vid första inloggningen. Alla uppgifter om användaren måste skickas varje gång. Det betyder att även om bara namnet har ändrats måste behörigheterna skickas igen. Användare importeras på något av följande sätt: Förändring (Change): De användare som finns i anropet uppdateras eller läggs till i IAsystemet. De användare som finns i IA-systemet men som inte finns i anropet påverkas inte av importen. Förkommer det användare som valideras fel kommer dessa användare inte att importeras. Total (Total): De användare som finns i anropet uppdateras eller läggs till i IA-systemet. De användare som finns i IA-systemet men som inte finns i anropet tas bort. Har de ansvar för händelser eller riskhanteringar inaktiveras dem i stället. Förekommer det en eller flera användare som valideras fel kommer ingen användare att importeras. Har ni angett en e-postadress för serviceanvändaren i IA-systemet skickas en lista över de nya användarkontona efter avslutad import. Följande fyra roller kan konfigureras för varje användare genom importen: Chef (Manager) Händelseansvarig (OccurrenceManager) Skyddsombud (OHSRepresentative) Utredare och åtgärdsutförare (InvestigatorAndActionOwner) Roller som finns med i importen måste ha minst en förvald händelsetyp i IA-systemet. 5 En användare kan ha flera roller samtidigt, men rollen skyddsombud kan inte kombineras med någon av rollerna chef eller händelseansvarig. Roller som inte hanteras av importen kommer inte att beröras av importen. Om en användare t.ex. har rollen utredare i IA-systemet och importeras som chef ska rollen utredare inte ändras. Däremot kommer rollen chef att läggas till eller ändras. För varje användare som förekommer i importen görs följande validering: Kontroll att varje roll endast förekommer en gång. Kontroll att varje enhet bara förekommer en gång för varje roll. 4 Läs mer om hur du anger ett förvalt lösenord i avsnitt Läs mer om hur du anger förvalda händelsetyper i avsnitt 3.2.

23 Sida 23 av 32 Om användarens status är Active måste information om behörigheten (roller och enheter där rollerna gäller) vara angiven. Om användarens status är Deleted tillåts att information om behörigheten saknas (gäller vid förändringsimport). Om användarnamnet inte är unikt kommer IA-systemet att föreslå ett nytt unikt användarnamn. Om detta inte är möjligt genereras ett felmeddelande. ExternID för användarens anställningsenhet och för enheten där användaren har sin roll måste finnas. Vid uppdatering av användare gäller följande: Om användaren finns sedan tidigare men är inaktiv, aktiveras användaren och få de nya rollerna. Om användaren finns sedan tidigare men är spärrad (p.g.a. felaktiga lösenord) blir användarkontot upplåst. Om användarkontot finns sedan tidigare med samma användarnamn men utan ExternID kommer det att uppdateras med ExternID:t som finns i anropet. Om användarkontot finns på ett annat företag i samma koncern kommer det kontot att kopplas till företaget som anropet görs ifrån. Vid radering av användare gäller följande: Om en användare som tidigare importerats saknas i anropet för totalimport raderas användaren. Har användaren roller som inte hanteras av importen så ligger dessa kvar på användaren. I så fall raderas användarkontot inte, men de roller som hanteras av importen tas bort från användaren. Om en användare som tidigare importerats har status Deleted vid förändringsimport raderas användarkontot. Det gäller även om användaren har roller som inte hanteras av importen. Finns händelser kopplade till användarkontot inaktiveras kontot i stället för att raderas. När en användare med rollen chef eller händelseansvarig inaktiveras, flyttas i vissa fall händelser som inte är klara över till en ny händelseansvarig. Det gäller: o o om det finns en, och endast en, användare med rollen chef eller händelseansvarig på samma enhet. om det finns flera användare med rollen chef eller händelseansvarig på samma enhet men en utav dem, och endast en, är angiven som förvald händelseansvarig för enheten. I annat fall kan IA-systemet inte sätta en ny händelseansvarig för dessa händelser. Händelseansvaret kommer då att ligga kvar på den inaktiverade personen. Webbservicen anropas med ett XML-objekt som innehåller följande element: User: Servicekontots namn och lösenord. ImportType: Typ av import, antingen Total eller Change.

24 Sida 24 av 32 IAUsers: Anger en eller flera användare som ska importeras. Varje användare (IAUser) beskrivs med följande element: ExternalId: ExternID, ett unikt ID för användaren, 1-50 tecken lång. Firstname: Förnamn, 1-50 tecken lång. Surename: Efternamn, 1-50 tecken lång. Username: Användarnamn, 1-50 tecken lång. Måste vara unikt i hela IA-systemet. Status: Användarens status, Active eller Deleted. E-postadress, 0-50 tecken lång. Kan utelämnas. EmploymentUnitExternalId: ExternID för enheten där användaren är anställd, 0-50 tecken lång. Kan utelämnas. Authorizations: Rollerna som användaren har samt på vilka enheter de gäller. Kan vara 0-2 roller. Behörigheten (Authorizations) för användaren beskrivs med följande element: Role: Rollen som användaren har i IA-systemet. Kan vara chef (Manager), händelseansvarig (OccurrenceManager), skyddsombud (OHSRepresentative) eller Utredare och åtgärdsutförare (InvestigatorAndActionOwner). Units: Lista över enheter där rollen gäller. Enheterna listas med sitt ExternID. ExternalId: ExternID för enheten där rollen gäller, 0-50 tecken lång. Blank = hela organisationen. Enheten kan vara inaktiv, och den kan vara händelse- eller anställningsenhet eller både och. Exempeldata för import av två användarkonton, observera att den andra användaren raderas från IA-systemet: <SaveUsers> <User> <Name>Servicekontots användarnamn</name> <PassWord>Servicekontots lösenord</password> </User> <ImportType>Change</ImportType> <IAUsers> <IAUser> <ExternalId>User 1</ExternalId> <FirstName>Agnes</FirstName> <SurName>Larsson</SurName> <UserName>Agnes123</UserName> <Status>Active</Status> < >agnes.larsson@xzy.se</ > <EmploymentUnitExternalId>Unit 1</EmploymentUnitExternalId> <Authorizations>

25 Sida 25 av 32 <Authorization> <Role>Manager</Role> <Units> <ExternalId>Unit 1</ExternalId> <ExternalId>Unit 2</ExternalId> </Units> </Authorization> <Authorization> <Role>OccurrenceManager</Role> <Units> <ExternalId>Unit 3</ExternalId> </Units> </Authorization> </Authorizations> </IAUser> <IAUser> <ExternalId>User 2</ExternalId> <FirstName>Anders</FirstName> <SurName>Johansson</SurName> <UserName>Anders123</UserName> <Status>Deleted</Status> < ></ > <EmploymentUnitExternalId></EmploymentUnitExternalId> <Authorizations></Authorizations> </IAUser> </IAUsers> </SaveUser> Webbservicen skickar ett XML-svarsobjekt som innehåller ett eller flera resultat för varje användare i importen. Följande element finns i svarsobjektet: ErrorText: Feltext, blank = OK. ExternalId: Användarens ExternID. Message: Ett meddelande eller felmeddelande för varje användare. Status: OK eller Error för användaren. Exempeldata: <SaveUser> <ErrorText /> <Result> <ImportResult> <ExternalId>User 1</ExternalId> <Message>Changed</Message> <Status>Ok</Status>

26 Sida 26 av 32 </ImportResult> <ImportResult> <ExternalId>User 2</ExternalId> <Message>Deleted</Message> <Status>Ok</Status> </ImportResult> </Result> </SaveUser>

27 Sida 27 av IMPORTERA ANVÄNDARE FLAT DATASTRUKTUR Metod: SaveUsersFlat Denna import används om ni har informationen om era användare i en platt datastruktur, till exempel i ett Excel-ark. I det här fallet innehåller datastrukturen ingen hierarkisk uppsättning av ert organisationsträd. Reglerna för denna import är dock desamma som för användarimporten som beskrivs i avsnitt 5.2. Observera! Om en användare har behörigheter på flera avdelningar anges användaren flera gånger, men med olika data i elementen Role och/eller OccurrenceUnitExternalId. Om en användare förekommer flera gånger men med olika uppgifter i ett och samma element, t.ex. , kommer endast den sista förekomsten av det elementet sparas i IAsystemet. Undantaget från detta är elementen Role och OccurrenceUnitExternalId. Varje användare (IAUser) beskrivs med följande element: ExternalId: ExternID, ett unikt ID för användaren, 1-50 tecken lång. Firstname: Förnamn, 1-50 tecken lång. Surename: Efternamn, 1-50 tecken lång. Username: Användarnamn, 1-50 tecken lång. Måste vara unikt i hela IA-systemet. Status: Användarens status, Active eller Deleted. E-postadress, 0-50 tecken lång. Kan utelämnas. EmploymentUnitExternalId: ExternID för enheten där användaren är anställd, 0-50 tecken lång. Kan utelämnas. Role: Rollen som användaren har i IA-systemet. Kan vara chef (Manager), händelseansvarig (OccurrenceManager), skyddsombud (OHSRepresentative) eller Utredare och åtgärdsutförare (InvestigatorAndActionOwner). OccurrenceUnitExternalId: ExternID för enheten där rollen gäller, 0-50 tecken lång. Blank = hela organisationen. Enheten kan vara inaktiv, och den kan vara händelse- eller anställningsenhet eller både och.

28 Sida 28 av 32 Exempeldata för import av två användarkonton, observera att den första användaren förekommer flera gånger och att den andra användaren raderas från IA-systemet: <SaveUsersFlat> <User> <Name>Servicekontots användarnamn</name> <PassWord>Servicekontots lösenord</password> </User> <ImportType>Change</ImportType> <IAUsers> <IAUserFlat> <ExternalId>User 1</ExternalId> <FirstName>Agnes</FirstName> <SurName>Larsson</SurName> <UserName>Agnes123</UserName> <Status>Active</Status> <EmploymentUnitExternalId>Unit 1</EmploymentUnitExternalId> <Role>Manager</Role> <OccurrenceUnitExternalId>Unit 1</OccurrenceUnitExternalId> </IAUserFlat> <IAUserFlat> <ExternalId>User 1</ExternalId> <FirstName>Agnes</FirstName> <SurName>Larsson</SurName> <UserName>Agnes123</UserName> <Status>Active</Status> <EmploymentUnitExternalId>Unit 1</EmploymentUnitExternalId> <Role>Manager</Role> <OccurrenceUnitExternalId>Unit 2</OccurrenceUnitExternalId> </IAUserFlat> <IAUserFlat> <ExternalId>User 1</ExternalId> <FirstName>Agnes</FirstName> <SurName>Larsson</SurName> <UserName>Agnes123</UserName> <Status>Active</Status> <EmploymentUnitExternalId>Unit 1</EmploymentUnitExternalId> <Role>OccurrenceManager</Role> <OccurrenceUnitExternalId>Unit 3</OccurrenceUnitExternalId> </IAUserFlat> <IAUserFlat> <ExternalId>User 2</ExternalId> <FirstName>Anders</FirstName>

29 Sida 29 av 32 <SurName>Johansson</SurName> <UserName>Anders123</UserName> <Status>Deleted</Status> < ></ > <EmploymentUnitExternalId></EmploymentUnitExternalId> <Authorizations></Authorizations> </IAUserFlat> </IAUsers> </SaveUserFlat> Webbservicen skickar ett XML-svarsobjekt som innehåller ett eller flera resultat för varje användare i importen. Följande element finns i svarsobjektet: ErrorText: Feltext, blank = OK. ExternalId: Användarens ExternID. Message: Ett meddelande eller felmeddelande för varje användare. Status: OK eller Error för användaren. Exempeldata: <SaveUsersFlat> <ErrorText /> <Result> <ImportResult> <ExternalId>User 1</ExternalId> <Message>Changed</Message> <Status>Ok</Status> </ImportResult> <ImportResult> <ExternalId>User 2</ExternalId> <Message>Deleted</Message> <Status>Ok</Status> </ImportResult> </Result> </SaveUsersFlat>

30 Sida 30 av IMPORTERA ÅTGÄRDER Metod: SaveAction Denna tjänst används för att kunna uppdatera en eller flera åtgärder i IA-systemet med information från ett externt system. Detta förutsätter att de åtgärder som ska importeras tidigare har exporterats från IA-systemet. 6 Tjänsten kan användas för att integrera med ett arbetsordersystem. Åtgärder som har behandlats i arbetsordersystemet kan sedan åter importeras till IA-systemet. Observera! Vid import av en klarmarkerad åtgärd där datumet är senare än dagens datum så sätter importen alltid klardatum till dagens datum i IA-systemet. Är klardatumet tidigare än dagens datum sätts det datumet som skickas med importen. Blir sista åtgärden i en händelse klarmarkerad genom importen uppdateras händelsens status. I IA-systemet kan man ange följande åtgärdssteg för varje åtgärd: Eliminering Utbyte Tekniska skyddsåtgärder Utmärkning, varning, rutiner Personlig skyddsutrustning Webbservicen anropas med ett XML-objekt som innehåller följande element: User: Servicekontots namn och lösenord. Actions: Anger en eller flera åtgärder som ska importeras. Varje åtgärd (Action) beskrivs med följande element: ActionId: ÅtgärdsID, ett unikt referensnummer för åtgärden i IA-systemet. ActionOwnerExternalId: ExternID, ett unikt ID för den användare i IA-systemet som står som utförare av åtgärden. ActionOwnerOther: Annan utförare, om en sådan har angetts i IA-systemet. ActionStep: Åtgärdssteg. ActionText: Åtgärdstext. EstimatedCompletionDate: Datum då åtgärden är beräknad att vara klar. Om åtgärden är klar anger EstimatedCompletionDate i stället datumet då åtgärden blev klar. 6 Läs mer om att exportera åtgärder i avsnitt 4.3.

31 Sida 31 av 32 Completed: 0 anger att åtgärden inte är klar, 1 anger att åtgärden är klar. WorkOrderNumber: Arbetsordernummer. Exempeldata: <SaveAction> <User> <Name>Servicekontots användarnamn</name> <PassWord>Servicekontots lösenord</password> </User> <Actions> <Action> </Action> <ActionId>800200</ActionId> <WorkOrderNumber>ABC3828-Y162</WorkOrderNumber> <ActionStep>Elimination</ActionStep> <ActionText>Beskrivning</ActionText> <EstimatedCompletionDate> </EstimatedCompletionDate> <ActionOwnerExternalId>PelleJohansson</ActionOwnerExternalId> <ActionOwnerOther>Pelle Johansson</ActionOwnerOther> <Completed>1</Completed> <Action> </Action> <ActionId>800300</ActionId> <WorkOrderNumber>XUAYA-Y162</WorkOrderNumber> <ActionStep>Exchange</ActionStep> <ActionText>Beskrivning</ActionText> <EstimatedCompletionDate> </EstimatedCompletionDate> <ActionOwnerExternalId>AndersJohansson</ActionOwnerExternalId> <ActionOwnerOther>Anders Johansson</ActionOwnerOther> <Completed>0</Completed> </Actions> </SaveAction> Webbservicen skickar ett XML-svarsobjekt som innehåller ett eller flera resultat för varje åtgärd i importen. Följande element finns i svarsobjektet: ErrorText: Feltext, blank = OK. ExternalId: ÅtgärdsID. Message: Ett meddelande eller felmeddelande för varje åtgärd. Status: OK eller Error för åtgärden.

32 Sida 32 av 32 Exempeldata: <SaveAction> <ErrorText /> <Result> <ImportResult> <ExternalId>800200</ExternalId> <Message>Changed</Message> <Status>Ok</Status> </ImportResult> <ImportResult> <ExternalId>800300</ExternalId> <Message>Changed</Message> <Status>Ok</Status> </ImportResult> </Result> </SaveAction>