Az OmegaCAD ELEKTRO tervezőrendszer felhasználói kézikönyve

Dokumentáció változatok kezelése

'Létesítmények kezelése' modul

Elérés:

Menü:

E L E K T R O Létesítmények kezelése...

Nyomógomb:


A funkció segítségével a létesítmény dokumentációinak 'történetét' , a kiadott dokumentumok változásának részleteit adminisztrálhatjuk.

A 'Dokumentáció adatok:'-ban a létesítmény terv dokumentációinak egy-egy befejezett, 'kidokumentált, kinyomtatott' állapotát rögzítjük. A dokumentációs lista a létesítmény tervdokumentumainak csak a legfontosabb, fejléc-szerű adatait tartalmazza. A tényleges teljes dokumentum állapotot, a dokumentum változat teljes archivált digitális anyaga fogja tartalmazni. Ez a dokumentációs lista csak 'leltár' szerűen sorolja fel a dokumentumokat, azok főbb jellemzőit. Egy dokumentum változathoz egy rövid, néhány karakteres (72), és egy részletes leírást lehet hozzáfűzni (4096). Ezek a leírások a dokumentum változat kiadásának főbb körülményeit tartalmazhatják. Ezen leírások alapján egyszerűen lehet a létesítmény dokumentációjának 'életét' követni.

Az egyes dokumentum változatokat a rendszer 'D001' -től 'D999'' -ig tudja követni. Ezek a dokumentumok listájában így is lesznek jelölve! Sőt a rendszer egy új dokumentum változat bejegyzésekor az egész létesítmény könyvtár és létesítménynév elnevezését ezzel a dokumentum változatjellel látja el '-D001'. Így tárolva a számítógépes állományokat az egyes változathoz tartozó digitális tervanyag egyszerűen és egyértelműen visszakereshető.

Ebből következik, hogy egy későbbi dokumentum változat tartalmazza az őt megelőző összes dokumentum változat listáját.

Egy dokumentum változat lista tartalmazza a dokumentum változat bejegyzésekor a létesítmény valamennyi tervlapjának az alábbi adatait:

Szereléshely alfanumerikus jele

Szereléshely megnevezése

Dokumentáció tervszáma

A dokumentum típusa:

Ami lehet az OmegaCAD ELEKTRO terv modul szerinti elnevezés, vagy csatolt dokumentum esetén a dokumentum elnevezés szerint szabadon megadható.

Tervkód

Dokumentum kiadásának dátuma

Tervtípus

Tervfajta

Tervelnevezés

Változás jele

Változás kiadásának dátuma

Változás kiadás leírása

Terv lapok száma

Kiadás jele:

Változatlan

A dokumentum nem változott, azonos az előző változatban kiadottal.

Új, kiadva

A dokumentum változott az előző kiadáshoz képest, vagy új.

A fenti adatokat a rendszer gyűjti ki a létesítmény tervállományából. Jól látható, hogy az egyes dokumentum adatai megegyeznek az egyes tervlapok pecsét adataival.

Az egyes dokumentum változathoz, a változat bejegyzése során meg lehet adni a következő adatokat:

A dokumentum változat rövid elnevezése. Ez e dokumentum listák cím sorában jelenik meg. Maximum 72 karakteres lehet.

A dokumentum változat kiadásának időpontját.

A dokumentum változat kiadásának részletes körülményeit leíró szöveges adatmezőt. (maximum 4096 karakter)

---> A kijelölt dokumentáció verzió módosítása. Csak akkor érvényes, ha a dokumentáció változat létrehozója azonos a bejelentkezett tervezővel! --->

'Új kiadás megjelenítve'

A kapcsoló bekapcsolt állapotában a 'Létesítmény dokumentációi' ablak bal oldalán lévő fül kijelölt állapotához tartozó dokumentum lista azon dokumentumai jelennek meg, amelyek ebben a kiadásban újak, vagy változtak az előző kiadáshoz képest!

'Változatlan kiadás megjelenítve'

A kapcsoló bekapcsolt állapotában állapotában a 'Létesítmény dokumentációi' ablak bal oldalán lévő fül kijelölt állapotához tartozó dokumentum lista azon dokumentumai jelennek meg, amelyek ebben a kiadásban nem változtak az előző kiadáshoz képest!

