Guide till CSV-Integrationer

Det här är en guide för hur ni integrerar era system med Boards on Fire via ".csv" filer.

Vad är en .csv fil?

.csv (comma-separated values) filer påminner om excelfiler, med skillnaden att värdena inte är uppställda i en tabell. Istället separeras "kolumnerna" av värden genom kommatecken (","). Nedan ser ni en jämförelse mellan Excelblad och .csv-filer. Csv är en etablerad standard och många system kan generera filer av denna typ automatiskt. 

Excelfil / .csv-fil

Vad ska vår .csv-fil innehålla?

En .csv-fil ska innehålla värden som hör ihop med varandra. Med det menar vi att ni inte ska blanda nyckeltal för t.ex OEE & Sjukfrånvaro i samma fil. En fil kan ha obegränsat med "kolumner" (värden), men de ska alla tillhöra samma datakälla/entitet. Detta betyder också att varje datakälla i BoF som ska ta emot data behöver sin egen .csv-fil. Varje "kolumn" matchas med ett fält i datakällan/entiteten ni vill koppla filen till.

Utformning av filen

I en .csv-fil så representar varje rad ett datum för en organisation i BoF. T.ex så har fälten "GOAL" & "OUTCOME" värdet 1229.77 respektive 248.72 för datumet 2023-05-23 i organisationen "T03"

Obligatoriska värden

Det finns två värden (kolumner) som varje rad i er fil måste innehålla. Dessa är:

• TIMESTAMP: Berättar för vilket datum radens värde gäller. Om ni vill skicka in värden veckovis/månadsvis så ska datumet vara det första för den aktuella perioden (ex datumet för måndag aktuell vecka eller den 1a aktuell månad). Formatet ska vara "YYYY-MM-DD".
• ORGANIZATION: Berättar för vilken organisation radens värde gäller. Ska motsvaras av en organisation i er BoF-miljö.

Valfria värden

Det är dessa värden (kolumner) som representerar fälten i BoF (i exemplet "GOAL" & "OUTCOME"). Det finns några regler för dem:

• Namnet på värdena (kolumnrubrikerna) får inte innehålla specialtecken (ex å,ä,ö,æ,ø) eller mellanslag (kan ersättas med underscore "_").
• Värdena i raderna får inte innehålla kommatecken ( , ), semikolon ( ; ) eller citattecken ( " ).
• Värdet ska motsvaras av av ett fält in en datakälla/entitet i BoF.

Namngivning av filen

Filens namn får inte förändras under dess användning, den bör därför inte innehålla datum. Vid varje uppladdning måste filens namn överensstämma exakt med den första filen ni laddade upp. Övriga regler är:

• Ge filen ett namn som motsvarar den datakälla/entitet den ska matchas med (ex "OEE.csv).
• Filens nam får inte innehålla specialtecken (ex å,ä,ö,æ,ø) eller mellanslag (kan ersättas med underscore "_").
• Om ni laddar upp flera olika filer så ska deras namn vara unika.

Uppladdning av er fil

När filen överensstämmer med ovanstående format är det dags att ladda upp den till vår server.

Vart ska filen laddas upp?

Ni kommer att tilldelas en mapp på vår server, som ni når via en sftp-klient. När vi har godkänt filen så får ni inloggningsuppgifter till servern.

Hur lång tid tar uppladdningen av data?

Från och med att filen placerats på servern tar det upp till 5 minuter för datan att dyka upp på era tavlor i BoF, oftast går det dock på ca 30-60 sekunder.

Hur ofta kan vi ladda upp filer med ny data?

Som regel ska högsta frekvens vara 1 uppladdning var 15e minut per fil. Det kan dock finnas scenarion då frekvensen kan höjas. Om det önskas, meddela vår supportavdelning. Vid hög uppladdningsfrekvens kan ni med fördel skriva ett skript som automatiskt skickar filerna till vår server.

Hur kommer data in i BoF?

Vid uppsättning av en csv-integration så mappas varje värde (kolumn) till ett fält i en datakälla/entitet i BoF. När ni sedan skickar upp filer till vår server så läses varje rad av automatiskt och värdena skickas till den organisation som beskrivs av radens värde i kolumnen "ORGANIZATION".

Vad händer med data som redan finns i BoF?

Om det redan finns ett värde för den organisation, datum och fält som beskrivs i filen så kommer det att skrivas över av filens värde. Data som kommit till er BoF-miljö via en integration sparas permanent precis som all annan data.

Frågor?

Om ni har några frågor eller funerignar kring integrationer med Boards on Fire kan ni alltid höra av er till support@boardsonfire.com