Dokumentation: Acubiz EMS SOAP API

Transkript

1 Dkumentatin: Acubiz EMS SOAP API Versin 1.7 / Tlf: Side 1 af 22

2 Indhldsfrtegnelse Adgang til Acubiz SOAP API... 3 Arkitektur... 3 Adgang via.net... 3 Generelle principper i Acubiz SOAP API... 5 Tilgængelige funktiner... 6 Generelle metder... 6 Metder g klasser til håndtering af brugere... 6 Metder g klasser til håndtering af EMS databaser... 7 Metder g klasser til håndtering af dimensiner... 7 Metder g klasser til håndtering af eksprt data... 8 Metder g klasser til håndtering af IMPORT data... 9 Brugere: Læsning, pdatering g prettelse Listning af brugere Oprettelse af brugere Opdatering af brugere Dimensiner: Læsning, pdatering g prettelse Opslag efter EMS databaser Listing af dimensiner Oprettelse af dimensiner Opdatering af dimensiner Imprt af data ImprtCSVdata ImprtXMLdata Eksprt af data EXPORTCSVDATA EXPORTXMLDATA Index Tlf: Side 2 af 22

3 ADGANG TIL ACUBIZ SOAP API Frskellige sprg g framewrks har deres egen funktinalitet fr at benytte en SOAP-baseret web service. De fleste af disse invlverer autmatisk generering klient kde baseret på WSDL, men det er gså muligt at bygge XML envelpes helt manuelt. Du skal sikre, at sessin ckie bliver sendt med i alle transaktiner. Ngle framesets vil gøre dette autmatisk, men ikke alle. ARKITEKTUR Acubiz EMS er pbygget med en Staff g knfiguratinsdatabase, der er det centrale i Acubiz EMS. Derudver er der en eller flere EMS databaser, afhængig af hvr mange segmenteringer man ønsker. Kntaktpunktet fr Acubiz SOAP API er Staff databasen, sm indehlder brugere g krtlægning af de tilknyttede EMS databaser. Igennem API et kan man gså tilgå hver enkelt EMS databases dimensiner g eksprter. Denne pbygning gør, at man skal hente en handler fr den EMS database man skal tilgå, fr at kunne håndtere dimensiner g eksprter. Staff database - API adgangspunkt - Brugere - EMS mapping EMS Database - Dimensiner - Eksprter EMS Database - Dimensiner - Eksprter EMS Database - Dimensiner - Eksprter ADGANG VIA.NET Via Service References menuen i Visual Studi, kan du tilføje en service reference til Acubiz SOAP API. URL en til dit SOAP API er angivet i API mdulets indstillinger. Fr at kunne læse WSDL beskrivelsen, skal du authentikere med en bruger på dit system. Det anbefales at du benytter en bruger der specifikt er prettet til API eller en admin bruger (se Authentikering). Tlf: Side 3 af 22

4 Når du har gjrt det, skal du mdificere service referencen til at bruge basic authenticatin g til at kunne sende g mdtage større pakker. Det gør du ved at ændre service reference bindingen til at indehlde en clientcredentialtype der hedder Basic : Altså: <security mde="transprt"> <transprt clientcredentialtype="basic" /> </security> Den samlede <bindings> vil således se sådan ud. Da du imprterede WebServicen, blev denne genereret autmatisk, så derfr kan du ikke indsætte denne sm den er, men skal flette dit <security> tag ind. <bindings> <basichttpbinding> <binding name="dminsapbinding" maxbuffersize="999999" maxreceivedmessagesize="999999"> <security mde="transprt"> <transprt clientcredentialtype="basic" /> </security> </binding> </basichttpbinding> </bindings> Fr at authentikere g tilslutte til webseriven, benyttes følgende fremgangsmøde. Vi har her kaldt vres service reference fr Acubiz. Acubiz.SessinClient WS = new Acubiz.SessinClient(); WS.ClientCredentials.UserName.UserName = <brugernavn> WS.ClientCredentials.UserName.Passwrd = <adgangskde> WS.Open(); Fr at læse hvilken state sm service referencen er i, kan der benyttes følgende kald: WS.State.TString(); Det vil give tre svar: Created Opened Clsed Authentikering En hvilken sm helst bruger, der er prettet i systemet, kan authentikere p imd webservicen fr at hente WSDL g fr at kmmunikere med Acubiz. Tlf: Side 4 af 22