A kijelölt dokumentáció verzió módosítása. Csak akkor érvényes, ha a dokumentáció változat létrehozója azonos a bejelentkezett tervezővel! --->

A létesítmény kiválasztott dokumentáció változat listáján dokumentáció típusok szerint a kijelöléssel csak a kijelölt dokumentáció típusra is szűkíthetjük a listát.

Új dokumentáció változat létrehozása

Az gombbal elindíthatjuk a létesítmény új dokumentáció változat bejegyzésének megkezdését.

Az új dokumentáció változat jele automatikusan a rendszer által nyilvántartott változatot követő lesz. Ez egyébként független a létesítmény névben található változattól!

Ezután meg kell adnunk a létesítmény változat kiadási időpontját. Bár ezt a rendszer automatikusan kitölti a mai nap dátummal. De itt van változtatási lehetőség.

Továbbá meg kell adni a dokumentáció változat rövid és részletes leírását. Ezeknek az adatmezőknek a kitöltése kötelező.

--->

Mielőtt elindítanánk az új dokumentáció változat létrehozása funkciót ebben az ablakban is, még a lista készítés folyamatra vonatkozó beállítást tehetünk meg.

'Lista készítés beállítások:'

A lista előállítási folyamathoz tartozó ablakban olyan paramétereket állíthatunk be, amelyek a folyamat nyomon követhetőségét befolyásolják. A rendszer üzeneteit és jelzéseit célszerű hibanaplóba íratni, amelynek segítségével a folyamat során esetlegesen bekövetkező hibák azonosítása és javítása egyszerűsödik.

'Lista készítés közben üzenetek'

A kapcsoló állításával beállítható, hogy a lista készítése közben a rendszer az éppen végrehajtott műveletről adjon-e tájékoztatást.

'Lista készítés közben hibajelzések'

A kapcsoló állításával beállítható, hogy a lista készítése közben a rendszer az észlelt hibáról adjon-e jelzést képernyőre.

'Hibanapló írása'

A kapcsoló állításával beállítható, hogy a lista készítés közben a rendszer az elvégzett művelet közben észlelt hibákról készítsen-e hibanaplót.

'Új hibanapló kezdése'

A kapcsoló állításával beállítható, hogy a lista készítés közben a rendszer a korábbi hibanaplót folytassa, vagy mindig újat kezdjen. A beállítás akkor érvényes, ha van hibanapló írás.

'Hibanapló fájl neve:'

Ablakrészben beállítható, hogy lista készítés közben a rendszer az elvégzett műveletről, észlelt hibákról készített hibanaplót milyen nevű állományba írja. A napló fájl nevét kiterjesztés nélkül kell megadni. A rendszer a naplófájlt az eltéréseket tartalmazó létesítmény alkönyvtárban hozza létre TXT kiterjesztéssel. A beállítási lehetőség akkor érvényes, ha van hibanapló írás.

'Naplózás hiba összegzés'

Ha a 'Hibanapló írása' bekapcsolt állapotú, akkor ebben a checkbox ablakban beállíthatjuk, hogy a hiba napló végére a rendszer készítsen e listát az előfordult hibák összegzésével. Ha a 'Hiba összegzés' bekapcsolt állapotú, akkor a Naplózás hiba összegzési mód beállítása-ban beállíthatjuk a hiba összegzés egyéb paramétereit is!

A gomb érvényes lesz, ha már van olyan nevű hibalista, amely be van állítva, és a hibanapló írása opció be van kapcsolva. Megnyomásával megtekinthetjük az elkészült hiba naplót.

Új dokumentáció változat létrehozása folyamat indítása

Ha minden adatot megadtunk, és elvégeztük a beállításokat, akkor a panelon ismét megtalálható gombbal elindíthatjuk a létesítmény új dokumentáció változat elemeinek kigyűjtés folyamatát.

Ha mégsem töltöttük ki a szükséges adatokat, akkor a következő hiba jelzés miatt, nem tudjuk végrehajtani a dokumentáció lista kigyűjtését!

Ha minden adat kitöltött, akkor elindul a dokumentáció lista kigyűjtése.


A gomb megnyomásával megszakíthatjuk a kigyűjtési folyamatot.

