BookLab System
(c) 2023 RENware Software Systems

Arhitectura sistemului

Cuprins:

Introducere

Procesele sistemului

Procesele administrative permit crearea si organizarea unei carti iar procesele de realizare permit realizare / editarea unei carti.

NOTA: O descriere sumara a proceselelor sistemului se gaseste si in documentul 130.02-Overview.md, sectiunea "Structura si componenta BookLab".

Corelarea proceselor cu componentele sistemului

In continuare se prezinta o matrice privind utilizarea componentelor (modulelor) sistemului de catre procesele enumerate anterior:

Componentele si modulele sistemului

Diagrama urmatoare reda modulele / componentele sistemului. Acestea sunt folosite de catre procesele acestuia. (Diagrama putin mai elaborata dar cu descrierea componentelor se gaseste in documentul 130.02-Overview.md, sectiunea "Structura si componenta BookLab" ce se recomanda a fi citit inainte de a incepe studiul acestuia, pentru o mai buna intelegere a lui.)

graph TD
    bklab([BookLab])
    bklab_static([staticbl \n STATIC BookLab \n server])
    bklab_dynamic([dynbl \n DYNAMIC BookLab \n server])

    bklab ---- bklab_static
    bklab ---- bklab_dynamic
    bklab --- sysInit

    sysInit[[sysInit \n Initializare \n sistem]]

    bcat[[BCAT \n Catalogul \n cartilor]]
    bcat_db[(baza de date \n Catalog Carti \n books_catalog.json)]
    book_tmpl[[TMPL \n Sablon \n carte noua]]
    newb[[NEWB \n Carte noua]]
    edtm[[EDTM \n Creare Editare \n documente]]
    orgm[[ORGM \n Organizare \n documente]]
    prvm[[PRVB \n Previzualizare \n carte]]
    dplm[[DPLB \n Asamblare \n carte]]
    hlps[[HLPS \n Manuale \n aplicatie]]
    jinja_tmplts[[Sabloane UI \\n format Jinja]]

    bklab_static --- hlps
    bklab_static --- jinja_tmplts

    bklab_dynamic ---- book_tmpl
    bklab_dynamic ---- bcat
    bklab_dynamic ---- newb
    bklab_dynamic ---- edtm
    bklab_dynamic ---- orgm
    bklab_dynamic ---- prvm
    bklab_dynamic ---- dplm

    bcat --- bcat_db
    newb --- bcat_db

    cdstk[\CD carte \n electronica/]
    aprvfl[\flux aprobare \n carte electronica/]
    pdfbk[\Carte PDF \n tiparibila/]

    dplm --> cdstk
    dplm --> aprvfl
    dplm --> pdfbk

Referitor la locatia fizica a componentelor se face remarca ca toate componentele sistemului ce prezinta interfata vizuala cu utilizatorul au reprezentare atit in directorul docs/ pentru partea de front-end (client side) cit si in radacina intregului sistem pentru partea de back-end (server-side). (Directorul docs/ este generat prin compilarea aplicatiei in faza de development din directorul doc_src/.)

sysInit Initializare sistem

Pornirea sistemului comporta doua mari componente "on top", si anume:

• staticbl - STATIC BookLab serverul HTTP static acesta va deservi partea de web compusa din "fisiere" statice. Acestea reprezinta fisierele HTML aferente interfetei UI dar si celelate fisiere "auxiliare" precum: CSS-uri, JS-uri, imagini, etc

• dynblsrv - DYNAMIC BookLab serverul CGI dinamic ce permite rularea de scripturi Python server-side si deserveste componentele care executa operatiile necesare (de ex create carte noua). Acest server este cunoscut si sub numele de BookLab API

De asemenea referitor la initializarea sistemului trebuie spus si ca prima instalare a acestuia se face cu o serie de programe / scripturi. Nu se intra in detalii deoarece procedura de instalare a sistemului este una cit se poate de clasica pentru instalarile executate manual pe sisteme Linux iar pentru sisteme Windows acesta este tot una clasica, cu un simplu wizard "standardizat" si care executa scrierea in toate locatiile necesare (ex Registry).

BCAT catalogul cartilor

Acest modul este responsabil de catalogul (lista) cartilor si de sablonul de creare a unei carti. Astfel el contine urmatoarele elemente:

• catalogul cartilor ce este baza de date cu informatiile de baza despre carti. Acest catalog contine informatiile necesare pentru identificarea si referentierea unei carti in aplicatie. Datele detaliate aferente unei carti se gasesc in directorul aferent acesteia, director al carui nume se regaseste in acest catalog. Catalogul este stocat in format JSON si se gaseste in fisierul books_catalog.json.

• interfata UI "Catalog carti" ce este interfata CLIENT-UI¹ pentru managementul catalogului cartilor oferind operatii tip CRUD asupra bazei de date cu catalogul cartilor.

TMPL sablon carte noua

Aceasta componenta refera sablonul implicit de creare a unei carti noi (si singurul in versiunea 1 a aplicatiei). Fisierele asociate acestui sablon se afla in subdirectorul book_tmpl/.

NEWB creare carte noua

-#TODO...

EDTM preluare si editare continut

-#TODO...

ORGM organizare structura carte

-#TODO...

PRVB previzualizare si testare carte

-#TODO...

DPLB asamblare publicare carte

-#TODO...

HLPS help asistenta si manuale

Manuale aplicatiei sunt de doua feluri (categorii) majore:

• Manuale de utilizare, acestea prezinta informatii pentru utilizarea curenta a aplicatiei. Catalogul acestora se poate accesa de la <SERVER NAME>/help/880.30-EUMA_catalog.html.

• Manuale de configurare, acestea prezinta informatii pentru configurarea aplicatiei. Catalogul acestora se poate accesa de la <SERVER NAME>/help/880.30-ADMA_catalog.html.

Pentru ambele tipuri de manuale se va prezenta un catalog ce contine lista tuturor manualelor disponibile in acea categorie. Lista contine numele manualului, o scurta descriere (daca numele nu este suficient de elocvent) si linkul catre manualul respectiv.

Manualele sunt localizate in sectiunea statica a aplicatiei (vezi si sectiunea "Serverul HTTP static") in directorul docs/help/.

Organizarea aplicatiei software

Cod document metodologic: 810.05b Application Software Organization

In principiu aplicatia (sistemul) este organizata pe principiul directoarelor de fisiere. Aceasta permite o "rapida" regasire si recunoastere a informatiilor necesare chiar de la nivelul sistemului de operare (fara a necesita instrumente speciale ci doar comenzile existente in sistemul de operare). De asemena o astfel de organizare este foarte apropiata de standardele clasice / originale ale aplicatiilor web.

Directoarele principale ale aplicatiei sunt enumerate la fiecare componenta din arhitectura si nu necesita explicatii suplimentare fata de cele scrise deja (vezi sectiunea Arhitectura sistemului). Detalii privind structura interna a fiecarui director aferent unei componente se regasesc in documentul de descriere detaliata aferent acelei componente. In situatii in care s-au considerat necesare diferite detelii pur specifice si "locale", in directorul componentei respective se gaseste un fisier README_<cod-name componenta>.md ce prezinta aceste lucruri. Aceste documente se adreseaza in special dezvoltarilor aplicatiei (dar nu in mod obligatoriu) iar ca exemplu de ce poate contine un astfel de fisier este prezentarea modalitatii de pregatire a mediului local pentru dezvoltare.

Note