5 Det er dg kun muligt at benytte funktiner g se data, relateret til brugerens adgang. Det vil altså sige, at hvis man ikke er admin på systemet, kan man ikke prette eller pdatere brugere g dimensiner, ligesm det kun er finansbrugere der kan eksprtere. GENERELLE PRINCIPPER I ACUBIZ SOAP API Klassen SessinClient indehlder metder, der benyttes til at læse, skrive g pdatere data i Acubiz EMS. Data bæres i tilhørende klasser, så sm USER, EMS g DIMENSION. Disse klasser mdtages med data g USER g DIMENSION klasserne kan sendes retur med pdateringer. Når der sendes en pdatering, returneres det tilrettede bjekt med eventuelle fejlkder. Metdekald hvr der returneres array af data I metdekald, hvr der returneres en klasse med ARRAYOFUSER, ARRAYOFEMS eller ARRAYOF- DIMENSION, kan man angive hvr mange man vil have retur samt hvr i den samlede liste man gerne vil starte. Denne mulighed gives fr at kunne styre hvr stre datamængder der sendes retur. Her kan man kunne angive integer værdien 0 i begge tilfælde, sm returnerer alle elementer eller i tilfælde af større lister, en delmængde. I klassen ARRAYOFUSER bliver der returneret hvr mange elementer der er i arrayet (COUNT) g hvrfra i den samlede liste første element kmmer (POSITION). Fr at få flere data, kan man fretage kaldet igen, med angivelse af psitin til POSITION + COUNT Eksempel Ønsker man at hente alle dimensiner, vil man starte med at få fat i den EMS database man vil søge i, g efterfølgende hente dimensinerne med metden GETDIMENSIONS(EMS, int POSITION, int COUNT); I dette kald henter vi referencen til EMS databasen emsid g efterfølgende henter de første 1000 elementer. Acubiz.EMS ems = WS.GETEMS("emsid"); Acubiz.ARRAYOFDIMENSION dimensins = WS.GETDIMENSIONS(ems, 1, 1000); Ønsker man at hente alle dimensiner, kan man ændre kaldet til: Acubiz.EMS ems = WS.GETEMS("emsid"); Acubiz.ARRAYOFDIMENSION dimensins = WS.GETDIMENSIONS(ems, 0, 0); Tlf: Side 5 af 22

6 TILGÆNGELIGE FUNKTIONER Klassen SessinClient indehlder følgende API funktiner, der benyttes til at læse, skrive g pdatere data i Acubiz EMS. GENERELLE METODER Disse metder returnerer infrmatin m den bruger der er lgget ind med, hvilken versin af API et der benyttes samt funktiner til håndtering g beskrivelse af fejl. APIVERSION() GETCURRENTUSER() GETUSERNAME() GETEFFECTIVEUSERNAME() ERRORSTRING() ISERROR() METODER OG KLASSER TIL HÅNDTERING AF BRUGERE Disse funktiner benyttes til at finde en eller flere brugere, prette en bruger eller pdatere en bruger. Infrmatiner m brugeren bæres i en USER klasse, der returneres når man slår en bruger p, pretter en bruger eller pdatere en bruger. Skal man mdificere en bruger, slår man først brugeren p g benytter derefter det USER bjekt der returneres til at pdatere de data man ønsker. Til sidst returneres USER bjektet g et pdateret USER bjektet mdtages retur, med eventuelle fejlkder. Skal man hente flere brugere, returneres en klasse ARRAYOFUSER, der ud ver et array med USER bjekter gså indehlder infrmatin m hvr mange der returneres g hvrfra i den samlede liste. Metder FINDUSER(string) GETUSERS(int, int) CREATEUSER(string, string, string, string, string, bl, bl, bl) UPDATEUSER(Acubiz.USER) Klasser USER FirstName : String LastName : String Initials : String String EmplyeeID : String DefaultEMS : EMS AcessableEMS : arrayofems Authriser : User AltAuthriser : User Secretary : User Bker : User ApprverLimit : Duble Tlf: Side 6 af 22