Az új dokumentum lista tartalmazza a létesítmény pillanatnyi tervdokumentumainak listáját a tervlapok pecsét adatai alapján.

A listában szerepel minden olyan tervlap, amelynek pecsét adatában a tervszám adat meg van adva! A tervszám adat nem lehet '?' és üres karakter.

Szerepel a listában minden csatolt dokumentum is, amelynek a pecsét adatai hasonlóan helyesen vannak kitöltve!

Lásd:

Terv pecsét adatok megadása
Tervjegyzék készítése
Csatolt dokumentumok kezelése (Word, Excel ...)

A dokumentáció listában az egyes dokumentumok sorrendje, az elrendezési és szereléstervek szereléshelyenkénti kigyűjtése a készítésekor megadottakkal azonosan történik, vagy ha ezen lista készítése során mást beállítást szeretnénk, akkor is itt kell elvégezni a beállításokat. Ez a beállítási mód azt feltételezi, hogy a tervjegyzék elkészítése a dokumentáció kiadásának utolsó lépése. Elvégezzük a tervjegyzék generálást, ugyan ilyen beállítások mellett elvégezzük a nyomtatást, majd utolsó lépésként elvégezzük a létesítményben is az új dokumentáció változat bejegyzését is!

Lásd:

Tervjegyzék készítése
Tervjegyzék lapok generálása
Tervjegyzék generálás beállítás
Tervjegyzék lista tartalma
Tervtípusok sorrendje, be/ki kapcsolása
Tervek dokumentálása
Tervtípusok sorrendje

Ha a lista kigyűjtése elkészült, és az a dokumentáció változat a létesítménynek nem az első dokumentációja, akkor az elkészült dokumentáció lista összevetésre kerül az előző változat listájával, és összevetés alapján az egyes dokumentumok 'Új kiadva', vagy 'Változatlan' jellel lesznek ellátva.

Az 'Új kiadva', vagy 'Változatlan' dokumentum állapot a két lista alábbi bejegyzéseinek összehasonlítása alapján kerül megállapításra:

Tervszám

Dokumentum kiadásának dátuma

Változás jele

Változás kiadásának dátuma

Terv lapok száma

Ha egy dokumentum a fenti adatokban azonosan megtalálható, akkor a 'Változatlan' jelet fogja megkapni. Ha nem található az előző állapotban ilyen jellemzővel dokumentum, akkor a dokumentum az 'Új kiadva' jelet kapja. Értelem szerűen, a létesítmény első '-D001' változatú dokumentum listájának minden elme ezt az 'Új kiadva' jelet kapja, függetlenül a dokumentum tervlap törésétől.

Az új dokumentáció változat listájának kigyűjtésének elvégzése után az ablak információs része a következő állapotokat mutathatja:

Új dokumentum változat bejegyzésének végrehajtása

Ha az új dokumentum lista tartalmaz 'Új kiadva' tulajdonságú dokumentumot, akkor a rendszer jelzi, hogy 'A dokumentumokban változás van!'. Ha az új dokumentum lista nem tartalmaz, 'Új kiadva' tulajdonságú dokumentumot, csak 'Változatlan' jelűeket, akkor a rendszer azt jelzi, hogy 'A dokumentumokban NINCS változás!'. Tudnunk kell, hogy az új dokumentáció verzió ekkeor is bejegyezhető, amely azonban a dokumentumok listájában nem lesz eltéeő az előző változattól. Ennek ellenére, ha mégis véglegesítjük a bejegyzést, akkor ennek a visszavonására, törlésre nincs lehetőségünk!

--->

Az ablakban visszajelzésre kerül az új dokumentum változat minden adata.

A gomb megnyomásával ellenőrizhetjük az elkészült dokumentációs listát, és döntést hozhatunk a végleges bejegyzésről.

A gomb megnyomásávala dokumentum verziószám léptetésre kerül, és az új dokumentáció változat bejegyzésének megerősítése ezzel a gombbal megtörténik. Ekkor az új dokumentáció változat lista mentésre kerül egy új dokumentáció verzió jel alá.
Az dokumentum verziót kétféle képpen hozhatjuk létre, az alábbi kijelölésnek megfelelően:

Az új dokumentáció változat létrehozásának módja:

