Bij het importeren van gegevens met behulp van een API wordt een recordindeling gebruikt om de structuur en het formaat van de gegevens te definiëren. Een recordindeling beschrijft hoe de gegevens moeten worden georganiseerd en uitgewisseld tussen de API en de ontvangende applicatie, in dit geval CASH.
Gegevens die bij elkaar horen worden gezien als 'records'. De waarden binnen zo'n record worden gezien als 'rubrieken'. De recordindeling bevat informatie over de velden, datatypes en de volgorde waarin ze moeten worden geplaatst.
Een recordindeling is essentieel voor een API omdat het consistentie, validatie, interoperabiliteit en documentatie mogelijk maakt. Het zorgt voor een gestandaardiseerde en betrouwbare uitwisseling van gegevens tussen systemen, waardoor API-gebaseerde integraties soepel kunnen verlopen.
Voor de toepassing in CASH voor de modules financieel en handel(ERP), kan de recordindeling worden gebruikt bij het importeren van gegevens zoals productinformatie, klantgegevens, voorraadniveaus, bestellingen, enzovoort. De specifieke recordindeling en velden kunnen variëren afhankelijk van het type gegevens dat wordt geïmporteerd.
Er wordt gecontroleerd op de aanwezigheid van stamgegevens. Het is daarom belangrijk dat deze eerst worden geïmporteerd. De relatiegegevens, grootboekrekeningen etc. dienen dus eerst ingelezen te worden.
Om de recordindeling toe te passen in CASH, dien je rekening te houden met het volgende;
- Als er fouten worden geconstateerd, dan wordt een bestand geproduceerd waarvan de naam gelijk is aan de naam van het te importeren bestand met als extensie ‘err’.
- In het foutenbestand zijn de regels aanwezig die niet zijn verwerkt. Er wordt aangegeven welke fouten zijn geconstateerd.
- Zowel het toevoegen als het wijzigen van bestaande waarden is mogelijk (behalve voor 301-records = boekregels).
- Rubrieken die zijn aangegeven als verplicht (voorzien van *) moeten binnen het gegeven aanwezig zijn.
- Is een numerieke rubriek te lang, dan wordt dit als een fout gezien.
- Is een tekstuele rubriek te lang, dan wordt de inhoud afgebroken.
- In een numerieke rubriek mag de punt of komma als scheidingsteken voor decimalen worden gebruikt. Wordt er geen punt of komma gebruikt, dan wordt de rubriek tot het maximaal aantal decimalen opgevuld, dus als 123456 wordt aangeboden als een rubriek met 2 decimalen, dan wordt dit gezien als 1234,56.
- Worden er in een regel fouten geconstateerd, dan wordt die gehele regel niet verwerkt, maar weggeschreven naar het foutenbestand met als extensie .err.
- Voor uitleg over de rubrieken wordt verwezen naar de helptekst van de betreffende onderhoudsfuncties. De helptekst is terug te vinden, wanneer je in een specifieke scherm op de blauwe vraagteken rechts in het scherm klikt.
Voor een specificatie en opsomming van de recordindelingen selecteer je één van de onderstaande opties;