Naamgevingsconventies

Hoewel u bij de naamgeving van geheugenvelden geheel vrij bent in de bepaling van de naam, heeft het voordelen om bepaalde conventies aan te houden.

In dit hoofdstuk wordt een naamgevingsconventie besproken, die de naamgeving van geheugenvelden 'standaardiseert'.

Voorvoegsel

Gebruik voor elk geheugenveld een voorvoegsel welke het type waarde aangeeft dat het geheugenveld zal bevatten. Een numeriek geheugenveld kunt u bijvoorbeeld het voorvoegsel num (afkorting voor numeriek) geven; bijvoorbeeld numBoekjaar. Indien u dit doet kunt u direct aan de naam herkennen wat het type waarde is dat dit geheugenveld accepteert/aankan.

Het gebruik van een voorvoegsel heeft tevens het voordeel dat de geheugenvelden automatisch gegroepeerd worden aan de hand van het voorvoegsel:

Ook bij het opvragen van de geheugenvelden in het snelmenu wordt deze groepering gehanteerd:

In onderstaande tabel staan veel gebruikte voorvoegsels die bij de naamgeving van de geheugenvelden gebruikt kunnen worden:

Voorvoegsel	Te gebruiken voor geheugenveld
str	Tekstwaarde (str staat voor string)
dat	Datum-/tijdwaarde
num	Numerieke waarde
jn	Een boolean waarde
dr	Dataregel waarde
ds	Dataset waarde

Bij het gebruik van tekstwaarden worden tevens de volgende voorvoegsels gebruikt om een verdere nuancering aan te brengen:

Voorvoegsel	Te gebruiken voor tekst geheugenveld
bn	Bestandsnaam (bijvoorbeeld Factuur 20160725.PDF)
bp	Bestandspad (bijvoorbeeld D:\Documents\Invoices\Factuur 20160725.PDF)
col	Kolomnummer (hoewel hier nummer staat, wordt deze waarde vaak in een tekst geheugenveld geplaatst)
cs	Connectiestring
csv	Door (punt-)komma gescheiden waarde
dir	Map (bijvoorbeeld D:\Documents\Invoices\)
ea	E-mailadres
html	HTML-code
prn	Printernaam
xml	XML-code

De volgende voorvoegsels kunnen gebruikt worden voor de koppelingen met pakketten:

Voorvoegsel	Te gebruiken voor tekst geheugenveld
eol	Exact Online (bijvoorbeeld gebruikersnaam, administratienummer, etc.)
egs	Exact Globe/Synergy
twf	Twinfield
u4m	Unit 4 Multivers
yuki	Yuki

N.B.: Deze lijsten dient puur als suggestie. BPM Server schrijft niets voor. U bent volledig vrij bij de keuze van een naam.

Benaming

Naast het gebruik van een voorvoegsel is het ook aan te raden het geheugenveld een beschrijvende naam te geven, waaraan de inhoud van het geheugenveld kan worden afgeleid.

Een veelgebruikte 'techniek' bij de benaming is gebruik te maken van een zogenaamde 'Camel'-notatie. Dit wil zeggen dat u elk woord laat beginnen met een hoofdletter. Het gebruik van een Camel-notatie verbeterd de leesbaarheid van het geheugenveld.

Voorbeeld

Een geheugenveld waarin de omzet van de vorige periode wordt opgeslagen wordt de volgende naam gegeven:

numOmzetVorigePeriode

Indien er geen gebruik zou worden gemaakt van de Camel-notatie zou de naam van dit geheugenveld als volgt eruit zien:

numOMZETVORIGEPERIODE

Over het algemeen zal de benaming met de Camel-notatie beter leesbaar zijn.