Az eredeti létesítmény átnevezésével.

Nem marad meg az eredeti dokumentum! Az eredeti létesítmény fájl és könyvtár átnevezésre kerül! A szükséges ellenőrzéseket gondosan végezzük el, mert a művelet nem vonható vissza!!!

Az eredeti létesítmény megtartásával! Másolat készítéssel.

Az eredeti dokumentum változatlan formában megmarad! A teljes létesítmény állomány az új dokumentum verziónak megfelelő állományba másolódik át! A művelet az újonnan létrejött létesítmény törlésével visszavonható!

Ha a listakészítés közben hiba lépet fel, vagy megszakítottuk a folyamatot, akkor a következő módon jelenik meg az ablak.

Ha elkészült a lista akkor megnézhetjük a hiba naplót, vagy ha mégsem akarjuk a dokumentációs listát elmenteni, akkor az gombbal kiléphetünk.

A gomb érvényes lesz, ha már van olyan nevű hibalista, amely be van állítva, és a hibanapló írása opció be van kapcsolva. Megnyomásával megtekinthetjük az elkészült hiba naplót.

Új dokumentum változat listájának ellenőrzése

Ez az ablak azt biztosítja, hogy döntést tudjunk hozni, hogy az elkészült dokumentációs listát bejegyezzük a létesítmény új dokumentációjaként. Ebben az ablakban soronként ellenőrizhetjük a létesítmény dokumentációs listáját véglegesítés előtt.

A kijelölt dokumentáció verzió módosítása

Csak akkor érvényes és hajtható végre a funkció, ha a dokumentáció változat létrehozója azonos a bejelentkezett tervezővel! Eltérő módon működik a dokumentáció verzió módosítása attól függően, hogy az utolsó dokumentáció verzió van kijelölve, vagy egy korábbi.

Ha nem az utolsó dokumentáció verzió van kijelölve, akkor csak a dokumentáció bejegyzés adatai módosíthatóak az alábbiak szerint.

Ha az utolsó dokumentáció verzió van kijelölve, akkor a dokumentáció verzió adatai módosíthatók, és a dokumentáció jegyzék is frissíthető az aktuális állapotnak megfelelően.

A gomb megnyomásával elindul a létesítmény dokumentáció változat elemeinek kigyűjtés folyamata. A lista kigyűjtése azonos az új dokumentáció változat készítése esetén végrehajtott művelettel. Ez azt is jelenti, hogy a dokumentumok változásaiak a figyelése is az előző változat dokumentumaival kerül összehasonlításra. Tehát ha az utolsó dokumentum változat, amit most frissítünk tartalmazott új dokumentumot, akkor az a jelen firssítésnél is új kiadású változatként fog szerepelni!

--->

A frissítési folyamat elindítása után megjelenő ablakban visszajelzésre kerül a módosított dokumentum változat minden adata. A gomb megnyomásával ellenőrizhetjük az elkészült dokumentációs listát, és döntést hozhatunk az megváltozott adatok mentéséről.

Természetesen jelentős eltérés, hogy a folyamat végén nem a dokumentáció változat léptetésére és új változat bejegyzése kerül sor! Hanem a jóváhagyás után a módosított adatokkal és a frissített listával az utolsó dokumentáció változat adatai íródnak felül.


Korlátozások/megjegyzések:

Ha egy új dokumentáció változatot a létesítménybe már bejegyeztünk, akkor azt már nem lehet a későbbiekben törölni.

A létesítmény nevében és az alkönyvtár nevében megjelenő dokumentáció verziószám eltérhet a létesítményben nyilvántartott verziók számától! /Ez nem szükséges, de a rendszeren belül nem lehet kizárni a fájlkezelővel végrehajtott fájlok és könyvtárak átnevezését!

Ha elvégeztük az új dokumentáció változat bejegyzését a létesítménybe, akkor a létesítmény adatokat mentését, tárolását is végezzük el a dokumentáció tárba. Ez a változat lesz az új tervezés kiindulási állapota.

A dialógus ablak átméretezhető. Az átméretezett értékeket a rendszer megőrzi!

Kapcsolat/E-mail Omega-Soft Kft.
1992-2022
Minden jog fenntartva. ©
OmegaSoft WEB Site