7 CashAccunt : String SalaryAccunt : String IsAuthrizer : Blean IsSecretary : Blean IsBker : Blean IsFinance : Blean IsAdmin : Blean IsPreApprver : Blean IsFinanceTime : Blean IsEmplyee : Blean IsErrr : Blean Errrstring : String ARRAYOFUSER Cunt : Lng Psitin : Lng Array() : User IsValid : Blean METODER OG KLASSER TIL HÅNDTERING AF EMS DATABASER I mdsætning til brugere, kan både dimensiner g bilag ligge i flere frskellige data siler. Disse siler kaldes EMS Databaser g benævnes i dette fr en EMS. Disse metder g klasser benyttes til at finde den EMS der skal benyttes, når der arbejdes med dimensiner eller eksprtdata. Der kan ikke arbejdes med disse t typer af data, uden at sende en EMS med i kaldet. Metder GETDEFAULTEMS() GETEMS(string) GETEMSUNITS() Klasser EMS EMSID : String EMSName : String EMSVersin : String IsErrr : Blean Errrstring : String ARRAYOFEMS Cunt : Lng Psitin : Lng Array() : User IsValid : Blean METODER OG KLASSER TIL HÅNDTERING AF DIMENSIONER Tlf: Side 7 af 22

8 Disse metder g klasser benyttes til at hente, pdatere g prette dimensiner. Fælles fr alle metder er, at der skal sendes et EMS bjekt med, fr at frtælle metden i hvilken EMS database man vil kikke i. Infrmatiner m brugeren bæres i en DIMENSION klasse, der returneres når man slår en dimensin p, pretter en dimensin eller pdatere en dimensin. Skal man mdificere en dimensin, slår man først dimensinen p g benytter derefter det DIMEN- SION bjekt der returneres til at pdatere de data man ønsker. Til sidst returneres DIMENSION bjektet g et pdateret DIMENSION bjekt mdtages retur, med eventuelle fejlkder. Skal man hente flere dimensiner, returneres en klasse ARRAYOF DIMENSION, der ud ver et array med DIMENSION bjekter gså indehlder infrmatin m hvr mange der returneres g hvrfra i den samlede liste. Metder GETDIMENSION(Acubiz.EMS, string) GETDIMENSIONS(Acubiz.EMS, int, int) GETDIMENSIONSBYTYPE(Acubiz.EMS, int, int, string) CREATEDIMENSION(Acubiz.EMS, string, string, string, string, string, string) UPDATEDIMENSION(Acubiz.DIMENSION) Klasser DIMENSION ID : String ParentID : String DisplayValue : String NameValue : String ID2 : String ID3 : String IsErrr : Blean Errrstring : String EMS : EMS ARRAYOFDIMENSION Cunt : Lng Psitin : Lng Array() : User IsValid : Blean METODER OG KLASSER TIL HÅNDTERING AF EKSPORT DATA Metde EXPORTCSVDATA(Acubiz.EMS, string, string, bl) EXPORTXMLDATA(Acubiz.EMS, string, string, bl) Klasse Tlf: Side 8 af 22

9 EXPORTDATA ID : String Data : Variant Cunt : Lng Frmat : String ExprtPrfileName : String ExprtDateTime : String IsExprted : Blean IsErrr : Blean ErrrInf : String METODER OG KLASSER TIL HÅNDTERING AF IMPORT DATA Metde IMPORTCSVDATA(Acubiz.EMS, string, string) IMPORTXMLDATA(Acubiz.EMS, string, string) Tlf: Side 9 af 22

