Webhuis wiki - User contributions [en]

Bootable USB

2026-09-15T19:27:42Z

Martin: /* Debian Bootable USB */

=Debian Bootable USB=
Dit is een zogenaamde non-Uefi usb boot stick. Een bootable Debian USB is goud waard in een migratie uit Windows naar Linux of bij het herstel of migreren van een Linux machine.
Stappen:
* Partitioneer een USB met gdisk
* Installeer Debian op een partitie met debootstrap
* Configureer de install naar een bootable usb
[https://en.wikipedia.org/wiki/BIOS_boot_partition "Hah!IdontNeedEFI"]

* mount de usb root partition
* debootstrap stable /mnt/sdb2 http://10.68.171.11:3142/debian
* mount-chroot
* chroot /mnt/sdc2 /bin/bash
==Partitioneren USB==
Gebruik gdisk voor het partitioneren van de USB en maak vier partities.
* De BIOS Boot partition, eindigend op sector 2047
* Twee linux Root partities, van 4G
* De rest voor een /home partitie
Maak geen /boot/efi partitie aan!
<pre>
label: gpt
label-id: 6522A0ED-ED48-4313-B710-169E0E898DC2
device: /dev/sdb
unit: sectors
first-lba: 64
last-lba: 60538817
table-length: 248
sector-size: 512

/dev/sdc1 : start= 64, size= 1984, type=21686148-6449-6E6F-744E-656564454649, uuid=327DD423-85F8-4D23-A978-522BFC43B499, name="BIOS boot partition"
/dev/sdc2 : start= 2048, size= 8388608, type=0FC63DAF-8483-4772-8E79-3D69D8477DE4, uuid=2AE9F26B-3000-43FB-9F66-7352D5C3D4A8, name="Linux filesystem"
/dev/sdc3 : start= 16779264, size= 8388608, type=0FC63DAF-8483-4772-8E79-3D69D8477DE4, uuid=1B64C33C-8F04-407D-AB5B-F3358C6B625D, name="Linux filesystem"
/dev/sdc4 : start= 25167872, size= 35370946, type=0FC63DAF-8483-4772-8E79-3D69D8477DE4, uuid=14251565-DA33-4682-946B-81F091438E4C, name="Linux filesystem"
</pre>

==fstab==
Op de USB zijn meerdere Debian OS installs mogelijk, dus is het zinvol om een apart home partitie te gebruiken, het heeft weinig zin om een swap te definiëren.
<pre>
# /etc/fstab: static file system information.
#
# Use 'blkid' to print the universally unique identifier for a
# device; this may be used with UUID= as a more robust way to name devices
# that works even if disks are added and removed. See fstab(5).
#
# systemd generates mount units based on this file, see systemd.mount(5).
# Please run 'systemctl daemon-reload' after making changes here.
#
# <file system> <mount point> <type> <options> <dump> <pass>
# / was on /dev/md0 during installation
UUID=eb35cee7-df6d-45ad-b2fb-9917b5630443 / ext4 errors=remount-ro 0 1
UUID=7440423e-10a4-42a2-a61c-3881981945e2 /home ext4 errors=remount-ro 0 2

# We don't use swap partitions
</pre>
Packages
<pre>

ssh
user
install kernel image
sudo
geen root passwd
netwerk config
exit chroot
mount-chroot
umount de usb root partition
resolv.conf
interfaces
</pre>
Maak de partitie bootable:
grub-install --target=i386-pc path/to/device

<pre>
Oude manier:
maak met unetbootin een netinstall aan op een partitie op een usb-stick
Boot de doel machine met de usb-stick en voer de installatie uit
Grub maakt een foutje door de devices te verwisselen, sda <-> sdb
Herstel de fout in grub edit en boot
Pas na de boot /etc/fstab aan en doe update-grub
</pre>
De installatie is nog niet erg minimaal, maar hij werkt.
mkfs.ext4 /dev/sdc2
1937 mkfs.ext4 /dev/sdc3
1938 mkfs.ext4 /dev/sdc4

root@host:~# apt-get clean
root@host:~# apt-get install localepurge
root@host:~# localepurge
root@squeeze-usb-i386:~# ln -s /home/squeeze-usb-i386/var/lib/* /var
root@squeeze-usb-i386:~# ln -s /home/squeeze-usb-i386/var/cache/* /var

Installeer ook nog tools om met Windows file systems te werken:

apt-get install ntfsprogs scrounge-ntfs dosfstools rsync

Op de host

Maak een file system aan voor het OS op de USB stick.

root@host:~# fdisk /dev/sdb
root@host:~# mkfs.ext2 /dev/sdb1

Maak een directory aan op de host om daarin de installatie voor de usb-stick voor te bereiden.

root@host:~# mkdir /usbsystem
root@host:~# debootstrap --arch i386 squeeze /usbsystem http://ftp.nl.debian.org/debian
root@host:~# ./croot.sh /usbsystem

Doe eerst alle stappen uit chrooted en doe daarna:

root@host:~# umount /usbsystem/dev/ /usbsystem/sys /usbsystem/proc /usbsystem/tmp
root@host:~# umount /usbsystem-amd64/dev/ /usbsystem-amd64/sys /usbsystem-amd64/proc /usbsystem-amd64/tmp

chrooted
fstab

# UNCONFIGURED FSTAB FOR BASE SYSTEM
LABEL=USB_ROOT / ext2 defaults,errors=remount-ro,noatime 0 1
proc /proc proc defaults 0 0
tmpfs /tmp tmpfs defaults,noatime 0 0
tmpfs /var/lock tmpfs defaults,noatime 0 0
tmpfs /var/log tmpfs defaults,noatime 0 0
tmpfs /var/run tmpfs defaults,noatime 0 0
tmpfs /var/tmp tmpfs defaults,noatime 0 0

Voorpagina

2026-07-27T22:37:02Z

Martin: Undo revision 5920 by 10.68.171.250 (talk)

[[Category:Algemeen]]
<big>'''Webhuis Wiki.'''</big> 
Welkom op de wiki van Webhuis, deze wiki heeft een [[PostgreSQL]] backend. 
De wiki is voornamelijk Nederlandstalig, met de bedoeling om een zo breed mogelijk publiek op het gebied van Open Standaarden en Open Source Software laagdrempelig te ondersteunen en te helpen. 
Webhuis gebruikt en produceert (op bescheiden schaal) Open Source Software (OSS). Webhuis gebruikt en onderhoudt de wiki ter ondersteuning van haar eigen werk op het gebied van configuratie en beheer van Informatie Systemen voor dienstverlening aan haar klanten. 
Webhuis stelt de informatie in de wiki, in lijn met het gedachtengoed van de vrije software, kostenloos ter beschikking aan de gemeenschap. 
Deze wiki heeft als voornaamste doel te ondersteunen bij het opzetten, configureren en beheren van automatiseringsomgevingen die zijn gebaseerd op OSS. De wiki bevat een groeiend repertoire van configuraties van OSS applicaties, howto's, voorbeelden en ook studie materiaal. De wiki is voortdurend in bewerking en sommige nieuwere onderdelen bevatten nog slechts de ruwe informatie van een bepaald aandachtsgebied. 
Webhuis gebruikt vrijwel uitsluitend Debian GNU Linux en de configuratie voorbeelden zijn daarop gericht. 

De bijdragen op deze wiki vallen onder de [http://www.gnu.org/copyleft/gpl.html GNU General Public License]. 
Disclaimer: All information comes with ABSOLUTELY NO WARRANTY, to the extent permitted by applicable law. 
Webhuis pagina [[webhuis_info]]

Documentatie

2026-03-26T23:00:11Z

Martin: /* LPI */

== Linux Gebruikershandleiding ==
* [[Media:Lgh-1.5.pdf|Linux Gebruikershandleiding Universiteit Utrecht]]
* [http://steve-parker.org/sh/sh.shtml Bash Scripting Tutorial]
* [http://www.freeos.com/guides/lsst/ Linux Shell Scripting Tutorial v1.05r3 A Beginner's handbook]
* [http://tldp.org/LDP/abs/html/ Advanced Bash-Scripting Guide]
* [http://www.faqs.org/docs/Linux-HOWTO/Bash-Prog-Intro-HOWTO.html Bash programming]

== NLLGG LPI training ==
Quick refs en aanvullende informatie.

== LPI ==
Lesmateriaal voor het behalen van systeembeheer Linux

LPI certification 101
* [https://wiki.webhuis.nl/images/l-lpi1-a4.pdf LPI certification 101 exam prep, Part 1]
* [https://wiki.webhuis.nl/images/l-lpi2-a4.pdf LPI certification 101 exam prep, Part 2]
* [https://wiki.webhuis.nl/images/l-lpi3-a4.pdf LPI certification 101 exam prep, Part 3]
* [https://wiki.webhuis.nl/images/l-lpi4-a4.pdf LPI certification 101 exam prep, Part 4]

LPI certification 102
* [https://wiki.webhuis.nl/images/l-lpi5-a4.pdf LPI certification 102 exam prep, Part 1]
* [https://wiki.webhuis.nl/images/l-lpi6-a4.pdf LPI certification 102 exam prep, Part 2]
* [https://wiki.webhuis.nl/images/l-lpi7-a4.pdf LPI certification 102 exam prep, Part 3]
* [https://wiki.webhuis.nl/images/l-lpi8-a4.pdf LPI certification 102 exam prep, Part 4]

Wat moet je doen?
* Netjes afdrukken
* Gaatjes erdoor
* Per deel in een aparte tab in de map
* Met de map open en de computer aan elk deel doornemen.

Elk deel duurt tussen de 30 en 60 minuten.

== bash ==
* http://www.smachado.com/2009/02/bash-send-a-running-process-to-background/
== osFinancials Gebruikershandleiding ==
osFinancials is een nederlands open source product voor het voeren van boekhoudingen. Het pakket is geschreven in het proprietary Delphi, maar er zijn al modules in open source lazarus pascal ontwikkeld.

osFinancials heeft een ingebouwde interfaces met:
* vtiger, maar niet met Sugarcrm
* Microsoft Office en niet met Open Office

De uitgebreide nederlandstalige gebruikershandleiding van osFinancials is met copyright beschermd, als je hem wilt lezen dan moet je hem kopen. Het ziet er niet heel erg gelikt uit, maar zo hebben boekhouders het graag. We willen je natuurlijk helpen en kunnen vanuit de handleiding van advies dienen.

== Sugarcrm Gebruikershandleiding ==
Sugarcrm documentatie in het nederkands.
* [http://wiki.webhuis.nl/upload/store/handleiding-sugarcrm.pdf Sugarcrm Gebruikershandleiding in het Nederlands]
== Ubuntu Karmic handleiding ==
Zeer uitgebreide handleiding van Ubuntu Karmic.
* http://ubuntuguide.org/wiki/Ubuntu:Karmic
== MediaWiki ==
=== Los gestort ===
* http://www.vanheusden.com/Linux/
* http://www.handleidinghtml.nl/
Wijzigen van de navigatie:
http://wiki.webhuis.nl/index.php?title=MediaWiki:Sidebar&action=edit
Maken van een ruler:
<pre>
<hr/> of <hr />
of
----
</pre>
==== rtfm ====
De betekenis van de afkorting rtfm is als volgt gedefinieerd: Request Tracker FAQ Manager. Het is een Debian package, kijk maar:
<pre>
Package : rtfm
Vulnerability : cross-site scripting
Problem type : remote
Debian-specific: no
CVE ID : CVE-2012-2768

It was discovered that rtfm, the Request Tracker FAQ Manager, contains
multiple cross-site scripting vulnerabilities in the topic
administration page.

For the stable distribution (squeeze), this problem has been fixed in
version 2.4.2-4+squeeze1.

For the testing distribution (wheezy) and the unstable distribution
(sid), this problem has been fixed in version 4.0.6-4 of the
request-tracker4 package.
</pre>
<hr/>
Terug naar: [[Main Page]]

Documentatie

2026-03-26T22:56:40Z

Martin: /* LPI */

== Linux Gebruikershandleiding ==
* [[Media:Lgh-1.5.pdf|Linux Gebruikershandleiding Universiteit Utrecht]]
* [http://steve-parker.org/sh/sh.shtml Bash Scripting Tutorial]
* [http://www.freeos.com/guides/lsst/ Linux Shell Scripting Tutorial v1.05r3 A Beginner's handbook]
* [http://tldp.org/LDP/abs/html/ Advanced Bash-Scripting Guide]
* [http://www.faqs.org/docs/Linux-HOWTO/Bash-Prog-Intro-HOWTO.html Bash programming]

== NLLGG LPI training ==
Quick refs en aanvullende informatie.

== LPI ==
Lesmateriaal voor het behalen van systeembeheer Linux

LPI certification 101
* [https://wiki.webhuis.nl/images/l-lpi1-a4.pdf LPI certification 101 exam prep, Part 1]
* [https://wiki.webhuis.nl/images/l-lpi2-a4.pdf LPI certification 101 exam prep, Part 2]
* [https://wiki.webhuis.nl/images/l-lpi3-a4.pdf LPI certification 101 exam prep, Part 3]
* [https://wiki.webhuis.nl/images/l-lpi4-a4.pdf LPI certification 101 exam prep, Part 4]

LPI certification 102
* [[Media:l-lpi5-a4.pdf|LPI certification 102 exam prep, Part 1]]
* [[Media:l-lpi6-a4.pdf|LPI certification 102 exam prep, Part 2]]
* [[Media:l-lpi7-a4.pdf|LPI certification 102 exam prep, Part 3]]
* [[Media:l-lpi8-a4.pdf|LPI certification 102 exam prep, Part 4]]

Wat moet je doen?
* Netjes afdrukken
* Gaatjes erdoor
* Per deel in een aparte tab in de map
* Met de map open en de computer aan elk deel doornemen.

Elk deel duurt tussen de 30 en 60 minuten.

== bash ==
* http://www.smachado.com/2009/02/bash-send-a-running-process-to-background/
== osFinancials Gebruikershandleiding ==
osFinancials is een nederlands open source product voor het voeren van boekhoudingen. Het pakket is geschreven in het proprietary Delphi, maar er zijn al modules in open source lazarus pascal ontwikkeld.

osFinancials heeft een ingebouwde interfaces met:
* vtiger, maar niet met Sugarcrm
* Microsoft Office en niet met Open Office

De uitgebreide nederlandstalige gebruikershandleiding van osFinancials is met copyright beschermd, als je hem wilt lezen dan moet je hem kopen. Het ziet er niet heel erg gelikt uit, maar zo hebben boekhouders het graag. We willen je natuurlijk helpen en kunnen vanuit de handleiding van advies dienen.

== Sugarcrm Gebruikershandleiding ==
Sugarcrm documentatie in het nederkands.
* [http://wiki.webhuis.nl/upload/store/handleiding-sugarcrm.pdf Sugarcrm Gebruikershandleiding in het Nederlands]
== Ubuntu Karmic handleiding ==
Zeer uitgebreide handleiding van Ubuntu Karmic.
* http://ubuntuguide.org/wiki/Ubuntu:Karmic
== MediaWiki ==
=== Los gestort ===
* http://www.vanheusden.com/Linux/
* http://www.handleidinghtml.nl/
Wijzigen van de navigatie:
http://wiki.webhuis.nl/index.php?title=MediaWiki:Sidebar&action=edit
Maken van een ruler:
<pre>
<hr/> of <hr />
of
----
</pre>
==== rtfm ====
De betekenis van de afkorting rtfm is als volgt gedefinieerd: Request Tracker FAQ Manager. Het is een Debian package, kijk maar:
<pre>
Package : rtfm
Vulnerability : cross-site scripting
Problem type : remote
Debian-specific: no
CVE ID : CVE-2012-2768

It was discovered that rtfm, the Request Tracker FAQ Manager, contains
multiple cross-site scripting vulnerabilities in the topic
administration page.

For the stable distribution (squeeze), this problem has been fixed in
version 2.4.2-4+squeeze1.

For the testing distribution (wheezy) and the unstable distribution
(sid), this problem has been fixed in version 4.0.6-4 of the
request-tracker4 package.
</pre>
<hr/>
Terug naar: [[Main Page]]

Documentatie

2026-03-26T22:51:42Z

Martin: /* LPI */

== Linux Gebruikershandleiding ==
* [[Media:Lgh-1.5.pdf|Linux Gebruikershandleiding Universiteit Utrecht]]
* [http://steve-parker.org/sh/sh.shtml Bash Scripting Tutorial]
* [http://www.freeos.com/guides/lsst/ Linux Shell Scripting Tutorial v1.05r3 A Beginner's handbook]
* [http://tldp.org/LDP/abs/html/ Advanced Bash-Scripting Guide]
* [http://www.faqs.org/docs/Linux-HOWTO/Bash-Prog-Intro-HOWTO.html Bash programming]

== NLLGG LPI training ==
Quick refs en aanvullende informatie.

== LPI ==
Lesmateriaal voor het behalen van systeembeheer Linux

LPI certification 101
* [[File:l-lpi1-a4.pdf|LPI certification 101 exam prep, Part 1]]
* [[Media:l-lpi1-a4.pdf]]
* [[Media:l-lpi2-a4.pdf|LPI certification 101 exam prep, Part 2]]
* [[Media:l-lpi3-a4.pdf|LPI certification 101 exam prep, Part 3]]
* [https://wiki.webhuis.nl/images/l-lpi3-a4.pdf LPI certification 101 exam prep, Part 2]
* [[Media:l-lpi4-a4.pdf|LPI certification 101 exam prep, Part 4]]

LPI certification 102
* [[Media:l-lpi5-a4.pdf|LPI certification 102 exam prep, Part 1]]
* [[Media:l-lpi6-a4.pdf|LPI certification 102 exam prep, Part 2]]
* [[Media:l-lpi7-a4.pdf|LPI certification 102 exam prep, Part 3]]
* [[Media:l-lpi8-a4.pdf|LPI certification 102 exam prep, Part 4]]

Wat moet je doen?
* Netjes afdrukken
* Gaatjes erdoor
* Per deel in een aparte tab in de map
* Met de map open en de computer aan elk deel doornemen.

Elk deel duurt tussen de 30 en 60 minuten.

== bash ==
* http://www.smachado.com/2009/02/bash-send-a-running-process-to-background/
== osFinancials Gebruikershandleiding ==
osFinancials is een nederlands open source product voor het voeren van boekhoudingen. Het pakket is geschreven in het proprietary Delphi, maar er zijn al modules in open source lazarus pascal ontwikkeld.

osFinancials heeft een ingebouwde interfaces met:
* vtiger, maar niet met Sugarcrm
* Microsoft Office en niet met Open Office

De uitgebreide nederlandstalige gebruikershandleiding van osFinancials is met copyright beschermd, als je hem wilt lezen dan moet je hem kopen. Het ziet er niet heel erg gelikt uit, maar zo hebben boekhouders het graag. We willen je natuurlijk helpen en kunnen vanuit de handleiding van advies dienen.

== Sugarcrm Gebruikershandleiding ==
Sugarcrm documentatie in het nederkands.
* [http://wiki.webhuis.nl/upload/store/handleiding-sugarcrm.pdf Sugarcrm Gebruikershandleiding in het Nederlands]
== Ubuntu Karmic handleiding ==
Zeer uitgebreide handleiding van Ubuntu Karmic.
* http://ubuntuguide.org/wiki/Ubuntu:Karmic
== MediaWiki ==
=== Los gestort ===
* http://www.vanheusden.com/Linux/
* http://www.handleidinghtml.nl/
Wijzigen van de navigatie:
http://wiki.webhuis.nl/index.php?title=MediaWiki:Sidebar&action=edit
Maken van een ruler:
<pre>
<hr/> of <hr />
of
----
</pre>
==== rtfm ====
De betekenis van de afkorting rtfm is als volgt gedefinieerd: Request Tracker FAQ Manager. Het is een Debian package, kijk maar:
<pre>
Package : rtfm
Vulnerability : cross-site scripting
Problem type : remote
Debian-specific: no
CVE ID : CVE-2012-2768

It was discovered that rtfm, the Request Tracker FAQ Manager, contains
multiple cross-site scripting vulnerabilities in the topic
administration page.

For the stable distribution (squeeze), this problem has been fixed in
version 2.4.2-4+squeeze1.

For the testing distribution (wheezy) and the unstable distribution
(sid), this problem has been fixed in version 4.0.6-4 of the
request-tracker4 package.
</pre>
<hr/>
Terug naar: [[Main Page]]

Documentatie

2026-03-26T22:50:42Z

Martin:

== Linux Gebruikershandleiding ==
* [[Media:Lgh-1.5.pdf|Linux Gebruikershandleiding Universiteit Utrecht]]
* [http://steve-parker.org/sh/sh.shtml Bash Scripting Tutorial]
* [http://www.freeos.com/guides/lsst/ Linux Shell Scripting Tutorial v1.05r3 A Beginner's handbook]
* [http://tldp.org/LDP/abs/html/ Advanced Bash-Scripting Guide]
* [http://www.faqs.org/docs/Linux-HOWTO/Bash-Prog-Intro-HOWTO.html Bash programming]

== NLLGG LPI training ==
Quick refs en aanvullende informatie.

== LPI ==
Lesmateriaal voor het behalen van systeembeheer Linux

LPI certification 101
* [[File:l-lpi1-a4.pdf|LPI certification 101 exam prep, Part 1]]
* [[Media:l-lpi1-a4.pdf]]
* [[Media:l-lpi2-a4.pdf|LPI certification 101 exam prep, Part 2]]
* [[Media:l-lpi3-a4.pdf|LPI certification 101 exam prep, Part 3]]
* [https://webhuis.nl/download/l-lpi3-a4.pdf LPI certification 101 exam prep, Part 2]
* [[Media:l-lpi4-a4.pdf|LPI certification 101 exam prep, Part 4]]

LPI certification 102
* [[Media:l-lpi5-a4.pdf|LPI certification 102 exam prep, Part 1]]
* [[Media:l-lpi6-a4.pdf|LPI certification 102 exam prep, Part 2]]
* [[Media:l-lpi7-a4.pdf|LPI certification 102 exam prep, Part 3]]
* [[Media:l-lpi8-a4.pdf|LPI certification 102 exam prep, Part 4]]

Wat moet je doen?
* Netjes afdrukken
* Gaatjes erdoor
* Per deel in een aparte tab in de map
* Met de map open en de computer aan elk deel doornemen.

Elk deel duurt tussen de 30 en 60 minuten.

== bash ==
* http://www.smachado.com/2009/02/bash-send-a-running-process-to-background/
== osFinancials Gebruikershandleiding ==
osFinancials is een nederlands open source product voor het voeren van boekhoudingen. Het pakket is geschreven in het proprietary Delphi, maar er zijn al modules in open source lazarus pascal ontwikkeld.

osFinancials heeft een ingebouwde interfaces met:
* vtiger, maar niet met Sugarcrm
* Microsoft Office en niet met Open Office

De uitgebreide nederlandstalige gebruikershandleiding van osFinancials is met copyright beschermd, als je hem wilt lezen dan moet je hem kopen. Het ziet er niet heel erg gelikt uit, maar zo hebben boekhouders het graag. We willen je natuurlijk helpen en kunnen vanuit de handleiding van advies dienen.

== Sugarcrm Gebruikershandleiding ==
Sugarcrm documentatie in het nederkands.
* [http://wiki.webhuis.nl/upload/store/handleiding-sugarcrm.pdf Sugarcrm Gebruikershandleiding in het Nederlands]
== Ubuntu Karmic handleiding ==
Zeer uitgebreide handleiding van Ubuntu Karmic.
* http://ubuntuguide.org/wiki/Ubuntu:Karmic
== MediaWiki ==
=== Los gestort ===
* http://www.vanheusden.com/Linux/
* http://www.handleidinghtml.nl/
Wijzigen van de navigatie:
http://wiki.webhuis.nl/index.php?title=MediaWiki:Sidebar&action=edit
Maken van een ruler:
<pre>
<hr/> of <hr />
of
----
</pre>
==== rtfm ====
De betekenis van de afkorting rtfm is als volgt gedefinieerd: Request Tracker FAQ Manager. Het is een Debian package, kijk maar:
<pre>
Package : rtfm
Vulnerability : cross-site scripting
Problem type : remote
Debian-specific: no
CVE ID : CVE-2012-2768

It was discovered that rtfm, the Request Tracker FAQ Manager, contains
multiple cross-site scripting vulnerabilities in the topic
administration page.

For the stable distribution (squeeze), this problem has been fixed in
version 2.4.2-4+squeeze1.

For the testing distribution (wheezy) and the unstable distribution
(sid), this problem has been fixed in version 4.0.6-4 of the
request-tracker4 package.
</pre>
<hr/>
Terug naar: [[Main Page]]

Documentatie

2026-03-26T22:48:39Z

Martin: /* LPI */

== Linux Gebruikershandleiding ==
* [[Media:Lgh-1.5.pdf|Linux Gebruikershandleiding Universiteit Utrecht]]
* [http://steve-parker.org/sh/sh.shtml Bash Scripting Tutorial]
* [http://www.freeos.com/guides/lsst/ Linux Shell Scripting Tutorial v1.05r3 A Beginner's handbook]
* [http://tldp.org/LDP/abs/html/ Advanced Bash-Scripting Guide]
* [http://www.faqs.org/docs/Linux-HOWTO/Bash-Prog-Intro-HOWTO.html Bash programming]

== NLLGG LPI training ==
Quick refs en aanvullende informatie.

== LPI ==
Lesmateriaal voor het behalen van systeembeheer Linux

LPI certification 101
* [[File:l-lpi1-a4.pdf|LPI certification 101 exam prep, Part 1]]
* [[Media:l-lpi1-a4.pdf]]
* [[Media:l-lpi2-a4.pdf|LPI certification 101 exam prep, Part 2]]
* [[Media:l-lpi3-a4.pdf|LPI certification 101 exam prep, Part 3]]
* [https://wiki.webhuis.nl/download/l-lpi3-a4.pdf LPI certification 101 exam prep, Part 2]
* [[Media:l-lpi4-a4.pdf|LPI certification 101 exam prep, Part 4]]

LPI certification 102
* [[Media:l-lpi5-a4.pdf|LPI certification 102 exam prep, Part 1]]
* [[Media:l-lpi6-a4.pdf|LPI certification 102 exam prep, Part 2]]
* [[Media:l-lpi7-a4.pdf|LPI certification 102 exam prep, Part 3]]
* [[Media:l-lpi8-a4.pdf|LPI certification 102 exam prep, Part 4]]

Wat moet je doen?
* Netjes afdrukken
* Gaatjes erdoor
* Per deel in een aparte tab in de map
* Met de map open en de computer aan elk deel doornemen.

Elk deel duurt tussen de 30 en 60 minuten.

== bash ==
* http://www.smachado.com/2009/02/bash-send-a-running-process-to-background/
== osFinancials Gebruikershandleiding ==
osFinancials is een nederlands open source product voor het voeren van boekhoudingen. Het pakket is geschreven in het proprietary Delphi, maar er zijn al modules in open source lazarus pascal ontwikkeld.

osFinancials heeft een ingebouwde interfaces met:
* vtiger, maar niet met Sugarcrm
* Microsoft Office en niet met Open Office

De uitgebreide nederlandstalige gebruikershandleiding van osFinancials is met copyright beschermd, als je hem wilt lezen dan moet je hem kopen. Het ziet er niet heel erg gelikt uit, maar zo hebben boekhouders het graag. We willen je natuurlijk helpen en kunnen vanuit de handleiding van advies dienen.

== Sugarcrm Gebruikershandleiding ==
Sugarcrm documentatie in het nederkands.
* [http://wiki.webhuis.nl/upload/store/handleiding-sugarcrm.pdf Sugarcrm Gebruikershandleiding in het Nederlands]
== Ubuntu Karmic handleiding ==
Zeer uitgebreide handleiding van Ubuntu Karmic.
* http://ubuntuguide.org/wiki/Ubuntu:Karmic
== MediaWiki ==
=== Los gestort ===
* http://www.vanheusden.com/Linux/
* http://www.handleidinghtml.nl/
Wijzigen van de navigatie:
http://wiki.webhuis.nl/index.php?title=MediaWiki:Sidebar&action=edit
Maken van een ruler:
<pre>
<hr/> of <hr />
of
----
</pre>
==== rtfm ====
De betekenis van de afkorting rtfm is als volgt gedefinieerd: Request Tracker FAQ Manager. Het is een Debian package, kijk maar:
<pre>
Package : rtfm
Vulnerability : cross-site scripting
Problem type : remote
Debian-specific: no
CVE ID : CVE-2012-2768

It was discovered that rtfm, the Request Tracker FAQ Manager, contains
multiple cross-site scripting vulnerabilities in the topic
administration page.

For the stable distribution (squeeze), this problem has been fixed in
version 2.4.2-4+squeeze1.

For the testing distribution (wheezy) and the unstable distribution
(sid), this problem has been fixed in version 4.0.6-4 of the
request-tracker4 package.
</pre>
<hr/>
Terug naar: [[Main Page]]

Documentatie

2026-03-26T22:47:40Z

Martin: /* LPI */

== Linux Gebruikershandleiding ==
* [[Media:Lgh-1.5.pdf|Linux Gebruikershandleiding Universiteit Utrecht]]
* [http://steve-parker.org/sh/sh.shtml Bash Scripting Tutorial]
* [http://www.freeos.com/guides/lsst/ Linux Shell Scripting Tutorial v1.05r3 A Beginner's handbook]
* [http://tldp.org/LDP/abs/html/ Advanced Bash-Scripting Guide]
* [http://www.faqs.org/docs/Linux-HOWTO/Bash-Prog-Intro-HOWTO.html Bash programming]

== NLLGG LPI training ==
Quick refs en aanvullende informatie.

== LPI ==
Lesmateriaal voor het behalen van systeembeheer Linux

LPI certification 101
* [[File:l-lpi1-a4.pdf|LPI certification 101 exam prep, Part 1]]
* [[Media:l-lpi1-a4.pdf]]
* [[Media:l-lpi2-a4.pdf|LPI certification 101 exam prep, Part 2]]
* [[Media:l-lpi3-a4.pdf|LPI certification 101 exam prep, Part 3]]
* [http://wiki.webhuis.nl/download/l-lpi3-a4.pdf LPI certification 101 exam prep, Part 2]
* [[Media:l-lpi4-a4.pdf|LPI certification 101 exam prep, Part 4]]

LPI certification 102
* [[Media:l-lpi5-a4.pdf|LPI certification 102 exam prep, Part 1]]
* [[Media:l-lpi6-a4.pdf|LPI certification 102 exam prep, Part 2]]
* [[Media:l-lpi7-a4.pdf|LPI certification 102 exam prep, Part 3]]
* [[Media:l-lpi8-a4.pdf|LPI certification 102 exam prep, Part 4]]

Wat moet je doen?
* Netjes afdrukken
* Gaatjes erdoor
* Per deel in een aparte tab in de map
* Met de map open en de computer aan elk deel doornemen.

Elk deel duurt tussen de 30 en 60 minuten.

== bash ==
* http://www.smachado.com/2009/02/bash-send-a-running-process-to-background/
== osFinancials Gebruikershandleiding ==
osFinancials is een nederlands open source product voor het voeren van boekhoudingen. Het pakket is geschreven in het proprietary Delphi, maar er zijn al modules in open source lazarus pascal ontwikkeld.

osFinancials heeft een ingebouwde interfaces met:
* vtiger, maar niet met Sugarcrm
* Microsoft Office en niet met Open Office

De uitgebreide nederlandstalige gebruikershandleiding van osFinancials is met copyright beschermd, als je hem wilt lezen dan moet je hem kopen. Het ziet er niet heel erg gelikt uit, maar zo hebben boekhouders het graag. We willen je natuurlijk helpen en kunnen vanuit de handleiding van advies dienen.

== Sugarcrm Gebruikershandleiding ==
Sugarcrm documentatie in het nederkands.
* [http://wiki.webhuis.nl/upload/store/handleiding-sugarcrm.pdf Sugarcrm Gebruikershandleiding in het Nederlands]
== Ubuntu Karmic handleiding ==
Zeer uitgebreide handleiding van Ubuntu Karmic.
* http://ubuntuguide.org/wiki/Ubuntu:Karmic
== MediaWiki ==
=== Los gestort ===
* http://www.vanheusden.com/Linux/
* http://www.handleidinghtml.nl/
Wijzigen van de navigatie:
http://wiki.webhuis.nl/index.php?title=MediaWiki:Sidebar&action=edit
Maken van een ruler:
<pre>
<hr/> of <hr />
of
----
</pre>
==== rtfm ====
De betekenis van de afkorting rtfm is als volgt gedefinieerd: Request Tracker FAQ Manager. Het is een Debian package, kijk maar:
<pre>
Package : rtfm
Vulnerability : cross-site scripting
Problem type : remote
Debian-specific: no
CVE ID : CVE-2012-2768

It was discovered that rtfm, the Request Tracker FAQ Manager, contains
multiple cross-site scripting vulnerabilities in the topic
administration page.

For the stable distribution (squeeze), this problem has been fixed in
version 2.4.2-4+squeeze1.

For the testing distribution (wheezy) and the unstable distribution
(sid), this problem has been fixed in version 4.0.6-4 of the
request-tracker4 package.
</pre>
<hr/>
Terug naar: [[Main Page]]

Documentatie

2026-03-26T22:30:46Z

Martin: /* LPI */

== Linux Gebruikershandleiding ==
* [[Media:Lgh-1.5.pdf|Linux Gebruikershandleiding Universiteit Utrecht]]
* [http://steve-parker.org/sh/sh.shtml Bash Scripting Tutorial]
* [http://www.freeos.com/guides/lsst/ Linux Shell Scripting Tutorial v1.05r3 A Beginner's handbook]
* [http://tldp.org/LDP/abs/html/ Advanced Bash-Scripting Guide]
* [http://www.faqs.org/docs/Linux-HOWTO/Bash-Prog-Intro-HOWTO.html Bash programming]

== NLLGG LPI training ==
Quick refs en aanvullende informatie.

== LPI ==
Lesmateriaal voor het behalen van systeembeheer Linux

LPI certification 101
* [[File:l-lpi1-a4.pdf|LPI certification 101 exam prep, Part 1]]
* [[Media:l-lpi1-a4.pdf]]
* [[Media:l-lpi2-a4.pdf|LPI certification 101 exam prep, Part 2]]
* [[Media:l-lpi3-a4.pdf|LPI certification 101 exam prep, Part 3]]
* [[Media:l-lpi4-a4.pdf|LPI certification 101 exam prep, Part 4]]

LPI certification 102
* [[Media:l-lpi5-a4.pdf|LPI certification 102 exam prep, Part 1]]
* [[Media:l-lpi6-a4.pdf|LPI certification 102 exam prep, Part 2]]
* [[Media:l-lpi7-a4.pdf|LPI certification 102 exam prep, Part 3]]
* [[Media:l-lpi8-a4.pdf|LPI certification 102 exam prep, Part 4]]

Wat moet je doen?
* Netjes afdrukken
* Gaatjes erdoor
* Per deel in een aparte tab in de map
* Met de map open en de computer aan elk deel doornemen.

Elk deel duurt tussen de 30 en 60 minuten.
--- [http://wiki.webhuis.nl/upload/store/l-lpi3-a4.pdf LPI certification 101 exam prep, Part 2]

== bash ==
* http://www.smachado.com/2009/02/bash-send-a-running-process-to-background/
== osFinancials Gebruikershandleiding ==
osFinancials is een nederlands open source product voor het voeren van boekhoudingen. Het pakket is geschreven in het proprietary Delphi, maar er zijn al modules in open source lazarus pascal ontwikkeld.

osFinancials heeft een ingebouwde interfaces met:
* vtiger, maar niet met Sugarcrm
* Microsoft Office en niet met Open Office

De uitgebreide nederlandstalige gebruikershandleiding van osFinancials is met copyright beschermd, als je hem wilt lezen dan moet je hem kopen. Het ziet er niet heel erg gelikt uit, maar zo hebben boekhouders het graag. We willen je natuurlijk helpen en kunnen vanuit de handleiding van advies dienen.

== Sugarcrm Gebruikershandleiding ==
Sugarcrm documentatie in het nederkands.
* [http://wiki.webhuis.nl/upload/store/handleiding-sugarcrm.pdf Sugarcrm Gebruikershandleiding in het Nederlands]
== Ubuntu Karmic handleiding ==
Zeer uitgebreide handleiding van Ubuntu Karmic.
* http://ubuntuguide.org/wiki/Ubuntu:Karmic
== MediaWiki ==
=== Los gestort ===
* http://www.vanheusden.com/Linux/
* http://www.handleidinghtml.nl/
Wijzigen van de navigatie:
http://wiki.webhuis.nl/index.php?title=MediaWiki:Sidebar&action=edit
Maken van een ruler:
<pre>
<hr/> of <hr />
of
----
</pre>
==== rtfm ====
De betekenis van de afkorting rtfm is als volgt gedefinieerd: Request Tracker FAQ Manager. Het is een Debian package, kijk maar:
<pre>
Package : rtfm
Vulnerability : cross-site scripting
Problem type : remote
Debian-specific: no
CVE ID : CVE-2012-2768

It was discovered that rtfm, the Request Tracker FAQ Manager, contains
multiple cross-site scripting vulnerabilities in the topic
administration page.

For the stable distribution (squeeze), this problem has been fixed in
version 2.4.2-4+squeeze1.

For the testing distribution (wheezy) and the unstable distribution
(sid), this problem has been fixed in version 4.0.6-4 of the
request-tracker4 package.
</pre>
<hr/>
Terug naar: [[Main Page]]

Documentatie

2026-03-26T22:14:18Z

Martin: /* LPI */

== Linux Gebruikershandleiding ==
* [[Media:Lgh-1.5.pdf|Linux Gebruikershandleiding Universiteit Utrecht]]
* [http://steve-parker.org/sh/sh.shtml Bash Scripting Tutorial]
* [http://www.freeos.com/guides/lsst/ Linux Shell Scripting Tutorial v1.05r3 A Beginner's handbook]
* [http://tldp.org/LDP/abs/html/ Advanced Bash-Scripting Guide]
* [http://www.faqs.org/docs/Linux-HOWTO/Bash-Prog-Intro-HOWTO.html Bash programming]

== NLLGG LPI training ==
Quick refs en aanvullende informatie.

== LPI ==
Lesmateriaal voor het behalen van systeembeheer Linux

LPI certification 101
* [[Media:l-lpi1-a4.pdf|LPI certification 101 exam prep, Part 1]]
* [[Media:l-lpi1-a4.pdf]]
* [[Media:l-lpi2-a4.pdf|LPI certification 101 exam prep, Part 2]]
* [[Media:l-lpi3-a4.pdf|LPI certification 101 exam prep, Part 3]]
* [[Media:l-lpi4-a4.pdf|LPI certification 101 exam prep, Part 4]]

LPI certification 102
* [[Media:l-lpi5-a4.pdf|LPI certification 102 exam prep, Part 1]]
* [[Media:l-lpi6-a4.pdf|LPI certification 102 exam prep, Part 2]]
* [[Media:l-lpi7-a4.pdf|LPI certification 102 exam prep, Part 3]]
* [[Media:l-lpi8-a4.pdf|LPI certification 102 exam prep, Part 4]]

Wat moet je doen?
* Netjes afdrukken
* Gaatjes erdoor
* Per deel in een aparte tab in de map
* Met de map open en de computer aan elk deel doornemen.

Elk deel duurt tussen de 30 en 60 minuten.
--- [http://wiki.webhuis.nl/upload/store/l-lpi3-a4.pdf LPI certification 101 exam prep, Part 2]

== bash ==
* http://www.smachado.com/2009/02/bash-send-a-running-process-to-background/
== osFinancials Gebruikershandleiding ==
osFinancials is een nederlands open source product voor het voeren van boekhoudingen. Het pakket is geschreven in het proprietary Delphi, maar er zijn al modules in open source lazarus pascal ontwikkeld.

osFinancials heeft een ingebouwde interfaces met:
* vtiger, maar niet met Sugarcrm
* Microsoft Office en niet met Open Office

De uitgebreide nederlandstalige gebruikershandleiding van osFinancials is met copyright beschermd, als je hem wilt lezen dan moet je hem kopen. Het ziet er niet heel erg gelikt uit, maar zo hebben boekhouders het graag. We willen je natuurlijk helpen en kunnen vanuit de handleiding van advies dienen.

== Sugarcrm Gebruikershandleiding ==
Sugarcrm documentatie in het nederkands.
* [http://wiki.webhuis.nl/upload/store/handleiding-sugarcrm.pdf Sugarcrm Gebruikershandleiding in het Nederlands]
== Ubuntu Karmic handleiding ==
Zeer uitgebreide handleiding van Ubuntu Karmic.
* http://ubuntuguide.org/wiki/Ubuntu:Karmic
== MediaWiki ==
=== Los gestort ===
* http://www.vanheusden.com/Linux/
* http://www.handleidinghtml.nl/
Wijzigen van de navigatie:
http://wiki.webhuis.nl/index.php?title=MediaWiki:Sidebar&action=edit
Maken van een ruler:
<pre>
<hr/> of <hr />
of
----
</pre>
==== rtfm ====
De betekenis van de afkorting rtfm is als volgt gedefinieerd: Request Tracker FAQ Manager. Het is een Debian package, kijk maar:
<pre>
Package : rtfm
Vulnerability : cross-site scripting
Problem type : remote
Debian-specific: no
CVE ID : CVE-2012-2768

It was discovered that rtfm, the Request Tracker FAQ Manager, contains
multiple cross-site scripting vulnerabilities in the topic
administration page.

For the stable distribution (squeeze), this problem has been fixed in
version 2.4.2-4+squeeze1.

For the testing distribution (wheezy) and the unstable distribution
(sid), this problem has been fixed in version 4.0.6-4 of the
request-tracker4 package.
</pre>
<hr/>
Terug naar: [[Main Page]]

Documentatie

2026-03-26T22:10:01Z

Martin: /* LPI */

== Linux Gebruikershandleiding ==
* [[Media:Lgh-1.5.pdf|Linux Gebruikershandleiding Universiteit Utrecht]]
* [http://steve-parker.org/sh/sh.shtml Bash Scripting Tutorial]
* [http://www.freeos.com/guides/lsst/ Linux Shell Scripting Tutorial v1.05r3 A Beginner's handbook]
* [http://tldp.org/LDP/abs/html/ Advanced Bash-Scripting Guide]
* [http://www.faqs.org/docs/Linux-HOWTO/Bash-Prog-Intro-HOWTO.html Bash programming]

== NLLGG LPI training ==
Quick refs en aanvullende informatie.

== LPI ==
Lesmateriaal voor het behalen van systeembeheer Linux

LPI certification 101
* [[Media:l-lpi1-a4.pdf|LPI certification 101 exam prep, Part 1]]
* [[Media:l-lpi2-a4.pdf|LPI certification 101 exam prep, Part 2]]
* [[Media:l-lpi3-a4.pdf|LPI certification 101 exam prep, Part 3]]
* [[Media:l-lpi4-a4.pdf|LPI certification 101 exam prep, Part 4]]

LPI certification 102
* [[Media:l-lpi5-a4.pdf|LPI certification 102 exam prep, Part 1]]
* [[Media:l-lpi6-a4.pdf|LPI certification 102 exam prep, Part 2]]
* [[Media:l-lpi7-a4.pdf|LPI certification 102 exam prep, Part 3]]
* [[Media:l-lpi8-a4.pdf|LPI certification 102 exam prep, Part 4]]

Wat moet je doen?
* Netjes afdrukken
* Gaatjes erdoor
* Per deel in een aparte tab in de map
* Met de map open en de computer aan elk deel doornemen.

Elk deel duurt tussen de 30 en 60 minuten.
--- [http://wiki.webhuis.nl/upload/store/l-lpi3-a4.pdf LPI certification 101 exam prep, Part 2]

== bash ==
* http://www.smachado.com/2009/02/bash-send-a-running-process-to-background/
== osFinancials Gebruikershandleiding ==
osFinancials is een nederlands open source product voor het voeren van boekhoudingen. Het pakket is geschreven in het proprietary Delphi, maar er zijn al modules in open source lazarus pascal ontwikkeld.

osFinancials heeft een ingebouwde interfaces met:
* vtiger, maar niet met Sugarcrm
* Microsoft Office en niet met Open Office

De uitgebreide nederlandstalige gebruikershandleiding van osFinancials is met copyright beschermd, als je hem wilt lezen dan moet je hem kopen. Het ziet er niet heel erg gelikt uit, maar zo hebben boekhouders het graag. We willen je natuurlijk helpen en kunnen vanuit de handleiding van advies dienen.

== Sugarcrm Gebruikershandleiding ==
Sugarcrm documentatie in het nederkands.
* [http://wiki.webhuis.nl/upload/store/handleiding-sugarcrm.pdf Sugarcrm Gebruikershandleiding in het Nederlands]
== Ubuntu Karmic handleiding ==
Zeer uitgebreide handleiding van Ubuntu Karmic.
* http://ubuntuguide.org/wiki/Ubuntu:Karmic
== MediaWiki ==
=== Los gestort ===
* http://www.vanheusden.com/Linux/
* http://www.handleidinghtml.nl/
Wijzigen van de navigatie:
http://wiki.webhuis.nl/index.php?title=MediaWiki:Sidebar&action=edit
Maken van een ruler:
<pre>
<hr/> of <hr />
of
----
</pre>
==== rtfm ====
De betekenis van de afkorting rtfm is als volgt gedefinieerd: Request Tracker FAQ Manager. Het is een Debian package, kijk maar:
<pre>
Package : rtfm
Vulnerability : cross-site scripting
Problem type : remote
Debian-specific: no
CVE ID : CVE-2012-2768

It was discovered that rtfm, the Request Tracker FAQ Manager, contains
multiple cross-site scripting vulnerabilities in the topic
administration page.

For the stable distribution (squeeze), this problem has been fixed in
version 2.4.2-4+squeeze1.

For the testing distribution (wheezy) and the unstable distribution
(sid), this problem has been fixed in version 4.0.6-4 of the
request-tracker4 package.
</pre>
<hr/>
Terug naar: [[Main Page]]

Documentatie

2026-03-26T22:08:31Z

Martin: /* LPI */

== Linux Gebruikershandleiding ==
* [[Media:Lgh-1.5.pdf|Linux Gebruikershandleiding Universiteit Utrecht]]
* [http://steve-parker.org/sh/sh.shtml Bash Scripting Tutorial]
* [http://www.freeos.com/guides/lsst/ Linux Shell Scripting Tutorial v1.05r3 A Beginner's handbook]
* [http://tldp.org/LDP/abs/html/ Advanced Bash-Scripting Guide]
* [http://www.faqs.org/docs/Linux-HOWTO/Bash-Prog-Intro-HOWTO.html Bash programming]

== NLLGG LPI training ==
Quick refs en aanvullende informatie.

== LPI ==
Lesmateriaal voor het behalen van systeembeheer Linux

LPI certification 101
* [[:File:l-lpi1-a4.pdf|LPI certification 101 exam prep, Part 1]]
* [[Media:l-lpi2-a4.pdf|LPI certification 101 exam prep, Part 2]]
* [[Media:l-lpi3-a4.pdf|LPI certification 101 exam prep, Part 3]]
* [[Media:l-lpi4-a4.pdf|LPI certification 101 exam prep, Part 4]]

LPI certification 102
* [[Media:l-lpi5-a4.pdf|LPI certification 102 exam prep, Part 1]]
* [[Media:l-lpi6-a4.pdf|LPI certification 102 exam prep, Part 2]]
* [[Media:l-lpi7-a4.pdf|LPI certification 102 exam prep, Part 3]]
* [[Media:l-lpi8-a4.pdf|LPI certification 102 exam prep, Part 4]]

Wat moet je doen?
* Netjes afdrukken
* Gaatjes erdoor
* Per deel in een aparte tab in de map
* Met de map open en de computer aan elk deel doornemen.

Elk deel duurt tussen de 30 en 60 minuten.
--- [http://wiki.webhuis.nl/upload/store/l-lpi3-a4.pdf LPI certification 101 exam prep, Part 2]

== bash ==
* http://www.smachado.com/2009/02/bash-send-a-running-process-to-background/
== osFinancials Gebruikershandleiding ==
osFinancials is een nederlands open source product voor het voeren van boekhoudingen. Het pakket is geschreven in het proprietary Delphi, maar er zijn al modules in open source lazarus pascal ontwikkeld.

osFinancials heeft een ingebouwde interfaces met:
* vtiger, maar niet met Sugarcrm
* Microsoft Office en niet met Open Office

De uitgebreide nederlandstalige gebruikershandleiding van osFinancials is met copyright beschermd, als je hem wilt lezen dan moet je hem kopen. Het ziet er niet heel erg gelikt uit, maar zo hebben boekhouders het graag. We willen je natuurlijk helpen en kunnen vanuit de handleiding van advies dienen.

== Sugarcrm Gebruikershandleiding ==
Sugarcrm documentatie in het nederkands.
* [http://wiki.webhuis.nl/upload/store/handleiding-sugarcrm.pdf Sugarcrm Gebruikershandleiding in het Nederlands]
== Ubuntu Karmic handleiding ==
Zeer uitgebreide handleiding van Ubuntu Karmic.
* http://ubuntuguide.org/wiki/Ubuntu:Karmic
== MediaWiki ==
=== Los gestort ===
* http://www.vanheusden.com/Linux/
* http://www.handleidinghtml.nl/
Wijzigen van de navigatie:
http://wiki.webhuis.nl/index.php?title=MediaWiki:Sidebar&action=edit
Maken van een ruler:
<pre>
<hr/> of <hr />
of
----
</pre>
==== rtfm ====
De betekenis van de afkorting rtfm is als volgt gedefinieerd: Request Tracker FAQ Manager. Het is een Debian package, kijk maar:
<pre>
Package : rtfm
Vulnerability : cross-site scripting
Problem type : remote
Debian-specific: no
CVE ID : CVE-2012-2768

It was discovered that rtfm, the Request Tracker FAQ Manager, contains
multiple cross-site scripting vulnerabilities in the topic
administration page.

For the stable distribution (squeeze), this problem has been fixed in
version 2.4.2-4+squeeze1.

For the testing distribution (wheezy) and the unstable distribution
(sid), this problem has been fixed in version 4.0.6-4 of the
request-tracker4 package.
</pre>
<hr/>
Terug naar: [[Main Page]]

Documentatie

2026-03-26T22:08:03Z

Martin: /* LPI */

== Linux Gebruikershandleiding ==
* [[Media:Lgh-1.5.pdf|Linux Gebruikershandleiding Universiteit Utrecht]]
* [http://steve-parker.org/sh/sh.shtml Bash Scripting Tutorial]
* [http://www.freeos.com/guides/lsst/ Linux Shell Scripting Tutorial v1.05r3 A Beginner's handbook]
* [http://tldp.org/LDP/abs/html/ Advanced Bash-Scripting Guide]
* [http://www.faqs.org/docs/Linux-HOWTO/Bash-Prog-Intro-HOWTO.html Bash programming]

== NLLGG LPI training ==
Quick refs en aanvullende informatie.

== LPI ==
Lesmateriaal voor het behalen van systeembeheer Linux

LPI certification 101
* [[:File:images/l-lpi1-a4.pdf|LPI certification 101 exam prep, Part 1]]
* [[Media:l-lpi2-a4.pdf|LPI certification 101 exam prep, Part 2]]
* [[Media:l-lpi3-a4.pdf|LPI certification 101 exam prep, Part 3]]
* [[Media:l-lpi4-a4.pdf|LPI certification 101 exam prep, Part 4]]

LPI certification 102
* [[Media:l-lpi5-a4.pdf|LPI certification 102 exam prep, Part 1]]
* [[Media:l-lpi6-a4.pdf|LPI certification 102 exam prep, Part 2]]
* [[Media:l-lpi7-a4.pdf|LPI certification 102 exam prep, Part 3]]
* [[Media:l-lpi8-a4.pdf|LPI certification 102 exam prep, Part 4]]

Wat moet je doen?
* Netjes afdrukken
* Gaatjes erdoor
* Per deel in een aparte tab in de map
* Met de map open en de computer aan elk deel doornemen.

Elk deel duurt tussen de 30 en 60 minuten.
--- [http://wiki.webhuis.nl/upload/store/l-lpi3-a4.pdf LPI certification 101 exam prep, Part 2]

== bash ==
* http://www.smachado.com/2009/02/bash-send-a-running-process-to-background/
== osFinancials Gebruikershandleiding ==
osFinancials is een nederlands open source product voor het voeren van boekhoudingen. Het pakket is geschreven in het proprietary Delphi, maar er zijn al modules in open source lazarus pascal ontwikkeld.

osFinancials heeft een ingebouwde interfaces met:
* vtiger, maar niet met Sugarcrm
* Microsoft Office en niet met Open Office

De uitgebreide nederlandstalige gebruikershandleiding van osFinancials is met copyright beschermd, als je hem wilt lezen dan moet je hem kopen. Het ziet er niet heel erg gelikt uit, maar zo hebben boekhouders het graag. We willen je natuurlijk helpen en kunnen vanuit de handleiding van advies dienen.

== Sugarcrm Gebruikershandleiding ==
Sugarcrm documentatie in het nederkands.
* [http://wiki.webhuis.nl/upload/store/handleiding-sugarcrm.pdf Sugarcrm Gebruikershandleiding in het Nederlands]
== Ubuntu Karmic handleiding ==
Zeer uitgebreide handleiding van Ubuntu Karmic.
* http://ubuntuguide.org/wiki/Ubuntu:Karmic
== MediaWiki ==
=== Los gestort ===
* http://www.vanheusden.com/Linux/
* http://www.handleidinghtml.nl/
Wijzigen van de navigatie:
http://wiki.webhuis.nl/index.php?title=MediaWiki:Sidebar&action=edit
Maken van een ruler:
<pre>
<hr/> of <hr />
of
----
</pre>
==== rtfm ====
De betekenis van de afkorting rtfm is als volgt gedefinieerd: Request Tracker FAQ Manager. Het is een Debian package, kijk maar:
<pre>
Package : rtfm
Vulnerability : cross-site scripting
Problem type : remote
Debian-specific: no
CVE ID : CVE-2012-2768

It was discovered that rtfm, the Request Tracker FAQ Manager, contains
multiple cross-site scripting vulnerabilities in the topic
administration page.

For the stable distribution (squeeze), this problem has been fixed in
version 2.4.2-4+squeeze1.

For the testing distribution (wheezy) and the unstable distribution
(sid), this problem has been fixed in version 4.0.6-4 of the
request-tracker4 package.
</pre>
<hr/>
Terug naar: [[Main Page]]

Documentatie

2026-03-26T22:05:17Z

Martin: /* LPI */

== Linux Gebruikershandleiding ==
* [[Media:Lgh-1.5.pdf|Linux Gebruikershandleiding Universiteit Utrecht]]
* [http://steve-parker.org/sh/sh.shtml Bash Scripting Tutorial]
* [http://www.freeos.com/guides/lsst/ Linux Shell Scripting Tutorial v1.05r3 A Beginner's handbook]
* [http://tldp.org/LDP/abs/html/ Advanced Bash-Scripting Guide]
* [http://www.faqs.org/docs/Linux-HOWTO/Bash-Prog-Intro-HOWTO.html Bash programming]

== NLLGG LPI training ==
Quick refs en aanvullende informatie.

== LPI ==
Lesmateriaal voor het behalen van systeembeheer Linux

LPI certification 101
* [[File:images/l-lpi1-a4.pdf|LPI certification 101 exam prep, Part 1]]
* [[Media:l-lpi2-a4.pdf|LPI certification 101 exam prep, Part 2]]
* [[Media:l-lpi3-a4.pdf|LPI certification 101 exam prep, Part 3]]
* [[Media:l-lpi4-a4.pdf|LPI certification 101 exam prep, Part 4]]

LPI certification 102
* [[Media:l-lpi5-a4.pdf|LPI certification 102 exam prep, Part 1]]
* [[Media:l-lpi6-a4.pdf|LPI certification 102 exam prep, Part 2]]
* [[Media:l-lpi7-a4.pdf|LPI certification 102 exam prep, Part 3]]
* [[Media:l-lpi8-a4.pdf|LPI certification 102 exam prep, Part 4]]

Wat moet je doen?
* Netjes afdrukken
* Gaatjes erdoor
* Per deel in een aparte tab in de map
* Met de map open en de computer aan elk deel doornemen.

Elk deel duurt tussen de 30 en 60 minuten.
--- [http://wiki.webhuis.nl/upload/store/l-lpi3-a4.pdf LPI certification 101 exam prep, Part 2]

== bash ==
* http://www.smachado.com/2009/02/bash-send-a-running-process-to-background/
== osFinancials Gebruikershandleiding ==
osFinancials is een nederlands open source product voor het voeren van boekhoudingen. Het pakket is geschreven in het proprietary Delphi, maar er zijn al modules in open source lazarus pascal ontwikkeld.

osFinancials heeft een ingebouwde interfaces met:
* vtiger, maar niet met Sugarcrm
* Microsoft Office en niet met Open Office

De uitgebreide nederlandstalige gebruikershandleiding van osFinancials is met copyright beschermd, als je hem wilt lezen dan moet je hem kopen. Het ziet er niet heel erg gelikt uit, maar zo hebben boekhouders het graag. We willen je natuurlijk helpen en kunnen vanuit de handleiding van advies dienen.

== Sugarcrm Gebruikershandleiding ==
Sugarcrm documentatie in het nederkands.
* [http://wiki.webhuis.nl/upload/store/handleiding-sugarcrm.pdf Sugarcrm Gebruikershandleiding in het Nederlands]
== Ubuntu Karmic handleiding ==
Zeer uitgebreide handleiding van Ubuntu Karmic.
* http://ubuntuguide.org/wiki/Ubuntu:Karmic
== MediaWiki ==
=== Los gestort ===
* http://www.vanheusden.com/Linux/
* http://www.handleidinghtml.nl/
Wijzigen van de navigatie:
http://wiki.webhuis.nl/index.php?title=MediaWiki:Sidebar&action=edit
Maken van een ruler:
<pre>
<hr/> of <hr />
of
----
</pre>
==== rtfm ====
De betekenis van de afkorting rtfm is als volgt gedefinieerd: Request Tracker FAQ Manager. Het is een Debian package, kijk maar:
<pre>
Package : rtfm
Vulnerability : cross-site scripting
Problem type : remote
Debian-specific: no
CVE ID : CVE-2012-2768

It was discovered that rtfm, the Request Tracker FAQ Manager, contains
multiple cross-site scripting vulnerabilities in the topic
administration page.

For the stable distribution (squeeze), this problem has been fixed in
version 2.4.2-4+squeeze1.

For the testing distribution (wheezy) and the unstable distribution
(sid), this problem has been fixed in version 4.0.6-4 of the
request-tracker4 package.
</pre>
<hr/>
Terug naar: [[Main Page]]

Documentatie

2026-03-26T22:04:22Z

Martin: /* LPI */

== Linux Gebruikershandleiding ==
* [[Media:Lgh-1.5.pdf|Linux Gebruikershandleiding Universiteit Utrecht]]
* [http://steve-parker.org/sh/sh.shtml Bash Scripting Tutorial]
* [http://www.freeos.com/guides/lsst/ Linux Shell Scripting Tutorial v1.05r3 A Beginner's handbook]
* [http://tldp.org/LDP/abs/html/ Advanced Bash-Scripting Guide]
* [http://www.faqs.org/docs/Linux-HOWTO/Bash-Prog-Intro-HOWTO.html Bash programming]

== NLLGG LPI training ==
Quick refs en aanvullende informatie.

== LPI ==
Lesmateriaal voor het behalen van systeembeheer Linux

LPI certification 101
* [[File:l-lpi1-a4.pdf|LPI certification 101 exam prep, Part 1]]
* [[Media:l-lpi2-a4.pdf|LPI certification 101 exam prep, Part 2]]
* [[Media:l-lpi3-a4.pdf|LPI certification 101 exam prep, Part 3]]
* [[Media:l-lpi4-a4.pdf|LPI certification 101 exam prep, Part 4]]

LPI certification 102
* [[Media:l-lpi5-a4.pdf|LPI certification 102 exam prep, Part 1]]
* [[Media:l-lpi6-a4.pdf|LPI certification 102 exam prep, Part 2]]
* [[Media:l-lpi7-a4.pdf|LPI certification 102 exam prep, Part 3]]
* [[Media:l-lpi8-a4.pdf|LPI certification 102 exam prep, Part 4]]

Wat moet je doen?
* Netjes afdrukken
* Gaatjes erdoor
* Per deel in een aparte tab in de map
* Met de map open en de computer aan elk deel doornemen.

Elk deel duurt tussen de 30 en 60 minuten.
--- [http://wiki.webhuis.nl/upload/store/l-lpi3-a4.pdf LPI certification 101 exam prep, Part 2]

== bash ==
* http://www.smachado.com/2009/02/bash-send-a-running-process-to-background/
== osFinancials Gebruikershandleiding ==
osFinancials is een nederlands open source product voor het voeren van boekhoudingen. Het pakket is geschreven in het proprietary Delphi, maar er zijn al modules in open source lazarus pascal ontwikkeld.

osFinancials heeft een ingebouwde interfaces met:
* vtiger, maar niet met Sugarcrm
* Microsoft Office en niet met Open Office

De uitgebreide nederlandstalige gebruikershandleiding van osFinancials is met copyright beschermd, als je hem wilt lezen dan moet je hem kopen. Het ziet er niet heel erg gelikt uit, maar zo hebben boekhouders het graag. We willen je natuurlijk helpen en kunnen vanuit de handleiding van advies dienen.

== Sugarcrm Gebruikershandleiding ==
Sugarcrm documentatie in het nederkands.
* [http://wiki.webhuis.nl/upload/store/handleiding-sugarcrm.pdf Sugarcrm Gebruikershandleiding in het Nederlands]
== Ubuntu Karmic handleiding ==
Zeer uitgebreide handleiding van Ubuntu Karmic.
* http://ubuntuguide.org/wiki/Ubuntu:Karmic
== MediaWiki ==
=== Los gestort ===
* http://www.vanheusden.com/Linux/
* http://www.handleidinghtml.nl/
Wijzigen van de navigatie:
http://wiki.webhuis.nl/index.php?title=MediaWiki:Sidebar&action=edit
Maken van een ruler:
<pre>
<hr/> of <hr />
of
----
</pre>
==== rtfm ====
De betekenis van de afkorting rtfm is als volgt gedefinieerd: Request Tracker FAQ Manager. Het is een Debian package, kijk maar:
<pre>
Package : rtfm
Vulnerability : cross-site scripting
Problem type : remote
Debian-specific: no
CVE ID : CVE-2012-2768

It was discovered that rtfm, the Request Tracker FAQ Manager, contains
multiple cross-site scripting vulnerabilities in the topic
administration page.

For the stable distribution (squeeze), this problem has been fixed in
version 2.4.2-4+squeeze1.

For the testing distribution (wheezy) and the unstable distribution
(sid), this problem has been fixed in version 4.0.6-4 of the
request-tracker4 package.
</pre>
<hr/>
Terug naar: [[Main Page]]

Documentatie

2026-03-26T21:58:01Z

Martin:

== Linux Gebruikershandleiding ==
* [[Media:Lgh-1.5.pdf|Linux Gebruikershandleiding Universiteit Utrecht]]
* [http://steve-parker.org/sh/sh.shtml Bash Scripting Tutorial]
* [http://www.freeos.com/guides/lsst/ Linux Shell Scripting Tutorial v1.05r3 A Beginner's handbook]
* [http://tldp.org/LDP/abs/html/ Advanced Bash-Scripting Guide]
* [http://www.faqs.org/docs/Linux-HOWTO/Bash-Prog-Intro-HOWTO.html Bash programming]

== NLLGG LPI training ==
Quick refs en aanvullende informatie.

== LPI ==
Lesmateriaal voor het behalen van systeembeheer Linux

LPI certification 101
* [[Media:l-lpi1-a4.pdf|LPI certification 101 exam prep, Part 1]]
* [[Media:l-lpi2-a4.pdf|LPI certification 101 exam prep, Part 2]]
* [[Media:l-lpi3-a4.pdf|LPI certification 101 exam prep, Part 3]]
* [[Media:l-lpi4-a4.pdf|LPI certification 101 exam prep, Part 4]]

LPI certification 102
* [[Media:l-lpi5-a4.pdf|LPI certification 102 exam prep, Part 1]]
* [[Media:l-lpi6-a4.pdf|LPI certification 102 exam prep, Part 2]]
* [[Media:l-lpi7-a4.pdf|LPI certification 102 exam prep, Part 3]]
* [[Media:l-lpi8-a4.pdf|LPI certification 102 exam prep, Part 4]]

Wat moet je doen?
* Netjes afdrukken
* Gaatjes erdoor
* Per deel in een aparte tab in de map
* Met de map open en de computer aan elk deel doornemen.

Elk deel duurt tussen de 30 en 60 minuten.
--- [http://wiki.webhuis.nl/upload/store/l-lpi3-a4.pdf LPI certification 101 exam prep, Part 2]

== bash ==
* http://www.smachado.com/2009/02/bash-send-a-running-process-to-background/
== osFinancials Gebruikershandleiding ==
osFinancials is een nederlands open source product voor het voeren van boekhoudingen. Het pakket is geschreven in het proprietary Delphi, maar er zijn al modules in open source lazarus pascal ontwikkeld.

osFinancials heeft een ingebouwde interfaces met:
* vtiger, maar niet met Sugarcrm
* Microsoft Office en niet met Open Office

De uitgebreide nederlandstalige gebruikershandleiding van osFinancials is met copyright beschermd, als je hem wilt lezen dan moet je hem kopen. Het ziet er niet heel erg gelikt uit, maar zo hebben boekhouders het graag. We willen je natuurlijk helpen en kunnen vanuit de handleiding van advies dienen.

== Sugarcrm Gebruikershandleiding ==
Sugarcrm documentatie in het nederkands.
* [http://wiki.webhuis.nl/upload/store/handleiding-sugarcrm.pdf Sugarcrm Gebruikershandleiding in het Nederlands]
== Ubuntu Karmic handleiding ==
Zeer uitgebreide handleiding van Ubuntu Karmic.
* http://ubuntuguide.org/wiki/Ubuntu:Karmic
== MediaWiki ==
=== Los gestort ===
* http://www.vanheusden.com/Linux/
* http://www.handleidinghtml.nl/
Wijzigen van de navigatie:
http://wiki.webhuis.nl/index.php?title=MediaWiki:Sidebar&action=edit
Maken van een ruler:
<pre>
<hr/> of <hr />
of
----
</pre>
==== rtfm ====
De betekenis van de afkorting rtfm is als volgt gedefinieerd: Request Tracker FAQ Manager. Het is een Debian package, kijk maar:
<pre>
Package : rtfm
Vulnerability : cross-site scripting
Problem type : remote
Debian-specific: no
CVE ID : CVE-2012-2768

It was discovered that rtfm, the Request Tracker FAQ Manager, contains
multiple cross-site scripting vulnerabilities in the topic
administration page.

For the stable distribution (squeeze), this problem has been fixed in
version 2.4.2-4+squeeze1.

For the testing distribution (wheezy) and the unstable distribution
(sid), this problem has been fixed in version 4.0.6-4 of the
request-tracker4 package.
</pre>
<hr/>
Terug naar: [[Main Page]]

Documentatie

2026-03-26T21:57:40Z

Martin:

== Linux Gebruikershandleiding ==
* [[Media:Lgh-1.5.pdf|Linux Gebruikershandleiding Universiteit Utrecht]]
* [http://steve-parker.org/sh/sh.shtml Bash Scripting Tutorial]
* [http://www.freeos.com/guides/lsst/ Linux Shell Scripting Tutorial v1.05r3 A Beginner's handbook]
* [http://tldp.org/LDP/abs/html/ Advanced Bash-Scripting Guide]
* [http://www.faqs.org/docs/Linux-HOWTO/Bash-Prog-Intro-HOWTO.html Bash programming]

== NLLGG LPI training ==
Quick refs en aanvullende informatie.

== LPI ==
Lesmateriaal voor het behalen van systeembeheer Linux

LPI certification 101
* [[Media:l-lpi1-a4.pdf|LPI certification 101 exam prep, Part 1]]
* [[Media:l-lpi2-a4.pdf|LPI certification 101 exam prep, Part 2]]
* [[Media:l-lpi3-a4.pdf|LPI certification 101 exam prep, Part 3]]
* [[Media:l-lpi4-a4.pdf|LPI certification 101 exam prep, Part 4]]

LPI certification 102
* [[Media:l-lpi5-a4.pdf|LPI certification 102 exam prep, Part 1]]
* [[Media:l-lpi6-a4.pdf|LPI certification 102 exam prep, Part 2]]
* [[Media:l-lpi7-a4.pdf|LPI certification 102 exam prep, Part 3]]
* [[Media:l-lpi8-a4.pdf|LPI certification 102 exam prep, Part 4]]

Wat moet je doen?
* Netjes afdrukken
* Gaatjes erdoor
* Per deel in een aparte tab in de map
* Met de map open en de computer aan elk deel doornemen.

Elk deel duurt tussen de 30 en 60 minuten.
#* [http://wiki.webhuis.nl/upload/store/l-lpi3-a4.pdf LPI certification 101 exam prep, Part 2]

== bash ==
* http://www.smachado.com/2009/02/bash-send-a-running-process-to-background/
== osFinancials Gebruikershandleiding ==
osFinancials is een nederlands open source product voor het voeren van boekhoudingen. Het pakket is geschreven in het proprietary Delphi, maar er zijn al modules in open source lazarus pascal ontwikkeld.

osFinancials heeft een ingebouwde interfaces met:
* vtiger, maar niet met Sugarcrm
* Microsoft Office en niet met Open Office

De uitgebreide nederlandstalige gebruikershandleiding van osFinancials is met copyright beschermd, als je hem wilt lezen dan moet je hem kopen. Het ziet er niet heel erg gelikt uit, maar zo hebben boekhouders het graag. We willen je natuurlijk helpen en kunnen vanuit de handleiding van advies dienen.

== Sugarcrm Gebruikershandleiding ==
Sugarcrm documentatie in het nederkands.
* [http://wiki.webhuis.nl/upload/store/handleiding-sugarcrm.pdf Sugarcrm Gebruikershandleiding in het Nederlands]
== Ubuntu Karmic handleiding ==
Zeer uitgebreide handleiding van Ubuntu Karmic.
* http://ubuntuguide.org/wiki/Ubuntu:Karmic
== MediaWiki ==
=== Los gestort ===
* http://www.vanheusden.com/Linux/
* http://www.handleidinghtml.nl/
Wijzigen van de navigatie:
http://wiki.webhuis.nl/index.php?title=MediaWiki:Sidebar&action=edit
Maken van een ruler:
<pre>
<hr/> of <hr />
of
----
</pre>
==== rtfm ====
De betekenis van de afkorting rtfm is als volgt gedefinieerd: Request Tracker FAQ Manager. Het is een Debian package, kijk maar:
<pre>
Package : rtfm
Vulnerability : cross-site scripting
Problem type : remote
Debian-specific: no
CVE ID : CVE-2012-2768

It was discovered that rtfm, the Request Tracker FAQ Manager, contains
multiple cross-site scripting vulnerabilities in the topic
administration page.

For the stable distribution (squeeze), this problem has been fixed in
version 2.4.2-4+squeeze1.

For the testing distribution (wheezy) and the unstable distribution
(sid), this problem has been fixed in version 4.0.6-4 of the
request-tracker4 package.
</pre>
<hr/>
Terug naar: [[Main Page]]

Control flow

2026-03-25T16:50:42Z

Martin: Created page with " = Control Flow = '''Project:''' pgcobol — Prime Numbers Application '''Version:''' 1.0 (reverse-engineered) '''Date:''' 2026-03-17 ----- == 1. Conventions == * '''PERFORM''' — synchronous paragraph call; returns to the next statement after the PERFORM. * '''CALL''' — dynamic subprogram call; passes a data block by reference; returns via EXIT PROGRAM. * '''EVALUATE TRUE''' — multi-way..."

= Control Flow =

'''Project:''' pgcobol — Prime Numbers Application 
'''Version:''' 1.0 (reverse-engineered) 
'''Date:''' 2026-03-17

-----


== 1. Conventions ==

* '''PERFORM''' — synchronous paragraph call; returns to the next statement after the PERFORM.
* '''CALL''' — dynamic subprogram call; passes a data block by reference; returns via EXIT PROGRAM.
* '''EVALUATE TRUE''' — multi-way branch on 88-level conditions; equivalent to a CASE statement.
* '''PERFORM … UNTIL''' — loop; condition tested before each iteration (DO-WHILE in reverse — test first).

-----


== 2. primesmain — Paragraph Map ==

<pre>PROCEDURE DIVISION
│
├── ACCEPT / MOVE setup
├── PERFORM r90-start-session ──────────────────────────────► r90-start-session
│ │ CALL primesui "start"
│ │ IF ok: CALL primesui "log-message" ×2
│ │ ELSE: DISPLAY + STOP RUN
│ └── return
│
├── EVALUATE TRUE
│ WHEN report-primes ──────────────────────────────────────► CALL primesui "log-message"
│ │ PERFORM r92-generate-primes ──► r92-generate-primes
│ │ │ CALL primesgen
│ │ └── return
│ WHEN generate-primes ────────────────────────────────────► CALL primesui "log-message"
│ │ *** PERFORM commented out ***
│ WHEN OTHER ─────────────────────────────────────────────► CALL primesui "log-message"
│ PERFORM r99-stop-session
│ STOP RUN
│
├── CALL primesui "log-message"
├── PERFORM r99-stop-session ───────────────────────────────► r99-stop-session
│ │ CALL primesui "stop"
│ └── return
└── STOP RUN</pre>
'''CALLs issued by primesmain:'''

{|
!width="33%"| Call
!width="33%"| Using
!width="33%"| Condition
|-
| <code>CALL "primesui"</code>
| primes-ui
| <code>ui-methods = "start"</code>
|-
| <code>CALL "primesui"</code>
| primes-ui
| <code>ui-methods = "log-message"</code> (multiple)
|-
| <code>CALL "primesgen"</code>
| primes-session
| method = “report” or “generate”
|-
| <code>CALL "primesui"</code>
| primes-ui
| <code>ui-methods = "stop"</code>
|}

-----


== 3. primesgen — Paragraph Map ==

<pre>PROCEDURE DIVISION USING primes-session
│
└── EVALUATE TRUE on methods
WHEN report-primes
│ PERFORM r90-start-primes-report ──────────────────► r90-start-primes-report
│ │ │ CALL primes "connect"
│ │ │ CALL primes "cursor"
│ │ │ PERFORM r94-fetch ──► r94-fetch
│ │ │ │ CALL primes "next-prime"
│ │ │ └── return
│ │ └── return
│ │
│ IF session-method-ok
│ PERFORM r86-report-primes UNTIL session-method-eof
│ │ ┌──────────────────────────────────────────────► r86-report-primes (loop body)
│ │ │ CALL primesui "write"
│ │ │ PERFORM r94-fetch ──────────────────────────► r94-fetch
│ │ │ │ CALL primes "next-prime"
│ │ │ └── return
│ │ └── (loop back)
│
WHEN generate-primes
│ PERFORM r91-start-primes-generation ──────────────► r91-start-primes-generation
│ │ │ CALL primes "connect"
│ │ └── return
│ │
│ IF session-method-ok
│ PERFORM r80-test-number UNTIL test-number = 999999999
│ │ ┌──────────────────────────────────────────────► r80-test-number (loop body)
│ │ │ DIVIDE test-number BY test-divider → test-rest
│ │ │ EVALUATE TRUE
│ │ │ WHEN test-rest = 0
│ │ │ PERFORM r82-next-test-number ──────────► r82-next-test-number
│ │ │ │ ADD 2 TO test-number
│ │ │ │ COMPUTE sqrt
│ │ │ │ MOVE 1 TO old-ident
│ │ │ │ PERFORM r89-get-next-divider ──► r89-get-next-divider
│ │ │ │ │ CALL primes "get"
│ │ │ │ └── return
│ │ │ └── return
│ │ │ WHEN test-divider > test-number-sqr
│ │ │ PERFORM r85-write-prime ─────────────► r85-write-prime
│ │ │ │ │ CALL primes "write"
│ │ │ │ │ CALL primesui "write"
│ │ │ │ └── return
│ │ │ PERFORM r82-next-test-number (as above)
│ │ │ WHEN OTHER
│ │ │ PERFORM r89-get-next-divider (as above)
│ │ └── (loop back)
│
WHEN OTHER
LOG "Bad method"
│
└── PERFORM r99-close-primes ────────────────────────────► r99-close-primes
│ │ CALL primes "disconnect"
│ └── return
EXIT PROGRAM</pre>
'''Loop summary — primesgen:'''

{|
!width="25%"| Loop
!width="25%"| Type
!width="25%"| Condition
!width="25%"| Paragraph
|-
| Report read
| PERFORM UNTIL
| <code>session-method-eof</code> (result = 9)
| r86-report-primes
|-
| Sieve
| PERFORM UNTIL
| <code>test-number = 999999999</code>
| r80-test-number
|-
| Inner (test-number)
| EVALUATE inside PERFORM
| drives calls to r82 / r85 / r89
| r80-test-number
|}

-----


== 4. primes (DAL) — Paragraph Map ==

<pre>PROCEDURE DIVISION USING primes-dal
│
└── EVALUATE TRUE on dal-methods
WHEN next-prime → PERFORM r80-get-next-prime ──────► r80-get-next-prime
│ │ PERFORM s02-fetch ──► s02-fetch
│ │ │ EXEC SQL FETCH
│ │ └── return
│ └── return
WHEN next-divider → PERFORM r81-get-next-divider ────► r81-get-next-divider
│ │ ADD 1 TO old-ident → new-ident
│ │ EXEC SQL SELECT prime WHERE ident=new-ident
│ │ MOVE new-ident TO old-ident
│ └── return
WHEN write-prime → PERFORM r83-write-prime ──────────► r83-write-prime
│ │ EXEC SQL INSERT
│ └── return
WHEN db-connect → PERFORM s00-connect ──────────────► s00-connect
│ │ EXEC SQL CONNECT
│ └── return
WHEN db-cursor → PERFORM s01-cursor ───────────────► s01-cursor
│ │ EXEC SQL START TRANSACTION
│ │ EXEC SQL OPEN primescursor
│ └── return
WHEN db-disconnect → PERFORM s99-disconnect ───────────► s99-disconnect
│ │ EXEC SQL CONNECT RESET
│ └── return
WHEN OTHER → dal-result = 1
│
└── EXIT PROGRAM</pre>
'''No loops''' in primes.cbl. Each invocation handles exactly one SQL operation and returns.

-----


== 5. primesui — Paragraph Map ==

<pre>PROCEDURE DIVISION USING primes-ui
│
└── EVALUATE TRUE on ui-methods
WHEN start-ui → PERFORM r90-start-primesui ────────► r90-start-primesui
│ │ OPEN OUTPUT fprinter
│ │ IF ok: result=0, idx=1
│ │ PERFORM r98-message-ui ──► r98-message-ui
│ │ │ DISPLAY on scherm
│ │ └── return
│ └── return
WHEN write-ui → PERFORM r92-write-primesui ─────────► r92-write-primesui
│ │ load cell(primes-idx)
│ │ idx + 1
│ │ IF new-page → PERFORM r93-new-page ──► r93-new-page
│ │ │ WRITE heading
│ │ │ WRITE col header
│ │ │ new-page = 0
│ │ └── return
│ │ IF idx = 7 → WRITE line, idx = 1
│ │ IF linage = 53 → PERFORM r94-eop ──► r94-eop
│ │ │ WRITE blank
│ │ │ WRITE footing
│ │ │ page-number + 1
│ │ │ new-page = 1
│ │ └── return
│ └── return
WHEN message-ui → PERFORM r98-message-ui (as above)
WHEN stop-ui → PERFORM r99-stop-primesui ──────────► r99-stop-primesui
│ │ u-sequence = 0, u-number = 0
│ │ PERFORM r92-write-primesui UNTIL new-page ← flush loop
│ │ PERFORM r98-message-ui
│ │ CLOSE fprinter
│ └── return
WHEN OTHER → ui-method-result = 1
│
└── EXIT PROGRAM</pre>
'''Loop summary — primesui:'''

{|
!width="25%"| Loop
!width="25%"| Type
!width="25%"| Condition
!width="25%"| Location
|-
| Flush partial line
| PERFORM UNTIL
| <code>new-page</code> (print-new-page = 1)
| r99-stop-primesui
|}

-----


== 6. Cross-Program Control Flow Summary ==

<pre>OS
└─► primesmain PROCEDURE DIVISION
│
├─► CALL primesui (start, log×n, stop)
│ └── EXIT PROGRAM back to primesmain
│
└─► CALL primesgen (once, with primes-session)
│
├─► CALL primes (connect)
│ └── EXIT PROGRAM back to primesgen
├─► CALL primes (cursor / next-prime / next-divider / write / disconnect)
│ └── EXIT PROGRAM back to primesgen [repeated in loop]
├─► CALL primesui (log-message / write)
│ └── EXIT PROGRAM back to primesgen [repeated in loop]
└── EXIT PROGRAM back to primesmain</pre>
All inter-program communication is by reference (shared data blocks). There are no GOTO statements in the current source. All branching is via PERFORM, EVALUATE, and IF/ELSE. No COPY-based GOTO or ALTER is used.
<hr/>
Terug naar: [[Primes_programs_specifications]] | [[Cobol and PostgreSQL]]

IO behaviour

2026-03-25T16:49:49Z

Martin: Created page with " = I/O Behaviour = '''Project:''' pgcobol — Prime Numbers Application '''Version:''' 1.0 (reverse-engineered) '''Date:''' 2026-03-17 ----- == 1. File I/O — primes.prt == === 1.1 File Definition (primesui.cbl) === <syntaxhighlight lang="cobol">SELECT fprinter ASSIGN TO "primes.prt" ORGANIZATION IS SEQUENTIAL FILE STATUS I..."

= I/O Behaviour =

'''Project:''' pgcobol — Prime Numbers Application 
'''Version:''' 1.0 (reverse-engineered) 
'''Date:''' 2026-03-17

-----


== 1. File I/O — primes.prt ==


=== 1.1 File Definition (primesui.cbl) ===

<syntaxhighlight lang="cobol">SELECT fprinter ASSIGN TO "primes.prt"
ORGANIZATION IS SEQUENTIAL
FILE STATUS IS primes-prt-status.

FD fprinter
LABEL RECORDS OMITTED
LINAGE 56,
FOOTING 2,
BOTTOM 2.

01 file-buffer PIC X(132).</syntaxhighlight>
{|
! Property
! Value
|-
| Logical name
| <code>fprinter</code>
|-
| Physical name
| <code>primes.prt</code> (relative to working directory)
|-
| Organisation
| Line-sequential
|-
| Record length
| 132 characters
|-
| Linage
| 56 lines per page
|-
| Footing area
| last 2 lines of linage
|-
| Bottom margin
| 2 lines
|-
| Top margin
| not specified (default 0)
|-
| Open mode
| OUTPUT only
|-
| Status field
| <code>primes-prt-status</code> PIC X(2)
|}


=== 1.2 Open ===

Called by <code>r90-start-primesui</code> when <code>ui-methods = "start"</code>:

<pre>OPEN OUTPUT fprinter</pre>
* Success: <code>primes-prt-status = "00"</code>, <code>ui-method-result = 0</code>, <code>primes-idx = 1</code>.
* Failure: <code>primes-prt-status ≠ "00"</code>, <code>ui-method-result = 1</code>, status displayed on console.


=== 1.3 Write — Data Lines ===

Called by <code>r92-write-primesui</code> when <code>primes-idx</code> reaches 7 (after loading 6 entries):

<pre>MOVE primes-table TO print-buffer
WRITE file-buffer FROM print-buffer</pre>
One 132-character record is written per six prime entries. The record layout is:

<pre>[Z(9)][XX][Z(9)][XX][Z(9)][XX][Z(9)][XX][Z(9)][XX][Z(9)][XX]
seq1 sp prime1 sp seq2 sp prime2 sp seq3 sp prime3 sp ... × 6</pre>
Each cell = 9 + 2 + 9 + 2 = 22 characters; 6 cells = 132 characters exactly.


=== 1.4 Write — Page Heading (<code>r93-new-page</code>) ===

<pre>WRITE file-buffer FROM primes-heading → "primes overview" (PIC X(118))
WRITE file-buffer FROM table-header → "Sequence Prime " × 6</pre>
Triggered by <code>new-page</code> flag = 1. Flag cleared after write.


=== 1.5 Write — Page Footing (<code>r94-eop</code>) ===

Triggered when <code>linage-counter = 53</code>:

<pre>WRITE file-buffer FROM ' ' → blank separator
WRITE file-buffer FROM primes-footing → spaces(118) + "page: " + Z(3)9
ADD 1 TO page-number
SET print-new-page = 1 → next write triggers new heading</pre>

=== 1.6 Close ===

Called by <code>r99-stop-primesui</code> when <code>ui-methods = "stop"</code>:

<pre>CLOSE fprinter</pre>
Before close, a flush loop pads remaining cells with zeros until <code>new-page</code> fires, guaranteeing the last partial data line is written.

Success / failure reflected in <code>ui-method-result</code> ← <code>primes-prt-status</code>.

-----


== 2. Console Output — scherm ==


=== 2.1 Definition ===

<syntaxhighlight lang="cobol">SPECIAL-NAMES. CONSOLE IS scherm.</syntaxhighlight>
All four programs declare <code>scherm</code> as the console special-name.


=== 2.2 Structured Log Messages (via primesui) ===

<code>r98-message-ui</code> in primesui:

<pre>DISPLAY process-message UPON scherm</pre>
<code>process-message</code> is a 132-character group:

<pre>program-name PIC X(20) e.g. "primesmain "
program-paragraph PIC X(20) e.g. "r90-start-session "
program-message PIC X(92) e.g. "UI initialisation succeeded. ..."</pre>
Every caller populates <code>program-name</code>, optionally <code>program-paragraph</code>, and always <code>program-message</code> before calling <code>primesui "log-message"</code>.


=== 2.3 Direct DISPLAY Statements (diagnostic / error) ===

Several paragraphs bypass primesui and write directly to <code>scherm</code>:

{|
!width="33%"| Location
!width="33%"| Statement
!width="33%"| Purpose
|-
| primesmain r90
| <code>DISPLAY "Emergency console message…" UPON scherm</code>
| Hard abort if UI fails
|-
| primes r81
| <code>DISPLAY SQLCODE UPON scherm</code>
| SQL error on next-divider
|-
| primes r81
| <code>DISPLAY "select new-divider nok" UPON scherm</code>
|
|-
| primes r83
| <code>DISPLAY SQLCODE UPON scherm</code>
| SQL error on insert
|-
| primes r83
| <code>DISPLAY "primes.cbl insert next prime nok…" UPON scherm</code>
|
|-
| primes s00
| <code>DISPLAY "connect to database" UPON scherm</code>
| Always shown on connect
|-
| primes s00
| <code>DISPLAY SQLCODE UPON scherm</code>
|
|-
| primes s99
| <code>DISPLAY "s99 disconnect from database" UPON scherm</code>
| Always shown on disconnect
|-
| primes s99
| <code>DISPLAY SQLCODE UPON scherm</code>
|
|-
| primesui r90
| <code>DISPLAY primes-prt-status UPON scherm</code>
| File open failure
|-
| primesui r99
| <code>DISPLAY primes-prt-status UPON scherm</code>
| File close failure
|}

-----


== 3. Database I/O (primes.cbl via GixSQL) ==


=== 3.1 Connection Management ===

{|
!width="33%"| Operation
!width="33%"| SQL
!width="33%"| Paragraph
|-
| Connect
| <code>CONNECT TO :DATASRC AS primes USER :DBUSR USING :DBPWD</code>
| s00-connect
|-
| Disconnect
| <code>CONNECT RESET primes</code>
| s99-disconnect
|}

Connection string: <code>pgsql://localhost:5432/primes&default_schema=primes</code> 
Connection alias: <code>primes</code> (used in all <code>EXEC SQL AT primes</code> statements)


=== 3.2 Cursor Lifecycle (report path only) ===

{|
!width="33%"| Operation
!width="33%"| SQL
!width="33%"| Paragraph
|-
| Declare
| <code>DECLARE primescursor CURSOR FOR SELECT * FROM primes</code>
| compile-time
|-
| Begin transaction
| <code>START TRANSACTION</code>
| s01-cursor
|-
| Open
| <code>OPEN primescursor</code>
| s01-cursor
|-
| Fetch one row
| <code>FETCH primescursor INTO :primes-row</code>
| s02-fetch
|-
| (Close)
| not explicitly closed — connection reset closes it
| —
|}

Each <code>FETCH</code> populates <code>primes-row</code> (r-ident, r-prime), which is then copied to <code>primes-sequence</code> and <code>prime-number</code> in <code>primes-dal</code> for the caller.

End-of-cursor is signalled by <code>SQLCODE ≠ 0</code>; <code>dal-result</code> is set to 1, which primesgen maps to <code>session-method-eof</code> implicitly (by checking <code>session-method-eof</code> condition, value 9 — note: there is a mapping gap; dal-result=1 does not equal session-result=9; the report loop relies on <code>session-method-eof</code> which is never explicitly set in the current code — see defect D-RPT-01 below).


=== 3.3 DML (generate path) ===

{|
!width="33%"| Operation
!width="33%"| SQL
!width="33%"| Paragraph
|-
| Insert prime
| <code>INSERT INTO primes (prime) VALUES (:prime)</code>
| r83-write-prime
|}

* Host variable <code>:prime</code> maps to <code>prime-number</code> in <code>primes-dal.primes-data</code>.
* No explicit COMMIT in the current code (statement is commented out).
* PostgreSQL default auto-commit applies per statement unless inside the transaction opened by <code>s01-cursor</code>.


=== 3.4 Queries (generate path — divider lookup) ===

{|
!width="33%"| Operation
!width="33%"| SQL
!width="33%"| Paragraph
|-
| Get next divider
| <code>SELECT prime INTO :test-divider FROM primes WHERE ident = :new-ident</code>
| r81-get-next-divider
|}

* <code>:new-ident</code> = <code>old-ident + 1</code> (computed inline before the SELECT).
* <code>:test-divider</code> is in the local <code>primes</code> working-storage group in primesgen, not in <code>primes-dal</code>.


=== 3.5 Error Handling Pattern ===

Every SQL statement uses the same pattern:

<pre>EXEC SQL ... END-EXEC
IF SQLCODE = 0 THEN
[success actions]
ELSE
[log error / set result code]</pre>
No <code>WHENEVER</code> directives are used.

-----


== 4. Command-Line Input ==

{|
!width="25%"| Program
!width="25%"| Statement
!width="25%"| Variable
!width="25%"| Length
|-
| primesmain
| <code>ACCEPT commandline-args FROM COMMAND-LINE</code>
| <code>commandline-args</code> PIC X(32)
| 32 chars
|}

Only the first 32 characters of the command-line argument are stored. The value is copied to <code>methods</code> in the session control block and also logged to the console via primesui after session start.

-----


== 5. Known I/O Defects ==

{|
!width="50%"| ID
!width="50%"| Description
|-
| D-RPT-01
| The report loop condition <code>session-method-eof</code> (value 9) is never set in the code path; when a fetch fails, <code>session-result</code> is set to 1 (nok), not 9, causing the loop to terminate on error rather than on true EOF.
|-
| D-IO-01
| <code>primesgen</code> declares a <code>SELECT fprinter</code> and <code>FD fprinter</code> but never opens or uses the file; print output is delegated entirely to primesui.
|-
| D-IO-02
| Connection reset in <code>s99-disconnect</code> targets alias <code>primes</code>; the pre-compiler listing (<code>primes_cbsql.out</code>) shows <code>primesdb</code> used in earlier iterations, which would cause a runtime alias-not-found error.
|}
<hr/>
Terug naar: [[Primes_programs_specifications]] | [[Cobol and PostgreSQL]]

Business rules

2026-03-25T16:48:56Z

Martin: Created page with " = Business Rules = '''Project:''' pgcobol — Prime Numbers Application '''Version:''' 1.0 (reverse-engineered) '''Date:''' 2026-03-17 ----- == 1. Primality Algorithm == === BR-ALGO-01 — Input domain === Only odd integers are tested for primality. The sieve begins at <code>test-number = 3</code> and advances in steps of 2 (<code>ADD 2 TO..."

= Business Rules =

'''Project:''' pgcobol — Prime Numbers Application 
'''Version:''' 1.0 (reverse-engineered) 
'''Date:''' 2026-03-17

-----


== 1. Primality Algorithm ==


=== BR-ALGO-01 — Input domain ===

Only odd integers are tested for primality. The sieve begins at <code>test-number = 3</code> and advances in steps of 2 (<code>ADD 2 TO test-number</code>), implicitly excluding all even numbers. The even prime 2 is intended as a seed but is not currently inserted in the active code path.


=== BR-ALGO-02 — Upper bound ===

Generation terminates when <code>test-number = 999,999,999</code>. This value is the terminal condition of the PERFORM loop in primesgen.

<pre>PERFORM r80-test-number UNTIL test-number = 999999999</pre>

=== BR-ALGO-03 — Divisibility test ===

A candidate is composite if the remainder of dividing it by the current trial divisor is zero:

<pre>DIVIDE test-number BY test-divider
GIVING test-quot REMAINDER test-rest

WHEN test-rest = 0 → composite; skip to next candidate</pre>

=== BR-ALGO-04 — Square-root bound (trial-division cutoff) ===

If the current trial divisor exceeds the square root of the candidate, no factor can exist and the candidate is prime. The square root is computed using COBOL exponentiation:

<pre>COMPUTE test-number-sqr = test-number ** 0.5

WHEN test-divider > test-number-sqr → prime confirmed</pre>
<code>test-number-sqr</code> is re-computed every time <code>test-number</code> advances (in <code>r82-next-test-number</code>).


=== BR-ALGO-05 — Trial divisors sourced from the database ===

Trial divisors are not held in memory; they are fetched from the <code>primes</code> table by <code>ident</code> sequence:

<pre>SELECT prime FROM primes WHERE ident = :new-ident</pre>
The index <code>old-ident</code> is initialised to 1 for each new candidate and incremented by 1 on each <code>next-divider</code> call. This means the algorithm uses previously stored primes as divisors — a characteristic of a sieve-of-Eratosthenes variant rather than pure trial division.


=== BR-ALGO-06 — Candidate advance rule ===

After a composite or prime determination, the candidate advances to the next odd integer and the divisor index resets:

<pre>ADD 2 TO test-number
COMPUTE test-number-sqr = test-number ** 0.5
MOVE 1 TO old-ident
PERFORM r89-get-next-divider ← loads test-divider = first prime (ident 1)</pre>

-----


== 2. Data Validation Rules ==


=== BR-VAL-01 — Command-line argument ===

The application accepts exactly one of two valid argument values:

{|
! Value
! Effect
|-
| <code>"report"</code>
| Execute reporting path
|-
| <code>"generate"</code>
| Execute generation path
|-
| anything else
| Log error; <code>STOP RUN</code> immediately
|}

Rule is implemented by 88-level conditions and an <code>EVALUATE TRUE</code> with <code>WHEN OTHER</code>:

<pre>88 report-primes VALUE "report".
88 generate-primes VALUE "generate".
...
WHEN OTHER
LOG "Bad parameter, program initialisation failed."
STOP RUN</pre>

=== BR-VAL-02 — UI initialisation must succeed before processing ===

If <code>primesui</code> returns <code>ui-method-result ≠ 0</code> on a <code>"start"</code> call, the program issues an emergency console message and halts unconditionally. No database activity is attempted.

<pre>IF ui-method-ok THEN ...
ELSE
DISPLAY "Emergency console message program stops." UPON scherm
STOP RUN</pre>

=== BR-VAL-03 — Database connection must succeed before processing ===

In both <code>r90-start-primes-report</code> and <code>r91-start-primes-generation</code>, a failed <code>"connect"</code> call sets <code>session-result = 1</code> and processing does not continue. The condition is checked via:

<pre>IF dal-method-ok THEN ...
ELSE
LOG "Database initialisation failed."
session-result = 1
(falls through to r99-close-primes)</pre>

=== BR-VAL-04 — Cursor must open successfully before fetching ===

In the report path, cursor failure sets <code>session-result = 1</code> and no fetch loop is entered. The guard is:

<pre>IF dal-method-ok THEN
PERFORM r86-report-primes UNTIL session-method-eof</pre>

=== BR-VAL-05 — SQLCODE = 0 is the sole SQL success criterion ===

All SQL error handling uses <code>IF SQLCODE = 0 THEN ... ELSE ...</code>. No other status codes (e.g., +100 NOT FOUND) are explicitly handled with named conditions; they fall into the <code>ELSE</code> branch.

-----


== 3. Calculations ==


=== BR-CALC-01 — Square root computation ===

<pre>COMPUTE test-number-sqr = test-number ** 0.5</pre>
<code>test-number-sqr</code> is declared as <code>PIC 9(9)V9(9)</code> — an 18-digit decimal with 9 integer and 9 fractional digits. The comparison <code>test-divider > test-number-sqr</code> relies on COBOL’s decimal comparison across the two fields.


=== BR-CALC-02 — Remainder computation ===

<pre>DIVIDE test-number BY test-divider
GIVING test-quot REMAINDER test-rest</pre>
Both <code>test-quot</code> and <code>test-rest</code> are declared <code>PIC 9(9)V9(9)</code>. The condition <code>test-rest = 0</code> detects exact divisibility.

-----


== 4. Output Formatting Rules ==


=== BR-FMT-01 — Six primes per print line ===

The <code>primes-table</code> working-storage in primesui holds 6 cells. A line is written to the print file only when all 6 are filled (<code>primes-idx = 7</code> after increment):

<pre>IF primes-idx = 7 THEN
WRITE print line
SET primes-idx TO 1</pre>

=== BR-FMT-02 — Zero suppression ===

Sequence numbers and prime values are formatted with <code>PIC Z(9)</code> (leading-zero suppression) in the print cells <code>t-ident</code> and <code>t-prime</code>.


=== BR-FMT-03 — Page trigger at line 53 ===

End-of-page processing fires when <code>linage-counter = 53</code> (3 lines before the 56-line page boundary), leaving room for the footing:

<pre>IF linage-counter = 53 THEN PERFORM r94-eop</pre>

=== BR-FMT-04 — New-page flag controls heading output ===

<code>print-new-page</code> (88 condition <code>new-page</code>, VALUE 1) is the gate for writing the heading. It is set to 1 at initialisation and after each page footing; cleared to 0 after the heading is written:

<pre>IF new-page THEN PERFORM r93-new-page
...
r93-new-page:
MOVE ZERO TO print-new-page</pre>

=== BR-FMT-05 — Partial line flush at stop ===

When <code>primesui</code> receives <code>"stop"</code>, it pads the remaining cells with zeros and keeps calling <code>r92-write-primesui</code> until <code>new-page</code> triggers (i.e., until the partial line fills, writes, and a new page would be needed), ensuring the last data line is always written:

<pre>MOVE 0 TO u-sequence
MOVE 0 TO u-number
PERFORM r92-write-primesui UNTIL new-page</pre>

-----


== 5. Session and Error-Handling Rules ==


=== BR-ERR-01 — Result-code convention ===

All three tier interfaces use the same pattern:

{|
! Code
! Meaning
|-
| 0
| Success
|-
| 1
| Failure / error
|-
| 9 or 99
| End-of-data / EOF
|}


=== BR-ERR-02 — No retry on failure ===

Errors at any tier cause a log message and a result code of 1. The calling tier checks the result and either skips subsequent steps or falls through to cleanup. There is no retry logic.


=== BR-ERR-03 — Cleanup always attempted ===

<code>r99-close-primes</code> in primesgen and <code>r99-stop-session</code> in primesmain are always performed before <code>EXIT PROGRAM</code> or <code>STOP RUN</code>, regardless of whether prior steps succeeded. This ensures the database connection and print file are always closed.
<hr/>
Terug naar: [[Primes_programs_specifications]] | [[Cobol and PostgreSQL]]

Program Logic

2026-03-25T16:47:57Z

Martin: Created page with " = Program Logic = '''Project:''' pgcobol — Prime Numbers Application '''Version:''' 1.0 (reverse-engineered) '''Date:''' 2026-03-17 ----- == 1. primesmain — Step-by-Step Logic == '''Source:''' <code>primesmain.cbl</code> '''Role:''' Entry point. Parses command-line argument, initialises UI, dispatches to processing, shuts down. <span id="procedure-division-main-i..."

= Program Logic =

'''Project:''' pgcobol — Prime Numbers Application 
'''Version:''' 1.0 (reverse-engineered) 
'''Date:''' 2026-03-17

-----


== 1. primesmain — Step-by-Step Logic ==

'''Source:''' <code>primesmain.cbl</code> 
'''Role:''' Entry point. Parses command-line argument, initialises UI, dispatches to processing, shuts down.


=== PROCEDURE DIVISION (main inline logic) ===

<pre>Step 1 ACCEPT commandline-args FROM COMMAND-LINE
→ reads first token of the OS command line into commandline-args (PIC X(32))

Step 2 MOVE commandline-args TO methods
MOVE 'primesmain' TO program-name
→ loads session control block ready for dispatch
→ sets log identity for subsequent messages

Step 3 PERFORM r90-start-session
→ opens primes.prt and verifies UI layer is ready (see §1.1)

Step 4 EVALUATE TRUE
WHEN report-primes (commandline-args = "report")
LOG "Primes report generation starts."
SET methods = "report"
PERFORM r92-generate-primes → CALL primesgen

WHEN generate-primes (commandline-args = "generate")
LOG "Primes generation starts."
SET methods = "generate"
*** PERFORM r92-generate-primes is COMMENTED OUT ***

WHEN OTHER
LOG "Bad parameter, program initialisation failed."
PERFORM r99-stop-session
STOP RUN

Step 5 LOG "Primes run complete, program stops."

Step 6 PERFORM r99-stop-session

Step 7 STOP RUN</pre>

=== 1.1 Paragraph: r90-start-session ===

<pre>MOVE 'start-session' TO program-paragraph
MOVE 'start' TO ui-methods
CALL "primesui" USING primes-ui

IF ui-method-ok (result = 0) THEN
LOG "UI initialisation succeeded."
LOG commandline-args value
ELSE
DISPLAY "Emergency console message program stops." UPON scherm
STOP RUN ← hard abort; no graceful close</pre>

=== 1.2 Paragraph: r92-generate-primes ===

<pre>CALL "primesgen" USING primes-session
← passes entire session control block by reference
← primesgen reads methods to determine its path</pre>

=== 1.3 Paragraph: r99-stop-session ===

<pre>MOVE 'stop' TO ui-methods
CALL "primesui" USING primes-ui
← primesui flushes print buffer and closes primes.prt</pre>

-----


== 2. primesgen — Step-by-Step Logic ==

'''Source:''' <code>primesgen.cbl</code> 
'''Role:''' Implements both the sieve algorithm (generate) and the cursor read-loop (report). Receives control via <code>primes-session</code> linkage; uses <code>primes-dal</code> and <code>primes-ui</code> locally.


=== PROCEDURE DIVISION (main inline logic) ===

<pre>Step 1 EVALUATE TRUE on methods (from primes-session)

WHEN report-primes
PERFORM r90-start-primes-report
IF session-method-ok THEN
PERFORM r86-report-primes UNTIL session-method-eof

WHEN generate-primes
PERFORM r91-start-primes-generation
IF session-method-ok THEN
PERFORM r80-test-number UNTIL test-number = 999999999

WHEN OTHER
SET program-name = "primesgen", program-paragraph = "main"
LOG "Bad method, primes process failed."

Step 2 PERFORM r99-close-primes

Step 3 EXIT PROGRAM</pre>

=== 2.1 Paragraph: r90-start-primes-report ===

<pre>CALL primes "connect"
IF dal-method-ok THEN LOG "DB init succeeded." ELSE LOG "DB init failed." + session-result=1

CALL primes "cursor"
→ START TRANSACTION
→ OPEN primescursor (SELECT * FROM primes)
IF dal-method-ok THEN LOG "Cursor init succeeded." ELSE LOG "Cursor init failed." + session-result=1

IF dal-method-ok THEN PERFORM r94-fetch (fetch first row)

IF dal-method-ok THEN
LOG "Fetch first row ok." + dal-result=0
ELSE
LOG "Fetch first row nok." + dal-result=1</pre>

=== 2.2 Paragraph: r91-start-primes-generation ===

<pre>CALL primes "connect"
IF dal-method-ok THEN
test-divider = 2
old-ident = 1
test-number = 3
test-number-sqr = COMPUTE test-number ** 0.5 (= SQRT(3) ≈ 1.732)
LOG "DB init succeeded."
ELSE
LOG "DB init failed."
session-result = 1</pre>

=== 2.3 Paragraph: r80-test-number ''(sieve main loop body)'' ===

<pre>DIVIDE test-number BY test-divider
GIVING test-quot REMAINDER test-rest

EVALUATE TRUE
WHEN test-rest = 0
→ test-number is divisible; it is composite
PERFORM r82-next-test-number

WHEN test-divider > test-number-sqr
→ no factor ≤ √test-number found; test-number IS PRIME
PERFORM r85-write-prime
PERFORM r82-next-test-number

WHEN OTHER
→ keep trying; get next trial divisor from DB
PERFORM r89-get-next-divider</pre>

=== 2.4 Paragraph: r82-next-test-number ===

<pre>ADD 2 TO test-number ← advance to next odd integer
COMPUTE test-number-sqr = test-number ** 0.5 ← recompute √
MOVE 1 TO old-ident ← reset divider index to first prime
PERFORM r89-get-next-divider ← load test-divider = prime[2]</pre>

=== 2.5 Paragraph: r85-write-prime ===

<pre>MOVE 'write' TO ui-methods
CALL "primes" USING primes-dal ← INSERT INTO primes (prime) VALUES (prime-number)
CALL "primesui" USING primes-ui ← add to print buffer</pre>

=== 2.6 Paragraph: r86-report-primes ''(report loop body)'' ===

<pre>MOVE 'write' TO ui-methods
MOVE primes-data TO u-primes ← copy sequence + value into UI block
CALL "primesui" USING primes-ui ← accumulate into 6-column print buffer
PERFORM r94-fetch ← advance cursor</pre>

=== 2.7 Paragraph: r89-get-next-divider ===

<pre>MOVE 'get' TO gen-methods ← note: uses local "primes" group, not primes-dal
CALL "primes" USING primes ← DAL selects prime WHERE ident = old-ident+1
sets test-divider</pre>

=== 2.8 Paragraph: r94-fetch ===

<pre>MOVE 'next-prime' TO dal-methods
CALL "primes" USING primes-dal ← FETCH primescursor INTO primes-row
IF dal-method-ok THEN
next sentence
ELSE
LOG "Fetch failed."
session-result = 1</pre>

=== 2.9 Paragraph: r99-close-primes ===

<pre>MOVE 'disconnect' TO dal-methods
CALL "primes" USING primes ← note: passes local "primes" group, not primes-dal
IF dal-method-ok THEN LOG "DB close succeeded."
ELSE LOG "DB close failed." + session-result=1</pre>

-----


== 3. primes (DAL) — Step-by-Step Logic ==

'''Source:''' <code>primes.cbl</code> 
'''Role:''' Data access layer. All SQL is here. Receives control via <code>primes-dal</code> linkage.


=== PROCEDURE DIVISION ===

<pre>EVALUATE TRUE on dal-methods
WHEN next-prime → PERFORM r80-get-next-prime
WHEN next-divider → PERFORM r81-get-next-divider
WHEN write-prime → PERFORM r83-write-prime
WHEN db-connect → PERFORM s00-connect
WHEN db-cursor → PERFORM s01-cursor
WHEN db-disconnect → PERFORM s99-disconnect
WHEN OTHER → dal-result = 1
EXIT PROGRAM</pre>

=== 3.1 Paragraph: s00-connect ===

<pre>MOVE 'CONNECT' TO CUR-STEP
EXEC SQL
CONNECT TO :DATASRC AS primes USER :DBUSR USING :DBPWD
END-EXEC
IF SQLCODE = 0 THEN
dal-result = 0
LOG "Database initialisation ok."
ELSE
LOG "Database initialisation failed, terminating program."
dal-result = 1</pre>

=== 3.2 Paragraph: s01-cursor ===

<pre>EXEC SQL AT primes START TRANSACTION END-EXEC
IF SQLCODE = 0 THEN LOG "Start transaction ok."
ELSE LOG "Start transaction nok." + dal-result = 1

IF dal-method-ok THEN
EXEC SQL OPEN primescursor END-EXEC
IF SQLCODE = 0 THEN LOG "Start primescursor ok."
ELSE LOG "Start primescursor nok." + dal-result = 1</pre>

=== 3.3 Paragraph: s02-fetch ''(called by r80-get-next-prime)'' ===

<pre>EXEC SQL FETCH primescursor INTO :primes-row END-EXEC
IF SQLCODE = 0 THEN
primes-sequence = r-ident
prime-number = r-prime
dal-result = 0
ELSE
LOG "Fetch row nok."
dal-result = 1
LOG from program-name / program-paragraph context</pre>

=== 3.4 Paragraph: r81-get-next-divider ===

<pre>new-ident = old-ident + 1

EXEC SQL AT primes
SELECT prime INTO :test-divider
FROM primes WHERE ident = :new-ident
END-EXEC

IF SQLCODE = 0 THEN next sentence
ELSE DISPLAY SQLCODE + "select new-divider nok" on console

MOVE new-ident TO old-ident</pre>

=== 3.5 Paragraph: r83-write-prime ===

<pre>EXEC SQL AT primes
INSERT INTO primes (prime) VALUES (:prime)
END-EXEC

IF SQLCODE = 0 THEN next sentence
ELSE
DISPLAY SQLCODE on console
DISPLAY "primes.cbl insert next prime nok: " prime-number on console

*** EXEC SQL AT primes COMMIT END-EXEC ← COMMENTED OUT</pre>

=== 3.6 Paragraph: s99-disconnect ===

<pre>MOVE 'DISCONNECT' TO CUR-STEP
EXEC SQL CONNECT RESET primes END-EXEC
IF SQLCODE = 0 THEN
dal-result = 0
LOG "Close database ok."
ELSE
LOG "Database initialisation failed, ending program."
dal-result = 1
DISPLAY "s99 disconnect from database" on console
DISPLAY SQLCODE on console</pre>

-----


== 4. primesui — Step-by-Step Logic ==

'''Source:''' <code>primesui.cbl</code> 
'''Role:''' All output. Manages the <code>primes.prt</code> print file and writes to the system console.


=== PROCEDURE DIVISION ===

<pre>EVALUATE TRUE on ui-methods
WHEN start-ui → PERFORM r90-start-primesui
WHEN write-ui → PERFORM r92-write-primesui
WHEN stop-ui → PERFORM r99-stop-primesui
WHEN message-ui → PERFORM r98-message-ui
WHEN OTHER → ui-method-result = 1
EXIT PROGRAM</pre>

=== 4.1 Paragraph: r90-start-primesui ===

<pre>MOVE 'start-primesui' TO program-paragraph
MOVE 'start-printer' TO program-message

OPEN OUTPUT fprinter (primes.prt)

IF primes-prt-status = '00' THEN
ui-method-result = 0
SET primes-idx TO 1 ← initialise table column index
LOG "Open printer Ok"
ELSE
ui-method-result = 1
DISPLAY primes-prt-status on console</pre>

=== 4.2 Paragraph: r92-write-primesui ''(called for every prime row)'' ===

<pre>t-ident(primes-idx) = u-sequence ← load sequence into current cell
t-prime(primes-idx) = u-number ← load prime value into current cell
SET primes-idx UP BY 1 ← advance to next cell

IF new-page (print-new-page = 1) THEN
PERFORM r93-new-page ← write heading + column header

IF primes-idx = 7 THEN ← 6 entries filled (index is post-increment)
MOVE primes-table TO print-buffer
WRITE file-buffer FROM print-buffer ← write the 132-char data line
SET primes-idx TO 1

IF linage-counter = 53 THEN ← within 3 lines of page end
PERFORM r94-eop</pre>

=== 4.3 Paragraph: r93-new-page ===

<pre>MOVE primes-heading TO print-buffer
WRITE file-buffer FROM print-buffer ← "primes overview"
MOVE table-header TO print-buffer
WRITE file-buffer FROM print-buffer ← "Sequence Prime " × 6
MOVE ZERO TO print-new-page ← clear new-page flag</pre>

=== 4.4 Paragraph: r94-eop ''(end-of-page)'' ===

<pre>MOVE page-number TO f-page-number
MOVE ' ' TO print-buffer
WRITE file-buffer FROM print-buffer ← blank separator line
MOVE primes-footing TO print-buffer
WRITE file-buffer FROM print-buffer ← " page: NNN"
ADD 1 TO page-number
MOVE 1 TO print-new-page ← trigger new heading on next write</pre>

=== 4.5 Paragraph: r98-message-ui ===

<pre>DISPLAY process-message UPON scherm ← writes program-name + paragraph + message to console</pre>

=== 4.6 Paragraph: r99-stop-primesui ===

<pre>MOVE 0 TO u-sequence
MOVE 0 TO u-number
PERFORM r92-write-primesui UNTIL new-page ← pad remaining cells to trigger line flush

MOVE 'stop-primesui' TO program-paragraph
MOVE 'close printer' TO program-message
PERFORM r98-message-ui

CLOSE fprinter

MOVE primes-prt-status TO ui-method-result
IF primes-prt-status = '00' THEN next sentence
ELSE DISPLAY primes-prt-status on console</pre>
<hr/>
Terug naar: [[Primes_programs_specifications]] | [[Cobol and PostgreSQL]]

Flow diagrams

2026-03-25T16:46:51Z

Martin: Created page with " = Flow Diagrams = '''Project:''' pgcobol — Prime Numbers Application '''Version:''' 1.0 (reverse-engineered) '''Date:''' 2026-03-17 '''Notation:''' Mermaid flowchart / sequence diagrams ----- == 1. System-Level Call Graph == <pre class="mermaid">graph TD OS([OS / shell]) -->|command-line arg| MAIN[primesmain] MAIN -->|CALL primesui start| UI[primesui] MA..."

= Flow Diagrams =

'''Project:''' pgcobol — Prime Numbers Application 
'''Version:''' 1.0 (reverse-engineered) 
'''Date:''' 2026-03-17 
'''Notation:''' Mermaid flowchart / sequence diagrams

-----


== 1. System-Level Call Graph ==

<pre class="mermaid">graph TD
OS([OS / shell]) -->|command-line arg| MAIN[primesmain]
MAIN -->|CALL primesui start| UI[primesui]
MAIN -->|CALL primesgen primes-session| GEN[primesgen]
GEN -->|CALL primes primes-dal| DAL[primes DAL]
GEN -->|CALL primesui primes-ui| UI
DAL -->|CALL primesui primes-ui| UI
DAL <-->|EXEC SQL via GixSQL| DB[(PostgreSQL\nprimes.primes)]
UI -->|WRITE records| PRT([primes.prt])
UI -->|DISPLAY| CON([console / scherm])</pre>

-----


== 2. Main Program Flow — primesmain ==

<pre class="mermaid">flowchart TD
START([Start]) --> ACCEPT[ACCEPT commandline-args\nfrom COMMAND-LINE]
ACCEPT --> MOVEMETHODS[MOVE commandline-args TO methods\nMOVE 'primesmain' TO program-name]
MOVEMETHODS --> STARTSESS[PERFORM r90-start-session\nCALL primesui start]
STARTSESS --> UIOK{ui-method-ok?}
UIOK -->|No| EMERGENCY[DISPLAY emergency message\non console\nSTOP RUN]
UIOK -->|Yes| LOGUI[LOG 'UI initialisation succeeded.'\nLOG commandline-args]
LOGUI --> EVAL{EVALUATE commandline-args}
EVAL -->|report| LOGRPT[LOG 'Primes report generation starts.'\nSET methods = 'report']
LOGRPT --> CALLGEN[PERFORM r92-generate-primes\nCALL primesgen USING primes-session]
EVAL -->|generate| LOGGEN[LOG 'Primes generation starts.'\nSET methods = 'generate']
LOGGEN --> COMMENTED["⚠ PERFORM r92-generate-primes\n[commented out in source]"]
EVAL -->|other| LOGBAD[LOG 'Bad parameter'\nCALL primesui stop]
LOGBAD --> STOPBAD([STOP RUN])
CALLGEN --> LOGDONE[LOG 'Primes run complete.']
COMMENTED --> LOGDONE
LOGDONE --> STOPSESS[PERFORM r99-stop-session\nCALL primesui stop]
STOPSESS --> STOP([STOP RUN])</pre>

-----


== 3. Generate Flow — primesgen (generate path) ==

<pre class="mermaid">flowchart TD
ENTRY([Entry: methods = 'generate']) --> CONNECT[CALL primes 'connect'\nEXEC SQL CONNECT]
CONNECT --> CONNOK{dal-method-ok?}
CONNOK -->|No| SETFAIL1[LOG 'Database init failed.'\nSET session-result = 1]
SETFAIL1 --> CLOSE
CONNOK -->|Yes| INIT[test-number = 3\ntest-divider = 2\nold-ident = 1\ntest-number-sqr = SQRT 3]
INIT --> LOGCONN[LOG 'Database init succeeded.']
LOGCONN --> LOOP{test-number\n= 999999999?}
LOOP -->|Yes| CLOSE
LOOP -->|No| DIVIDE[DIVIDE test-number\nBY test-divider\nGIVING test-quot\nREMAINDER test-rest]
DIVIDE --> CASE{EVALUATE}
CASE -->|test-rest = 0\ncomposite| NEXTN[r82-next-test-number:\nADD 2 TO test-number\nSQRT recalc\nold-ident = 1\nFETCH first divider]
NEXTN --> LOOP
CASE -->|test-divider > SQRT\nprime confirmed| WRITE[r85-write-prime:\nCALL primes 'write' INSERT\nCALL primesui 'write']
WRITE --> NEXTN2[r82-next-test-number]
NEXTN2 --> LOOP
CASE -->|otherwise\ntry next divisor| NEXTDIV[r89-get-next-divider:\nCALL primes 'next-divider'\nSELECT prime WHERE ident=new-ident]
NEXTDIV --> LOOP
CLOSE([PERFORM r99-close-primes\nCALL primes 'disconnect'\nEXIT PROGRAM])</pre>

-----


== 4. Report Flow — primesgen (report path) ==

<pre class="mermaid">flowchart TD
ENTRY([Entry: methods = 'report']) --> CONNECT[CALL primes 'connect']
CONNECT --> CONNOK{dal-method-ok?}
CONNOK -->|No| FAIL1[LOG 'Database init failed.'\nsession-result = 1\nGO TO CLOSE]
CONNOK -->|Yes| CURSOR[CALL primes 'cursor'\nSTART TRANSACTION\nOPEN primescursor]
CURSOR --> CURROK{dal-method-ok?}
CURROK -->|No| FAIL2[LOG 'Cursor init failed.'\nsession-result = 1\nGO TO CLOSE]
CURROK -->|Yes| FETCH1[r94-fetch:\nCALL primes 'next-prime'\nFETCH primescursor]
FETCH1 --> FETCHOK{dal-method-ok?}
FETCHOK -->|No| LOGFAIL[LOG 'Fetch first row nok.'\ndal-result = 1]
LOGFAIL --> CLOSE
FETCHOK -->|Yes| LOGOK[LOG 'Fetch first row ok.'\ndal-result = 0]
LOGOK --> RPTLOOP{session-method-eof?}
RPTLOOP -->|Yes| CLOSE
RPTLOOP -->|No| UIWRITE[r86-report-primes:\nMOVE primes-data TO u-primes\nCALL primesui 'write']
UIWRITE --> FETCHN[r94-fetch:\nCALL primes 'next-prime']
FETCHN --> RPTLOOP
CLOSE([PERFORM r99-close-primes\nCALL primes 'disconnect'\nEXIT PROGRAM])</pre>

-----


== 5. DAL Dispatch — primes.cbl ==

<pre class="mermaid">flowchart TD
ENTRY([ENTRY primes-dal]) --> EVAL{dal-methods}
EVAL -->|connect| S00[s00-connect:\nEXEC SQL CONNECT TO datasrc\nAS primes USER dbusr USING dbpwd]
EVAL -->|cursor| S01[s01-cursor:\nEXEC SQL START TRANSACTION\nEXEC SQL OPEN primescursor]
EVAL -->|next-prime| R80[r80-get-next-prime → s02-fetch:\nEXEC SQL FETCH primescursor\nINTO primes-row]
EVAL -->|next-divider| R81[r81-get-next-divider:\nnew-ident = old-ident + 1\nEXEC SQL SELECT prime\nWHERE ident = new-ident]
EVAL -->|write| R83[r83-write-prime:\nEXEC SQL INSERT INTO primes\nVALUES prime-number]
EVAL -->|disconnect| S99[s99-disconnect:\nEXEC SQL CONNECT RESET primes]
EVAL -->|other| ERR[dal-result = 1]
S00 --> SQLCK1{SQLCODE = 0?}
SQLCK1 -->|Yes| OK1[dal-result = 0]
SQLCK1 -->|No| NOK1[LOG error\ndal-result = 1]
S01 --> SQLCK2{SQLCODE = 0?}
SQLCK2 -->|Yes| OPEN[OPEN primescursor]
SQLCK2 -->|No| NOK2[dal-result = 1]
R80 --> SQLCK3{SQLCODE = 0?}
SQLCK3 -->|Yes| MOVROW[primes-sequence = r-ident\nprime-number = r-prime\ndal-result = 0]
SQLCK3 -->|No| NOK3[LOG error\ndal-result = 1]
OK1 & MOVROW & NOK1 & NOK2 & NOK3 & OK1 & R81 & R83 & S99 & ERR --> EXIT([EXIT PROGRAM])</pre>

-----


== 6. UI Dispatch — primesui.cbl ==

<pre class="mermaid">flowchart TD
ENTRY([ENTRY primes-ui]) --> EVAL{ui-methods}
EVAL -->|start| R90[r90-start-primesui:\nOPEN OUTPUT fprinter\ncheck file-status]
EVAL -->|write| R92[r92-write-primesui:\nload t-ident / t-prime into cell\nprimes-idx + 1]
EVAL -->|log-message| R98[r98-message-ui:\nDISPLAY process-message\nUPON scherm]
EVAL -->|stop| R99[r99-stop-primesui:\nflush partial line\nCLOSE fprinter]
EVAL -->|other| ERR[ui-method-result = 1]
R90 --> STATCK{file-status = '00'?}
STATCK -->|Yes| OPENOK[ui-method-result = 0\nprimes-idx = 1]
STATCK -->|No| OPENNOK[ui-method-result = 1\nDISPLAY status on console]
R92 --> NEWPG{new-page?}
NEWPG -->|Yes| R93[r93-new-page:\nwrite heading + column header\nprint-new-page = 0]
NEWPG -->|No| IDX7{primes-idx = 7?}
R93 --> IDX7
IDX7 -->|Yes| WRITELN[WRITE print line\nprimes-idx = 1]
IDX7 -->|No| LINCNT{linage-counter = 53?}
WRITELN --> LINCNT
LINCNT -->|Yes| R94[r94-eop:\nwrite footing\npage-number + 1\nprint-new-page = 1]
LINCNT -->|No| UIEXIT
R94 --> UIEXIT
R99 --> FLUSH[PERFORM r92-write-primesui\nUNTIL new-page\nwriting zero rows]
FLUSH --> CLSFIL[CLOSE fprinter]
CLSFIL --> UIEXIT
OPENOK & OPENNOK & R98 & ERR & CLSFIL --> UIEXIT([EXIT PROGRAM])</pre>

-----


== 7. Sequence Diagram — Full Report Run ==

<pre class="mermaid">sequenceDiagram
participant Shell
participant MAIN as primesmain
participant GEN as primesgen
participant DAL as primes (DAL)
participant UI as primesui
participant DB as PostgreSQL
participant PRT as primes.prt

Shell->>MAIN: execute "report"
MAIN->>UI: ui-methods="start"
UI->>PRT: OPEN OUTPUT
PRT-->>UI: file-status "00"
UI-->>MAIN: ui-method-result=0
MAIN->>UI: ui-methods="log-message" "UI init OK"
UI->>Shell: DISPLAY on console

MAIN->>GEN: CALL primesgen methods="report"
GEN->>DAL: dal-methods="connect"
DAL->>DB: EXEC SQL CONNECT
DB-->>DAL: SQLCODE=0
DAL-->>GEN: dal-result=0
GEN->>UI: ui-methods="log-message" "DB init OK"

GEN->>DAL: dal-methods="cursor"
DAL->>DB: START TRANSACTION
DAL->>DB: OPEN primescursor
DB-->>DAL: SQLCODE=0
DAL-->>GEN: dal-result=0

GEN->>DAL: dal-methods="next-prime" (first fetch)
DAL->>DB: FETCH primescursor
DB-->>DAL: row (ident, prime)
DAL-->>GEN: primes-sequence, prime-number

loop for each row until EOF
GEN->>UI: ui-methods="write" u-sequence, u-number
UI->>PRT: accumulate / WRITE line (every 6 entries)
GEN->>DAL: dal-methods="next-prime"
DAL->>DB: FETCH primescursor
DB-->>DAL: row or EOF
DAL-->>GEN: dal-result (0 or 1)
end

GEN->>DAL: dal-methods="disconnect"
DAL->>DB: CONNECT RESET primes
DB-->>DAL: SQLCODE=0
DAL-->>GEN: dal-result=0
GEN-->>MAIN: EXIT PROGRAM

MAIN->>UI: ui-methods="log-message" "Run complete"
MAIN->>UI: ui-methods="stop"
UI->>PRT: flush + CLOSE
PRT-->>UI: file-status "00"
UI-->>MAIN: ui-method-result=0
MAIN->>Shell: STOP RUN</pre>

<hr/>
Terug naar: [[Primes_programs_specifications]] | [[Cobol and PostgreSQL]]

Data dictionary

2026-03-25T16:46:04Z

Martin: Created page with " = Data Dictionary = '''Project:''' pgcobol — Prime Numbers Application '''Version:''' 1.0 (reverse-engineered) '''Date:''' 2026-03-17 ----- == 1. Conventions == {| ! Column ! Meaning |- | Name | COBOL data-name as written in source |- | Level | 01 / 03 / 05 / 07 hierarchy level |- | Picture | COBOL PICTURE clause |- | Usage | DISPLAY (default) / COMP-3 / COMP-5 |- | Source | Copybook or..."

= Data Dictionary =

'''Project:''' pgcobol — Prime Numbers Application 
'''Version:''' 1.0 (reverse-engineered) 
'''Date:''' 2026-03-17

-----


== 1. Conventions ==

{|
! Column
! Meaning
|-
| Name
| COBOL data-name as written in source
|-
| Level
| 01 / 03 / 05 / 07 hierarchy level
|-
| Picture
| COBOL PICTURE clause
|-
| Usage
| DISPLAY (default) / COMP-3 / COMP-5
|-
| Source
| Copybook or program where defined
|-
| Description
| Semantic meaning and valid values
|}

Condition-names (88-level) are listed under the field they qualify.

-----


== 2. Copybook: primes-session.cpy ==

'''Control block for the session (main → business-logic) tier.'''

{|
!width="20%"| Name
!width="20%"| Level
!width="20%"| Picture
!width="20%"| Usage
!width="20%"| Description
|-
| <code>primes-session</code>
| 01
| —
| —
| Root of session control block; passed as linkage to primesgen
|-
| <code>methods</code>
| 03
| X(32)
| DISPLAY
| Operation verb set by primesmain before calling primesgen
|-
| — <code>report-primes</code>
| 88
| —
| —
| VALUE “report” — run the report path
|-
| — <code>generate-primes</code>
| 88
| —
| —
| VALUE “generate” — run the sieve path
|-
| — <code>start-primes</code>
| 88
| —
| —
| VALUE “start” — (reserved, not used in current flow)
|-
| — <code>stop-primes</code>
| 88
| —
| —
| VALUE “stop” — (reserved, not used in current flow)
|-
| — <code>invalid-method</code>
| 88
| —
| —
| VALUE “bad” — sentinel for bad dispatch
|-
| <code>session-result</code>
| 03
| 9(2)
| DISPLAY
| Result code written back by primesgen; initial value ZERO
|-
| — <code>session-method-ok</code>
| 88
| —
| —
| VALUE 0 — operation succeeded
|-
| — <code>session-method-nok</code>
| 88
| —
| —
| VALUE 1 — operation failed
|-
| — <code>session-method-eof</code>
| 88
| —
| —
| VALUE 9 — cursor exhausted (end of data)
|}

-----


== 3. Copybook: primes-dal.cpy ==

'''Control block for the DAL (business-logic → data-access) tier.'''

{|
!width="20%"| Name
!width="20%"| Level
!width="20%"| Picture
!width="20%"| Usage
!width="20%"| Description
|-
| <code>primes-dal</code>
| 01
| —
| —
| Root of DAL control block; passed as linkage to primes
|-
| <code>dal-methods</code>
| 03
| X(32)
| DISPLAY
| Operation verb set by caller
|-
| — <code>next-prime</code>
| 88
| —
| —
| VALUE “next-prime” — fetch next row from cursor
|-
| — <code>next-divider</code>
| 88
| —
| —
| VALUE “next-divider” — select divider by ident
|-
| — <code>write-prime</code>
| 88
| —
| —
| VALUE “write” — insert prime into table
|-
| — <code>db-cursor</code>
| 88
| —
| —
| VALUE “cursor” — start transaction and open cursor
|-
| — <code>db-connect</code>
| 88
| —
| —
| VALUE “connect” — connect to PostgreSQL
|-
| — <code>db-disconnect</code>
| 88
| —
| —
| VALUE “disconnect” — disconnect from PostgreSQL
|-
| — <code>invalid-method</code>
| 88
| —
| —
| VALUE “bad” — sentinel for bad dispatch
|-
| <code>primes-data</code>
| 03
| —
| —
| One-row data payload
|-
| <code>primes-sequence</code>
| 05
| 9(9)
| DISPLAY
| Sequence / ident of the current prime row
|-
| <code>prime-number</code>
| 05
| 9(9)
| DISPLAY
| Value of the current prime
|-
| <code>dal-result</code>
| 03
| 9(2)
| DISPLAY
| Result code written back by primes; initial value ZERO
|-
| — <code>dal-method-ok</code>
| 88
| —
| —
| VALUE 0 — operation succeeded
|-
| — <code>dal-method-nok</code>
| 88
| —
| —
| VALUE 1 — operation failed
|-
| — <code>dal-method-eof</code>
| 88
| —
| —
| VALUE 99 — cursor exhausted
|}

-----


== 4. Copybook: primes-ui.cpy ==

'''Control block for the UI tier; included by all four programs.'''

{|
!width="20%"| Name
!width="20%"| Level
!width="20%"| Picture
!width="20%"| Usage
!width="20%"| Description
|-
| <code>primes-ui</code>
| 01
| —
| —
| Root of UI control block; passed as linkage to primesui
|-
| <code>ui-methods</code>
| 03
| X(32)
| DISPLAY
| Operation verb set by caller
|-
| — <code>write-ui</code>
| 88
| —
| —
| VALUE “write” — add one prime row to print buffer
|-
| — <code>message-ui</code>
| 88
| —
| —
| VALUE “log-message” — display console message
|-
| — <code>start-ui</code>
| 88
| —
| —
| VALUE “start” — open print file
|-
| — <code>stop-ui</code>
| 88
| —
| —
| VALUE “stop” — flush and close print file
|-
| <code>process-message</code>
| 03
| —
| —
| Structured console log record
|-
| <code>program-name</code>
| 05
| X(20)
| DISPLAY
| Name of the calling program (for log messages)
|-
| <code>program-line</code>
| 05
| —
| —
| Group: paragraph name + message text
|-
| <code>program-paragraph</code>
| 07
| X(20)
| DISPLAY
| Name of the calling paragraph
|-
| <code>program-message</code>
| 07
| X(92)
| DISPLAY
| Human-readable status or error message
|-
| <code>u-primes</code>
| 03
| —
| —
| One prime row for the print writer
|-
| <code>u-sequence</code>
| 05
| 9(9)
| DISPLAY
| Prime sequence number (ident) to print
|-
| <code>u-number</code>
| 05
| 9(9)
| DISPLAY
| Prime value to print
|-
| <code>ui-method-result</code>
| 03
| 9(2)
| DISPLAY
| Result code from primesui; initial value ZERO
|-
| — <code>ui-method-ok</code>
| 88
| —
| —
| VALUE 0 — operation succeeded
|-
| — <code>ui-method-nok</code>
| 88
| —
| —
| VALUE 1 — operation failed
|}

-----


== 5. Copybook: primes-table.cpy ==

'''SQL host variable — character (DISPLAY) format.'''

{|
!width="20%"| Name
!width="20%"| Level
!width="20%"| Picture
!width="20%"| Usage
!width="20%"| Description
|-
| <code>primes-table</code>
| 01
| —
| —
| Host variable group for SQL bind/into
|-
| <code>ident</code>
| 03
| S9(9)
| DISPLAY
| Row identity (sequence number), signed
|-
| <code>prime</code>
| 03
| S9(9)
| DISPLAY
| Prime value, signed
|}

-----


== 6. Copybook: primes_table.cpy ==

'''SQL host variable — packed-decimal (COMP-3) format. Alternate version of primes-table.cpy.'''

{|
! Name
! Level
! Picture
! Usage
! Description
|-
| <code>primes_table</code>
| 01
| —
| —
| Host variable group for SQL bind/into
|-
| <code>ident</code>
| 03
| S9(9)
| COMP-3
| Row identity, packed decimal
|-
| <code>prime</code>
| 03
| S9(9)
| COMP-3
| Prime value, packed decimal
|}

-----


== 7. Copybook: SQLCA.cpy ==

'''GixSQL SQL Communications Area — standard across all embedded-SQL programs.'''

{|
!width="20%"| Name
!width="20%"| Level
!width="20%"| Picture
!width="20%"| Usage
!width="20%"| Description
|-
| <code>SQLCA</code>
| 01
| —
| —
| SQL communications area
|-
| <code>SQLCAID</code>
| 05
| X(8)
| DISPLAY
| SQLCA identifier string
|-
| <code>SQLCABC</code>
| 05
| S9(9)
| COMP-5
| Byte length of SQLCA
|-
| <code>SQLCODE</code>
| 05
| S9(9)
| COMP-5
| SQL return code: 0 = success, negative = error, +100 = not found
|-
| <code>SQLERRM</code>
| 05
| —
| —
| Error message group
|-
| <code>SQLERRML</code>
| 49
| S9(4)
| COMP-5
| Length of error message text
|-
| <code>SQLERRMC</code>
| 49
| X(70)
| DISPLAY
| Error message text
|-
| <code>SQLERRP</code>
| 05
| X(8)
| DISPLAY
| Error program (not used)
|-
| <code>SQLERRD</code>
| 05
| S9(9) OCCURS 6
| COMP-5
| Diagnostic codes; SQLERRD(3) = rows processed
|-
| <code>SQLWARN</code>
| 05
| —
| —
| Warning flags group (not used)
|-
| <code>SQLWARN0</code>–<code>SQLWARN7</code>
| 10
| X(1)
| DISPLAY
| Individual warning flags
|-
| <code>SQLSTATE</code>
| 05
| X(5)
| DISPLAY
| ANSI SQL state code
|}

-----


== 8. Program: primesmain — Working Storage ==

{|
!width="16%"| Name
!width="16%"| Level
!width="16%"| Picture
!width="16%"| Usage
!width="16%"| Source
!width="16%"| Description
|-
| <code>filler</code>
| 01
| X(32) VALUE “Start WS primesmain”
| DISPLAY
| primesmain.cbl
| Debug marker to locate WS in memory dump
|-
| <code>commandline-args</code>
| 01
| X(32)
| DISPLAY
| primesmain.cbl
| Command-line argument accepted from OS
|-
| — <code>execute-generate</code>
| 88
| —
| —
| primesmain.cbl
| VALUE “generate”
|-
| — <code>execute-report</code>
| 88
| —
| —
| primesmain.cbl
| VALUE “report”
|-
| <code>primes-session</code>
| 01
| (group)
| —
| COPY
| See §2
|-
| <code>primes-ui</code>
| 01
| (group)
| —
| COPY
| See §4
|}

-----


== 9. Program: primesgen — Working Storage ==

{|
!width="20%"| Name
!width="20%"| Level
!width="20%"| Picture
!width="20%"| Usage
!width="20%"| Description
|-
| <code>filler</code>
| 01
| X(32) VALUE “Start WS primesgen”
| DISPLAY
| Debug WS marker
|-
| <code>file-buffer</code>
| 01
| X(132)
| DISPLAY
| FD record area for fprinter (declared but file not opened in primesgen)
|-
| <code>printer</code>
| 01
| —
| —
| Print control group (unused in primesgen; print handled by primesui)
|-
| <code>print-buffer</code>
| 03
| X(132)
| DISPLAY
| Line buffer
|-
| <code>line-number</code>
| 03
| 99 VALUE 99
| DISPLAY
| Current line counter
|-
| <code>page-number</code>
| 03
| 9(4) VALUE ZERO
| DISPLAY
| Current page counter
|-
| <code>test-quot</code>
| 01
| 9(9)
| DISPLAY
| Quotient from DIVIDE in sieve loop
|-
| <code>primes</code>
| 01
| —
| —
| Local sieve control group (mirrors primes-dal structure)
|-
| <code>gen-methods</code>
| 03
| X(32)
| DISPLAY
| Method verb for internal DAL calls
|-
| — <code>query-process</code>
| 88
| —
| —
| VALUE “query”
|-
| — <code>start-process</code>
| 88
| —
| —
| VALUE “start”
|-
| — <code>next-divider</code>
| 88
| —
| —
| VALUE “get”
|-
| — <code>write-prime</code>
| 88
| —
| —
| VALUE “put”
|-
| — <code>stop-process</code>
| 88
| —
| —
| VALUE “stop”
|-
| <code>primes-result</code>
| 03
| 9(2) VALUE ZERO
| DISPLAY
| Result of sieve DAL call
|-
| — <code>init-primes-ok</code>
| 88
| —
| —
| VALUE 1
|-
| — <code>first-divider-ok</code>
| 88
| —
| —
| VALUE 2
|-
| — <code>next-divider-ok</code>
| 88
| —
| —
| VALUE 3
|-
| <code>test-number</code>
| 03
| 9(9)
| DISPLAY
| Current candidate being tested for primality
|-
| <code>test-number-sqr</code>
| 03
| 9(9)V9(9)
| DISPLAY
| Square root of test-number (decimal)
|-
| <code>test-divider</code>
| 03
| 9(9)
| DISPLAY
| Current trial divisor fetched from DB
|-
| <code>test-rest</code>
| 03
| 9(9)V9(9)
| DISPLAY
| Remainder from DIVIDE
|-
| <code>old-test-number</code>
| 03
| 9(9)
| DISPLAY
| Previous test-number (diagnostic / unused)
|-
| <code>old-ident</code>
| 03
| 9(9)
| DISPLAY
| ident of the last divider fetched; incremented before next fetch
|-
| <code>new-ident</code>
| 03
| 9(9)
| DISPLAY
| old-ident + 1; used as key in SELECT to get next divider
|-
| <code>primes-ui</code>
| 01
| (group)
| —
| COPY — see §4
|-
| <code>primes-dal</code>
| 01
| (group)
| —
| COPY — see §3
|}

'''Linkage section:'''

{|
! Name
! Source
! Description
|-
| <code>primes-session</code>
| COPY primes-session
| Passed in by primesmain
|}

-----


== 10. Program: primes (DAL) — Working Storage ==

{|
!width="20%"| Name
!width="20%"| Level
!width="20%"| Picture
!width="20%"| Usage
!width="20%"| Description
|-
| <code>filler</code>
| 01
| X(32) VALUE “Start WS primes”
| DISPLAY
| Debug WS marker
|-
| <code>DATASRC</code>
| 01
| X(64) VALUE “pgsql://localhost:5432/primes&default_schema=primes”
| DISPLAY
| GixSQL connection string
|-
| <code>DBUSR</code>
| 01
| X(64) VALUE “primes_user”
| DISPLAY
| Database user name
|-
| <code>DBPWD</code>
| 01
| X(64) VALUE “pr1mes_user”
| DISPLAY
| Database password (plain-text)
|-
| <code>CUR-STEP</code>
| 01
| X(16)
| DISPLAY
| Diagnostic: current SQL step (“CONNECT” / “DISCONNECT”)
|-
| <code>primes-row</code>
| 01
| —
| —
| FETCH target for cursor
|-
| <code>r-ident</code>
| 03
| 9(9)
| COMP-3
| Fetched ident value
|-
| <code>r-prime</code>
| 03
| 9(9)
| COMP-3
| Fetched prime value
|-
| <code>prime-count</code>
| 01
| 9(9)
| DISPLAY
| (Unused in current flow)
|-
| <code>prime_seq</code>
| 01
| 9(9)
| DISPLAY
| (Unused in current flow)
|-
| <code>divider</code>
| 01
| 9(9)
| DISPLAY
| (Unused in current flow)
|-
| <code>primes</code>
| 01
| —
| —
| Local copy of sieve control (mirrors primes-dal; used for internal paragraphs)
|-
| <code>SQLCA</code>
| 01
| —
| —
| COPY SQLCA — see §7
|-
| <code>primes-table</code>
| 01
| —
| —
| EXEC SQL INCLUDE primes-table — see §5
|-
| <code>primes-ui</code>
| 01
| —
| —
| COPY primes-ui — see §4
|}

'''Linkage section:'''

{|
! Name
! Source
! Description
|-
| <code>primes-dal</code>
| COPY primes-dal
| Passed in by primesgen
|}

-----


== 11. Program: primesui — Working Storage ==

{|
!width="20%"| Name
!width="20%"| Level
!width="20%"| Picture
!width="20%"| Usage
!width="20%"| Description
|-
| <code>filler</code>
| 01
| X(32) VALUE “start ws primesui”
| DISPLAY
| Debug WS marker
|-
| <code>primes-table</code>
| 01
| —
| —
| 6-column print accumulator (OCCURS 6)
|-
| <code>primes-cel</code>
| 03
| OCCURS 6 INDEXED primes-idx
| —
| One cell per prime entry on a print line
|-
| <code>t-ident</code>
| 05
| Z(9)
| DISPLAY
| Sequence number, zero-suppressed
|-
| filler
| 05
| X(2)
| DISPLAY
| Column separator spaces
|-
| <code>t-prime</code>
| 05
| Z(9)
| DISPLAY
| Prime value, zero-suppressed
|-
| filler
| 05
| X(2)
| DISPLAY
| Column separator spaces
|-
| <code>table-header</code>
| 01
| —
| —
| Heading row (OCCURS 6) — “Sequence Prime” × 6
|-
| <code>printer</code>
| 01
| —
| —
| Print control group
|-
| <code>print-buffer</code>
| 03
| X(132)
| DISPLAY
| Current line being built
|-
| <code>primes-prt-status</code>
| 03
| X(2)
| DISPLAY
| File-status code for fprinter
|-
| <code>page-number</code>
| 03
| 9(4) VALUE 1
| DISPLAY
| Current page number
|-
| <code>print-new-page</code>
| 03
| 9 VALUE 1
| DISPLAY
| Flag: 1 = new page needed
|-
| — <code>new-page</code>
| 88
| —
| —
| VALUE 1
|-
| <code>primes-heading</code>
| 01
| X(118) VALUE “primes overview”
| DISPLAY
| Page heading text
|-
| <code>primes-footing</code>
| 01
| —
| —
| Page footing group
|-
| filler
| 03
| X(118) VALUE SPACE
| DISPLAY
| Left padding
|-
| filler
| 03
| X(6) VALUE “page:”
| DISPLAY
| Label
|-
| <code>f-page-number</code>
| 03
| Z(3)9 VALUE 1
| DISPLAY
| Formatted page number
|-
| <code>primes-line</code>
| 01
| —
| —
| (Declared but not used in current flow)
|-
| <code>primes-total</code>
| 01
| —
| —
| (Declared but not used in current flow)
|-
| <code>primes-count</code>
| 03
| 9(8)
| DISPLAY
| (Declared but not used in current flow)
|}

'''Linkage section:'''

{|
! Name
! Source
! Description
|-
| <code>primes-ui</code>
| COPY primes-ui
| Passed in by all callers
|}

-----


== 12. Database Objects ==

{|
!width="20%"| Object
!width="20%"| Type
!width="20%"| Schema
!width="20%"| Owner
!width="20%"| Definition
|-
| <code>primes</code>
| Schema
| —
| primes_user
| Container schema
|-
| <code>asc_ident</code>
| Sequence
| primes
| primes_user
| INTEGER, START 1, INCREMENT 1
|-
| <code>primes</code>
| Table
| primes
| primes_user
| See below
|-
| <code>primescursor</code>
| Cursor
| runtime
| —
| DECLARE … CURSOR FOR SELECT * FROM primes
|}


=== Table: primes.primes ===

{|
!width="20%"| Column
!width="20%"| Type
!width="20%"| Nullable
!width="20%"| Default
!width="20%"| Description
|-
| <code>ident</code>
| INTEGER
| YES
| nextval(‘primes.asc_ident’)
| Auto-assigned insertion sequence
|-
| <code>prime</code>
| INTEGER
| YES
| —
| Prime number value
|}

<hr/>
Terug naar: [[Primes_programs_specifications]] | [[Cobol and PostgreSQL]]

Technical specifications

2026-03-25T16:44:47Z

Martin: Created page with " = Technical Specification = '''Project:''' pgcobol — Prime Numbers Application '''Version:''' 1.0 (reverse-engineered) '''Date:''' 2026-03-17 ----- == 1. Technology Stack == {| !width="50%"| Component !width="50%"| Technology |- | Runtime | GnuCOBOL 4.0, Linux |- | SQL pre-processor | GixSQL (translates EXEC SQL … END-EXEC to GIXSQLExec calls) |- | Database server | Postgr..."

= Technical Specification =

'''Project:''' pgcobol — Prime Numbers Application 
'''Version:''' 1.0 (reverse-engineered) 
'''Date:''' 2026-03-17

-----


== 1. Technology Stack ==

{|
!width="50%"| Component
!width="50%"| Technology
|-
| Runtime
| GnuCOBOL 4.0, Linux
|-
| SQL pre-processor
| GixSQL (translates EXEC SQL … END-EXEC to GIXSQLExec calls)
|-
| Database server
| PostgreSQL 11.22, localhost:5432
|-
| Database schema
| <code>primes</code>
|-
| Credentials
| user <code>primes_user</code>, password <code>pr1mes_user</code> (hard-coded)
|-
| Output file
| <code>primes.prt</code> — line-sequential, 132 chars/record, linage 56
|-
| Console
| GnuCOBOL special-name <code>scherm</code> mapped to system console
|}

-----


== 2. Component Architecture ==

<pre>┌─────────────────────────────────────────────────────┐
│ primesmain │ ← Entry point / orchestrator
│ WORKING-STORAGE: commandline-args │
│ COPY: primes-session, primes-ui │
└────────────┬────────────────────────────────────────┘
│ CALL "primesgen" USING primes-session
▼
┌─────────────────────────────────────────────────────┐
│ primesgen │ ← Business logic / sieve engine
│ WORKING-STORAGE: primes (local), printer │
│ COPY (linkage): primes-session │
│ COPY (local): primes-ui, primes-dal │
└────────┬──────────────────────┬─────────────────────┘
│ CALL "primes" │ CALL "primesui"
│ USING primes-dal │ USING primes-ui
▼ ▼
┌──────────────────┐ ┌──────────────────────────────┐
│ primes │ │ primesui │ ← Presentation / output
│ (DAL + SQL) │ │ FILE: fprinter → primes.prt │
│ EXEC SQL via │ │ WORKING-STORAGE: primes-table│
│ GixSQL │ │ COPY (linkage): primes-ui │
└──────────────────┘ └──────────────────────────────┘
│
▼
┌──────────────────┐
│ PostgreSQL │
│ schema: primes │
│ table: primes │
└──────────────────┘</pre>

-----


== 3. Inter-Tier Interface Contracts ==

All communication between tiers uses method-dispatch over shared copybook control blocks. A caller sets a verb string in the <code>methods</code> field, invokes the subprogram, and reads the result code on return.


=== 3.1 Session tier — <code>primes-session</code> ===

<pre>primes-session
methods PIC X(32) verb sent by caller
88 report-primes "report"
88 generate-primes "generate"
88 start-primes "start"
88 stop-primes "stop"
88 invalid-method "bad"
session-result PIC 9(2) set by callee
88 session-method-ok 0
88 session-method-nok 1
88 session-method-eof 9</pre>

=== 3.2 DAL tier — <code>primes-dal</code> ===

<pre>primes-dal
dal-methods PIC X(32) verb sent by caller
88 next-prime "next-prime"
88 next-divider "next-divider"
88 write-prime "write"
88 db-cursor "cursor"
88 db-connect "connect"
88 db-disconnect "disconnect"
primes-data data payload (one row)
primes-sequence PIC 9(9) ident from DB
prime-number PIC 9(9) prime value from DB
dal-result PIC 9(2) set by callee
88 dal-method-ok 0
88 dal-method-nok 1
88 dal-method-eof 99</pre>

=== 3.3 UI tier — <code>primes-ui</code> ===

<pre>primes-ui
ui-methods PIC X(32) verb sent by caller
88 start-ui "start"
88 write-ui "write"
88 message-ui "log-message"
88 stop-ui "stop"
process-message structured console message
program-name PIC X(20)
program-paragraph PIC X(20)
program-message PIC X(92)
u-primes one prime row for print output
u-sequence PIC 9(9)
u-number PIC 9(9)
ui-method-result PIC 9(2) set by callee
88 ui-method-ok 0
88 ui-method-nok 1</pre>

-----


== 4. Pseudocode ==


=== 4.1 primesmain ===

<pre>PROGRAM primesmain
INPUT: command-line argument → commandline-args

CALL primesui("start")
IF ui-method-ok THEN
LOG "UI initialisation succeeded."
LOG commandline-args
ELSE
DISPLAY emergency message on console
STOP

CASE commandline-args OF

"report":
LOG "Primes report generation starts."
SET methods = "report"
CALL primesgen(primes-session) -- report flow

"generate":
LOG "Primes generation starts."
SET methods = "generate"
-- NOTE: CALL primesgen commented out in current source

OTHER:
LOG "Bad parameter, program initialisation failed."
CALL primesui("stop")
STOP

END CASE

LOG "Primes run complete, program stops."
CALL primesui("stop")
STOP
END PROGRAM</pre>

=== 4.2 primesgen — report path ===

<pre>PROCEDURE report-path
CALL primes-dal("connect")
IF dal-method-ok THEN
LOG "Database initialisation succeeded."
ELSE
LOG "Database initialisation failed."
SET session-result = 1
RETURN

CALL primes-dal("cursor") -- START TRANSACTION + OPEN primescursor
IF dal-method-ok THEN
LOG "Cursor initialisation succeeded."
ELSE
LOG "Cursor initialisation failed."
SET session-result = 1
RETURN

FETCH first row via primes-dal("next-prime")
IF fetch fails THEN
LOG "Fetch first row nok."
SET dal-result = 1

LOOP UNTIL session-method-eof
SET u-sequence = primes-sequence
SET u-number = prime-number
CALL primesui("write") -- accumulate into print buffer
CALL primes-dal("next-prime") -- advance cursor
END LOOP
END PROCEDURE</pre>

=== 4.3 primesgen — generate path ===

<pre>PROCEDURE generate-path
CALL primes-dal("connect")
IF dal-method-ok THEN
SET test-divider = 2
SET old-ident = 1
SET test-number = 3
SET test-number-sqr = SQRT(3)
LOG "Database initialisation succeeded."
ELSE
LOG "Database initialisation failed."
SET session-result = 1
RETURN

LOOP UNTIL test-number = 999,999,999

DIVIDE test-number BY test-divider → test-quot REMAINDER test-rest

CASE OF
test-rest = 0:
-- test-number is composite; move to next candidate
ADD 2 TO test-number
SET test-number-sqr = SQRT(test-number)
SET old-ident = 1
FETCH divider[old-ident+1] via primes-dal("next-divider")

test-divider > test-number-sqr:
-- no factor found up to sqrt; test-number is prime
CALL primes-dal("write") -- INSERT INTO primes
CALL primesui("write") -- add to print buffer
ADD 2 TO test-number
SET test-number-sqr = SQRT(test-number)
SET old-ident = 1
FETCH divider[old-ident+1] via primes-dal("next-divider")

OTHERWISE:
-- try next divider from DB
FETCH divider[old-ident+1] via primes-dal("next-divider")
END CASE

END LOOP
END PROCEDURE</pre>

=== 4.4 primes (DAL) ===

<pre>PROGRAM primes
LINKAGE: primes-dal

CASE dal-methods OF
"connect":
EXEC SQL CONNECT TO datasrc AS primes USER dbusr USING dbpwd
IF SQLCODE = 0 THEN dal-result = 0 ELSE dal-result = 1

"cursor":
EXEC SQL AT primes START TRANSACTION
IF SQLCODE = 0 THEN
EXEC SQL OPEN primescursor
IF SQLCODE = 0 THEN dal-result = 0 ELSE dal-result = 1
ELSE dal-result = 1

"next-prime":
EXEC SQL FETCH primescursor INTO :primes-row
IF SQLCODE = 0 THEN
primes-sequence = r-ident
prime-number = r-prime
dal-result = 0
ELSE dal-result = 1

"next-divider":
new-ident = old-ident + 1
EXEC SQL SELECT prime INTO :test-divider
FROM primes WHERE ident = :new-ident
old-ident = new-ident

"write":
EXEC SQL INSERT INTO primes (prime) VALUES (:prime)

"disconnect":
EXEC SQL CONNECT RESET primes
IF SQLCODE = 0 THEN dal-result = 0 ELSE dal-result = 1

OTHER:
dal-result = 1
END CASE
EXIT PROGRAM
END PROGRAM</pre>

=== 4.5 primesui ===

<pre>PROGRAM primesui
LINKAGE: primes-ui

CASE ui-methods OF
"start":
OPEN OUTPUT fprinter (primes.prt)
IF file-status = "00" THEN
ui-method-result = 0
primes-idx = 1
ELSE
ui-method-result = 1

"write":
t-ident(primes-idx) = u-sequence
t-prime(primes-idx) = u-number
primes-idx = primes-idx + 1
IF new-page THEN write heading + column header
IF primes-idx = 7 THEN
WRITE primes-table line to fprinter
primes-idx = 1
IF linage-counter = 53 THEN write footing, increment page

"log-message":
DISPLAY process-message ON CONSOLE

"stop":
LOOP writing zero rows UNTIL new-page -- flush partial line
CLOSE fprinter

END CASE
EXIT PROGRAM
END PROGRAM</pre>

-----


== 5. Database Interface Specification ==


=== 5.1 Connection ===

{|
! Parameter
! Value
|-
| Driver
| GixSQL pgsql
|-
| Host
| localhost
|-
| Port
| 5432
|-
| Database
| primes
|-
| Schema search path
| primes
|-
| Connection alias
| primes
|-
| User
| primes_user
|-
| Password
| pr1mes_user
|}


=== 5.2 SQL Statements ===

{|
!width="33%"| ID
!width="33%"| Statement
!width="33%"| Called from
|-
| S-01
| <code>CONNECT TO :DATASRC AS primes USER :DBUSR USING :DBPWD</code>
| s00-connect
|-
| S-02
| <code>START TRANSACTION</code>
| s01-cursor
|-
| S-03
| <code>DECLARE primescursor CURSOR FOR SELECT * FROM primes</code>
| compile-time
|-
| S-04
| <code>OPEN primescursor</code>
| s01-cursor
|-
| S-05
| <code>FETCH primescursor INTO :primes-row</code>
| s02-fetch
|-
| S-06
| <code>SELECT prime INTO :test-divider FROM primes WHERE ident = :new-ident</code>
| r81-get-next-divider
|-
| S-07
| <code>INSERT INTO primes (prime) VALUES (:prime)</code>
| r83-write-prime
|-
| S-08
| <code>CONNECT RESET primes</code>
| s99-disconnect
|}


=== 5.3 Error Handling ===

* All SQL paths test <code>SQLCODE = 0</code> for success.
* On failure, a diagnostic string is moved to <code>program-message</code> and logged via primesui.
* <code>dal-result</code> is set to <code>1</code> (nok) on SQL errors; callers check <code>dal-method-ok</code> before continuing.
* No retry logic is implemented; errors cause the current operation to be skipped or the session to terminate.

-----


== 6. Output File Specification ==

{|
! Property
! Value
|-
| Filename
| <code>primes.prt</code>
|-
| Organisation
| Line-sequential
|-
| Record length
| 132 characters
|-
| Linage
| 56 lines per page
|-
| Footing area
| 2 lines from bottom
|-
| Bottom margin
| 2 lines
|-
| Records per data line
| 6 primes (sequence + value pairs)
|-
| Page heading
| <code>"primes overview"</code> (col 1)
|-
| Column header
| <code>"Sequence Prime"</code> × 6 across
|-
| Page footing
| Spaces + <code>"page: ZZZZ9"</code> (right side)
|-
| EOP trigger
| linage-counter = 53
|}

-----


== 7. Known Defects and Limitations ==

{|
!width="33%"| ID
!width="33%"| Severity
!width="33%"| Description
|-
| D-01
| High
| Generate loop (<code>PERFORM r80-test-number</code>) is commented out in primesmain; generation mode does not execute the sieve.
|-
| D-02
| Medium
| Prime 2 is never seeded; generation starts at 3 with first divider = 2 retrieved from DB, but DB is empty at start of a fresh run.
|-
| D-03
| Medium
| <code>primes_cbsql.out</code> shows disconnect using alias <code>primesdb</code>; primes.cbl uses alias <code>primes</code> — alias mismatch will cause runtime SQL error.
|-
| D-04
| Low
| Database credentials are hard-coded in WORKING-STORAGE of primes.cbl.
|-
| D-05
| Low
| No COMMIT after INSERT in r83-write-prime (statement is commented out); relies on PostgreSQL auto-commit or session-level transaction semantics.
|-
| D-06
| Low
| Two almost-identical host-variable copybooks (<code>primes-table.cpy</code> vs <code>primes_table.cpy</code>) suggest unresolved refactoring.
|}
<hr/>
Terug naar: [[Primes_programs_specifications]] | [[Cobol and PostgreSQL]]

Business requirements

2026-03-25T16:43:26Z

Martin: Created page with " = Business Requirements Document = '''Project:''' pgcobol — Prime Numbers Application '''Version:''' 1.0 (reverse-engineered) '''Date:''' 2026-03-17 '''Status:''' Baseline ----- == 1. Purpose == The system generates prime numbers and stores them in a relational database, and provides a printed report of all stored primes. It demonstrates a three-tier COBOL application ar..."

= Business Requirements Document =

'''Project:''' pgcobol — Prime Numbers Application 
'''Version:''' 1.0 (reverse-engineered) 
'''Date:''' 2026-03-17 
'''Status:''' Baseline

-----


== 1. Purpose ==

The system generates prime numbers and stores them in a relational database, and provides a printed report of all stored primes. It demonstrates a three-tier COBOL application architecture running on Linux against a PostgreSQL database.

-----


== 2. Stakeholders ==

{|
!width="50%"| Role
!width="50%"| Concern
|-
| Developer / operator
| Runs generation and reporting jobs from the command line
|-
| Database administrator
| Manages schema, credentials, and data retention
|-
| End user
| Receives the printed prime-number report
|}

-----


== 3. Business Requirements ==


=== BR-01 — Prime Number Generation ===

The system shall compute all prime numbers from 3 up to 999,999,999 using a trial-division algorithm and store each confirmed prime in the database.

'''Acceptance criteria:''' - Every integer stored in the primes table is a prime number. - No prime in the range 3–999,999,999 is omitted. - The sequence column records insertion order via an auto-incrementing identity.


=== BR-02 — Prime Number Reporting ===

The system shall produce a formatted printed report listing all primes currently stored in the database.

'''Acceptance criteria:''' - Every row in the primes table appears in the report. - Rows are presented in database-cursor order (insertion order by ident). - The report is paginated with headings, column headers, and page numbers.


=== BR-03 — Operational Modes ===

The system shall support two mutually exclusive operational modes selectable at invocation:

{|
! Mode
! Argument
! Effect
|-
| Generate
| <code>generate</code>
| Compute primes and persist to DB
|-
| Report
| <code>report</code>
| Read DB and produce print file
|}

Any argument other than <code>generate</code> or <code>report</code> shall cause the program to log an error and terminate without processing.


=== BR-04 — Audit Trail / Console Logging ===

All significant processing events (session start/stop, database connection, cursor open, fetch errors, write confirmation) shall be written to the system console in real time.


=== BR-05 — Data Persistence ===

Prime numbers shall be stored persistently in a PostgreSQL database so that the report can be produced independently of and after the generation run.


=== BR-06 — Report Format ===

The printed report shall: - Carry a page heading (“primes overview”) and a column header row on every page. - Present six prime entries per print line (sequence number + prime value). - Carry a page-number footing at the bottom of each page. - Be written to a line-sequential file (<code>primes.prt</code>) with 132-character records.

-----


== 4. Constraints ==

{|
!width="50%"| ID
!width="50%"| Constraint
|-
| C-01
| Target runtime is GnuCOBOL 4.0 on Linux.
|-
| C-02
| Database is PostgreSQL 11; connection is localhost only.
|-
| C-03
| Database credentials are currently hard-coded in the DAL program.
|-
| C-04
| The upper bound of generation is fixed at 999,999,999.
|-
| C-05
| The print file is fixed at 132 columns, 56 lines per page.
|}

-----


== 5. Out of Scope ==

* Interactive (screen) input or output.
* Concurrent multi-user access.
* Prime generation restart / checkpoint recovery.
* Authentication or credential management.
* Scheduling or job-control integration.
<hr/>
Terug naar: [[Primes_programs_specifications]] | [[Cobol and PostgreSQL]]

COBOL Std 1 Purpose and Scope

2026-03-25T16:42:14Z

Martin: Undo revision 4764 by Martin (talk)

== 1. Purpose and Scope ==

This document defines the baseline coding standard for COBOL programs targeting GnuCOBOL 4.x on Linux, with optional GixSQL pre-processing for embedded PostgreSQL access. It applies to all newly written programs, to programs undergoing significant modification, and to reverse-engineering or migration work.

The standard covers four concerns:

* Source-code layout and formatting
* Naming conventions for data items, paragraphs, copybooks, and files
* Structural and architectural patterns (divisions, tiers, method-dispatch)
* Error handling, embedded SQL, and output formatting rules

{{Ambox
name = COBOL Std 1 Purpose and Scope{{subst:void|Don't change anything on this line. It will change itself when you save.}}
subst = <includeonly>{{subst:substcheck}}</includeonly>
type = notice
text = '''Compliance note''' — Existing programs may deviate from this standard. Any modification touching more than 20 % of a program's statements must bring the changed portions into conformance.
}}

<hr/>
[[Cobol programming standards]] | [[Cobol and PostgreSQL]]

COBOL Std 1 Purpose and Scope

2026-03-25T16:41:41Z

Martin:

== 1. Purpose and Scope ==

This document defines the baseline coding standard for COBOL programs targeting GnuCOBOL 4.x on Linux, with optional GixSQL pre-processing for embedded PostgreSQL access. It applies to all newly written programs, to programs undergoing significant modification, and to reverse-engineering or migration work.

The standard covers four concerns:

* Source-code layout and formatting
* Naming conventions for data items, paragraphs, copybooks, and files
* Structural and architectural patterns (divisions, tiers, method-dispatch)
* Error handling, embedded SQL, and output formatting rules

{{Ambox
name = COBOL Std 1 Purpose and Scope{{subst:void|Don't change anything on this line. It will change itself when you save.}}
subst = <includeonly>{{subst:substcheck}}</includeonly>
type = notice
text = '''Compliance note''' — Existing programs may deviate from this standard. Any modification touching more than 20 % of a program's statements must bring the changed portions into conformance.
}}

<hr/>
[[Primes programs specifications]] | [[Cobol and PostgreSQL]]

Primes programs specifications

2026-03-25T16:38:35Z

Martin:

= The Cobol Primes program =
This is a reverse generated program specification.
# [[Business requirements]]
# [[Technical specifications]]
# [[Data dictionary]]
# [[Flow diagrams]]
# [[Program Logic]]
# [[Business rules]]
# [[IO behaviour]]
# [[Control flow]]
<hr/>
Terug naar: [[Cobol and PostgreSQL]]

Cobol and PostgreSQL

2026-03-25T16:31:45Z

Martin:

This chapter contains
* The description of a complete working example of a '''Cobol''' '''PostgreSQL''' program of the sample employee database, that comes with GixSQL
* The three tier object oriented primes program, using a PostgreSQL database.
GixSQL is the Open Source way in which Cobol programs are able to use modern database management systems in a Linux environment.
= Primes program =
A prime number is defined by the fact that it can only be divided by 1 and itself. The [[primes]] program is a simple program to demonstrate the implementation of a three tier object oriented Cobol program. It consists of:
* A main program to invoke the process
* A UI layer
* A business logic layer, that is responsible for the logic involving prime numbers
* Database layer, for data storage.
The subprograms are al invoked by means of methods, in such a way that the PostgreSQL database could easily be replaced by MariaDB.
== Making sense of IT ==
The Primes program is just a one off, written for demonstration purposes and on top of my head without design apart from a few notes on the edge of a news paper. Budget constraints put pressure on projects, time to market of features comes first, testing comes second and documentation in this day and age of program focused delivery at best comes last,
=== The forgotten design ===
Standards are lacking, because of political issues, time constraints and a too rapid pace of developments. Of course, there should have been a design, lacking standards, accidents or laziness are another cause of missing, insufficient or outdated documentation. It can go as bad as programs running in production of which nobody has a clue of what they are doing exactly, the only certainty is that things go wrong whenever the program goes wrong.
I wrote the non nonsensical primes programs set on top of my head as an example three tier oriented system system, just to demonstrate the working of such a system. The challenge was to have some documentation at least, which is in line with the running joke in so many organisations: 'The program source is the best and most reliable source of information'. This is true under the condition that the program source is available, which is not always the case. There are loads of programs running in production today of which no one has a clue of what the program is doing, but everybody knows the program has to run to avoid problems. I did not go to the extend of re-engineering cobol source from the running executable (yet).
Thanks to [https://claude.ai Claude.ai]there is at least some documentation now.
* The primes system design [[Primes system Design]].
* Design standards [[Design standards]].
=== The forgotten documentation ===
On top of of the design and program specifications documents we require design standards and programming standards. The [[Cobol programming standards]] below have been generated in my hown grown ailab.
* The primes program specification [[Primes programs specifications]].
* One page [[Primes Software Specification]]
* Cobol programming standards [[Cobol programming standards]].
= Employee program =
The setup of the lab environment, source code and a simple compilation workflow are below.
* Program name: pgcobol
* Source code: pgcobol.cbl
* Intermediate preprocessed source code file: pgcobol.cbsql
* Cobol compiler output: pgcobol.out
* Database: Employee, with table emptable
* pgcobol print output file: pgcobol.prt
== Cobol ==
Cobol has been around for more than 60 years and will stay around for the foreseeable future, estimates are that there are about 800 billion lines of Business Cobol code around. The programs are heavily used, servicing about 80% of all financial and business transactions world wide. 
The reason behind this endurance lies in the fact that Cobol is a standardised language, a program written in 1974 can be compiled today with a modern compiler. The resulting executable program still runs today, without the need of adaptation. This very fact is of high value to enterprises, their investments are safe and well protected on the long term. 
Traditionally Cobol programs have their application in big business mainframe environments. These large enterprises, however, are shifting more and more of their applications to the Linux platform. The broad adoption of Linux in the enterprise environment started around 2010. So, it is no wonder that Cobol gradually is being made available for the Linux platform, enter [https://gnucobol.sourceforge.io/ GNUCobol].
=== GNUCobol ===
Is an Open Source Cobol compiler, the project originally started in 2002 [https://en.wikipedia.org/wiki/GnuCOBOL GNUCobol] as OpenCobol. GNUCobol now is a full blown Cobol compiler.

== GixSQL links PostgreSQL and Cobol ==
PostgreSQL is getting more and more traction around the world, also in the big enterprises. Big enterprises have ample reason to stick to their Cobol program stack, in which they invested huge amounts of money. So if PostgreSQL is to make it to the business applications of the big enterprises, it has to find a way to interact in a reliable manner with Cobol. Enter the [https://github.com/mridoni/gixsql GixSQL] SQL preprocessor for Cobol.
=== An SQL statement in Cobol ===
This is the way the SQL code is embedded in the Cobol program:
<pre>
EXEC SQL
CONNECT TO :DATASRC AS cobol_sql USER :DBUSR USING :DBPWD
END-EXEC.
</pre>
The example shows the program making a connection to the database with the variables DATASRC, DBUSR and DBPWD.

= Practical introduction to GixSQL =
This chapter provides guidance to set up a working GixSQL for GNUCobol with PostgreSQL development environment.
== Prerequisites ==
* Debian 12
* GnuCobol4
* libmariadb-dev libmariadb-dev-compat libpq5 unixodbc libfmt9
* GixSQL, find the link below
* optionally the PostgreSQL database server on the same machine.
GixSQL is available here: [https://github.com/mridoni/gixsql/releases/download/v1.0.21dev/gixsql-debian-12-x64-1.0.21dev-1.deb GixSQL].
Just install the software in the sequence as described above and the system is ready to go. 
For reasons of convenience add the follow lines to /etx/profile:
<pre>
LD_DIRECTORY_PATH="/usr/local/src/gix/gixisql/runtime/libgixsql:/usr/local/src/gix/gixsql/common:/usr/local/src/gix/gixsql/common"
export LD_DIRECTORY_PATH
</pre>

== Workflow ==
Once the editing of the program is finished, the program has to be compiled. This is done in various steps, but this can also be done by using the Python script below. 
The steps are:
# The precompile process
# Inspect (but do not edit the output)
# The compilation process
# Inspect the compilation listing
# Run the program
== Simple Workflow script ==
The python script [[gixc.py]] implements the GixSQL Cobol compilation workflow. It is invoked with a single parameter, being the program_name suffixed by either 'cbl or 'cob'. People that like to get their hands dirty follow the two steps below.
=== gixsql precompilation ===
The command invoking the precompile process is as follows: 
<pre>
/usr/bin/gixsql pgcobol.cbl pgcobol.cbsql -S -I . -e ".,*.cpy,*.CPY"
</pre>
The input file is pgcobol.cbl, the preprocessing output file is [[pgcobol.cbsql]]. It is very important to leave the cbsql file as is, because meddling with the file easily leads to errors in the next step of the workflow. 
The result of the precompile step of the SQL stement above looks like this:
<pre>
GIXSQL* EXEC SQL
GIXSQL* CONNECT TO :DATASRC AS cobol_sql USER :DBUSR USING :DBPWD
GIXSQL* END-EXEC.
GIXSQL CALL STATIC "GIXSQLConnect" USING
GIXSQL BY REFERENCE SQLCA
GIXSQL BY REFERENCE DATASRC
GIXSQL BY VALUE 64
GIXSQL BY REFERENCE "cobol_sql" & x"00"
GIXSQL BY VALUE 0
GIXSQL BY REFERENCE x"00"
GIXSQL BY VALUE 0
GIXSQL BY REFERENCE DBUSR
GIXSQL BY VALUE 64
GIXSQL BY REFERENCE DBPWD
GIXSQL BY VALUE 64
GIXSQL END-CALL.
</pre>
The precompile program translated the SQL statement in to a standardised Cobol call.

=== The cobc GNUCobol compilation ===
The command invoking the precompile process is as follows:
<pre>
/usr/bin/cobc -x pgcobol.cbsql -l:libgixsql.so -T pgcobol.out
</pre>
This results in the executable program file '''pgcobol''' and the compilation listing [[pgcobol.out]].

== Sample Program ==
The sample program [[pgcobol.cbl]] makes use of the sample database: employee. When executed pgcobol puts out the file [[pgcobol.prt]]. 
The pgcobol program file is available for download here: [https://wiki.webhuis.nl/images/pgcobol.cbl pgcobol.cbl ].

== Sample database ==
The [[employee database]] is a very simple database, with one table containing three lines. The pg_dump file is in the link.
<hr/>
Back to: [[voorpagina]]

Primes programs specifications

2026-03-25T16:18:58Z

Martin: Created page with " ```mediawiki = pgcobol Prime Numbers Application Documentation = This documentation provides a comprehensive overview of the prime numbers application developed using GnuCOBOL on Linux with PostgreSQL as the database backend. Below you will find links to various sections of the documentation. == Quick Links == * Technology Stack * Component Architecture * Business Requirements (BR) * Database Objects * [[Output File Specification]..."

```mediawiki
= pgcobol Prime Numbers Application Documentation =

This documentation provides a comprehensive overview of the prime numbers application developed using GnuCOBOL on Linux with PostgreSQL as the database backend. Below you will find links to various sections of the documentation.

== Quick Links ==
* [[Technology Stack]]
* [[Component Architecture]]
* [[Business Requirements|Business Requirements (BR)]]
* [[Database Objects]]
* [[Output File Specification]]

== Technology Stack ==
The application utilizes the following technologies:

{| class="wikitable"
! Component !! Technology
|-
| Runtime !! GnuCOBOL 4.0, Linux
|-
| SQL pre-processor !! GixSQL (translates EXEC SQL … END-EXEC to GIXSQLExec calls)
|-
| Database server !! PostgreSQL 11.22, localhost:5432
|-
| Database schema !! primes
|}

[[Technology Stack|More details]]

== Component Architecture ==
The application consists of the following components:

<pre>┌─────────────────────────────────────────────────────┐</pre>
[[Component Architecture|More details]]

== Business Requirements ==
The system is designed to meet the following business requirements:

=== BR-01: Prime Number Generation ===
The system shall compute all prime numbers from 3 up to 999,999,999 using a trial-division algorithm and store each confirmed prime in the database.

=== BR-02: Prime Number Reporting ===
The system shall produce a formatted printed report listing all primes currently stored in the database.

[[Business Requirements|More details]]

== Database Objects ==
The application interacts with the following database objects:

{| class="wikitable"
! Object !! Type !! Schema !! Owner !! Definition
|-
| primes !! Schema !! — !! primes_user !! Container schema
|-
| asc_ident !! Sequence !! primes !! primes_user !! INTEGER, START 1, INCREMENT 1
|-
| primes !! Table !! primes !! primes_user !! See below
|}

[[Database Objects|More details]]

== Output File Specification ==
The output report is generated in the following format:

{| class="wikitable"
! Property !! Value
|-
| Filename !! primes.prt
|-
| Organisation !! Line-sequential
|-
| Record length !! 132 characters
|}

[[Output File Specification|More details]]

== Constraints ==
The application operates under the following constraints:

{| class="wikitable"
<hr/>
Terug naar: [[Cobol and PostgreSQL]]

Cobol and PostgreSQL

2026-03-25T16:15:05Z

Martin: /* Primes program */

This chapter contains
* The description of a complete working example of a '''Cobol''' '''PostgreSQL''' program of the sample employee database, that comes with GixSQL
* The three tier object oriented primes program, using a PostgreSQL database.
GixSQL is the Open Source way in which Cobol programs are able to use modern database management systems in a Linux environment.
= Primes program =
A prime number is defined by the fact that it can only be divided by 1 and itself. The [[primes]] program is a simple program to demonstrate the implementation of a three tier object oriented Cobol program. It consists of:
* A main program to invoke the process
* A UI layer
* A business logic layer, that is responsible for the logic involving prime numbers
* Database layer, for data storage.
The subprograms are al invoked by means of methods, in such a way that the PostgreSQL database could easily be replaced by MariaDB.
== Making sense of IT ==
The Primes program is just a one off, written for demonstration purposes and on top of my head without design apart from a few notes on the edge of a news paper. Budget constraints put pressure on projects, time to market of features comes first, testing comes second and documentation in this day and age of program focused delivery at best comes last,
=== The forgotten design ===
Standards are lacking, because of political issues, time constraints and a too rapid pace of developments. Of course, there should have been a design, lacking standards, accidents or laziness are another cause of missing, insufficient or outdated documentation. It can go as bad as programs running in production of which nobody has a clue of what they are doing exactly, the only certainty is that things go wrong whenever the program goes wrong.
I wrote the non nonsensical primes programs set on top of my head as an example three tier oriented system system, just to demonstrate the working of such a system. The challenge was to have some documentation at least, which is in line with the running joke in so many organisations: 'The program source is the best and most reliable source of information'. This is true under the condition that the program source is available, which is not always the case. There are loads of programs running in production today of which no one has a clue of what the program is doing, but everybody knows the program has to run to avoid problems. I did not go to the extend of re-engineering cobol source from the running executable (yet).
Thanks to [https://claude.ai Claude.ai]there is at least some documentation now.
* The primes system design [[Primes system Design]].
* Design standards [[Design standards]].
=== The forgotten documentation ===
On top of of the design and program specifications documents we require design standards and programming standards. The [[Cobol programming standards]] below have been generated in my hown grown ailab.
* The primes program specification [[Primes programs specifications]].
* Cobol programming standards [[Cobol programming standards]].

[[Primes Software Specification]]

= Employee program =
The setup of the lab environment, source code and a simple compilation workflow are below.
* Program name: pgcobol
* Source code: pgcobol.cbl
* Intermediate preprocessed source code file: pgcobol.cbsql
* Cobol compiler output: pgcobol.out
* Database: Employee, with table emptable
* pgcobol print output file: pgcobol.prt
== Cobol ==
Cobol has been around for more than 60 years and will stay around for the foreseeable future, estimates are that there are about 800 billion lines of Business Cobol code around. The programs are heavily used, servicing about 80% of all financial and business transactions world wide. 
The reason behind this endurance lies in the fact that Cobol is a standardised language, a program written in 1974 can be compiled today with a modern compiler. The resulting executable program still runs today, without the need of adaptation. This very fact is of high value to enterprises, their investments are safe and well protected on the long term. 
Traditionally Cobol programs have their application in big business mainframe environments. These large enterprises, however, are shifting more and more of their applications to the Linux platform. The broad adoption of Linux in the enterprise environment started around 2010. So, it is no wonder that Cobol gradually is being made available for the Linux platform, enter [https://gnucobol.sourceforge.io/ GNUCobol].
=== GNUCobol ===
Is an Open Source Cobol compiler, the project originally started in 2002 [https://en.wikipedia.org/wiki/GnuCOBOL GNUCobol] as OpenCobol. GNUCobol now is a full blown Cobol compiler.

== GixSQL links PostgreSQL and Cobol ==
PostgreSQL is getting more and more traction around the world, also in the big enterprises. Big enterprises have ample reason to stick to their Cobol program stack, in which they invested huge amounts of money. So if PostgreSQL is to make it to the business applications of the big enterprises, it has to find a way to interact in a reliable manner with Cobol. Enter the [https://github.com/mridoni/gixsql GixSQL] SQL preprocessor for Cobol.
=== An SQL statement in Cobol ===
This is the way the SQL code is embedded in the Cobol program:
<pre>
EXEC SQL
CONNECT TO :DATASRC AS cobol_sql USER :DBUSR USING :DBPWD
END-EXEC.
</pre>
The example shows the program making a connection to the database with the variables DATASRC, DBUSR and DBPWD.

= Practical introduction to GixSQL =
This chapter provides guidance to set up a working GixSQL for GNUCobol with PostgreSQL development environment.
== Prerequisites ==
* Debian 12
* GnuCobol4
* libmariadb-dev libmariadb-dev-compat libpq5 unixodbc libfmt9
* GixSQL, find the link below
* optionally the PostgreSQL database server on the same machine.
GixSQL is available here: [https://github.com/mridoni/gixsql/releases/download/v1.0.21dev/gixsql-debian-12-x64-1.0.21dev-1.deb GixSQL].
Just install the software in the sequence as described above and the system is ready to go. 
For reasons of convenience add the follow lines to /etx/profile:
<pre>
LD_DIRECTORY_PATH="/usr/local/src/gix/gixisql/runtime/libgixsql:/usr/local/src/gix/gixsql/common:/usr/local/src/gix/gixsql/common"
export LD_DIRECTORY_PATH
</pre>

== Workflow ==
Once the editing of the program is finished, the program has to be compiled. This is done in various steps, but this can also be done by using the Python script below. 
The steps are:
# The precompile process
# Inspect (but do not edit the output)
# The compilation process
# Inspect the compilation listing
# Run the program
== Simple Workflow script ==
The python script [[gixc.py]] implements the GixSQL Cobol compilation workflow. It is invoked with a single parameter, being the program_name suffixed by either 'cbl or 'cob'. People that like to get their hands dirty follow the two steps below.
=== gixsql precompilation ===
The command invoking the precompile process is as follows: 
<pre>
/usr/bin/gixsql pgcobol.cbl pgcobol.cbsql -S -I . -e ".,*.cpy,*.CPY"
</pre>
The input file is pgcobol.cbl, the preprocessing output file is [[pgcobol.cbsql]]. It is very important to leave the cbsql file as is, because meddling with the file easily leads to errors in the next step of the workflow. 
The result of the precompile step of the SQL stement above looks like this:
<pre>
GIXSQL* EXEC SQL
GIXSQL* CONNECT TO :DATASRC AS cobol_sql USER :DBUSR USING :DBPWD
GIXSQL* END-EXEC.
GIXSQL CALL STATIC "GIXSQLConnect" USING
GIXSQL BY REFERENCE SQLCA
GIXSQL BY REFERENCE DATASRC
GIXSQL BY VALUE 64
GIXSQL BY REFERENCE "cobol_sql" & x"00"
GIXSQL BY VALUE 0
GIXSQL BY REFERENCE x"00"
GIXSQL BY VALUE 0
GIXSQL BY REFERENCE DBUSR
GIXSQL BY VALUE 64
GIXSQL BY REFERENCE DBPWD
GIXSQL BY VALUE 64
GIXSQL END-CALL.
</pre>
The precompile program translated the SQL statement in to a standardised Cobol call.

=== The cobc GNUCobol compilation ===
The command invoking the precompile process is as follows:
<pre>
/usr/bin/cobc -x pgcobol.cbsql -l:libgixsql.so -T pgcobol.out
</pre>
This results in the executable program file '''pgcobol''' and the compilation listing [[pgcobol.out]].

== Sample Program ==
The sample program [[pgcobol.cbl]] makes use of the sample database: employee. When executed pgcobol puts out the file [[pgcobol.prt]]. 
The pgcobol program file is available for download here: [https://wiki.webhuis.nl/images/pgcobol.cbl pgcobol.cbl ].

== Sample database ==
The [[employee database]] is a very simple database, with one table containing three lines. The pg_dump file is in the link.
<hr/>
Back to: [[voorpagina]]

Cobol and PostgreSQL

2026-03-25T16:14:38Z

Martin: /* The forgotten design */

This chapter contains
* The description of a complete working example of a '''Cobol''' '''PostgreSQL''' program of the sample employee database, that comes with GixSQL
* The three tier object oriented primes program, using a PostgreSQL database.
GixSQL is the Open Source way in which Cobol programs are able to use modern database management systems in a Linux environment.
= Primes program =
A prime number is defined by the fact that it can only be divided by 1 and itself. The [[primes]] program is a simple program to demonstrate the implementation of a three tier object oriented Cobol program. It consists of:
* A main program to invoke the process
* A UI layer
* A business logic layer, that is responsible for the logic involving prime numbers
* Database layer, for data storage.
The subprograms are al invoked by means of methods, in such a way that the PostgreSQL database could easily be replaced by MariaDB.
== Making sense of IT ==
The Primes program is just a one off, written for demonstration purposes and on top of my head without design apart from a few notes on the edge of a news paper. Budget constraints put pressure on projects, time to market of features comes first, testing comes second and documentation in this day and age of program focused delivery at best comes last,
=== The forgotten design ===
Standards are lacking, because of political issues, time constraints and a too rapid pace of developments. Of course, there should have been a design, lacking standards, accidents or laziness are another cause of missing, insufficient or outdated documentation. It can go as bad as programs running in production of which nobody has a clue of what they are doing exactly, the only certainty is that things go wrong whenever the program goes wrong.
I wrote the non nonsensical primes programs set on top of my head as an example three tier oriented system system, just to demonstrate the working of such a system. The challenge was to have some documentation at least, which is in line with the running joke in so many organisations: 'The program source is the best and most reliable source of information'. This is true under the condition that the program source is available, which is not always the case. There are loads of programs running in production today of which no one has a clue of what the program is doing, but everybody knows the program has to run to avoid problems. I did not go to the extend of re-engineering cobol source from the running executable (yet).
Thanks to [https://claude.ai Claude.ai]there is at least some documentation now.
* The primes system design [[Primes system Design]].
* Design standards [[Design standards]].

On top of of the design and program specifications documents we require design standards and programming standards. The [[Cobol programming standards]] below have been generated in my hown grown ailab.
* The primes program specification [[Primes programs specifications]].
* Cobol programming standards [[Cobol programming standards]].

[[Primes Software Specification]]

=== The forgotten documentation ===

= Employee program =
The setup of the lab environment, source code and a simple compilation workflow are below.
* Program name: pgcobol
* Source code: pgcobol.cbl
* Intermediate preprocessed source code file: pgcobol.cbsql
* Cobol compiler output: pgcobol.out
* Database: Employee, with table emptable
* pgcobol print output file: pgcobol.prt
== Cobol ==
Cobol has been around for more than 60 years and will stay around for the foreseeable future, estimates are that there are about 800 billion lines of Business Cobol code around. The programs are heavily used, servicing about 80% of all financial and business transactions world wide. 
The reason behind this endurance lies in the fact that Cobol is a standardised language, a program written in 1974 can be compiled today with a modern compiler. The resulting executable program still runs today, without the need of adaptation. This very fact is of high value to enterprises, their investments are safe and well protected on the long term. 
Traditionally Cobol programs have their application in big business mainframe environments. These large enterprises, however, are shifting more and more of their applications to the Linux platform. The broad adoption of Linux in the enterprise environment started around 2010. So, it is no wonder that Cobol gradually is being made available for the Linux platform, enter [https://gnucobol.sourceforge.io/ GNUCobol].
=== GNUCobol ===
Is an Open Source Cobol compiler, the project originally started in 2002 [https://en.wikipedia.org/wiki/GnuCOBOL GNUCobol] as OpenCobol. GNUCobol now is a full blown Cobol compiler.

== GixSQL links PostgreSQL and Cobol ==
PostgreSQL is getting more and more traction around the world, also in the big enterprises. Big enterprises have ample reason to stick to their Cobol program stack, in which they invested huge amounts of money. So if PostgreSQL is to make it to the business applications of the big enterprises, it has to find a way to interact in a reliable manner with Cobol. Enter the [https://github.com/mridoni/gixsql GixSQL] SQL preprocessor for Cobol.
=== An SQL statement in Cobol ===
This is the way the SQL code is embedded in the Cobol program:
<pre>
EXEC SQL
CONNECT TO :DATASRC AS cobol_sql USER :DBUSR USING :DBPWD
END-EXEC.
</pre>
The example shows the program making a connection to the database with the variables DATASRC, DBUSR and DBPWD.

= Practical introduction to GixSQL =
This chapter provides guidance to set up a working GixSQL for GNUCobol with PostgreSQL development environment.
== Prerequisites ==
* Debian 12
* GnuCobol4
* libmariadb-dev libmariadb-dev-compat libpq5 unixodbc libfmt9
* GixSQL, find the link below
* optionally the PostgreSQL database server on the same machine.
GixSQL is available here: [https://github.com/mridoni/gixsql/releases/download/v1.0.21dev/gixsql-debian-12-x64-1.0.21dev-1.deb GixSQL].
Just install the software in the sequence as described above and the system is ready to go. 
For reasons of convenience add the follow lines to /etx/profile:
<pre>
LD_DIRECTORY_PATH="/usr/local/src/gix/gixisql/runtime/libgixsql:/usr/local/src/gix/gixsql/common:/usr/local/src/gix/gixsql/common"
export LD_DIRECTORY_PATH
</pre>

== Workflow ==
Once the editing of the program is finished, the program has to be compiled. This is done in various steps, but this can also be done by using the Python script below. 
The steps are:
# The precompile process
# Inspect (but do not edit the output)
# The compilation process
# Inspect the compilation listing
# Run the program
== Simple Workflow script ==
The python script [[gixc.py]] implements the GixSQL Cobol compilation workflow. It is invoked with a single parameter, being the program_name suffixed by either 'cbl or 'cob'. People that like to get their hands dirty follow the two steps below.
=== gixsql precompilation ===
The command invoking the precompile process is as follows: 
<pre>
/usr/bin/gixsql pgcobol.cbl pgcobol.cbsql -S -I . -e ".,*.cpy,*.CPY"
</pre>
The input file is pgcobol.cbl, the preprocessing output file is [[pgcobol.cbsql]]. It is very important to leave the cbsql file as is, because meddling with the file easily leads to errors in the next step of the workflow. 
The result of the precompile step of the SQL stement above looks like this:
<pre>
GIXSQL* EXEC SQL
GIXSQL* CONNECT TO :DATASRC AS cobol_sql USER :DBUSR USING :DBPWD
GIXSQL* END-EXEC.
GIXSQL CALL STATIC "GIXSQLConnect" USING
GIXSQL BY REFERENCE SQLCA
GIXSQL BY REFERENCE DATASRC
GIXSQL BY VALUE 64
GIXSQL BY REFERENCE "cobol_sql" & x"00"
GIXSQL BY VALUE 0
GIXSQL BY REFERENCE x"00"
GIXSQL BY VALUE 0
GIXSQL BY REFERENCE DBUSR
GIXSQL BY VALUE 64
GIXSQL BY REFERENCE DBPWD
GIXSQL BY VALUE 64
GIXSQL END-CALL.
</pre>
The precompile program translated the SQL statement in to a standardised Cobol call.

=== The cobc GNUCobol compilation ===
The command invoking the precompile process is as follows:
<pre>
/usr/bin/cobc -x pgcobol.cbsql -l:libgixsql.so -T pgcobol.out
</pre>
This results in the executable program file '''pgcobol''' and the compilation listing [[pgcobol.out]].

== Sample Program ==
The sample program [[pgcobol.cbl]] makes use of the sample database: employee. When executed pgcobol puts out the file [[pgcobol.prt]]. 
The pgcobol program file is available for download here: [https://wiki.webhuis.nl/images/pgcobol.cbl pgcobol.cbl ].

== Sample database ==
The [[employee database]] is a very simple database, with one table containing three lines. The pg_dump file is in the link.
<hr/>
Back to: [[voorpagina]]

Business Requirement Document

2026-03-25T15:37:41Z

Martin: Created page with " = Business Requirements Document = {| !width="23%"| Field !width="76%"| Value |- | Document ID | PGCBL-BRD-001 |- | Document Type | Business Requirements Document |- | System | pgcobol — Prime Numbers Application v1.0 |- | Version | 1.0 |- | Status | Approved |- | Owner | Lead Developer |- | Author | [reverse-engineered from source artifacts] |- | Reviewers | — (pending) |- | Approved by | — (pending) |- | Created..."

= Business Requirements Document =

{|
!width="23%"| Field
!width="76%"| Value
|-
| Document ID
| PGCBL-BRD-001
|-
| Document Type
| Business Requirements Document
|-
| System
| pgcobol — Prime Numbers Application v1.0
|-
| Version
| 1.0
|-
| Status
| Approved
|-
| Owner
| Lead Developer
|-
| Author
| [reverse-engineered from source artifacts]
|-
| Reviewers
| — (pending)
|-
| Approved by
| — (pending)
|-
| Created
| 2026-03-17
|-
| Last modified
| 2026-03-17
|-
| Classification
| Internal
|-
| Parent document
| PGCBL-SAD-001 (Scope and Applicability)
|-
| Supersedes
| —
|}


== Version History ==

{|
!width="11%"| Version
!width="14%"| Date
!width="9%"| Author
!width="12%"| Status
!width="51%"| Change Summary
|-
| 0.1
| 2026-03-17
| —
| Draft
| Initial reverse-engineering baseline
|-
| 1.0
| 2026-03-17
| —
| Approved
| Baselined
|}

-----


== Table of Contents ==

# [[#1-purpose-and-scope|Purpose and Scope]]
# [[#2-assumptions-and-dependencies|Assumptions and Dependencies]]
# [[#3-stakeholders|Stakeholders]]
# [[#4-functional-requirements|Functional Requirements]]
# [[#5-non-functional-requirements|Non-Functional Requirements]]
# [[#6-constraints|Constraints]]
# [[#7-out-of-scope|Out of Scope]]
# [[#8-related-documents|Related Documents]]
# [[#9-open-issues|Open Issues]]

-----


== 1. Purpose and Scope ==


=== 1.1 Purpose ===

This document defines what the pgcobol system must do from a business perspective. It is the primary input to all technical and design documents in the specification set. Any feature not described here is out of scope.


=== 1.2 Scope ===

This document covers all externally observable behaviour of pgcobol v1.0: prime-number generation, database persistence, and printed report production.


=== 1.3 Out of Scope ===

* How the system achieves its requirements (that is PGCBL-TSD-001).
* Internal program structure and algorithm details (PGCBL-PLG-001).
* Non-functional quality attributes in detail (PGCBL-NFR-001).


=== 1.4 Audience ===

Business analysts, QA engineers, and stakeholders who need to understand what the system does without needing to read COBOL.


=== 1.5 Related Documents ===

{|
!width="27%"| Document ID
!width="50%"| Title
!width="22%"| Relationship
|-
| PGCBL-SAD-001
| Scope and Applicability
| Navigation; defines document set
|-
| PGCBL-NFR-001
| Non-Functional Requirements
| Complements this BRD with quality attributes
|-
| PGCBL-TSD-001
| Technical Specification
| Implements requirements in this document
|-
| PGCBL-TTM-001
| Test Traceability Matrix
| Maps each requirement here to a test case
|-
| PGCBL-ADD-001
| Architecture Decision Records
| Documents why the design is as it is
|}

-----


== 2. Assumptions and Dependencies ==

See PGCBL-SAD-002 for the full register. Key items:

{|
!width="36%"| ID
!width="31%"| Item
!width="31%"| Type
|-
| A-01
| Prime 2 is manually seeded in the DB before generation
| Assumption
|-
| A-02
| DB is empty at the start of a generation run
| Assumption
|-
| DEP-03
| PostgreSQL running on localhost:5432
| Dependency
|-
| DEP-08
| Prime 2 seeded before first generation
| Dependency
|}

-----


== 3. Stakeholders ==

{|
!width="50%"| Role
!width="50%"| Interest
|-
| System operator
| Runs generation and reporting jobs from the command line
|-
| Database administrator
| Owns the PostgreSQL schema; manages credentials and data
|-
| Report consumer
| Reads the formatted print file <code>primes.prt</code>
|}

-----


== 4. Functional Requirements ==


=== FR-01 — Prime Generation ===

* The system shall accept a <code>generate</code> command-line argument to trigger prime-number generation.
* The system shall test every odd integer from 3 upward for primality using trial division.
* The system shall store each confirmed prime in the database in ascending order of discovery.
* Generation shall continue until the candidate number reaches 999,999,999.


=== FR-02 — Trial-Division Algorithm Correctness ===

* For each candidate number N, the system shall divide N by each known prime p where p ≤ √N.
* If any p divides N exactly (remainder = 0), N is composite and shall not be stored.
* If no p ≤ √N divides N, N is prime and shall be persisted.


=== FR-03 — Prime Reporting ===

* The system shall accept a <code>report</code> command-line argument to trigger report generation.
* The system shall read all stored primes from the database in sequence order.
* The system shall write a paginated, formatted print file containing all primes.


=== FR-04 — Print Report Format ===

* The report shall contain a page heading (“primes overview”) and column headers on each page.
* Each data line shall display six prime entries side by side: sequence number and prime value.
* Each page shall carry a page-number footing.
* The print record width shall be 132 characters.
* The report shall be written to a file named <code>primes.prt</code>.


=== FR-05 — Operational Logging ===

* The system shall write progress and status messages to the system console throughout execution.
* Each message shall identify the issuing program name and paragraph.


=== FR-06 — Error Handling ===

* The system shall log an error message and stop cleanly if an unrecognised command-line argument is provided.
* The system shall log an error message and stop cleanly if the print file cannot be opened.
* The system shall log database connection or cursor failures and set an error indicator before exiting.

-----


== 5. Non-Functional Requirements ==

Summary only — see PGCBL-NFR-001 for full specification.

{|
!width="33%"| ID
!width="33%"| Category
!width="33%"| Requirement
|-
| NFR-PERF-01
| Performance
| ≥ 1,000 primes generated per second
|-
| NFR-REL-01
| Reliability
| Batch runs to completion without manual intervention
|-
| NFR-SEC-01
| Security
| No credentials in compiled binary
|-
| NFR-MAIN-01
| Maintainability
| SQL only in <code>primes.cbl</code>; file I/O only in <code>primesui.cbl</code>
|-
| NFR-OPER-02
| Operability
| Non-zero process return code on failure
|}

-----


== 6. Constraints ==

{|
! ID
! Constraint
|-
| C-01
| Must run on Linux with GnuCOBOL 4.0
|-
| C-02
| Must use PostgreSQL as the database
|-
| C-03
| Upper generation limit: 999,999,999 (hard-coded)
|-
| C-04
| Single-user batch execution only
|}

-----


== 7. Out of Scope ==

* Interactive or web-based user interfaces.
* Concurrent or distributed execution.
* Generation of prime numbers by any algorithm other than trial division.
* Any prime number below 2 or above 999,999,999.
* Checkpoint/restart capability for interrupted generation runs.

-----


== 8. Related Documents ==

As listed in §1.5.

-----


== 9. Open Issues ==

{|
!width="18%"| ID
!width="18%"| Issue
!width="18%"| Owner
!width="21%"| Target
!width="21%"| Status
|-
| OI-01
| FR-01: generate loop is commented out in current source — this is defect D-01. FR-01 is not fully met by the current code.
| Developer
| —
| Open
|-
| OI-02
| FR-06: the process does not return a non-zero exit code on error (NFR-OPER-02 gap).
| Developer
| —
| Open
|}
<hr/>
Terug naar: [[Design standards]] | [[Cobol and PostgreSQL]]

Naming and Coding Standards

2026-03-25T15:36:46Z

Martin: Created page with " = Naming and Coding Standard — COBOL = {| !width="23%"| Field !width="76%"| Value |- | Document ID | PGCBL-NCS-001 |- | Document Type | Naming and Coding Standard |- | System | pgcobol — Prime Numbers Application v1.0 |- | Applies to | All GnuCOBOL source files (<code>.cbl</code>) and copybooks (<code>.cpy</code>) |- | Version | 1.0 |- | Status | Approved |- | Owner | Lead Developer |- | Author | Derived from: IBM..."

= Naming and Coding Standard — COBOL =

{|
!width="23%"| Field
!width="76%"| Value
|-
| Document ID
| PGCBL-NCS-001
|-
| Document Type
| Naming and Coding Standard
|-
| System
| pgcobol — Prime Numbers Application v1.0
|-
| Applies to
| All GnuCOBOL source files (<code>.cbl</code>) and copybooks (<code>.cpy</code>)
|-
| Version
| 1.0
|-
| Status
| Approved
|-
| Owner
| Lead Developer
|-
| Author
| Derived from: IBM Enterprise COBOL Coding Guidelines, GnuCOBOL Best Practices, Micro Focus COBOL Standards, and observation of existing pgcobol source
|-
| Created
| 2026-03-17
|-
| Last modified
| 2026-03-17
|-
| Classification
| Internal
|}


== Version History ==

{|
!width="16%"| Version
!width="22%"| Date
!width="15%"| Author
!width="15%"| Status
!width="30%"| Change Summary
|-
| 0.1
| 2026-03-17
| —
| Draft
| Initial standard from source analysis
|-
| 1.0
| 2026-03-17
| —
| Approved
| Baselined
|}

-----


== Table of Contents ==

# [[#1-standards-basis|Standards Basis]]
# [[#2-source-file-conventions|Source File Conventions]]
# [[#3-division-and-section-structure|Division and Section Structure]]
# [[#4-data-naming-conventions|Data Naming Conventions]]
# [[#5-paragraph-naming-conventions|Paragraph Naming Conventions]]
# [[#6-procedure-division-coding-rules|Procedure Division Coding Rules]]
# [[#7-sql-embedding-conventions|SQL Embedding Conventions]]
# [[#8-commentary-standards|Commentary Standards]]
# [[#9-copybook-standards|Copybook Standards]]
# [[#10-method-dispatch-pattern-standard|Method-Dispatch Pattern Standard]]
# [[#11-error-handling-standard|Error Handling Standard]]
# [[#12-compliance-checklist|Compliance Checklist]]
# [[#13-open-issues|Open Issues]]

-----


== 1. Standards Basis ==

This standard synthesises rules from the following well-known and published sources:

{|
!width="50%"| Source
!width="50%"| What it contributes
|-
| '''ISO/IEC 1989:2014''' (COBOL 2014 standard)
| Syntax compliance baseline
|-
| '''IBM Enterprise COBOL Programming Guide (SC27-1460)'''
| Naming conventions, data division layout, structured programming
|-
| '''Micro Focus COBOL Coding Standards'''
| Paragraph prefixing, copybook discipline, comment headers
|-
| '''GnuCOBOL Programmer’s Guide'''
| GnuCOBOL-specific extensions and limitations
|-
| '''NIST COBOL Test Suite conventions'''
| Identifier uniqueness and column discipline
|-
| '''Yourdon / Constantine structured design'''
| Module cohesion, coupling reduction — applied to COBOL tiers
|-
| '''pgcobol source'''
| Existing conventions extracted and formalised
|}

-----


== 2. Source File Conventions ==


=== 2.1 File names ===

<pre><program-id>.cbl Main program source
<copybook-name>.cpy Copybook source
<program-id>.cbsql GixSQL pre-processor input (if SQL present)
<program-id>_cbsql.out GixSQL pre-processor listing (generated; do not edit)</pre>
* All lowercase.
* Hyphens as word separators (not underscores) for new files. Underscores are a legacy convention in this codebase (<code>primes_table.cpy</code>); new files use hyphens.
* The <code>PROGRAM-ID</code> in the source must match the filename exactly (case-insensitive).


=== 2.2 Column discipline ===

GnuCOBOL supports both fixed-format (traditional) and free-format source. This codebase uses '''fixed format''':

<pre>Columns 1–6 Sequence number area (blank in new code; used by legacy tools)
Column 7 Indicator area: space = code, * = comment, / = page eject, - = continuation
Columns 8–11 Area A: DIVISION, SECTION, paragraph names, 01/77-level data
Columns 12–72 Area B: all other code
Columns 73–80 Identification area (optional; ignored by compiler)</pre>
'''Rule:''' All paragraph names and top-level items begin in column 8 (Area A). All subordinate code begins at column 12 or beyond (Area B).

-----


== 3. Division and Section Structure ==


=== 3.1 Mandatory division order ===

Every program must contain these divisions in this order:

<pre>IDENTIFICATION DIVISION.
PROGRAM-ID.
(AUTHOR. — optional)
(DATE-WRITTEN. — optional)

ENVIRONMENT DIVISION.
CONFIGURATION SECTION.
SOURCE-COMPUTER.
OBJECT-COMPUTER.
SPECIAL-NAMES.
INPUT-OUTPUT SECTION. (only if files are used)
FILE-CONTROL.

DATA DIVISION.
FILE SECTION. (only if files are used)
WORKING-STORAGE SECTION.
LINKAGE SECTION. (only for called programs)

PROCEDURE DIVISION [USING ...].</pre>

=== 3.2 Working-Storage section order ===

Items in WORKING-STORAGE must appear in this order:

# Debug marker filler (01 FILLER PIC X(32) VALUE “Start WS <program>”) — for memory-dump readability.
# File status fields (if any files).
# Constants (01 level, VALUE clause, no modification at runtime).
# Work fields grouped by function.
# COPY statements for local copybooks (primes-ui, primes-dal, etc.).


=== 3.3 Linkage section ===

The linkage section must contain only COPY statements referencing the published inter-tier copybooks. No fields should be defined directly in the LINKAGE SECTION of a standard program.

-----


== 4. Data Naming Conventions ==


=== 4.1 General rules ===

{|
!width="50%"| Rule
!width="50%"| Rationale
|-
| Use hyphens as word separators: <code>test-number</code>, not <code>testNumber</code> or <code>test_number</code>
| COBOL convention; underscores are non-standard in some compilers
|-
| Maximum name length: 30 characters (COBOL 85 limit)
| Portability
|-
| Names must be meaningful: no single-letter names except loop indexes
| Readability
|-
| Avoid COBOL reserved words and common abbreviations that conflict (e.g. <code>LENGTH</code>, <code>SPACE</code>)
| Prevents ambiguity
|-
| Prefix 88-level condition names with the purpose they test, not the field name
| <code>dal-method-ok</code> not <code>dal-result-zero</code>
|}


=== 4.2 Level number conventions ===

{|
!width="50%"| Level
!width="50%"| Use
|-
| 01
| Group items, independent items, copybook roots
|-
| 03, 05, 07
| Subordinate group and elementary items (use odd numbers: 01, 03, 05, 07 …)
|-
| 66
| RENAMES clause (use sparingly)
|-
| 77
| Independent elementary items (prefer 01 unless 77 is clearly appropriate)
|-
| 88
| Condition names; always immediately under the field they qualify
|}

'''Rule:''' Use odd-numbered levels (01, 03, 05, 07, 09) to allow insertion of intermediate levels without renumbering. Never use even levels in new code.


=== 4.3 Naming prefixes for scope ===

{|
!width="33%"| Prefix
!width="33%"| Meaning
!width="33%"| Example
|-
| <code>r-</code>
| Record / row field (fetched from DB)
| <code>r-ident</code>, <code>r-prime</code>
|-
| <code>u-</code>
| UI-layer field (in primes-ui block)
| <code>u-sequence</code>, <code>u-number</code>
|-
| <code>t-</code>
| Table cell / temporary print field
| <code>t-ident</code>, <code>t-prime</code>
|-
| <code>f-</code>
| Formatted / print-ready field
| <code>f-page-number</code>
|-
| <code>w-</code>
| Work field (local computation)
| <code>w-remainder</code>
|}


=== 4.4 Picture clause conventions ===

{|
!width="33%"| Type
!width="33%"| Preferred PICTURE
!width="33%"| Notes
|-
| Positive integer, display
| <code>9(n)</code>
| n ≤ 9 for standard arithmetic
|-
| Signed integer, display
| <code>S9(n)</code>
| Use S prefix for fields that can go negative or are SQL host variables
|-
| Packed decimal
| <code>S9(n) COMP-3</code>
| For high-volume arithmetic and SQL host variables
|-
| Binary integer
| <code>S9(n) COMP-5</code>
| For SQLCA fields and counters needing maximum performance
|-
| Fixed decimal
| <code>9(n)V9(m)</code>
| V = implied decimal point; no actual decimal character stored
|-
| Alphanumeric
| <code>X(n)</code>
| For text, method verbs, messages
|-
| Edited numeric (print)
| <code>Z(n)9</code> or <code>Z(n)</code>
| For zero-suppressed print output only; never used in arithmetic
|-
| Boolean flag
| <code>9(1)</code> with 88-levels
| e.g. <code>PIC 9 VALUE 1. 88 new-page VALUE 1.</code>
|}


=== 4.5 88-level condition names ===

* Must be named for what is '''true''' when the condition fires, not for the value: <code>session-method-ok</code> not <code>result-is-zero</code>.
* Result-code 88-levels must cover all meaningful values; add a <code>88 invalid-method VALUE "bad"</code> sentinel.
* Multiple conditions for the same field must have non-overlapping VALUES.


=== 4.6 Copybook field naming ===

* Fields in a copybook must be globally unique across all copybooks in the project (COBOL does not namespace copybooks).
* Prefix copybook fields with the copybook’s logical name: <code>dal-methods</code>, <code>ui-method-result</code>, <code>session-result</code>.

-----


== 5. Paragraph Naming Conventions ==

This project uses a '''prefix-number naming scheme''' derived from IBM COBOL shop practice:


=== 5.1 Prefix codes ===

{|
!width="33%"| Prefix
!width="33%"| Meaning
!width="33%"| Example
|-
| <code>r</code>
| Regular processing paragraph (business logic, I/O)
| <code>r80-test-number</code>
|-
| <code>s</code>
| System / infrastructure paragraph (DB connect, file open)
| <code>s00-connect</code>
|-
| <code>e</code>
| Error-handling paragraph
| <code>e10-handle-db-error</code>
|-
| <code>x</code>
| Exit / cleanup paragraph (always PERFORM last)
| <code>x99-shutdown</code>
|}

<blockquote>'''Observation from existing source:''' The project uses <code>r</code> and <code>s</code> prefixes already. The <code>e</code> and <code>x</code> prefixes are introduced here as an extension. The <code>r99</code> convention for shutdown paragraphs is retained.
</blockquote>

=== 5.2 Numbering ===

* Two-digit sequence: <code>00</code>, <code>10</code>, <code>20</code> … <code>90</code>, <code>99</code>.
* Low numbers (00–29): initialisation / setup.
* Mid numbers (30–79): main processing.
* High numbers (80–89): sub-processing / helpers.
* 90–98: cleanup and close.
* 99: final exit / stop.
* Leave gaps of 10 between paragraphs to allow insertion.


=== 5.3 Name format ===

<pre><prefix><NN>-<short-hyphenated-description>

Examples:
r80-test-number
r82-next-test-number
r85-write-prime
r89-get-next-divider
r90-start-primes-report
r99-close-primes
s00-connect
s01-cursor
s02-fetch
s99-disconnect</pre>

=== 5.4 Rules ===

* Paragraph names must be unique within the program.
* A paragraph must do one thing. If it needs a comment explaining “also does X”, split it.
* Paragraphs called only from one place may be inlined (PERFORM vs inline code) — choose consistency over micro-optimisation.
* Never use <code>GO TO</code> except for the structured <code>GO TO <paragraph></code> used as a skip (an accepted COBOL idiom). Do not use <code>ALTER</code>.

-----


== 6. Procedure Division Coding Rules ==


=== 6.1 Structured programming ===

All control flow must use structured constructs:

{|
!width="50%"| Construct
!width="50%"| Use for
|-
| <code>PERFORM <paragraph></code>
| Single call to a named paragraph
|-
| <code>PERFORM <paragraph> UNTIL <condition></code>
| Loops with pre-test condition
|-
| <code>EVALUATE TRUE … WHEN … END-EVALUATE</code>
| Multi-way branch (preferred over nested IF)
|-
| <code>IF … ELSE … END-IF</code>
| Two-way branch
|-
| <code>NEXT SENTENCE</code>
| Skip remainder of sentence (used sparingly; prefer END-IF)
|}

'''Never use:''' - <code>GO TO</code> (except structured skip idiom in legacy contexts) - <code>ALTER</code> - <code>PERFORM … THRU</code> (couples paragraphs; prefer explicit PERFORM chains)


=== 6.2 EVALUATE TRUE convention ===

The method-dispatch EVALUATE always takes this form:

<syntaxhighlight lang="cobol">EVALUATE TRUE
WHEN <condition-name-1>
PERFORM <paragraph>
WHEN <condition-name-2>
PERFORM <paragraph>
WHEN OTHER
MOVE 1 TO <result-field>
END-EVALUATE.</syntaxhighlight>
* Every EVALUATE must have a <code>WHEN OTHER</code> clause.
* The <code>WHEN OTHER</code> must set a meaningful error indicator; it must never be a no-op.


=== 6.3 PERFORM … UNTIL ===

* The loop condition is checked '''before''' the first iteration (test-before / DO-WHILE reversed).
* Infinite loops are not permitted. Every PERFORM UNTIL must have a reachable exit condition.
* Loop termination must be tested and documented in the program logic guide.


=== 6.4 CALL conventions ===

* All inter-program calls use <code>CALL "literal" USING <data-block></code>.
* The called program name must be a string literal, not a data name (for static linkage and security).
* Always check the result field of the called program’s control block immediately after the CALL.


=== 6.5 Arithmetic ===

* Use <code>COMPUTE</code> for complex expressions: <code>COMPUTE x = a ** 0.5</code>.
* Use <code>ADD … TO</code>, <code>SUBTRACT … FROM</code>, <code>MULTIPLY … BY</code>, <code>DIVIDE … BY … GIVING … REMAINDER</code> for simple operations.
* Always use <code>GIVING</code> and <code>REMAINDER</code> clauses to avoid in-place modification of source operands.
* Always check for zero divisor before DIVIDE.
* Declare intermediate results with sufficient precision to avoid truncation: <code>PIC 9(9)V9(9)</code> for square-root results.

-----


== 7. SQL Embedding Conventions ==


=== 7.1 EXEC SQL block layout ===

<syntaxhighlight lang="cobol"> EXEC SQL [AT <connection-alias>]
<sql statement>
END-EXEC.</syntaxhighlight>
* <code>EXEC SQL</code> on its own line, indented to Area B.
* SQL keywords in uppercase.
* Host variable prefix <code>:</code> immediately before the variable name, no space.
* <code>END-EXEC.</code> on its own line, followed by a period.


=== 7.2 Host variable declaration ===

* All SQL host variables must be declared via <code>EXEC SQL INCLUDE <copybook> END-EXEC</code> or directly in WORKING-STORAGE.
* Host variables for row-level data must be grouped under a 01-level record that mirrors the table structure.
* Use <code>COMP-3</code> for numeric host variables for performance.


=== 7.3 SQLCODE checking ===

Every EXEC SQL block must be followed immediately by a SQLCODE check:

<syntaxhighlight lang="cobol"> EXEC SQL ... END-EXEC.

IF SQLCODE = 0 THEN
<success path>
ELSE
MOVE SQLERRMC TO program-message
PERFORM e10-handle-sql-error
END-IF.</syntaxhighlight>
* Never fall through after an unchecked SQL statement.
* Log <code>SQLCODE</code> and <code>SQLERRMC</code> on every error path.


=== 7.4 Cursor naming ===

<pre><table-name>cursor

Example: primescursor (cursor on the primes table)</pre>

=== 7.5 Connection alias naming ===

<pre><database-name>

Example: primes (alias for the primes database connection)</pre>
The alias must be consistent across all <code>AT <alias></code> clauses and the CONNECT/RESET statements.

-----


== 8. Commentary Standards ==


=== 8.1 Program header block ===

Every <code>.cbl</code> file must open with a standardised comment block in columns 7–72:

<syntaxhighlight lang="cobol"> *=================================================================
* Program: <PROGRAM-ID>
* Document: <PGCBL-PLG-NNN>
* Purpose: <one sentence>
* Tier: Orchestrator | Business Logic | Data Access | UI
* Calls: <list of programs this program calls>
* Called by: <list of programs that call this program>
* Copybooks: <list of copybooks copied>
* Author: <name>
* Created: YYYY-MM-DD
* Modified: YYYY-MM-DD <name> <change summary>
*=================================================================</syntaxhighlight>

=== 8.2 Paragraph headers ===

Every paragraph must have a comment immediately before it:

<syntaxhighlight lang="cobol"> *-----------------------------------------------------------------
* r80-test-number
* Tests whether test-number is prime by trial division.
* Called by: PERFORM UNTIL test-number = 999999999
* Uses: test-number, test-divider, test-number-sqr, test-rest
*-----------------------------------------------------------------
r80-test-number.</syntaxhighlight>

=== 8.3 Inline comments ===

* Use <code>*></code> (GnuCOBOL free-format inline comment) or a <code>*</code> in column 7 for a full-line comment.
* Comment the '''why''', not the '''what''': the code shows what; the comment explains why.
* Every EXEC SQL block must have a comment above it stating what it does and under what conditions it is called.

<syntaxhighlight lang="cobol"> * Fetch the next prime from the cursor.
* Called after every successful report loop iteration.
EXEC SQL FETCH primescursor INTO :primes-row END-EXEC.</syntaxhighlight>

=== 8.4 Prohibited comment patterns ===

* Do not comment out code and leave it in the source permanently. Use version control instead.
* Do not write comments that merely restate the code: <code>* MOVE 1 TO X (moves 1 to X)</code>.

-----


== 9. Copybook Standards ==


=== 9.1 File name and content rules ===

* Each copybook defines exactly one logical structure (one 01-level group).
* The copybook file name matches the 01-level name: <code>primes-dal.cpy</code> defines <code>01 primes-dal</code>.
* Copybooks must not contain PROCEDURE DIVISION code.
* Copybooks must not contain COPY statements (no nested copies).


=== 9.2 Copybook header ===

Every copybook must open with:

<syntaxhighlight lang="cobol"> *=================================================================
* Copybook: <name>.cpy
* Purpose: <one sentence>
* Used by: <list of programs>
* Document: <PGCBL-DDD-001> §<section>
*=================================================================</syntaxhighlight>

=== 9.3 Change control ===

* Any change to a copybook is a '''breaking change''' for all programs that include it.
* Changes must be accompanied by a recompilation of all affected programs.
* The copybook version history must be updated in the header comment.


=== 9.4 Canonical copybook rule ===

Where two copybooks define the same structure (e.g. <code>primes-table.cpy</code> and <code>primes_table.cpy</code>), one must be designated canonical and the other deprecated and removed. The canonical version is documented in the Data Dictionary.

-----


== 10. Method-Dispatch Pattern Standard ==

This pattern is the core inter-tier communication mechanism. These rules ensure it is applied consistently.


=== 10.1 Control block layout ===

<syntaxhighlight lang="cobol"> 01 <tier>-<control-block>.
03 <tier>-methods PIC X(32).
88 <verb-1> VALUE "<verb-1-string>".
88 <verb-2> VALUE "<verb-2-string>".
88 invalid-method VALUE "bad".
03 <data-payload-group>.
05 <field-1> PIC ...
03 <tier>-result PIC 9(2) VALUE ZERO.
88 <tier>-method-ok VALUE 0.
88 <tier>-method-nok VALUE 1.
88 <tier>-method-eof VALUE 9.</syntaxhighlight>

=== 10.2 Result code convention ===

{|
!width="33%"| Value
!width="33%"| 88-level name
!width="33%"| Meaning
|-
| 0
| <code><tier>-method-ok</code>
| Operation succeeded
|-
| 1
| <code><tier>-method-nok</code>
| Operation failed (error)
|-
| 9 or 99
| <code><tier>-method-eof</code>
| End of data (cursor exhausted, no more rows)
|}

* All tiers must use these values consistently.
* No other result codes may be introduced without updating this standard and the Data Dictionary.


=== 10.3 Caller obligations ===

<syntaxhighlight lang="cobol"> MOVE "<verb>" TO <tier>-methods.
CALL "<program>" USING <control-block>.
IF <tier>-method-ok THEN
<success path>
ELSE
<error path — must not be empty>
END-IF.</syntaxhighlight>
* The caller must always check the result immediately after the CALL.
* An unchecked result is a coding error.


=== 10.4 Callee obligations ===

* The callee must set the result field before EXIT PROGRAM on every code path.
* The callee must handle <code>WHEN OTHER</code> in the EVALUATE and set result to 1 (nok).
* The callee must not STOP RUN (only EXIT PROGRAM); the caller decides whether to stop.

-----


== 11. Error Handling Standard ==


=== 11.1 SQL errors ===

Every EXEC SQL block must check SQLCODE as specified in §7.3. On error:

# Move <code>SQLERRMC</code> to <code>program-message</code>.
# Set the tier’s result field to 1 (nok).
# Call primesui with <code>ui-methods = "log-message"</code> to log the error.
# EXIT PROGRAM — do not STOP RUN from within a subprogram.


=== 11.2 File I/O errors ===

Every file OPEN, READ, WRITE, CLOSE must check the file-status field:

<syntaxhighlight lang="cobol"> IF <file>-status = "00" THEN
<success>
ELSE
MOVE <file>-status TO program-message
PERFORM r98-message-ui
MOVE 1 TO ui-method-result
END-IF.</syntaxhighlight>

=== 11.3 Return code ===

At the end of <code>primesmain</code> (the only <code>STOP RUN</code> in the system), set the process return code:

<syntaxhighlight lang="cobol"> IF <any-error-indicator> THEN
MOVE 1 TO RETURN-CODE
ELSE
MOVE 0 TO RETURN-CODE
END-IF.
STOP RUN.</syntaxhighlight>

-----


== 12. Compliance Checklist ==

Use this checklist during code review:


=== Structure ===

* ☐ Program header block present and complete.
* ☐ All divisions in correct order.
* ☐ WORKING-STORAGE follows the prescribed section order.
* ☐ LINKAGE SECTION contains only COPY statements.


=== Naming ===

* ☐ All paragraph names follow <code><prefix><NN>-<description></code> scheme.
* ☐ All data names use hyphens, not underscores (except legacy names).
* ☐ 88-level names describe the true condition, not the value.
* ☐ Copybook fields are globally unique and prefixed with the copybook’s logical name.


=== Procedure Division ===

* ☐ No GO TO (except structured skip).
* ☐ No PERFORM … THRU.
* ☐ Every EVALUATE has WHEN OTHER.
* ☐ Every CALL is followed by a result check.
* ☐ Every EXEC SQL is followed by a SQLCODE check.
* ☐ Every file operation is followed by a file-status check.
* ☐ RETURN-CODE is set before STOP RUN in primesmain.


=== Comments ===

* ☐ Every paragraph has a comment header.
* ☐ Every EXEC SQL block has a purpose comment.
* ☐ No commented-out code left in permanent source.


=== Copybooks ===

* ☐ Each copybook defines exactly one 01-level structure.
* ☐ Copybook file name matches the 01-level name.
* ☐ No nested COPY statements.
* ☐ Copybook header present.

-----


== 13. Open Issues ==

{|
!width="18%"| ID
!width="18%"| Issue
!width="18%"| Owner
!width="21%"| Target
!width="21%"| Status
|-
| OI-01
| <code>primes_table.cpy</code> (underscore) needs to be designated as deprecated in favour of <code>primes-table.cpy</code> (hyphen)
| Developer
| —
| Open
|-
| OI-02
| No program header blocks present in current source — all four programs need retrofitting
| Developer
| —
| Open
|-
| OI-03
| No paragraph comment headers present in current source — all paragraphs need retrofitting
| Developer
| —
| Open
|-
| OI-04
| Direct DISPLAY statements in <code>primes.cbl</code> bypass the structured log format; should be replaced with calls to primesui
| Developer
| —
| Open
|-
| OI-05
| <code>RETURN-CODE</code> not set in <code>primesmain</code>; needs adding before STOP RUN
| Developer
| —
| Open
|}
<hr/>
Terug naar: [[Design standards]] | [[Cobol and PostgreSQL]]

Architecture decision records

2026-03-25T15:34:59Z

Martin: Created page with " = Architecture Decision Records = {| !width="23%"| Field !width="76%"| Value |- | Document ID | PGCBL-ADD-001 |- | Document Type | Architecture Decision Document |- | System | pgcobol — Prime Numbers Application v1.0 |- | Version | 1.0 |- | Status | Draft — decisions marked [INFERRED] need developer confirmation |- | Owner | Lead Developer / Architect |- | Author | [reverse-engineered from source artifacts] |- | Creat..."

= Architecture Decision Records =

{|
!width="23%"| Field
!width="76%"| Value
|-
| Document ID
| PGCBL-ADD-001
|-
| Document Type
| Architecture Decision Document
|-
| System
| pgcobol — Prime Numbers Application v1.0
|-
| Version
| 1.0
|-
| Status
| Draft — decisions marked [INFERRED] need developer confirmation
|-
| Owner
| Lead Developer / Architect
|-
| Author
| [reverse-engineered from source artifacts]
|-
| Created
| 2026-03-17
|-
| Last modified
| 2026-03-17
|-
| Classification
| Internal
|-
| Parent document
| PGCBL-TSD-001
|}


== Version History ==

{|
!width="16%"| Version
!width="22%"| Date
!width="15%"| Author
!width="15%"| Status
!width="30%"| Change Summary
|-
| 0.1
| 2026-03-17
| —
| Draft
| All ADRs inferred from source
|}

-----


== Table of Contents ==

# [[#1-purpose-and-format|Purpose and Format]]
# [[#2-adr-001--three-tier-architecture|ADR-001 — Three-Tier Architecture]]
# [[#3-adr-002--method-dispatch-pattern|ADR-002 — Method-Dispatch Pattern]]
# [[#4-adr-003--divisors-stored-in-database|ADR-003 — Divisors Stored in Database]]
# [[#5-adr-004--gixsql-as-sql-pre-processor|ADR-004 — GixSQL as SQL Pre-Processor]]
# [[#6-adr-005--copybooks-as-interface-contracts|ADR-005 — Copybooks as Interface Contracts]]
# [[#7-adr-006--hard-coded-database-credentials|ADR-006 — Hard-Coded Database Credentials]]
# [[#8-adr-007--no-explicit-commit-on-insert|ADR-007 — No Explicit COMMIT on INSERT]]
# [[#9-adr-008--odd-only-sieve-starting-at-3|ADR-008 — Odd-Only Sieve Starting at 3]]
# [[#10-open-issues|Open Issues]]

-----


== 1. Purpose and Format ==

An Architecture Decision Record (ADR) captures a single significant design decision: the context that prompted it, the options that were considered, the choice that was made, and the consequences. ADRs are written once and never deleted — if a decision is reversed, a new ADR documents the reversal and links to the original.

This document follows the '''MADR (Markdown Architectural Decision Records)''' format, a widely adopted lightweight standard (see <code>https://adr.github.io/madr/</code>).


=== ADR template ===

<pre class="markdown">## N. ADR-NNN — <Short title of the decision>

**Date:** YYYY-MM-DD
**Status:** Proposed | Accepted | Deprecated | Superseded by ADR-NNN
**Deciders:** <names or roles>
**Source:** [CONFIRMED] | [INFERRED from source] | [ASSUMED]

### Context

<What situation or problem prompted this decision? What forces are at play?>

### Decision Drivers

- <driver 1>
- <driver 2>

### Options Considered

| Option | Description | Pros | Cons |
|--------|-------------|------|------|
| A | ... | ... | ... |
| B | ... | ... | ... |

### Decision

<The option chosen and a one-line justification.>

### Consequences

**Positive:**
- <benefit 1>

**Negative / trade-offs:**
- <drawback 1>

**Risks:**
- <risk 1>

### Compliance check

<How to verify this decision is being followed in the codebase.></pre>

-----


== 2. ADR-001 — Three-Tier Architecture ==

'''Date:''' 2025 (inferred) 
'''Status:''' Accepted 
'''Deciders:''' Original developer 
'''Source:''' [INFERRED from source structure]


=== Context ===

A batch COBOL program could be written as a single monolithic program with all logic, SQL, and output in one place. This project chose to separate concerns into distinct compiled units.


=== Decision Drivers ===

* Demonstrate a maintainable, layered COBOL design pattern.
* Allow each tier to be tested, replaced, or modified independently.
* Keep SQL in one place so that database changes affect only one program.


=== Options Considered ===

{|
!width="24%"| Option
!width="39%"| Description
!width="18%"| Pros
!width="18%"| Cons
|-
| A
| Single monolithic program
| Simple; one file to manage
| Hard to test; all concerns coupled
|-
| B
| Three-tier (chosen)
| Separation of concerns; independently testable tiers
| More files; inter-program calling overhead
|-
| C
| Two-tier (no UI layer)
| Simpler than three
| Print formatting coupled to business logic
|}


=== Decision ===

Option B — three-tier (presentation / business logic / data access), each as a separate compiled COBOL program. A fourth orchestrating program (<code>primesmain</code>) manages the session lifecycle.


=== Consequences ===

'''Positive:''' - SQL is isolated in <code>primes.cbl</code>; database changes do not affect other programs. - Print formatting is isolated in <code>primesui.cbl</code>; output format changes do not affect logic. - Each program can be called from a test harness independently.

'''Negative / trade-offs:''' - Four programs must be compiled and linked instead of one. - Inter-program calls carry a small runtime overhead. - A shared copybook change requires recompiling all programs that use it.


=== Compliance check ===

<code>grep -l "EXEC SQL" *.cbl</code> should return only <code>primes.cbl</code>. 
<code>grep -l "OPEN.*fprinter\|WRITE.*file-buffer" *.cbl</code> should return only <code>primesui.cbl</code>.

-----


== 3. ADR-002 — Method-Dispatch Pattern ==

'''Date:''' 2025 (inferred) 
'''Status:''' Accepted 
'''Deciders:''' Original developer 
'''Source:''' [INFERRED from copybook design]


=== Context ===

COBOL does not have objects, interfaces, or function pointers in the traditional sense. When a caller invokes a subprogram, it can either call different entry points (ENTRY paragraphs) or pass a discriminator value and let the callee dispatch internally. The design must allow each subprogram to expose multiple operations without multiple entry points.


=== Decision Drivers ===

* Keep the inter-tier interface to a single <code>CALL</code> statement per tier.
* Allow new operations to be added to a tier without changing the caller’s CALL syntax.
* Use a pattern that is idiomatic in COBOL and familiar to COBOL programmers.


=== Options Considered ===

{|
!width="24%"| Option
!width="39%"| Description
!width="18%"| Pros
!width="18%"| Cons
|-
| A
| Separate CALL per operation (<code>CALL "primes-connect"</code>, <code>CALL "primes-fetch"</code> …)
| Explicit; no dispatch overhead
| Many CALL statements; callers must know all entry names
|-
| B
| ENTRY paragraph per operation (single program, multiple named entries)
| Standard COBOL; compiler-enforced
| Callers must still reference entry names; no single interface point
|-
| C
| Method-dispatch over a control block (chosen)
| Single CALL; extensible; copybook is the interface contract
| Verb strings must be kept in sync between copybooks and EVALUATE
|}


=== Decision ===

Option C — a string verb in a copybook field (<code>dal-methods</code>, <code>ui-methods</code>, <code>methods</code>) drives an <code>EVALUATE TRUE</code> inside the called program. The copybook is the published interface; the 88-level conditions make the valid verbs self-documenting.


=== Consequences ===

'''Positive:''' - Adding a new operation requires only: a new 88-level condition in the copybook and a new <code>WHEN</code> clause in the callee. - The caller’s CALL statement never changes. - The copybook 88-levels serve as the API documentation.

'''Negative / trade-offs:''' - Verb strings are not type-checked at compile time; a misspelled verb silently falls through to the <code>WHEN OTHER</code> error branch. - Result codes (0/1/9/99) are numeric constants, not named conditions at the caller site — callers must remember the convention.

'''Risks:''' - Verb string drift: if a verb is renamed in the copybook but not in the callee’s EVALUATE, the operation silently does nothing and returns result 1.


=== Compliance check ===

Every verb listed in a <code>dal-methods</code> / <code>ui-methods</code> / <code>methods</code> 88-level must have a corresponding <code>WHEN</code> clause in the callee’s EVALUATE. Verify with a diff of copybook 88-values against callee WHEN values.

-----


== 4. ADR-003 — Divisors Stored in Database ==

'''Date:''' 2025 (inferred) 
'''Status:''' Accepted 
'''Deciders:''' Original developer 
'''Source:''' [INFERRED from algorithm and SQL design]


=== Context ===

The trial-division sieve needs a list of previously found primes to use as divisors. These could be held in a COBOL working-storage table (an array), in a flat file, or in the database.


=== Decision Drivers ===

* Demonstrate database interaction as part of the algorithm (pedagogical goal).
* Keep the COBOL working-storage footprint small — avoid a large in-memory prime array.
* Persist divisors so the report can run independently of the generation run.


=== Options Considered ===

{|
!width="24%"| Option
!width="39%"| Description
!width="18%"| Pros
!width="18%"| Cons
|-
| A
| In-memory COBOL table
| Fastest; no I/O
| Fixed size; lost between runs; defeats the DB demonstration goal
|-
| B
| Flat file
| Persistent; simple
| Requires file I/O; not the DB demonstration goal
|-
| C
| Database (chosen)
| Persistent; demonstrates DB use; divisors and output in same store
| One SQL query per trial division step — potentially very slow
|}


=== Decision ===

Option C — each divisor is fetched from the <code>primes</code> table by ident using a point SELECT. Generated primes accumulate in the same table as the divisors.


=== Consequences ===

'''Positive:''' - Demonstrates the full three-tier pattern end-to-end. - All state is in the database; generation can be interrupted and (in principle) resumed.

'''Negative / trade-offs:''' - Performance is heavily dependent on the <code>SELECT prime WHERE ident = :n</code> query. Without an index on <code>ident</code>, this becomes a sequential scan that gets slower as the table grows. - The design requires prime 2 to be pre-seeded in the table before the algorithm starts, since the first divider fetch assumes ident=2 exists.

'''Risks:''' - No index on <code>ident</code> is defined in <code>primes_schema.sql</code> (see NFR-PERF-03). This is the most significant performance risk in the system.


=== Compliance check ===

Run <code>\d primes.primes</code> in psql; verify an index on <code>ident</code> is present. If absent, add: <code>CREATE INDEX idx_primes_ident ON primes.primes (ident);</code>

-----


== 5. ADR-004 — GixSQL as SQL Pre-Processor ==

'''Date:''' 2025 (inferred) 
'''Status:''' Accepted 
'''Deciders:''' Original developer 
'''Source:''' [CONFIRMED — explicit in compiler listing header and DATASRC prefix <code>pgsql://</code>]


=== Context ===

GnuCOBOL does not natively support embedded SQL. An external pre-processor is needed to translate <code>EXEC SQL … END-EXEC</code> blocks into COBOL CALL statements to a SQL runtime library.


=== Decision Drivers ===

* Open-source toolchain (no licensing cost).
* PostgreSQL support.
* Compatible with GnuCOBOL.


=== Options Considered ===

{|
!width="38%"| Option
!width="61%"| Description
|-
| ESQL/C bridge
| Write SQL in C, call from COBOL — complex
|-
| OCESQL
| Another open-source COBOL SQL pre-processor — less PostgreSQL-specific
|-
| GixSQL (chosen)
| Open-source; PostgreSQL-optimised; active development
|}


=== Decision ===

GixSQL — translates EXEC SQL to <code>GIXSQLExec</code>, <code>GIXSQLConnect</code>, <code>GIXSQLConnectReset</code> calls. Connection string prefix <code>pgsql://</code> is GixSQL-specific.


=== Consequences ===

'''Positive:''' - Standard embedded SQL syntax in COBOL source. - PostgreSQL-native driver.

'''Negative / trade-offs:''' - GixSQL-specific connection string prefix (<code>pgsql://</code>) and runtime library are not portable to other COBOL SQL pre-processors. - GixSQL is not part of the GnuCOBOL distribution; must be installed separately.


=== Compliance check ===

All SQL pre-processing must be done through GixSQL. Verify no raw <code>CALL "GIXSQLExec"</code> statements appear in handwritten source (only in generated <code>.out</code> files).

-----


== 6. ADR-005 — Copybooks as Interface Contracts ==

'''Date:''' 2025 (inferred) 
'''Status:''' Accepted 
'''Deciders:''' Original developer 
'''Source:''' [INFERRED from copybook design]


=== Context ===

In a multi-program COBOL system, data shared between programs can be defined redundantly in each program’s WORKING-STORAGE, or defined once in a copybook included by all parties.


=== Decision ===

Define each tier’s control block once in a copybook (<code>primes-session.cpy</code>, <code>primes-dal.cpy</code>, <code>primes-ui.cpy</code>) and COPY it into both the caller’s WORKING-STORAGE and the callee’s LINKAGE SECTION. The copybook is the published interface; changing it is a breaking change affecting all users.


=== Consequences ===

'''Positive:''' - Single source of truth for each interface. - Field layout guaranteed to match between caller and callee.

'''Negative / trade-offs:''' - Any field size change in a copybook requires recompiling every program that includes it. - Two nearly-identical host-variable copybooks exist (<code>primes-table.cpy</code> vs <code>primes_table.cpy</code>) — the canonical version must be designated and the other retired.


=== Compliance check ===

<code>grep -r "COPY primes-dal" *.cbl</code> — should list only <code>primesgen.cbl</code> (caller) and <code>primes.cbl</code> (callee).

-----


== 7. ADR-006 — Hard-Coded Database Credentials ==

'''Date:''' 2025 (inferred) 
'''Status:''' Accepted (as technical debt — see note) 
'''Deciders:''' Original developer 
'''Source:''' [CONFIRMED — visible in <code>primes.cbl</code> lines 14–17]


=== Context ===

Database credentials must be provided to the GixSQL CONNECT call. Options include hard-coding, environment variables, a configuration file, or a secrets manager.


=== Decision ===

Credentials are hard-coded in WORKING-STORAGE of <code>primes.cbl</code> as a pragmatic choice for a demonstration application.

<blockquote>⚠ '''Technical debt note:''' This decision is explicitly acknowledged as a security defect (NFR-SEC-01). It is documented here so that the decision is visible and the remediation can be tracked. It must not be carried forward to a production deployment.
</blockquote>

=== Recommended remediation ===

Replace <code>DBUSR</code> and <code>DBPWD</code> VALUE clauses with:

<syntaxhighlight lang="cobol">ACCEPT DBUSR FROM ENVIRONMENT "PRIMES_DB_USER"
ACCEPT DBPWD FROM ENVIRONMENT "PRIMES_DB_PASS"</syntaxhighlight>
Or read from a protected configuration file at startup.


=== Consequences ===

'''Negative:''' - Credential rotation requires recompilation and redeployment. - Credentials are visible in the binary and in any version-control history. - Violates NFR-SEC-01 and OWASP Secure Coding Practice #3.

-----


== 8. ADR-007 — No Explicit COMMIT on INSERT ==

'''Date:''' 2025 (inferred) 
'''Status:''' Accepted (status uncertain — see note) 
'''Deciders:''' Original developer 
'''Source:''' [INFERRED — COMMIT statement is commented out in <code>primes.cbl</code> r83-write-prime]


=== Context ===

The INSERT in <code>r83-write-prime</code> does not issue an explicit COMMIT. The commented-out COMMIT suggests this was a deliberate choice or a deferred decision.


=== Decision ===

Rely on PostgreSQL’s default auto-commit behaviour for individual INSERT statements outside an explicit transaction. The COMMIT is not needed because each INSERT auto-commits.

<blockquote>⚠ '''Note:''' The report path opens an explicit transaction (<code>START TRANSACTION</code>) via <code>s01-cursor</code>. If the generate path is ever run while a transaction is open (e.g. if the session management is changed), the INSERTs will not auto-commit. This is a latent risk.
</blockquote>

=== Consequences ===

'''Positive:''' - Simpler code; no COMMIT overhead per row.

'''Risks:''' - If a transaction is ever opened on the <code>primes</code> connection before <code>r83-write-prime</code>, the INSERTs will not be committed until an explicit COMMIT or ROLLBACK, and data will be lost on failure.

-----


== 9. ADR-008 — Odd-Only Sieve Starting at 3 ==

'''Date:''' 2025 (inferred) 
'''Status:''' Accepted 
'''Deciders:''' Original developer 
'''Source:''' [CONFIRMED — ADD 2 TO test-number in r82-next-test-number; initial value 3]


=== Context ===

The sieve must test whether each integer is prime. Testing every integer (2, 3, 4, 5 …) is correct but wasteful: all even numbers greater than 2 are composite and need not be tested.


=== Decision ===

Start the candidate at 3 and advance by 2 (ADD 2 TO test-number), testing only odd integers. Prime 2 is handled as a manual seed rather than by the algorithm.


=== Consequences ===

'''Positive:''' - Roughly halves the number of candidates that must be tested, improving performance.

'''Negative / trade-offs:''' - Prime 2 must be manually seeded in the database before the algorithm runs (see Assumption A-01). This is an external dependency on an operational step, not a code-enforced constraint.


=== Compliance check ===

Verify <code>test-number</code> is initialised to 3 (odd) and that only <code>ADD 2 TO test-number</code> (never ADD 1) advances the candidate in <code>r82-next-test-number</code>.

-----


== 10. Open Issues ==

{|
!width="18%"| ID
!width="18%"| Issue
!width="18%"| Owner
!width="21%"| Target
!width="21%"| Status
|-
| OI-01
| All ADRs marked [INFERRED] need confirmation from original developer
| Lead Dev
| —
| Open
|-
| OI-02
| ADR-006 remediation (credentials) has no target date
| Lead Dev
| —
| Open
|-
| OI-03
| ADR-007 (no COMMIT) — confirm the intent is auto-commit, not an oversight
| Lead Dev
| —
| Open
|-
| OI-04
| Duplicate copybooks (ADR-005) — designate canonical version and retire the other
| Developer
| —
| Open
|}
<hr/>
Terug naar: [[Design standards]] | [[Cobol and PostgreSQL]]

Design standards

2026-03-25T15:33:49Z

Martin:

= Index of Document Engineering and System Requirements =

# [[Document Engineering]]
# [[Scope and applicability]]
# [[Assumptions and Dependencies]]
# [[Architecture decision records]]
# [[Non-Functional Requirements]]
# [[Test Traceability Matrix]]
# [[Naming and Coding Standards]]
# [[Business Requirement Document]]
== Cross-Document References]]
; Document ID | Title | Relationship
|---|---|---
| PGCBL-SAD-001 | Scope and Applicability | Navigation Guide
| PGCBL-NFR-001 | Non-Functional Requirements | Quality Attributes Complement
| PGCBL-TSD-001 | Technical Specification | Implementation Details
| PGCBL-TTM-001 | Test Traceability Matrix | Test Case Mapping
| PGCBL-ADD-001 | Architecture Decision Records | Design Documentation

This index provides a structured overview of the document set, facilitating easy navigation and understanding of the interrelated components.
<hr/>
Terug naar: [[Cobol and PostgreSQL]]

Test Traceability Matrix

2026-03-25T15:31:54Z

Martin: Created page with " = Test Traceability Matrix = {| !width="23%"| Field !width="76%"| Value |- | Document ID | PGCBL-TTM-001 |- | Document Type | Test Traceability Matrix |- | System | pgcobol — Prime Numbers Application v1.0 |- | Version | 1.0 |- | Status | Draft — test cases not yet written; matrix is a planning skeleton |- | Owner | QA Lead / Lead Developer |- | Author | [derived from PGCBL-BRD-001 and PGCBL-NFR-001] |- | Created | 2026-03..."

= Test Traceability Matrix =

{|
!width="23%"| Field
!width="76%"| Value
|-
| Document ID
| PGCBL-TTM-001
|-
| Document Type
| Test Traceability Matrix
|-
| System
| pgcobol — Prime Numbers Application v1.0
|-
| Version
| 1.0
|-
| Status
| Draft — test cases not yet written; matrix is a planning skeleton
|-
| Owner
| QA Lead / Lead Developer
|-
| Author
| [derived from PGCBL-BRD-001 and PGCBL-NFR-001]
|-
| Created
| 2026-03-17
|-
| Last modified
| 2026-03-17
|-
| Classification
| Internal
|-
| Parent document
| PGCBL-BRD-001, PGCBL-NFR-001
|}


== Version History ==

{|
! Version
! Date
! Author
! Status
! Change Summary
|-
| 0.1
| 2026-03-17
| —
| Draft
| Planning skeleton
|}

-----


== Table of Contents ==

# [[#1-purpose-and-how-to-use-this-matrix|Purpose and How to Use This Matrix]]
# [[#2-test-levels-and-types|Test Levels and Types]]
# [[#3-requirements-coverage-matrix|Requirements Coverage Matrix]]
# [[#4-test-case-catalogue|Test Case Catalogue]]
# [[#5-defect-traceability|Defect Traceability]]
# [[#6-coverage-summary|Coverage Summary]]
# [[#7-open-issues|Open Issues]]

-----


== 1. Purpose and How to Use This Matrix ==

A Test Traceability Matrix (TTM) provides bidirectional traceability between:

<pre>Business Requirement ←→ Design Element ←→ Test Case ←→ Test Result</pre>
It answers two critical questions:

# '''Completeness:''' Is every requirement covered by at least one test? (forward trace)
# '''Necessity:''' Does every test correspond to a requirement? (backward trace — prevents test bloat)


=== Status values used in this document ===

{|
!width="50%"| Status
!width="50%"| Meaning
|-
| <code>Planned</code>
| Test case defined; not yet implemented
|-
| <code>Implemented</code>
| Test case exists in the test suite
|-
| <code>Passed</code>
| Test executed and passed in the latest run
|-
| <code>Failed</code>
| Test executed and failed in the latest run
|-
| <code>Blocked</code>
| Cannot be run due to an open defect or missing dependency
|-
| <code>N/A</code>
| Not applicable to this version
|}


=== Test case ID scheme ===

<pre>TC-<LEVEL>-<NNN>

LEVEL:
UT Unit test (single program in isolation)
IT Integration test (two or more programs together)
ST System test (full end-to-end)
NFT Non-functional test (performance, security, etc.)

NNN: zero-padded sequence

Examples:
TC-UT-001 Unit test #1
TC-ST-001 System test #1
TC-NFT-001 Non-functional test #1</pre>

-----


== 2. Test Levels and Types ==


=== 2.1 Unit tests (UT) ===

Test a single COBOL program in isolation using a synthetic control block. No real database or print file is required; stubs or mocks may be used.

'''Target programs:''' primesgen (sieve logic), primes (SQL operations), primesui (print formatting)


=== 2.2 Integration tests (IT) ===

Test two or more programs working together. Typically: primesgen + primes (with a real database), or primesgen + primesui (with a real print file).


=== 2.3 System tests (ST) ===

Test the complete stack end-to-end: compile all programs, set up the database, run primesmain with a command-line argument, inspect all outputs.


=== 2.4 Non-functional tests (NFT) ===

Test quality attributes: performance, security (credential exposure), operability (return code, log completeness).

-----


== 3. Requirements Coverage Matrix ==

Each row is a requirement. Each column is a test case. A cell contains <code>✓</code> if the test covers that requirement.


=== 3.1 Functional Requirements (from PGCBL-BRD-001) ===

{|
!width="5%"| Req ID
!width="14%"| Requirement summary
!width="7%"| TC-UT-001
!width="7%"| TC-UT-002
!width="7%"| TC-UT-003
!width="7%"| TC-UT-004
!width="7%"| TC-UT-005
!width="7%"| TC-IT-001
!width="7%"| TC-IT-002
!width="7%"| TC-ST-001
!width="7%"| TC-ST-002
!width="7%"| TC-ST-003
!width="6%"| Coverage
|-
| FR-01
| Prime generation (generate arg)
|
|
|
|
|
| ✓
|
| ✓
|
|
| Planned
|-
| FR-02
| Trial-division algorithm correctness
| ✓
| ✓
|
|
|
| ✓
|
| ✓
|
|
| Planned
|-
| FR-03
| Prime reporting (report arg)
|
|
|
|
|
|
| ✓
|
| ✓
|
| Planned
|-
| FR-04
| Print report format (6/line, heading, footing)
|
|
| ✓
| ✓
|
|
| ✓
|
| ✓
|
| Planned
|-
| FR-05
| Console logging
|
|
|
|
|
|
|
| ✓
| ✓
|
| Planned
|-
| FR-06
| Error handling — bad arg
|
|
|
|
|
|
|
|
|
| ✓
| Planned
|-
| FR-06
| Error handling — DB connect failure
|
|
|
|
| ✓
|
|
|
|
|
| Planned
|-
| FR-06
| Error handling — print file cannot open
|
|
|
| ✓
|
|
|
|
|
|
| Planned
|}


=== 3.2 Non-Functional Requirements (from PGCBL-NFR-001) ===

{|
!width="8%"| Req ID
!width="21%"| Requirement summary
!width="12%"| TC-NFT-001
!width="12%"| TC-NFT-002
!width="12%"| TC-NFT-003
!width="12%"| TC-NFT-004
!width="12%"| TC-NFT-005
!width="10%"| Coverage
|-
| NFR-PERF-01
| Generation throughput ≥ 1,000/sec
| ✓
|
|
|
|
| Planned
|-
| NFR-PERF-03
| Divider lookup < 50 ms
|
| ✓
|
|
|
| Planned
|-
| NFR-REL-01
| Batch completes without intervention
|
|
|
|
|
| TC-ST-001/002 cover this
|-
| NFR-REL-02
| Graceful DB failure
|
|
| ✓
|
|
| Planned
|-
| NFR-SEC-01
| No hard-coded credentials
|
|
|
| ✓
|
| Planned
|-
| NFR-OPER-02
| Non-zero return code on failure
|
|
|
|
| ✓
| Planned
|}

-----


== 4. Test Case Catalogue ==

Each test case below is a planning entry. Fields marked <code>[TBD]</code> must be completed when the test is implemented.

-----


=== TC-UT-001 — Sieve: known prime confirmation ===

{|
!width="50%"| Field
!width="50%"| Value
|-
| ID
| TC-UT-001
|-
| Level
| Unit
|-
| Program under test
| primesgen (r80-test-number logic)
|-
| Requirements covered
| FR-02
|-
| Description
| Verify that known prime numbers are correctly identified.
|-
| Pre-conditions
| A test harness that can call primesgen with a synthetic primes-session and a stub primes DAL returning pre-set dividers. Prime 2 pre-seeded in stub.
|-
| Test data
| Candidates: 3, 5, 7, 11, 13, 17, 19 (all prime). Stub DAL returns pre-calculated divisors.
|-
| Expected result
| Each candidate is written (r85-write-prime called) exactly once for each prime. No composite candidate is written.
|-
| Status
| Planned
|-
| Defects linked
| —
|}

-----


=== TC-UT-002 — Sieve: known composite rejection ===

{|
!width="50%"| Field
!width="50%"| Value
|-
| ID
| TC-UT-002
|-
| Level
| Unit
|-
| Program under test
| primesgen
|-
| Requirements covered
| FR-02
|-
| Description
| Verify that known composite numbers are not written as primes.
|-
| Pre-conditions
| Same harness as TC-UT-001.
|-
| Test data
| Candidates: 4, 6, 8, 9, 10, 15, 21, 25, 49.
|-
| Expected result
| r85-write-prime is never called for any of these candidates.
|-
| Status
| Planned
|-
| Defects linked
| —
|}

-----


=== TC-UT-003 — UI: six-per-line accumulation ===

{|
!width="50%"| Field
!width="50%"| Value
|-
| ID
| TC-UT-003
|-
| Level
| Unit
|-
| Program under test
| primesui
|-
| Requirements covered
| FR-04
|-
| Description
| Verify that exactly 6 prime entries are accumulated before a line is written to the print file.
|-
| Pre-conditions
| Call primesui with ui-methods=“start”; then call with ui-methods=“write” seven times. Inspect file after calls 6 and 7.
|-
| Test data
| u-sequence = 1–7; u-number = 2, 3, 5, 7, 11, 13, 17.
|-
| Expected result
| One line written after 6th entry. File buffer reset. 7th entry starts a new accumulation cycle.
|-
| Status
| Planned
|-
| Defects linked
| —
|}

-----


=== TC-UT-004 — UI: print file cannot be opened ===

{|
!width="50%"| Field
!width="50%"| Value
|-
| ID
| TC-UT-004
|-
| Level
| Unit
|-
| Program under test
| primesui
|-
| Requirements covered
| FR-06
|-
| Description
| Verify that primesui returns ui-method-result = 1 when the print file cannot be created (e.g. directory is read-only).
|-
| Pre-conditions
| Set up a read-only target directory so <code>primes.prt</code> cannot be created.
|-
| Test data
| Call primesui with ui-methods=“start”.
|-
| Expected result
| ui-method-result = 1; error status displayed on console; no abort/crash.
|-
| Status
| Planned
|-
| Defects linked
| —
|}

-----


=== TC-UT-005 — DAL: database connection failure ===

{|
!width="50%"| Field
!width="50%"| Value
|-
| ID
| TC-UT-005
|-
| Level
| Unit
|-
| Program under test
| primes (DAL)
|-
| Requirements covered
| FR-06
|-
| Description
| Verify that primes returns dal-result = 1 and logs a message when the database is unreachable.
|-
| Pre-conditions
| PostgreSQL not running, or DATASRC points to an invalid host.
|-
| Test data
| CALL primes USING primes-dal with dal-methods=“connect”.
|-
| Expected result
| dal-result = 1; SQLCODE ≠ 0; error message on console; no crash.
|-
| Status
| Planned
|-
| Defects linked
| —
|}

-----


=== TC-IT-001 — Generation integration: first 100 primes ===

{|
!width="50%"| Field
!width="50%"| Value
|-
| ID
| TC-IT-001
|-
| Level
| Integration
|-
| Programs under test
| primesgen + primes (DAL)
|-
| Requirements covered
| FR-01, FR-02
|-
| Description
| Run the full generate path for the first 100 primes (up to 541). Verify correctness of results in the database.
|-
| Pre-conditions
| Database reset (<code>reset-primes.sql</code>). Prime 2 manually inserted. PostgreSQL running. primesui replaced with a stub that accepts “write” calls silently.
|-
| Test data
| Generate until test-number > 541.
|-
| Expected result
| <code>SELECT prime FROM primes.primes ORDER BY ident</code> returns exactly the first 100 primes: 2, 3, 5, 7, 11, … 541.
|-
| Pass criteria
| 100 rows; each row is a known prime; no duplicates; sequence matches insertion order.
|-
| Status
| Planned
|-
| Defects linked
| D-01 (generate loop commented out in primesmain — this test bypasses primesmain and calls primesgen directly)
|}

-----


=== TC-IT-002 — Report integration: all primes from database ===

{|
!width="50%"| Field
!width="50%"| Value
|-
| ID
| TC-IT-002
|-
| Level
| Integration
|-
| Programs under test
| primesgen + primes (DAL) + primesui
|-
| Requirements covered
| FR-03, FR-04
|-
| Description
| Seed 12 known primes in the database; run the report path; inspect <code>primes.prt</code>.
|-
| Pre-conditions
| Database reset. Insert the first 12 primes (2 through 37) manually.
|-
| Test data
| 12 primes → 2 data lines (6 per line); should produce one page with heading, 2 data lines, footing.
|-
| Expected result
| <code>primes.prt</code> contains: heading line, column header line, data line 1 (primes 2–13), data line 2 (primes 17–37), footing line with page 1.
|-
| Status
| Planned
|-
| Defects linked
| —
|}

-----


=== TC-ST-001 — System test: full generate run (first 1,000 primes) ===

{|
!width="50%"| Field
!width="50%"| Value
|-
| ID
| TC-ST-001
|-
| Level
| System
|-
| Programs under test
| All (primesmain → primesgen → primes + primesui)
|-
| Requirements covered
| FR-01, FR-02, FR-05
|-
| Description
| Full end-to-end generate run via <code>primesmain generate</code>.
|-
| Pre-conditions
| All programs compiled and linked. Database reset. Prime 2 seeded. Fix for D-01 (generate loop) applied or tested separately.
|-
| Expected result
| Database contains the first 1,000 primes (2 through 7,919). Console log shows all lifecycle messages. Process exits without crash.
|-
| Status
| Blocked — D-01 (generate loop commented out)
|-
| Defects linked
| D-01
|}

-----


=== TC-ST-002 — System test: full report run ===

{|
!width="50%"| Field
!width="50%"| Value
|-
| ID
| TC-ST-002
|-
| Level
| System
|-
| Programs under test
| All (primesmain → primesgen → primes + primesui)
|-
| Requirements covered
| FR-03, FR-04, FR-05
|-
| Description
| Full end-to-end report run via <code>primesmain report</code> after TC-ST-001 has populated the database.
|-
| Pre-conditions
| TC-ST-001 has run successfully; database contains at least 1,000 primes.
|-
| Expected result
| <code>primes.prt</code> contains all primes in order; correct page headings and footings; last page flushed correctly.
|-
| Status
| Planned
|-
| Defects linked
| —
|}

-----


=== TC-ST-003 — System test: bad command-line argument ===

{|
!width="50%"| Field
!width="50%"| Value
|-
| ID
| TC-ST-003
|-
| Level
| System
|-
| Programs under test
| primesmain
|-
| Requirements covered
| FR-06
|-
| Description
| Run <code>primesmain badarg</code>; verify graceful exit.
|-
| Pre-conditions
| All programs compiled.
|-
| Expected result
| Console message “Bad parameter, program initialisation failed.” Process exits. No database connection attempted.
|-
| Status
| Planned
|-
| Defects linked
| —
|}

-----


=== TC-NFT-001 — Performance: generation throughput ===

{|
!width="50%"| Field
!width="50%"| Value
|-
| ID
| TC-NFT-001
|-
| Level
| Non-functional
|-
| Requirements covered
| NFR-PERF-01
|-
| Description
| Time the generation of the first 10,000 primes; calculate primes-per-second.
|-
| Pass criteria
| ≥ 1,000 primes/second.
|-
| Status
| Planned — requires D-01 fix and index on <code>ident</code> (NFR-PERF-03)
|}

-----


=== TC-NFT-002 — Performance: divider lookup query plan ===

{|
!width="50%"| Field
!width="50%"| Value
|-
| ID
| TC-NFT-002
|-
| Level
| Non-functional
|-
| Requirements covered
| NFR-PERF-03
|-
| Description
| Run EXPLAIN ANALYZE on <code>SELECT prime FROM primes.primes WHERE ident = 500</code> with 1,000 rows in the table.
|-
| Pass criteria
| Query plan shows Index Scan; execution time < 50 ms.
|-
| Status
| Planned — likely to fail until index on <code>ident</code> is added
|}

-----


=== TC-NFT-003 — Reliability: graceful DB failure mid-run ===

{|
!width="50%"| Field
!width="50%"| Value
|-
| ID
| TC-NFT-003
|-
| Level
| Non-functional
|-
| Requirements covered
| NFR-REL-02
|-
| Description
| Kill the PostgreSQL process during a report run; verify clean exit and no zombie connections.
|-
| Pass criteria
| Program logs an error and exits; <code>primes.prt</code> is closed; no orphan DB connections.
|-
| Status
| Planned
|}

-----


=== TC-NFT-004 — Security: no credentials in binary ===

{|
!width="50%"| Field
!width="50%"| Value
|-
| ID
| TC-NFT-004
|-
| Level
| Non-functional
|-
| Requirements covered
| NFR-SEC-01
|-
| Description
| Run <code>strings primes</code> (the compiled binary) and grep for the password string <code>pr1mes_user</code>.
|-
| Pass criteria
| String not found in binary.
|-
| Status
| Planned — expected to FAIL until ADR-006 remediation is applied
|}

-----


=== TC-NFT-005 — Operability: non-zero return code on error ===

{|
!width="50%"| Field
!width="50%"| Value
|-
| ID
| TC-NFT-005
|-
| Level
| Non-functional
|-
| Requirements covered
| NFR-OPER-02
|-
| Description
| Run <code>primesmain badarg</code>; check <code>echo $?</code>.
|-
| Pass criteria
| Exit code ≠ 0.
|-
| Status
| Planned — expected to FAIL until <code>MOVE 1 TO RETURN-CODE</code> is added
|}

-----


== 5. Defect Traceability ==

Known defects identified during reverse engineering, linked to the test cases that expose them:

{|
!width="20%"| Defect ID
!width="24%"| Description
!width="39%"| Test cases affected
!width="15%"| Status
|-
| D-01
| Generate loop commented out in primesmain
| TC-ST-001, TC-NFT-001
| Open — blocks system-level generation tests
|-
| D-02
| Prime 2 not seeded by algorithm
| TC-IT-001, TC-ST-001
| Open — manual pre-step required
|-
| D-03
| Connection alias mismatch (<code>primes</code> vs <code>primesdb</code>)
| TC-ST-001, TC-ST-002
| Open — may cause runtime failure
|-
| D-04
| Hard-coded credentials
| TC-NFT-004
| Open — expected test failure
|-
| D-05
| No index on <code>primes.ident</code>
| TC-NFT-001, TC-NFT-002
| Open — performance defect
|-
| D-06
| No process return code on error
| TC-NFT-005
| Open — expected test failure
|}

-----


== 6. Coverage Summary ==

{|
!width="20%"| Category
!width="20%"| Total requirements
!width="20%"| Tests planned
!width="20%"| Tests passing
!width="20%"| Coverage %
|-
| Functional (FR)
| 8
| 8
| 0
| 0% (tests not yet run)
|-
| Non-functional (NFR)
| 10
| 6
| 0
| 0%
|-
| '''Total'''
| '''18'''
| '''14'''
| '''0'''
| —
|}

<blockquote>Target before release: 100% functional coverage; 80% non-functional coverage.
</blockquote>

-----


== 7. Open Issues ==

{|
!width="18%"| ID
!width="18%"| Issue
!width="18%"| Owner
!width="21%"| Target
!width="21%"| Status
|-
| OI-01
| D-01 (generate loop) blocks TC-ST-001, TC-NFT-001 — must be fixed before system testing
| Developer
| —
| Open
|-
| OI-02
| No test harness / stub exists for any program; unit tests cannot run until stubs are written
| QA / Developer
| —
| Open
|-
| OI-03
| TTM coverage for NFR-MAIN (maintainability) NFRs is not yet defined
| QA
| —
| Open
|}
<hr/>
Terug naar: [[Design standards]] | [[Cobol and PostgreSQL]]

Non-Functional Requirements

2026-03-25T15:30:24Z

Martin: Created page with " = Non-Functional Requirements = {| !width="23%"| Field !width="76%"| Value |- | Document ID | PGCBL-NFR-001 |- | Document Type | Non-Functional Requirements |- | System | pgcobol — Prime Numbers Application v1.0 |- | Version | 1.0 |- | Status | Draft — performance and security targets require stakeholder input |- | Owner | Lead Developer / Architect |- | Author | [reverse-engineered; targets are best-practice defaults w..."

= Non-Functional Requirements =

{|
!width="23%"| Field
!width="76%"| Value
|-
| Document ID
| PGCBL-NFR-001
|-
| Document Type
| Non-Functional Requirements
|-
| System
| pgcobol — Prime Numbers Application v1.0
|-
| Version
| 1.0
|-
| Status
| Draft — performance and security targets require stakeholder input
|-
| Owner
| Lead Developer / Architect
|-
| Author
| [reverse-engineered; targets are best-practice defaults where not specified in source]
|-
| Created
| 2026-03-17
|-
| Last modified
| 2026-03-17
|-
| Classification
| Internal
|-
| Parent document
| PGCBL-BRD-001
|}


== Version History ==

{|
!width="16%"| Version
!width="22%"| Date
!width="15%"| Author
!width="15%"| Status
!width="30%"| Change Summary
|-
| 0.1
| 2026-03-17
| —
| Draft
| Initial draft from source analysis and best-practice defaults
|}

-----


== Table of Contents ==

# [[#1-purpose-and-taxonomy|Purpose and Taxonomy]]
# [[#2-performance|Performance]]
# [[#3-reliability-and-availability|Reliability and Availability]]
# [[#4-security|Security]]
# [[#5-maintainability|Maintainability]]
# [[#6-portability-and-compatibility|Portability and Compatibility]]
# [[#7-operability|Operability]]
# [[#8-auditability-and-compliance|Auditability and Compliance]]
# [[#9-recoverability|Recoverability]]
# [[#10-open-issues|Open Issues]]

-----


== 1. Purpose and Taxonomy ==

Non-functional requirements (NFRs) specify '''how well''' the system must do things, as opposed to '''what''' it must do (functional requirements). They are the quality attributes of the system.

This document uses the '''ISO/IEC 25010:2011 (SQuaRE)''' quality model as its taxonomy. Each NFR is assigned a category from that model:

{|
!width="50%"| ISO 25010 Category
!width="50%"| Subcategories
|-
| '''Performance efficiency'''
| Time behaviour, resource utilisation, capacity
|-
| '''Reliability'''
| Maturity, availability, fault tolerance, recoverability
|-
| '''Security'''
| Confidentiality, integrity, non-repudiation, accountability, authenticity
|-
| '''Maintainability'''
| Modularity, reusability, analysability, modifiability, testability
|-
| '''Portability'''
| Adaptability, installability, replaceability
|-
| '''Operability'''
| Appropriateness recognisability, learnability, user error protection
|-
| '''Compatibility'''
| Co-existence, interoperability
|}

Each NFR entry follows this format:

<pre>NFR-<category>-<NN>
Requirement: <measurable statement of what is required>
Rationale: <why this matters>
Test approach: <how it will be verified>
Priority: Must Have | Should Have | Nice to Have
Source: <observed in code / stakeholder input / best-practice default>
Status: [CONFIRMED] | [UNCONFIRMED — needs stakeholder sign-off]</pre>

-----


== 2. Performance ==


=== NFR-PERF-01 — Generation throughput ===

'''Requirement:''' The system should generate and insert at least 1,000 primes per second under normal operating conditions (single-user, unloaded PostgreSQL on localhost). 
'''Rationale:''' There are approximately 50 million primes below 10^9. Without a throughput target the system may be functionally correct but practically unusable. 
'''Test approach:''' Time a generation run of the first 10,000 primes; divide by elapsed seconds. 
'''Priority:''' Should Have 
'''Source:''' Best-practice default [UNCONFIRMED — no target specified in source] 
'''Status:''' Open — target must be agreed with the system owner.


=== NFR-PERF-02 — Report generation time ===

'''Requirement:''' A report covering up to 1 million stored primes should complete within 5 minutes. 
'''Rationale:''' A batch report that runs overnight is operationally acceptable; one that runs for days is not. 
'''Test approach:''' Seed 1,000,000 rows; time a full report run. 
'''Priority:''' Should Have 
'''Source:''' Best-practice default [UNCONFIRMED] 
'''Status:''' Open.


=== NFR-PERF-03 — Database query response ===

'''Requirement:''' The <code>SELECT prime WHERE ident = :n</code> divider lookup should return in under 50 ms at any point in the generation run. 
'''Rationale:''' This query is called once per trial division step; if it is slow, the entire sieve is slow. 
'''Test approach:''' Run EXPLAIN ANALYZE on the query with a populated table; check absence of sequential scan on <code>primes.primes</code>. 
'''Priority:''' Must Have 
'''Source:''' Algorithm design analysis 
'''Status:''' Open — no index on <code>ident</code> is defined in <code>primes_schema.sql</code>; a sequential scan is likely. This is a defect.

-----


== 3. Reliability and Availability ==


=== NFR-REL-01 — Batch completion ===

'''Requirement:''' A generation or report run, once started on a healthy system, should complete without manual intervention. 
'''Rationale:''' Batch jobs that require operator interaction to proceed are unreliable. 
'''Test approach:''' Run end-to-end generation and report on a healthy environment; observe for any interactive prompts or hangs. 
'''Priority:''' Must Have 
'''Source:''' Standard batch computing requirement 
'''Status:''' [CONFIRMED by design — no interactive prompts in the code]


=== NFR-REL-02 — Graceful failure ===

'''Requirement:''' On any database error, the system shall log a descriptive message, set an error code, and exit cleanly (closing the database connection and print file) rather than abending. 
'''Rationale:''' An abend may leave the database connection open or the print file in an inconsistent state. 
'''Test approach:''' Simulate a database failure mid-run (e.g. kill the PostgreSQL process); verify clean exit and closed resources. 
'''Priority:''' Must Have 
'''Source:''' Observed in source; partial — cleanup paragraphs exist but error propagation is incomplete (see PGCBL-IOB-001 D-RPT-01). 
'''Status:''' Partially met; D-RPT-01 is an open defect.


=== NFR-REL-03 — Idempotent reset ===

'''Requirement:''' Running <code>reset-primes.sql</code> shall always produce a clean, empty, ready-to-use database state regardless of the prior state of the database. 
'''Rationale:''' Developers and operators must be able to reset state reliably between test runs. 
'''Test approach:''' Run the reset script three times consecutively; verify the same clean state each time. 
'''Priority:''' Must Have 
'''Source:''' <code>reset-primes.sql</code> uses <code>DROP … CASCADE</code> + <code>CREATE</code>; this is correct. 
'''Status:''' [CONFIRMED by SQL analysis]

-----


== 4. Security ==


=== NFR-SEC-01 — Credential storage ===

'''Requirement:''' Database credentials shall not be stored in plain text within compiled program source code. 
'''Rationale:''' Credentials in source code are exposed to anyone who can read the binary, the source, or the version-control history. 
'''Test approach:''' Inspect all <code>.cbl</code> files for hard-coded user names and passwords; verify none are present. 
'''Priority:''' Must Have 
'''Source:''' OWASP Secure Coding Practice #3 — Credential Management 
'''Status:''' '''NOT MET''' — <code>DBUSR</code> and <code>DBPWD</code> are hard-coded in <code>primes.cbl</code> WORKING-STORAGE. Remediation: use environment variables or a secrets manager.


=== NFR-SEC-02 — Principle of least privilege ===

'''Requirement:''' The database user <code>primes_user</code> shall have only the minimum privileges required: INSERT and SELECT on <code>primes.primes</code>, USAGE on <code>primes.asc_ident</code>. 
'''Rationale:''' If the application account is compromised, the attacker cannot drop tables, access other schemas, or escalate. 
'''Test approach:''' Review PostgreSQL privilege grants; attempt a DROP TABLE as <code>primes_user</code> and verify it is denied. 
'''Priority:''' Must Have 
'''Source:''' CIS PostgreSQL Benchmark, control 6.1 
'''Status:''' [UNCONFIRMED — not specified in <code>primes_schema.sql</code>; only ownership is set]


=== NFR-SEC-03 — Output file permissions ===

'''Requirement:''' <code>primes.prt</code> shall be readable only by the operator user and the intended report consumer; it shall not be world-readable. 
'''Rationale:''' Prime numbers are not sensitive, but the file permissions standard is a good habit and should be enforced as a baseline. 
'''Test approach:''' Check umask of the running process; verify <code>primes.prt</code> permissions after creation. 
'''Priority:''' Nice to Have 
'''Source:''' Best-practice default 
'''Status:''' [UNCONFIRMED]

-----


== 5. Maintainability ==


=== NFR-MAIN-01 — Three-tier separation ===

'''Requirement:''' No SQL shall appear outside <code>primes.cbl</code>. No file I/O (other than console DISPLAY) shall appear outside <code>primesui.cbl</code>. 
'''Rationale:''' Tier separation is the principal architectural rule of this system; violating it makes changes to one tier affect others. 
'''Test approach:''' Grep all <code>.cbl</code> files for EXEC SQL and for SELECT/WRITE file statements; verify only the expected programs contain them. 
'''Priority:''' Must Have 
'''Source:''' Architecture design principle; observed and partially met (primesgen has an unused FD declaration — minor violation). 
'''Status:''' Partially met.


=== NFR-MAIN-02 — Copybook as interface contract ===

'''Requirement:''' Changes to any copybook must be reviewed for impact on all programs that COPY it before the change is applied. 
'''Rationale:''' Copybooks are shared; a field-size change in a copybook breaks every program that uses it without any compile-time warning in all cases. 
'''Test approach:''' Impact analysis process; verified by recompiling all programs after any copybook change. 
'''Priority:''' Must Have 
'''Source:''' Standard COBOL maintenance practice 
'''Status:''' [CONFIRMED as a process requirement — no tooling enforcement in place]


=== NFR-MAIN-03 — Code commentary ===

'''Requirement:''' Every paragraph shall carry a comment line stating its purpose. Every EXEC SQL block shall carry a comment stating what it does and why. 
'''Rationale:''' Current source has minimal commentary; future maintainers depend on the specification documents, which is insufficient. 
'''Test approach:''' Code review checklist. 
'''Priority:''' Should Have 
'''Source:''' COBOL coding best practice 
'''Status:''' '''NOT MET''' in current source.


=== NFR-MAIN-04 — Testability ===

'''Requirement:''' Each tier (primesgen, primes, primesui) shall be callable in isolation with a synthetic control block, without requiring the full three-tier stack. 
'''Rationale:''' Unit testing individual tiers is only possible if they can be called with a test harness. 
'''Test approach:''' Write a minimal test driver for each program; verify it compiles and runs independently. 
'''Priority:''' Should Have 
'''Source:''' Testability principle; the method-dispatch pattern makes this achievable by design. 
'''Status:''' [UNCONFIRMED — no test harnesses exist]

-----


== 6. Portability and Compatibility ==


=== NFR-PORT-01 — COBOL standard compliance ===

'''Requirement:''' Source code shall conform to COBOL 2002 (ISO 1989:2002) where GnuCOBOL extensions are not required, so that migration to a standard-compliant compiler is possible. 
'''Rationale:''' GnuCOBOL 4.0-early-dev is a pre-release; the team should not depend on behaviours not in the standard. 
'''Test approach:''' Compile with <code>-std=cobol2002</code> flag; resolve any warnings. 
'''Priority:''' Should Have 
'''Source:''' Best-practice default 
'''Status:''' [UNCONFIRMED — not tested]


=== NFR-PORT-02 — PostgreSQL version range ===

'''Requirement:''' The system shall operate correctly against PostgreSQL 11 through 16. 
'''Rationale:''' PostgreSQL 11 is the minimum observed in the schema dump; operators may use a more recent version. 
'''Test approach:''' Run integration tests against PostgreSQL 11, 14, and 16. 
'''Priority:''' Should Have 
'''Source:''' Best-practice default 
'''Status:''' [UNCONFIRMED]

-----


== 7. Operability ==


=== NFR-OPER-01 — Console log completeness ===

'''Requirement:''' Every significant state transition (session start/stop, DB connect/disconnect, first fetch, last fetch, error) shall produce a console log entry identifying the program name, paragraph, and a human-readable message. 
'''Rationale:''' Operators diagnosing failures need to reconstruct what happened from the console log alone. 
'''Test approach:''' Run both modes; verify all defined state transitions produce a log line. 
'''Priority:''' Must Have 
'''Source:''' Observed in source; partially met — direct DISPLAY statements in <code>primes.cbl</code> bypass the structured log format. 
'''Status:''' Partially met.


=== NFR-OPER-02 — Return code ===

'''Requirement:''' The process shall exit with return code 0 on success and non-zero on failure. 
'''Rationale:''' Job schedulers and shell scripts depend on process exit codes to detect failures. 
'''Test approach:''' Run with a bad argument; check <code>$?</code> in the shell. 
'''Priority:''' Must Have 
'''Source:''' POSIX convention 
'''Status:''' '''NOT MET''' — <code>STOP RUN</code> in GnuCOBOL returns 0 regardless of the path taken unless <code>MOVE n TO RETURN-CODE</code> is used; not present in current source.

-----


== 8. Auditability and Compliance ==


=== NFR-AUD-01 — Run log retention ===

'''Requirement:''' Console output from each run should be captured and retained for at least 30 days. 
'''Rationale:''' Enables post-hoc investigation of incorrect results or failures. 
'''Test approach:''' Verify a shell wrapper redirects stdout/stderr to a dated log file. 
'''Priority:''' Should Have 
'''Source:''' Best-practice default 
'''Status:''' [UNCONFIRMED — no wrapper script exists]


=== NFR-AUD-02 — Schema change control ===

'''Requirement:''' Changes to <code>primes_schema.sql</code> or <code>reset-primes.sql</code> must be version-controlled and reviewed before deployment. 
'''Rationale:''' Schema changes can destroy data or break the application silently. 
'''Test approach:''' Verify files are under git; verify a change-review process exists. 
'''Priority:''' Must Have 
'''Source:''' Standard DBA practice 
'''Status:''' [UNCONFIRMED]

-----


== 9. Recoverability ==


=== NFR-REC-01 — Clean restart after failure ===

'''Requirement:''' After any failure, it shall be possible to restore the system to a known clean state by running <code>reset-primes.sql</code> and re-running the generation job. 
'''Rationale:''' Without a clean-restart procedure, a failed run leaves the database in an unknown state. 
'''Test approach:''' Simulate a mid-run failure; run <code>reset-primes.sql</code>; run a full generation; verify correctness. 
'''Priority:''' Must Have 
'''Source:''' <code>reset-primes.sql</code> provides this; it must be documented as the recovery procedure. 
'''Status:''' Script exists; recovery procedure not yet documented.


=== NFR-REC-02 — No partial-page print output ===

'''Requirement:''' The report print file shall always end with a complete, flushed page — no partial lines or missing footings. 
'''Rationale:''' A partial last page is confusing to report consumers. 
'''Test approach:''' Run a report with a number of primes that does not divide evenly by 6; inspect the last page of <code>primes.prt</code>. 
'''Priority:''' Must Have 
'''Source:''' <code>r99-stop-primesui</code> flush loop — implemented. 
'''Status:''' [CONFIRMED by code analysis]

-----


== 10. Open Issues ==

{|
!width="18%"| ID
!width="18%"| Issue
!width="18%"| Owner
!width="21%"| Target
!width="21%"| Status
|-
| OI-01
| NFR-PERF-01, 02, 03 targets not confirmed by stakeholder
| System owner
| —
| Open
|-
| OI-02
| NFR-SEC-01 (hard-coded credentials) is a defect; remediation plan needed
| Lead Dev
| —
| Open
|-
| OI-03
| NFR-OPER-02 (return code) not implemented; affects job scheduler integration
| Developer
| —
| Open
|-
| OI-04
| NFR-PERF-03: no index on <code>primes.ident</code>; likely sequential scan — performance defect
| DBA
| —
| Open
|}
<hr/>
Terug naar: [[Design standards]] | [[Cobol and PostgreSQL]]

Assumptions and Dependencies

2026-03-25T15:29:33Z

Martin: Created page with " = Assumptions, Dependencies, and Constraints = {| !width="23%"| Field !width="76%"| Value |- | Document ID | PGCBL-SAD-002 |- | Document Type | Assumptions, Dependencies, and Constraints Register |- | System | pgcobol — Prime Numbers Application v1.0 |- | Version | 1.0 |- | Status | Draft — requires stakeholder confirmation |- | Owner | Lead Developer |- | Author | [reverse-engineered from source artifacts]..."

= Assumptions, Dependencies, and Constraints =

{|
!width="23%"| Field
!width="76%"| Value
|-
| Document ID
| PGCBL-SAD-002
|-
| Document Type
| Assumptions, Dependencies, and Constraints Register
|-
| System
| pgcobol — Prime Numbers Application v1.0
|-
| Version
| 1.0
|-
| Status
| Draft — requires stakeholder confirmation
|-
| Owner
| Lead Developer
|-
| Author
| [reverse-engineered from source artifacts]
|-
| Created
| 2026-03-17
|-
| Last modified
| 2026-03-17
|-
| Classification
| Internal
|-
| Parent document
| PGCBL-BRD-001
|}


== Version History ==

{|
!width="13%"| Version
!width="17%"| Date
!width="11%"| Author
!width="11%"| Status
!width="44%"| Change Summary
|-
| 0.1
| 2026-03-17
| —
| Draft
| Derived from source analysis
|}

-----


== Table of Contents ==

# [[#1-purpose|Purpose]]
# [[#2-how-to-use-this-register|How to Use This Register]]
# [[#3-assumptions|Assumptions]]
# [[#4-dependencies|Dependencies]]
# [[#5-constraints|Constraints]]
# [[#6-risk-summary|Risk Summary]]
# [[#7-open-issues|Open Issues]]

-----


== 1. Purpose ==

This register captures every assumption made during the design, every dependency the system relies on, and every constraint that limits the design space. It exists so that:

* If an assumption turns out to be wrong, the impact on the design can be assessed quickly.
* If a dependency is unavailable, the team knows what is blocked.
* Constraints are documented with their source, so they can be challenged if the source changes.

Items marked '''[UNCONFIRMED]''' were inferred from source code analysis and have not been verified with a stakeholder.

-----


== 2. How to Use This Register ==


=== Best practice — generic ===

An assumption is something the team '''believes to be true''' but has not verified. Every assumption carries a risk: if the assumption is wrong, some part of the design or implementation will fail. Good practice is to:

# State the assumption precisely (not vaguely).
# Identify who should confirm or refute it.
# Assign a risk severity if the assumption is wrong.
# Track confirmation explicitly — an unconfirmed assumption is a risk item.

A dependency is something '''external to the system''' that must exist or be in a known state for the system to function. Dependencies are not assumptions — they are facts that must be managed.

A constraint is a '''limit imposed from outside''' the design team (a regulation, a platform choice, a budget) that restricts what solutions are possible.


=== Severity scale ===

{|
!width="50%"| Severity
!width="50%"| Meaning
|-
| High
| If wrong/unmet, the system cannot run or produces incorrect results
|-
| Medium
| If wrong/unmet, a feature is degraded or a workaround is needed
|-
| Low
| If wrong/unmet, a minor inconvenience; easily remediated
|}

-----


== 3. Assumptions ==

{|
!width="9%"| ID
!width="15%"| Assumption
!width="18%"| Confirmed by
!width="21%"| Confirmed date
!width="25%"| Severity if wrong
!width="10%"| Status
|-
| A-01
| Prime 2 is manually inserted into the database before the first generation run. The algorithm starts at candidate 3 and immediately calls <code>next-divider</code> (ident=2), which requires a row with ident=2 to exist.
| [UNCONFIRMED]
| —
| High
| Open
|-
| A-02
| The <code>primes</code> table is empty at the start of a fresh generation run. No de-duplication logic exists in the INSERT path; re-running generation will insert duplicate primes.
| [UNCONFIRMED]
| —
| High
| Open
|-
| A-03
| The <code>asc_ident</code> sequence is reset to 1 before each generation run (achieved by running <code>reset-primes.sql</code>). If the sequence is not reset, the ident values used by the divider lookup will be wrong.
| [UNCONFIRMED]
| —
| High
| Open
|-
| A-04
| The working directory at runtime is writable by the process owner, so <code>primes.prt</code> can be created.
| [UNCONFIRMED]
| —
| High
| Open
|-
| A-05
| GnuCOBOL 4.0 and the GixSQL pre-processor are installed and on PATH before compilation.
| [UNCONFIRMED]
| —
| High
| Open
|-
| A-06
| PostgreSQL is running on <code>localhost:5432</code> when any program that calls <code>primes.cbl</code> is executed.
| [UNCONFIRMED]
| —
| High
| Open
|-
| A-07
| The PostgreSQL schema <code>primes</code> and the user <code>primes_user</code> exist and have been granted the necessary privileges before first run.
| [UNCONFIRMED]
| —
| High
| Open
|-
| A-08
| The system is run by a single operator at a time; no concurrent execution is expected.
| [UNCONFIRMED]
| —
| Medium
| Open
|-
| A-09
| The 132-character print record width matches the target printer or viewer.
| [UNCONFIRMED]
| —
| Low
| Open
|-
| A-10
| <code>primes_cbsql.out</code> (the pre-compiler listing) is a historical artefact of an earlier version of <code>primes.cbl</code> and the <code>primesdb</code> connection alias it references is no longer active.
| [UNCONFIRMED]
| —
| Medium
| Open
|}

-----


== 4. Dependencies ==

{|
!width="12%"| ID
!width="21%"| Dependency
!width="10%"| Type
!width="29%"| Version required
!width="12%"| Owner
!width="14%"| Status
|-
| DEP-01
| GnuCOBOL compiler
| Build-time
| 4.0 or later
| Developer environment
| Must be installed
|-
| DEP-02
| GixSQL pre-processor
| Build-time
| Compatible with GnuCOBOL 4.0
| Developer environment
| Must be installed
|-
| DEP-03
| PostgreSQL server
| Runtime
| 11 or later
| DBA
| Must be running on localhost:5432
|-
| DEP-04
| <code>primes</code> database and schema
| Runtime
| —
| DBA
| Must exist; created by <code>primes_schema.sql</code>
|-
| DEP-05
| <code>primes_user</code> account
| Runtime
| —
| DBA
| Must exist with INSERT, SELECT privileges on <code>primes.primes</code>
|-
| DEP-06
| Writable working directory
| Runtime
| —
| OS / operator
| Needed for <code>primes.prt</code>
|-
| DEP-07
| <code>reset-primes.sql</code> executed before each generation run
| Operational
| —
| Operator
| Required for idempotent generation
|-
| DEP-08
| Prime 2 seeded in <code>primes.primes</code> before first generation
| Operational
| —
| Operator
| Required for divider lookup to work from candidate 3
|}

-----


== 5. Constraints ==

{|
!width="20%"| ID
!width="34%"| Constraint
!width="22%"| Source
!width="22%"| Impact
|-
| C-01
| Target runtime is Linux only. <code>SPECIAL-NAMES. CONSOLE IS scherm</code> is platform-specific.
| GnuCOBOL platform support
| Cannot run on Windows or mainframe without porting
|-
| C-02
| Database must be PostgreSQL. The connection string prefix <code>pgsql://</code> and GixSQL dialect are PostgreSQL-specific.
| GixSQL driver
| Not portable to DB2, Oracle, or SQL Server without code changes
|-
| C-03
| Upper generation limit is hard-coded at 999,999,999.
| Source code <code>primesgen.cbl</code> line 91
| Cannot be changed without recompilation
|-
| C-04
| Database credentials are hard-coded in <code>primes.cbl</code> WORKING-STORAGE.
| Source code; technical debt
| Credential rotation requires recompilation and redeployment
|-
| C-05
| Print record width is fixed at 132 characters.
| <code>primesui.cbl</code> FD and table layout
| Report format cannot be changed without recompiling <code>primesui</code>
|-
| C-06
| The two operational modes (generate / report) are mutually exclusive per invocation.
| <code>primesmain.cbl</code> EVALUATE structure
| Cannot generate and report in the same run
|-
| C-07
| GnuCOBOL 4.0-early-dev was used; behaviour may differ from stable GnuCOBOL 3.x.
| Compiler listing header
| Compatibility with stable GnuCOBOL releases unverified
|}

-----


== 6. Risk Summary ==

Items with High severity that are still unconfirmed represent the greatest project risk:

{|
!width="33%"| Risk
!width="33%"| Assumptions involved
!width="33%"| Recommended action
|-
| Generation produces wrong results or crashes on fresh DB
| A-01, A-02, A-03
| Write a pre-run setup script and document it as a mandatory step
|-
| Program fails silently at runtime due to missing infrastructure
| A-04, A-05, A-06, A-07
| Add pre-flight checks to <code>primesmain</code> (file/DB accessibility tests)
|-
| Pre-compiler listing alias mismatch causes disconnect failure
| A-10
| Inspect current <code>primes.cbl</code> disconnect path and confirm alias is <code>primes</code>
|}

-----


== 7. Open Issues ==

{|
!width="18%"| ID
!width="18%"| Issue
!width="18%"| Owner
!width="21%"| Target
!width="21%"| Status
|-
| OI-01
| All assumptions are unconfirmed. A stakeholder/developer review session is needed to confirm or correct each one.
| Lead Dev
| —
| Open
|-
| OI-02
| No pre-run setup script exists. DEP-07 and DEP-08 are manual steps with no enforcement.
| Developer
| —
| Open
|}
<hr/>
Terug naar: [[Design standards]] | [[Cobol and PostgreSQL]]

Design standards

2026-03-25T15:28:44Z

Martin:

= Index of Document Engineering and System Requirements =

# [[Document Engineering]]
# [[Scope and applicability]]
# [[Assumptions and Dependencies]]
# [[Non-Functional Requirements]]
# [[Test Traceability Matrix]]
# [[Naming and Coding Standards]]
# [[Business Requirement Document]]
== Cross-Document References]]
; Document ID | Title | Relationship
|---|---|---
| PGCBL-SAD-001 | Scope and Applicability | Navigation Guide
| PGCBL-NFR-001 | Non-Functional Requirements | Quality Attributes Complement
| PGCBL-TSD-001 | Technical Specification | Implementation Details
| PGCBL-TTM-001 | Test Traceability Matrix | Test Case Mapping
| PGCBL-ADD-001 | Architecture Decision Records | Design Documentation

This index provides a structured overview of the document set, facilitating easy navigation and understanding of the interrelated components.
<hr/>
Terug naar: [[Cobol and PostgreSQL]]

Document Engineering

2026-03-25T15:21:52Z

Martin: Created page with " = Document Engineering Standard = '''Document ID:''' STD-DOC-001 '''Applies to:''' All design-level and program-level specification documents in the pgcobol set '''Version:''' 1.0 '''Status:''' Approved '''Owner:''' Lead Developer / Architect ----- == 1. Purpose == This standard defines the mandatory scaffolding, metadata blocks, and governance structure that every do..."

= Document Engineering Standard =

'''Document ID:''' STD-DOC-001 
'''Applies to:''' All design-level and program-level specification documents in the pgcobol set 
'''Version:''' 1.0 
'''Status:''' Approved 
'''Owner:''' Lead Developer / Architect

-----


== 1. Purpose ==

This standard defines the mandatory scaffolding, metadata blocks, and governance structure that every document in this specification set must carry. It exists so that:

* Documents can be located, versioned, and audited independently of their content.
* Reviewers know immediately who owns the document, what it covers, and whether it is current.
* The set as a whole is traceable — each document can be linked to requirements, decisions, and tests.

-----


== 2. Mandatory Document Header ==

Every document '''must''' open with the following block before any content section. Fields marked '''[R]''' are required; fields marked '''[O]''' are optional but strongly recommended.

<pre class="markdown"># <Document Title>

| Field | Value |
|--------------------|--------------------------------------------|
| Document ID | <PROJ>-<TYPE>-<NNN> [R] |
| Document Type | <full type name> [R] |
| System / Project | <system name and version> [R] |
| Version | <major.minor> [R] |
| Status | Draft | Review | Approved | Superseded [R] |
| Owner | <name, role> [R] |
| Author(s) | <name(s)> [R] |
| Reviewers | <name, role — one per row> [O] |
| Approved by | <name, role, date> [O] |
| Created | YYYY-MM-DD [R] |
| Last modified | YYYY-MM-DD [R] |
| Classification | Internal | Confidential | Public [R] |
| Parent document | <Document ID of parent, if any> [O] |
| Supersedes | <Document ID this replaces, if any> [O] |</pre>

=== 2.1 Document ID Scheme ===

<pre><PROJ> - <TYPE> - <NNN>

PROJ Two-to-six letter project code e.g. PGCBL
TYPE Document type code (see §2.2) e.g. BRD
NNN Zero-padded sequence within type e.g. 001

Examples:
PGCBL-BRD-001 Business Requirements Document #1
PGCBL-TSD-001 Technical Specification #1
PGCBL-ADD-001 Architecture Decision Document #1
PGCBL-TTM-001 Test Traceability Matrix #1</pre>

=== 2.2 Document Type Codes ===

{|
! Code
! Full Name
! Abbrev used in filenames
|-
| BRD
| Business Requirements Document
| brd
|-
| TSD
| Technical Specification Document
| tsd
|-
| DDD
| Data Dictionary Document
| ddd
|-
| FLD
| Flow Diagram Document
| fld
|-
| PLG
| Program Logic Guide
| plg
|-
| BRG
| Business Rules Guide
| brg
|-
| IOB
| I/O Behaviour Document
| iob
|-
| CFD
| Control Flow Document
| cfd
|-
| ADD
| Architecture Decision Document
| add
|-
| NFR
| Non-Functional Requirements
| nfr
|-
| SAD
| Scope and Applicability Document
| sad
|-
| TTM
| Test Traceability Matrix
| ttm
|-
| NCS
| Naming and Coding Standard
| ncs
|-
| DEP
| Deployment Guide
| dep
|-
| GLO
| Glossary
| glo
|}

-----


== 3. Mandatory Version History Table ==

Every document '''must''' carry a version history table immediately after the header block.

<pre class="markdown">## Version History

| Version | Date | Author | Status | Change Summary |
|---------|------------|--------------|----------|-----------------------------------|
| 0.1 | YYYY-MM-DD | <name> | Draft | Initial draft |
| 0.2 | YYYY-MM-DD | <name> | Review | Incorporated review comments |
| 1.0 | YYYY-MM-DD | <name> | Approved | Approved by <approver> |
| 1.1 | YYYY-MM-DD | <name> | Approved | <brief description of change> |</pre>
'''Versioning rules:'''

* <code>0.x</code> — draft iterations before first approval.
* <code>1.0</code> — first approved baseline.
* <code>1.x</code> — minor corrections or additions that do not change approved scope.
* <code>x.0</code> (x > 1) — major revision requiring re-approval.
* A superseded document retains its history; the new document references it in the header.

-----


== 4. Mandatory Sections (all document types) ==

After the header and version history, every document must contain these sections in order:


=== 4.1 Table of Contents ===

For documents longer than three sections, include a Markdown ToC:

<pre class="markdown">## Table of Contents

1. [Purpose and Scope](#1-purpose-and-scope)
2. [Assumptions and Dependencies](#2-assumptions-and-dependencies)
3. [<content sections>](#...)
N. [Open Issues](#n-open-issues)</pre>

=== 4.2 Purpose and Scope ===

<pre class="markdown">## 1. Purpose and Scope

### 1.1 Purpose
<One paragraph: what this document is and why it exists.>

### 1.2 Scope
<What system version, components, and time period this document covers.>

### 1.3 Out of Scope
<Explicit list of what this document does NOT cover, to prevent misuse.>

### 1.4 Audience
<Who should read this document and what prior knowledge is assumed.>

### 1.5 Related Documents

| Document ID | Title | Relationship |
|-----------------|------------------------------|----------------------|
| PGCBL-BRD-001 | Business Requirements | Parent requirements |
| PGCBL-ADD-001 | Architecture Decisions | Design rationale |</pre>

=== 4.3 Assumptions and Dependencies ===

See document <code>PGCBL-SAD-001</code> for the full template. Minimum required inline:

<pre class="markdown">## 2. Assumptions and Dependencies

### Assumptions
| ID | Assumption | Risk if wrong |
|-------|------------------------------------------------------|------------------------|
| A-01 | <statement believed to be true, unverified> | <consequence> |

### Dependencies
| ID | Dependency | Owner |
|-------|------------------------------------------------------|------------------------|
| D-01 | <something that must be in place before this works> | <who provides it> |

### Constraints
| ID | Constraint | Source |
|-------|------------------------------------------------------|------------------------|
| C-01 | <limit on the design space> | <requirement / policy> |</pre>

=== 4.4 Open Issues ===

Every document must carry an open-issues section at the end, even if empty:

<pre class="markdown">## N. Open Issues

| ID | Issue | Owner | Target date | Status |
|--------|--------------------------------------|----------|-------------|--------|
| OI-01 | <description> | <name> | YYYY-MM-DD | Open |</pre>

-----


== 5. Section Numbering Convention ==

* Top-level sections: <code>## 1.</code>, <code>## 2.</code>, etc.
* Subsections: <code>### 1.1</code>, <code>### 1.2</code>, <code>#### 1.1.1</code> (max three levels).
* Appendices: <code>## Appendix A —</code>, <code>## Appendix B —</code>.
* Do not use letters for main sections; numbers only.

-----


== 6. Table Formatting Convention ==

All tables use GFM (GitHub Flavoured Markdown) pipe syntax. Column alignment:

* Left-align text columns.
* Right-align numeric columns.
* Use a header separator row with at least three dashes.

IDs in tables follow the pattern <code><TYPE>-<NN></code> where TYPE is a two-to-four letter mnemonic and NN is a zero-padded sequence (e.g. <code>FR-01</code>, <code>BR-ALGO-03</code>, <code>A-01</code>).

-----


== 7. Code and Pseudocode Blocks ==

* COBOL source extracts: use fenced code blocks with language hint <code>cobol</code>.
* SQL: <code>sql</code>.
* Pseudocode (language-neutral): no language hint, or <code>text</code>.
* Shell commands: <code>bash</code>.
* Mermaid diagrams: <code>mermaid</code>.

-----


== 8. Cross-Reference Convention ==

When one document references content in another, use:

<pre>[<title>](<Document ID>) §<section></pre>
Example: <code>[Technical Specification](PGCBL-TSD-001) §3.2</code> means section 3.2 of the TSD.

-----


== 9. Review and Approval Process ==

<pre>Author creates draft (v0.1)
│
▼
Peer review — reviewer comments added as inline notes or GitHub/Jira issues
│
▼
Author resolves comments, increments to v0.2 … v0.n
│
▼
Owner sign-off → status changes to "Approved", version becomes 1.0
│
▼
Document baselined in version control (git tag or DMS record)
│
▼
Any change raises a new draft (v1.1-draft), repeat cycle</pre>

-----


== 10. File Naming Convention ==

<pre><proj>-<type>-<nnn>-<short-title>.md

Examples:
pgcbl-brd-001-business-requirements.md
pgcbl-tsd-001-technical-specification.md
pgcbl-add-001-method-dispatch-pattern.md
pgcbl-ncs-001-cobol-naming-standard.md</pre>
All lowercase, hyphens as separators, no spaces, <code>.md</code> extension.
<hr/>
Terug naar: [[Design standards]] | [[Cobol and PostgreSQL]]

Scope and applicability

2026-03-25T15:20:36Z

Martin:

= Scope and Applicability Document =

{|
!width="23%"| Field
!width="76%"| Value
|-
| Document ID
| PGCBL-SAD-001
|-
| Document Type
| Scope and Applicability Document
|-
| System
| pgcobol — Prime Numbers Application v1.0
|-
| Version
| 1.0
|-
| Status
| Approved
|-
| Owner
| Lead Developer
|-
| Author
| [reverse-engineered from source artifacts]
|-
| Created
| 2026-03-17
|-
| Last modified
| 2026-03-17
|-
| Classification
| Internal
|}


== Version History ==

{|
!width="13%"| Version
!width="18%"| Date
!width="13%"| Author
!width="15%"| Status
!width="38%"| Change Summary
|-
| 0.1
| 2026-03-17
| —
| Draft
| Initial reverse-eng draft
|-
| 1.0
| 2026-03-17
| —
| Approved
| Baselined
|}

-----


== Table of Contents ==

# [[#1-purpose|Purpose]]
# [[#2-system-scope|System Scope]]
# [[#3-document-set-scope|Document Set Scope]]
# [[#4-audience|Audience]]
# [[#5-related-documents|Related Documents]]
# [[#6-open-issues|Open Issues]]

-----


== 1. Purpose ==

This document defines what is and is not covered by the pgcobol specification set. It exists to prevent readers from applying any single document outside its intended context, and to provide a navigational entry point to the full document set.

-----


== 2. System Scope ==


=== 2.1 What the system is ===

pgcobol is a three-tier batch COBOL application that:

* Generates prime numbers by trial division and stores them in a PostgreSQL database.
* Reads stored primes from the database and produces a formatted line-printer report.

It runs as a command-line batch job on Linux. There is no interactive interface.


=== 2.2 System boundary ===

'''Inside scope:'''

* The four COBOL programs: <code>primesmain</code>, <code>primesgen</code>, <code>primes</code>, <code>primesui</code>.
* The five copybooks that define the inter-tier interfaces.
* The PostgreSQL schema <code>primes</code> and its objects.
* The output file <code>primes.prt</code>.
* The console log output.

'''Outside scope:'''

* The GnuCOBOL compiler and GixSQL pre-processor (third-party tools, not modified).
* The PostgreSQL server installation and administration.
* The operating system, file system, and network infrastructure.
* Any job scheduler or wrapper scripts.
* Any downstream processing of <code>primes.prt</code>.


=== 2.3 System version covered ===

This document set describes pgcobol as found in source artifacts dated November–December 2025, compiled under GnuCOBOL 4.0-early-dev.


=== 2.4 What is explicitly not covered ===

{|
!width="50%"| Excluded topic
!width="50%"| Reason
|-
| Prime numbers beyond 999,999,999
| Hard-coded upper bound in the source
|-
| Even primes (2)
| The algorithm tests odd candidates only; prime 2 is a known seeding gap
|-
| Interactive or web interfaces
| Not implemented
|-
| Concurrent execution
| Single-process batch design; no concurrency controls present
|-
| Encryption or secure credential storage
| Not implemented in this version
|-
| High-availability or disaster recovery
| Not in scope for this version
|}

-----


== 3. Document Set Scope ==


=== 3.1 Documents in this set ===

{|
!width="26%"| Document ID
!width="9%"| Type
!width="50%"| Title
!width="12%"| Covers
|-
| PGCBL-SAD-001
| SAD
| Scope and Applicability
| Navigation and scope
|-
| PGCBL-BRD-001
| BRD
| Business Requirements
| What the system must do
|-
| PGCBL-NFR-001
| NFR
| Non-Functional Requirements
| Quality attributes
|-
| PGCBL-TSD-001
| TSD
| Technical Specification
| Architecture and pseudocode
|-
| PGCBL-DDD-001
| DDD
| Data Dictionary
| All fields and structures
|-
| PGCBL-FLD-001
| FLD
| Flow Diagrams
| Mermaid process diagrams
|-
| PGCBL-PLG-001
| PLG
| Program Logic Guide
| Step-by-step paragraph logic
|-
| PGCBL-BRG-001
| BRG
| Business Rules Guide
| Rules, calculations, validations
|-
| PGCBL-IOB-001
| IOB
| I/O Behaviour
| File, console, DB I/O
|-
| PGCBL-CFD-001
| CFD
| Control Flow Document
| PERFORM/CALL trees
|-
| PGCBL-ADD-001
| ADD
| Architecture Decision Records
| Design decisions and rationale
|-
| PGCBL-TTM-001
| TTM
| Test Traceability Matrix
| Requirements → design → tests
|-
| PGCBL-NCS-001
| NCS
| Naming and Coding Standard
| COBOL conventions
|-
| STD-DOC-001
| STD
| Document Engineering Standard
| This document set’s scaffolding
|}


=== 3.2 How to use this set ===

{|
! I want to…
! Start with…
|-
| Understand what the system must do
| PGCBL-BRD-001
|-
| Understand the overall architecture
| PGCBL-TSD-001 §1–2
|-
| Look up a specific data field
| PGCBL-DDD-001
|-
| Understand how a program works step-by-step
| PGCBL-PLG-001
|-
| Understand why a design decision was made
| PGCBL-ADD-001
|-
| Check what tests cover a requirement
| PGCBL-TTM-001
|-
| Write new COBOL code to the same standards
| PGCBL-NCS-001
|}

-----


== 4. Audience ==

{|
!width="33%"| Audience
!width="33%"| Assumed knowledge
!width="33%"| Documents most relevant
|-
| COBOL developer
| COBOL syntax, batch processing
| TSD, PLG, CFD, NCS
|-
| Database developer
| SQL, PostgreSQL
| TSD §5, DDD §12, IOB §3
|-
| Business analyst
| None technical required
| BRD, BRG
|-
| QA engineer
| Testing concepts
| TTM, BRD, BRG
|-
| Architect / reviewer
| Systems design
| TSD, ADD, NFR
|-
| New team member
| None
| SAD (start here), then BRD
|}

-----


== 5. Related Documents ==

{|
!width="27%"| Document ID
!width="49%"| Title
!width="22%"| Relationship
|-
| STD-DOC-001
| Document Engineering Standard
| Governs the format of all documents in this set
|}

-----


== 6. Open Issues ==

{|
!width="8%"| ID
!width="60%"| Issue
!width="8%"| Owner
!width="13%"| Target
!width="9%"| Status
|-
| OI-01
| System version identifier not present in source; version inferred from compiler listing date
| Lead Dev
| —
| Open
|}
<hr/>
Terug naar: [[Design standards]]

Design standards

2026-03-25T15:11:19Z

Martin:

= Index of Document Engineering and System Requirements =

# [[Document Engineering]]
# [[Scope and applicability]]
# Assumptions and Dependencies ==
# Non-Functional Requirements ==
# Test Traceability Matrix ==
# Naming and Coding Standards ==
# Business Requirement Document (BRD) ==
== Cross-Document References ==
; Document ID | Title | Relationship
|---|---|---
| PGCBL-SAD-001 | Scope and Applicability | Navigation Guide
| PGCBL-NFR-001 | Non-Functional Requirements | Quality Attributes Complement
| PGCBL-TSD-001 | Technical Specification | Implementation Details
| PGCBL-TTM-001 | Test Traceability Matrix | Test Case Mapping
| PGCBL-ADD-001 | Architecture Decision Records | Design Documentation

This index provides a structured overview of the document set, facilitating easy navigation and understanding of the interrelated components.
<hr/>
Terug naar: [[Cobol and PostgreSQL]]

Design standards

2026-03-25T15:09:46Z

Martin:

= Index of Document Engineering and System Requirements =

# [[Document Engineering]]
# [[Scope and Applicability]]
# Assumptions and Dependencies ==
# Non-Functional Requirements ==
# Test Traceability Matrix ==
# Naming and Coding Standards ==
# Business Requirement Document (BRD) ==
== Cross-Document References ==
; Document ID | Title | Relationship
|---|---|---
| PGCBL-SAD-001 | Scope and Applicability | Navigation Guide
| PGCBL-NFR-001 | Non-Functional Requirements | Quality Attributes Complement
| PGCBL-TSD-001 | Technical Specification | Implementation Details
| PGCBL-TTM-001 | Test Traceability Matrix | Test Case Mapping
| PGCBL-ADD-001 | Architecture Decision Records | Design Documentation

This index provides a structured overview of the document set, facilitating easy navigation and understanding of the interrelated components.
<hr/>
Terug naar: [[Cobol and PostgreSQL]]

Scope and applicability

2026-03-25T15:00:33Z

Martin: Created page with " = Scope and Applicability Document = {| !width="23%"| Field !width="76%"| Value |- | Document ID | PGCBL-SAD-001 |- | Document Type | Scope and Applicability Document |- | System | pgcobol — Prime Numbers Application v1.0 |- | Version | 1.0 |- | Status | Approved |- | Owner | Lead Developer |- | Author | [reverse-engineered from source artifacts] |- | Created | 2026-03-17 |- | Last modified | 2026-03-17 |- | Classifi..."

Design standards

2026-03-25T14:59:25Z

Martin: /* 2. Scope and Applicability */

= Index of Document Engineering and System Requirements =

== 1. Document Engineering ==
- [[Document Versioning|Versioning Rules]]
- Major version increments (e.g., 1.0)
- Minor version updates (e.g., 1.1, 1.2)
- [[Mandatory Sections in Documents|Mandatory Sections]]
- Scope and Applicability
- Audience Identification
- Related Documents Reference
- [[Document Format Standards|Format Standards]]
- Mediawiki Syntax Usage
- Template Application

== 2. Scope and Applicability ==
[[Scope and applicability]]
- [[System Version Identifier|System Version Identifier]]
- pgcobol — Prime Numbers Application v1.0
- [[Document Hierarchy|Document Hierarchy]]
- Navigation Links Between Documents
- [[Component Coverage|Component Coverage]]
- Covered Components: dal-methods, ui-methods, methods

== 3. Assumptions and Dependencies ==
- [[Assumption Register|Assumption Register (PGCBL-SAD-002)]]
- Key Items and Their Types
- [[Dependency Management|Dependency Handling]]
- External Systems and Interfaces
- [[Constraint Handling|Constraints Overview]]

== 4. Non-Functional Requirements ==
- [[Quality Attributes|Using ISO/IEC 25010 Taxonomy]]
- Categories: Auditability, Compliance, Operability
- [[Requirement Taxonomy|Taxonomy Details]]
- Hierarchical breakdown of requirements

== 5. Architecture Decision Records ==
- [[Design Decisions|Architecture Decisions (ADR-005)]]
- Option C Implementation Details
- [[Consequences of Choices|Positive and Negative Outcomes]]
- Impact Analysis of Design Choices
- [[Known Issues|Current Issues]]
- Duplicate copybooks, Versioning Conflicts

== 6. Test Traceability Matrix ==
- [[Test Planning|Matrix Structure]]
- PGCBL-TTM-001 Template
- [[Requirements Mapping|Mapping Requirements to Tests]]
- BRD and NFR Integration
- [[Status Tracking|Test Case Status]]
- Draft, In Progress, Completed

== 7. Naming and Coding Standards ==
- [[Source File Conventions|File Naming Rules]]
- Verb Usage in Copybooks
- [[Division Structure|Code Division Hierarchy]]
- Module Organization
- [[Compliance with Standards|Standards Adherence]]
- Coding Best Practices

== 8. Business Requirement Document (BRD) ==
- [[Audience and Distribution|Intended Readers]]
- Business Analysts, QA Engineers
- [[Related Documents Linkage|Document Relationships]]
- SAD, NFR, TSD, TTM, ADD
- [[Assumptions and Dependencies Overview|Key Dependencies]]
- System Integration Points

== Cross-Document References ==
; Document ID | Title | Relationship
|---|---|---
| PGCBL-SAD-001 | Scope and Applicability | Navigation Guide
| PGCBL-NFR-001 | Non-Functional Requirements | Quality Attributes Complement
| PGCBL-TSD-001 | Technical Specification | Implementation Details
| PGCBL-TTM-001 | Test Traceability Matrix | Test Case Mapping
| PGCBL-ADD-001 | Architecture Decision Records | Design Documentation

This index provides a structured overview of the document set, facilitating easy navigation and understanding of the interrelated components.
<hr/>
Terug naar: [[Cobol and PostgreSQL]]

Design standards

2026-03-25T14:57:49Z

Martin:

= Index of Document Engineering and System Requirements =

== 1. Document Engineering ==
- [[Document Versioning|Versioning Rules]]
- Major version increments (e.g., 1.0)
- Minor version updates (e.g., 1.1, 1.2)
- [[Mandatory Sections in Documents|Mandatory Sections]]
- Scope and Applicability
- Audience Identification
- Related Documents Reference
- [[Document Format Standards|Format Standards]]
- Mediawiki Syntax Usage
- Template Application

== 2. Scope and Applicability ==
- [[System Version Identifier|System Version Identifier]]
- pgcobol — Prime Numbers Application v1.0
- [[Document Hierarchy|Document Hierarchy]]
- Navigation Links Between Documents
- [[Component Coverage|Component Coverage]]
- Covered Components: dal-methods, ui-methods, methods

== 3. Assumptions and Dependencies ==
- [[Assumption Register|Assumption Register (PGCBL-SAD-002)]]
- Key Items and Their Types
- [[Dependency Management|Dependency Handling]]
- External Systems and Interfaces
- [[Constraint Handling|Constraints Overview]]

== 4. Non-Functional Requirements ==
- [[Quality Attributes|Using ISO/IEC 25010 Taxonomy]]
- Categories: Auditability, Compliance, Operability
- [[Requirement Taxonomy|Taxonomy Details]]
- Hierarchical breakdown of requirements

== 5. Architecture Decision Records ==
- [[Design Decisions|Architecture Decisions (ADR-005)]]
- Option C Implementation Details
- [[Consequences of Choices|Positive and Negative Outcomes]]
- Impact Analysis of Design Choices
- [[Known Issues|Current Issues]]
- Duplicate copybooks, Versioning Conflicts

== 6. Test Traceability Matrix ==
- [[Test Planning|Matrix Structure]]
- PGCBL-TTM-001 Template
- [[Requirements Mapping|Mapping Requirements to Tests]]
- BRD and NFR Integration
- [[Status Tracking|Test Case Status]]
- Draft, In Progress, Completed

== 7. Naming and Coding Standards ==
- [[Source File Conventions|File Naming Rules]]
- Verb Usage in Copybooks
- [[Division Structure|Code Division Hierarchy]]
- Module Organization
- [[Compliance with Standards|Standards Adherence]]
- Coding Best Practices

== 8. Business Requirement Document (BRD) ==
- [[Audience and Distribution|Intended Readers]]
- Business Analysts, QA Engineers
- [[Related Documents Linkage|Document Relationships]]
- SAD, NFR, TSD, TTM, ADD
- [[Assumptions and Dependencies Overview|Key Dependencies]]
- System Integration Points

== Cross-Document References ==
; Document ID | Title | Relationship
|---|---|---
| PGCBL-SAD-001 | Scope and Applicability | Navigation Guide
| PGCBL-NFR-001 | Non-Functional Requirements | Quality Attributes Complement
| PGCBL-TSD-001 | Technical Specification | Implementation Details
| PGCBL-TTM-001 | Test Traceability Matrix | Test Case Mapping
| PGCBL-ADD-001 | Architecture Decision Records | Design Documentation

This index provides a structured overview of the document set, facilitating easy navigation and understanding of the interrelated components.
<hr/>
Terug naar: [[Cobol and PostgreSQL]]

Design standards

2026-03-25T14:55:38Z

Martin:

```mediawiki
= Index of Document Engineering and System Requirements =

== 1. Document Engineering ==
- [[Document Versioning|Versioning Rules]]
- Major version increments (e.g., 1.0)
- Minor version updates (e.g., 1.1, 1.2)
- [[Mandatory Sections in Documents|Mandatory Sections]]
- Scope and Applicability
- Audience Identification
- Related Documents Reference
- [[Document Format Standards|Format Standards]]
- Mediawiki Syntax Usage
- Template Application

== 2. Scope and Applicability ==
- [[System Version Identifier|System Version Identifier]]
- pgcobol — Prime Numbers Application v1.0
- [[Document Hierarchy|Document Hierarchy]]
- Navigation Links Between Documents
- [[Component Coverage|Component Coverage]]
- Covered Components: dal-methods, ui-methods, methods

== 3. Assumptions and Dependencies ==
- [[Assumption Register|Assumption Register (PGCBL-SAD-002)]]
- Key Items and Their Types
- [[Dependency Management|Dependency Handling]]
- External Systems and Interfaces
- [[Constraint Handling|Constraints Overview]]

== 4. Non-Functional Requirements ==
- [[Quality Attributes|Using ISO/IEC 25010 Taxonomy]]
- Categories: Auditability, Compliance, Operability
- [[Requirement Taxonomy|Taxonomy Details]]
- Hierarchical breakdown of requirements

== 5. Architecture Decision Records ==
- [[Design Decisions|Architecture Decisions (ADR-005)]]
- Option C Implementation Details
- [[Consequences of Choices|Positive and Negative Outcomes]]
- Impact Analysis of Design Choices
- [[Known Issues|Current Issues]]
- Duplicate copybooks, Versioning Conflicts

== 6. Test Traceability Matrix ==
- [[Test Planning|Matrix Structure]]
- PGCBL-TTM-001 Template
- [[Requirements Mapping|Mapping Requirements to Tests]]
- BRD and NFR Integration
- [[Status Tracking|Test Case Status]]
- Draft, In Progress, Completed

== 7. Naming and Coding Standards ==
- [[Source File Conventions|File Naming Rules]]
- Verb Usage in Copybooks
- [[Division Structure|Code Division Hierarchy]]
- Module Organization
- [[Compliance with Standards|Standards Adherence]]
- Coding Best Practices

== 8. Business Requirement Document (BRD) ==
- [[Audience and Distribution|Intended Readers]]
- Business Analysts, QA Engineers
- [[Related Documents Linkage|Document Relationships]]
- SAD, NFR, TSD, TTM, ADD
- [[Assumptions and Dependencies Overview|Key Dependencies]]
- System Integration Points

== Cross-Document References ==
; Document ID | Title | Relationship
|---|---|---
| PGCBL-SAD-001 | Scope and Applicability | Navigation Guide
| PGCBL-NFR-001 | Non-Functional Requirements | Quality Attributes Complement
| PGCBL-TSD-001 | Technical Specification | Implementation Details
| PGCBL-TTM-001 | Test Traceability Matrix | Test Case Mapping
| PGCBL-ADD-001 | Architecture Decision Records | Design Documentation

This index provides a structured overview of the document set, facilitating easy navigation and understanding of the interrelated components.
```
<hr/>
Terug naar: [[Cobol and PostgreSQL]]

Design standards

2026-03-25T13:55:38Z

Martin:

# Document Index

## Architecture Decision Records (ADR)
### File: `04_architecture_decision_records.mediawiki`
- **Purpose**: Captures significant design decisions and their consequences.
- **Format**: Follows the MADR format, a lightweight standard for documenting architectural decisions.
- **Contents**:
- ADR template
- Specific decisions (e.g., Three-Tier Architecture)

## Test Traceability Matrix (TTM)
### File: `05_test_traceability_matrix.mediawiki`
- **Purpose**: Tracks the relationship between requirements and test cases.
- **Contents**:
- TC-NFT-002 — Performance: divider lookup query plan
- TC-NFT-003 — Reliability: graceful DB failure mid-run

## Non-Functional Requirements (NFR)
### File: `03_non_functional_requirements.mediawiki`
- **Purpose**: Specifies quality attributes of the system.
- **Taxonomy**: Uses ISO/IEC 25010:2011 (SQuaRE) model.
- **Contents**:
- Categories: Performance, Reliability, Security, etc.

## Business Requirements Document (BRD)
### File: `07_brd_pgcbl-brd-001.mediawiki`
- **Purpose**: Defines business requirements and scope.
- **Audience**: Business analysts, QA engineers, stakeholders.
- **Contents**:
- Assumptions and dependencies
- Out of Scope items
- Open issues (e.g., FR-01: generate loop commented out)

## Naming Coding Standard
### File: `06_naming_coding_standard.mediawiki`
- **Purpose**: Standards for source file conventions.
- **Status**:
- Version: 1.0
- Approved and baselined.

## Scope and Applicability (SAD)
### File: `02_scope_and_applicability.mediawiki`
- **Purpose**: Defines the document set and its navigation.
- **Related Documents**:
- Links to other documents in the set.

## Technical Specification Document (TSD)
### File: `01_technical_specification.mediawiki`
- **Purpose**: Implements system requirements.
- **Assumptions**: See PGCBL-SAD-002 for full register.

## Assumptions and Dependencies Register
### File: `08_assumptions_and_dependencies_register.mediawiki`
- **Contents**:
- Key assumptions and dependencies (e.g., A-01, C-01)

## Test Case Catalogue
### File: `05_test_traceability_matrix.mediawiki`
- **Purpose**: Catalogues test cases linked to requirements.
- **Status**: Includes planned tests requiring fixes.

## Out of Scope Items
### File: `07_brd_pgcbl-brd-001.mediawiki`
- **Contents**:
- Exclusions from the system's functionality.

## Open Issues and Defects
### File: `09_open_issues_and_defects.mediawiki`
- **Contents**:
- Known issues (e.g., OI-01, D-01)
- Targets and owners

## Cross-References
- **Related Documents**: Each document references others in the set, such as SAD, NFR, TSD, ADR, and TTM.

## Revision History
- **Version Control**: Not explicitly detailed in provided context.
<hr/>
Terug naar: [[Cobol and PostgreSQL]]

COBOL Std 1 Purpose and Scope

2026-03-25T13:48:30Z

Martin: