Praktičen kontrolni seznam
Kako pripraviti dobro specifikacijo podatkovne integracije
Za začetno oceno ne potrebujete popolne tehnične dokumentacije. Potrebujemo pa dovolj jasen opis sistemov, podatkov in želenega rezultata, da odkrijemo neznanke ter pripravimo naslednji korak.
- realen anonimiziran vzorec
- brez gesel in API ključev
- oddaja ni naročilo
1. Za začetno tehnično oceno
Pošljite kratek poslovni opis: kaj danes poteka ročno, kateri sistem je izvor, kateri cilj in kakšen rezultat pričakujete. Dodajte okvirno količino zapisov ter želeno pogostost.
- Izvorni sistem – naziv, različica, moduli in skrbnik.
- Ciljni sistem – naziv, različica, moduli in skrbnik.
- Podatkovni tokovi – izdelki, cene, zaloga, naročila, partnerji ali drugo.
- Želeni rezultat – kaj mora po uspešnem prenosu obstajati v cilju.
- Obseg – število zapisov, pogostost sprememb in pričakovana rast.
2. Dostop do izvora in cilja
Za oceno navedite, kateri vmesnik je na voljo. Za razvoj pozneje uredimo testni dostop z najmanjšim potrebnim obsegom pravic.
- API oziroma spletna storitev in povezava do dokumentacije,
- XML, CSV, JSON, Excel ali drug datotečni izvoz oziroma uvoz,
- SFTP ali drug dogovorjen datotečni predal,
- spletni kavelj ali čakalna vrsta,
- omejen neposreden dostop do podatkovne baze, kadar je dovoljen in primeren.
Skrivnosti si po dogovoru izmenjamo po varnejši poti. Začetni vzorec naj bo anonimiziran in brez osebnih podatkov, ki za oceno niso nujni.
3. Podatki, polja in preslikave
Najboljši začetek je realen, vendar anonimiziran vzorec. Poleg vsakega pomembnega polja opišite pomen, ciljno polje, obliko in dovoljene vrednosti.
- Identifikatorji – SKU, EAN, notranje šifre ali drugi stabilni ključi.
- Glavni vir – kateri sistem odloča o posameznem podatku.
- Preslikave – kategorije, statusi, davki, enote, skladišča in šifranti.
- Pretvorbe – datumi, decimalke, valute, merske enote in sestavljena polja.
- Obveznost – katera polja morajo biti vedno prisotna in kaj se zgodi, če manjkajo.
4. Pravila delovanja in izjeme
Določite smer za vsak tok posebej, sprožilo prenosa in vedenje pri napaki. Pri dvosmerni povezavi mora biti jasno, kdo je lastnik podatka in kako se preprečijo zanke.
- enosmerno ali dvosmerno ter glavni vir po podatkovnem sklopu,
- enkratno, ročno, po urniku ali ob dogodku,
- obdelava samo sprememb ali celotnega nabora,
- ponovni poskusi, karantena napačnih zapisov in obvestila,
- želena administracija, potrjevanje, uporabniške vloge in poročila,
- morebitna AI-obdelava, človeški pregled, prag zanesljivosti in okvir porabe.
5. Testni primeri in potrditev
Pred uvedbo skupaj potrdimo sprejemne scenarije. Vključujejo običajne primere, mejne vrednosti, manjkajoče podatke, podvojene ključe in napake ciljnega sistema.
- običajen zapis se pravilno prenese in preslika,
- obstoječi zapis se pravilno posodobi brez podvajanja,
- neveljaven zapis se varno zavrne ali označi,
- ponovni zagon ne ustvari podvojenih dokumentov,
- odgovorna oseba prejme dogovorjeno obvestilo o napaki.
6. Primer kratkega začetnega opisa
Ta vzorec lahko kopirate, dopolnite in prilepite v polje »Podrobnosti« v obrazcu.