10 BRUGERE: LÆSNING, OPDATERING OG OPRETTELSE Det er muligt at liste, pdatere g prette brugere på systemet. Det gøres via klassen USER g de funktiner der er tilknyttet SessinClient klassen (Se: Adgang via.net, side 3). LISTNING AF BRUGERE Listning af brugere gøres gennem følgende funktiner: FINDUSER(string) GETUSERS(int, int) FINDUSER FINDUSER benyttes til at slå en given bruger p på initialer eller EmplyeeID. Funktinen returnerer et USER bjekt med data, hvis der blev fundet en bruger g et null bjekt, hvis der ikke blevet fundet en bruger Parametre Initialer (String): Initialer på den bruger man vil have returneret Retursvar USER bjekt med data på den frespurgte bruger Eksempel Funktinen kaldes således: Acubiz.USER User = WS.FINDUSER( initialer ); USER bjektet der returneres kan mdificeres g benyttes sammen med UpdateUser funktinen. Her gives det samme USER bjekt sm parameter til UpdateUser funktinen. GETUSERS GETUSERS benyttes til at finde alle brugere fr en eventuel bulk håndtering. Funktinen returnerer et array af USER bjekter, der er pakket ind i bjektet ARRAYOFUSERS Parametre Psitin (lng): Hvr i den samlede brugerliste skal der udlæses fra. Angives 0 læses fra begyndelsen Cunt (lng): Hvr mange elementer skal der udlæses Retursvar ARRAYOFUSER bjekt Eksempel Funktinen kaldes således: Acubiz.ARRAYOFUSER Users = WS.GETUSERS(0, 0); Tlf: Side 10 af 22

11 Efterfølgende kan antal af returnerede pster læses via Users.COUNT. OPRETTELSE AF BRUGERE Oprettelse af brugere gøres via følgende funktin: CREATEUSER(string, string, string, string, string, bl, bl, bl) CREATEUSER CREATEUSER pretter en bruger g returnerer det USER bject der er prettet, med de infrmatiner der er angivet g de default værdier sm det er knfigureret i systemet. Det USER bjekt der bliver returneret kan mdificeres g bruges sm parameter til UPDATEUSER funktinen, fr at ændre/sætte de egenskaber sm ikke bliver sat ved selve prettelsen Parametre Initials (String) : Initialer på brugeren Firstname (String) : Frnavn på brugeren Lastname (String) : Efternavn på brugeren (String) : adresse til brugeren EmplyeeID (String) : Brugerens medarbejdernummer IsAuthrizer (Blean) : Sættes til sand hvis brugeren er gdkender IsSecretary (Blean) : Sættes til sand hvis brugeren er sekretær IsBker (Blean) : Sættes til sand hvis brugeren er bker Retursvar USER bjekt med den prettede brugere. Sker der fejl under prettelsen, vil bjektets ISER- ROR egenskab være sat til sand g ERRORSTRING vil indehlde den eller de fejl der blev fundet Eksempel Funktinen bruges således: Her gives input via textbx fra brugerfladen g sendes videre til prettelsesfunktinen. Efterfølgende kntrlleres der fr m der er sket en fejl. Endeligt sættes admin, finiance g preapprver flagene på den nye bruger, sm endelig pdateres. Retursvaret kntrlleres til sidst igen fr fejl. Acubiz.USER User = WS.CREATEUSER( textbxusergivenname.text, textbxusersurname.text, textbxuser .text, "", textbxuserinitials.text, checkbxuserauthrizer.checked, checkbxusersecretary.checked, checkbxuserbker.checked); Tlf: Side 11 af 22

12 if (User.ISERROR) { MessageBx.Shw("Errr: " + User.ERRORSTRING, "Errr", MessageBxButtns.OK, MessageBxIcn.Errr); } User.ISADMIN = checkbxuseradmin.checked; User.ISFINANCE = checkbxuserfinance.checked; User.ISPREAPPROVER = checkbxuserpreapprver.checked; User = WS.UPDATEUSER(User); if (User.ISERROR) { } MessageBx.Shw(User.ERRORSTRING, "Errr", MessageBxButtns.OK, MessageBxIcn.Errr); OPDATERING AF BRUGERE Opdatering af brugere sker via funktinen: UPDATEUSER(Acubiz.USER) UPDATEUSER UPDATEUSER mdtager et USER bjekt med den bruger der skal pdateres i systemet. USER bjektet, der sendes til UPDATEUSER, skal tidligere være mdtaget enten igennem brugerprettelse eller via en pslagsfunktin. Har USER bjektet ikke tidligere sin prindelse fra API ets andre funktiner, vil UPDATEUSER afvise pdateringen Parametre Bruger (USER): USER bjektet fra den bruger der skal pdateres Retursvar Bruger (USER): Den pdaterede bruger med eventuelle fejl infrmatin Eksempel Se Eksempel hs CREATEUSER side 11 Tlf: Side 12 af 22

13 DIMENSIONER: LÆSNING, OPDATERING OG OPRETTELSE Det er muligt at læse, pdatere g prette dimensiner i hver af de tilknyttede EMS database der er prettet på systemet. Fr at få adgang til dimensiner i EMS databaserne, skal man have et handle til den EMS database man vil interagere med. OPSLAG EFTER EMS DATABASER GETDEFAULTEMS() GETEMS(string) GETEMSUNITS() GETDEFAULTEMS GETDEFAULTEMS returnerer den EMS database der er psat til at være standard fr den bruger der er lgget in på SOAP API et. Det vil altså sige, at hvis man bruger SOAP API et frntend Parametre Funktinen mdtager ingen parametre Returværdi EMS : Der returneres det EMS bjekt der hører til den EMS database, sm brugeren har sm default EMS Eksempel Fr at få fat i den authentikerede SOAP Api brugers EMS, kaldes følgende: Acubiz.EMS ems = WS.GETDEFAULTEMS(); GETEMS GETEMS returnerer den EMS database, der bliver frespurgt på sm parameter til funktinen Parametre EmsID (String): ID identifikatin på den EMS database der ønskes leveret retur Returværdi EMS : der returneres det EMS bjekt der hører til EMS databasen, sm der er angivet sm parameter. Hvis der ikke blev fundet en database med det givne ID, returneres NULL Eksempel Fr at få fat i en EMS database, med navnet marketing, kaldes: Acubiz.EMS ems = WS.GETEMS( marketing); GETEMSUNITS Funktinen returnerer alle registrerede EMS databaser I systemet. Tlf: Side 13 af 22

14 Parametre Funktinen mdtager ingen parametre Returværdi ARRAYOFEMS bjekt Eksempel I dette eksempel hentes plysninger m alle EMS databaser, hvrefter antallet skrives til en label g alle EMS databaser skrives til et listview. Her lægges selve EMS bjektet på listviewitem ets tag parameter. Det vil sige at man kan tage direkte fat i EMS bjektet, når listviewitem et vælges, uden at skulle hente det igen. listviewems.items.clear(); ListViewItem item = null; Acubiz.ARRAYOFEMS EMSUnits = WS.GETEMSUNITS(); labelemsfund.text = "EMS Fund: " + EMSUnits.COUNT.TString(); freach (Acubiz.EMS EMS in EMSUnits.ARRAY) { } item = new ListViewItem(); item.text = EMS.EMSNAME; item.tag = EMS; listviewems.items.add(item); LISTING AF DIMENSIONER Til listing af dimensiner benyttes følgende funktiner: GETDIMENSION(Acubiz.EMS, string) GETDIMENSIONS(Acubiz.EMS, int, int) GETDIMENSIONSBYTYPE(Acubiz.EMS, int, int, string) GETDIMENSION GETDIMENSION finder g returnerer en enkelt dimensin, på baggrund af dimensinens ID Parametre EMS (EMS): Handle til den EMS database der skal søges i ID (String): ID på den dimensin der skal returneres Returværdi DIMENSION bjekt Tlf: Side 14 af 22

15 Eksempel I dette eksempel hentes der et EMS handle fra et listview (se eksempel fra GETEMSUNITS på side 14) g bruges til at finde den dimensin, hvis ID er skrevet i textbx en textbxdimsearch. Acubiz.EMS ems = (Acubiz.EMS)listViewEMS.SelectedItems[0].Tag; Acubiz.DIMENSION dimensin = WS.GETDIMENSION (ems, textbxdimsearch.text); I dette eksempel hentes dimensinen 0010 I EMS databasen marketing. Acubiz.EMS ems = WS.GETEMS( marketing ); Acubiz.DIMENSION dimensin = WS.GETDIMENSION (ems, 0010 ); GETDIMENSIONS GETDIMENSIONS henter alle dimensiner, der ligger i den EMS database der er angivet sm parameter Parametre EMS (EMS): Handle til den EMS database der skal søges i Psitin (lng): Hvr i den samlede liste af dimensiner skal der udlæses fra. Angives 0 læses fra begyndelsen Cunt (lng): Hvr mange elementer skal der udlæses Returværdi ARRAYOFDIMENSIONS bjekt Eksempel Dette eksempel bygger videre på vres tidligere listview as EMS databaser g ppulerer et listview med de dimensiner der bliver returneret. Den valgte EMS database i listviewems findes g bruges sm ems database til at få alle dimensiner. Efterfølgende skrives antallet af dimensiner i en label g hver dimensin gennemgås g skrives til et listview. Acubiz.EMS ems = (Acubiz.EMS)listViewEMS.SelectedItems[0].Tag; Acubiz.ARRAYOFDIMENSION dimensins = WS.GETDIMENSIONS(ems, 0, 0); labeldimfund.text = "Dimensins fund: " + dimensins.count.tstring(); ListViewItem item = null; listviewdim.items.clear(); string[] arr = new string[5]; freach (Acubiz.DIMENSION dimensin in dimensins.array) { arr[0] = dimensin.id; arr[1] = dimensin.namevalue; Tlf: Side 15 af 22

16 arr[2] = dimensin.displayvalue; arr[3] = dimensin.id2; arr[4] = dimensin.id3; } item = new ListViewItem(arr); listviewdim.items.add(item); } Dette eksempel henter alle dimensiner I EMS databasen marketing : Acubiz.EMS ems = WS.GETEMS( marketing ); Acubiz.ARRAYOFDIMENSION dimensins = WS.GETDIMENSIONS(ems, 0, 0); GETDIMENSIONSBYTYPE GETDIMENSIONS henter alle dimensiner af en bestemt type, der ligger i den EMS database der er angivet sm parameter Parametre EMS (EMS): Handle til den EMS database der skal søges i Psitin (lng): Hvr i den samlede liste af dimensiner skal der udlæses fra. Angives 0 læses fra begyndelsen Cunt (lng): Hvr mange elementer skal der udlæses Type (string): Den dimensinstype der skal hentes ind. Dette er typisk ID på det øverste niveaus dimensiner Returværdi ARRAYOFDIMENSIONS bjekt Eksempel Dette eksempel henter alle dimensiner I EMS databasen marketing, der har typen Dim1 : Acubiz.EMS ems = WS.GETEMS( marketing ); Acubiz.ARRAYOFDIMENSION dimensins = WS.GETDIMENSIONS(ems, 0, 0, Dim1 ); OPRETTELSE AF DIMENSIONER Til prettelse af en dimensin benyttes følgende funktin: CREATEDIMENSION(Acubiz.EMS, string, string, string, string, string, string) CREATEDIMENSION CREATEDIMENSION pretter en bruger g returnerer det DIMENSION bjekt der er prettet, med de infrmatiner der er angivet. Tlf: Side 16 af 22

17 Det DIMENSION bjekt der bliver returneret kan mdificeres g bruges sm parameter til UPDATE DIMENSION funktinen, fr at ændre/sætte de egenskaber sm ikke bliver sat ved selve prettelsen Parametre EMS (EMS) : Handle til den EMS database der skal prettes i ID (String) : ID på den dimensin der skal prettes. ID skal være unik i EMS databasen Parent ID (String) : ID på den dimensin der ligger ven ver Name (String) : Navn på dimensin Display (String) : Navn til visning af dimensin ID2 (String) : 2. nøgle på dimensinen ID3 (String) : 3. nøgle på dimensinen Retursvar DIMENSION bjekt med den prettede brugere. Sker der fejl under prettelsen, vil bjektets ISERROR egenskab være sat til sand g ERRORSTRING vil indehlde den eller de fejl der blev fundet Eksempel Funktinen bruges således: Acubiz.DIMENSION dimensin = WS.CREATEDIMENSION(ems, textbxdimid.text, textbxdim- Level.Text, textbxdimname.text, textbxdimdisplay.text, textbxdimid2.text, text- BxDIMID3.Text); OPDATERING AF DIMENSIONER Opdatering af dimensiner sker via funktinen: UPDATEDIMENSION(Acubiz.DIMENSION) UPDATEDIMENSION UPDATEDIMENSION mdtager et DIMENSION bjekt med den dimensin der skal pdateres i systemet. DIMENSION bjektet, der sendes til UPDATEDIMENSION, skal tidligere være mdtaget enten igennem prettelse eller via en pslagsfunktin. Har DIMENSION bjektet ikke tidligere sin prindelse fra API ets andre funktiner, vil UPDATEDIMENSION afvise pdateringen Parametre Dimensin (DIMENSION): DIMENSION bjektet fra den dimensin der skal pdateres Retursvar Dimensin (DIMENSION): Den pdaterede dimensin med eventuelle fejl infrmatin Eksempel Acubiz.DIMENSION dimensin = WS.GETDIMENSION(ems, ID); dimensin = WS.UPDATEDIMENSION(dimensin); Tlf: Side 17 af 22

18 IMPORT AF DATA Imprt af data fregår ud fra imprt prfiler der allerede er prettet i systemet. Imprt af data bruges til at sende mange data p på samme tid. Her fås dg ikke fejlmeddelelser eller valideringsfejl tilbage, ud ver den validering der fregår på m det frmat der sendes p er krrekt. IMPORTCSVDATA IMPORTCSVDATA sætter en dataimprt i gang g returnerer derefter en indikering m datasættet blev accepteret til imprt eller ej. Et data sæt afvises, hvis Imprt Prfilen er frkert, hvis frmatet er frkert eller hvis der mangler felter eller pster i datafrmatet Parametre ImprtPrfile (String) : Eksprt prfil navn ImprtType (String) : Eksprt type ImprtData (String) : Imprt data I CSV frmat Imprt frmatet er i CSV frmat, g fremgår af den pågældende psætningsprfil Retursvar Blean: Hvis ImprtData blev accepteret til imprt g imprten er sat I gang. Dette er ikke en indikering m selve imprten er succesfuld eller ej Eksempel Acubiz.EMS ems = WS.GETEMS( marketing ); Acubiz.EXPORTDATA IMPORTCSVDATA = WS.IMPORTCSVDATA(ems, textbximprtprfile.text, textbximprttype.text, CSV); IMPORTXMLDATA IMPORTXMLDATA sætter en dataimprt i gang g returnerer derefter en indikering m datasættet blev accepteret til imprt eller ej. Et data sæt afvises, hvis Imprt Prfilen er frkert, hvis frmatet er frkert eller hvis der mangler felter eller pster i datafrmatet Parametre ImprtPrfile (String) : Eksprt prfil navn ImprtType (String) : Eksprt type ImprtData (String) : Imprt data I XML frmat Tlf: Side 18 af 22

19 Imprt frmatet er i XML frmat, g fremgår af den pågældende psætningsprfil Retursvar Blean: Hvis ImprtData blev accepteret til imprt g imprten er sat I gang. Dette er ikke en indikering m selve imprten er succesfuld eller ej Eksempel Acubiz.EMS ems = WS.GETEMS( marketing ); Acubiz.EXPORTDATA IMPORTXMLData = WS.IMPORTCSVDATA(ems, textbximprtprfile.text, textbximprttype.text, XML); EKSPORT AF DATA Eksprt af data fregår ud fra eksprt prfiler der allerede er prettet i systemet. Ligesm man kan få eksprterne ud sm filer, kan man gså få dem ud via SOAP API et. Det gøres via funktinen EKSPORTCSVDATA g EKSPORTXMLDATA. EXPORTCSVDATA EKSPORTCSVDATA sætter en dataeksprt i gang g leverer efterfølgende et dataset af data retur Parametre EMS (EMS) : Handle til den EMS database der skal prettes i ExprtPrfile (String) : Eksprt prfil navn ExprtType (String) : Eksprt type IsTestExprt (Bl) : Angiver m det er en test eksprt eller m data skal markeres sm eksprteret Retursvar EXPORTCSVDATA bjekt Data returneres i et ESPORTDATA bjekt, der hlder data samt infrmatiner m eventuelle fejl, antal g et unikt ID på ekspreten: EXPORTCSVDATA ID : String Data : Variant Cunt : Lng Frmat : String ExprtPrfileName : String ExprtDateTime : String IsExprted : Blean IsErrr : Blean ErrrInf : String Tlf: Side 19 af 22

20 Eksprten returneres med et ID, der er en unik identifikatr på denne eksprt. Data ligger i DATA varianten, sm et streng array af datalinjer. Datalinjerne er i denne versin af API et er semikln separerede linjer med de felter sm der er beskrevet i eksprt prfilen. Man kan altså selv bestemme hvilke felter der skal returneres i eksprt prfilen, der sættes p i applikatinen. Fejl returneres i ErrrInf, hvr IsErrr er sat til sand, hvis det er en fejl. Hvis eksprten er fuldendt, sættes IsExprted til sand. Er der pstået et prblem, der gør at datasættet ikke er eksprteret, sættes IsExprted til falsk. Frmat returneres sm CSV i dette kald. Cunt indehlder antal linjer i eksprten Eksempel Dette eksempel henter alle de eksprtdata, der ikke er eksprteret I EMS databasen marketing, fra eksprt prfilen 01. Omkstninger - uden summering med eksprt typen Expense Accunts. Acubiz.EMS ems = WS.GETEMS( marketing ); Acubiz.EXPORTDATA exprtdata = WS.EXPORTCSVDATA(ems, 01. Omkstninger - uden summering, Expense Accunts, true); EXPORTXMLDATA EKSPORTXMLDATA sætter en dataeksprt i gang g leverer efterfølgende et dataset af data retur Parametre EMS (EMS) : Handle til den EMS database der skal prettes i ExprtPrfile (String) : Eksprt prfil navn ExprtType (String) : Eksprt type IsTestExprt (Bl) : Angiver m det er en test eksprt eller m data skal markeres sm eksprteret Retursvar EXPORTXMLDATA bjekt Data returneres i et ESPORTDATA bjekt, der hlder data samt infrmatiner m eventuelle fejl, antal g et unikt ID på ekspreten: EXPORTXMLDATA ID : String Data : Variant Cunt : Lng Frmat : String ExprtPrfileName : String ExprtDateTime : String IsExprted : Blean IsErrr : Blean ErrrInf : String Eksprten returneres med et ID, der er en unik identifikatr på denne eksprt. Tlf: Side 20 af 22

21 Data ligger i DATA varianten, sm et streng array af XML data. Datalinjerne er i denne versin af API et er XML med de felter sm der er beskrevet i eksprt prfilen. Man kan altså selv bestemme hvilke felter der skal returneres i eksprt prfilen, der sættes p i applikatinen. Fejl returneres i ErrrInf, hvr IsErrr er sat til sand, hvis det er en fejl. Hvis eksprten er fuldendt, sættes IsExprted til sand. Er der pstået et prblem, der gør at datasættet ikke er eksprteret, sættes IsExprted til falsk. Frmat sættes til XML ved dette kald. Cunt indehlder antal linjer i eksprten Eksempel Dette eksempel henter alle de eksprtdata, der ikke er eksprteret I EMS databasen marketing, fra eksprt prfilen 01. Omkstninger - uden summering med eksprt typen Expense Accunts. Acubiz.EMS ems = WS.GETEMS( marketing ); Acubiz.EXPORTDATA exprtdata = WS.EXPORTXMLDATA(ems, 01. Omkstninger - uden summering, Expense Accunts, true); Tlf: Side 21 af 22

22 INDEX A APIVERSION; 6 ARRAYOFDIMENSION; 8 ARRAYOFEMS; 7; 14 ARRAYOFUSER; 7 B Brugere: Læsning, pdatering g prettelse; 10 C CREATEDIMENSION; 8; 16 CREATEUSER; 6; 11; 16 D DIMENSION; 8 E EMS; 7 ERRORSTRING; 6 EXPORTDATA; 9; 18; 19; 20; 21 F FINDUSER; 6; 10 G GETDEFAULTEMS; 7; 13 GETDIMENSION; 8; 14 GETDIMENSIONS; 8; 14; 15 GETDIMENSIONSBYTYPE; 8; 14; 16 GETEFFECTIVEUSERNAME; 6 GETEMS; 7; 13 GETEMSUNITS; 7; 13 GETEXPORTDATA; 8; 9 GETUSERNAME; 6 GETUSERS; 6; 10 I ISERROR; 6 L Listning af brugere; 10 O Opdatering af brugere; 12; 17 Oprettelse af brugere; 11 U UPDATEDIMENSION; 8 UPDATEUSER; 6; 12; 17 USER; 6 GETCURRENTUSER; 6 Tlf: Side 22 af 22