Dokumentacja
Katalogi i pliki
Do systemu dodano archiwum ogólnych plików/katalogów. Pozwala to na wykorzystanie systemu do przechowywana danych i załączników niepowiązanych z istniejącymi w systemie zasobami, typami lub innymi obiektami. Mamy możliwość dodania katalogów, plików oraz kolejnych wersji plików.
Pliki mogą być przeglądane, pobierane oraz dołączane do struktury zasobów i typów. Pozwala to na szybsze generowanie i wyświetlanie danych w formie archiwum plików.
System umożliwia również szybkie pobranie większej liczby plików w formie archiwum ZIP. Aby to zrobić, należy zaznaczyć pliki, które chcemy pobrać, a następnie wybrać opcję "Pobierz" z przycisków dostępnych w górnej części okna. System wygeneruje archiwum ZIP z wybranymi plikami, które następnie zostanie pobrane na komputer użytkownika.
Moduł posiada również pomocniczą funkcję, która pozwala na wydruk wybranych plików typu PDF lub pobranie innych typów plików. Aby to uzyskać, zaznaczamy wybrane pliki w interfejsie i wybieramy akcję z menu narzędziowego widoku Drukuj wszystkie.
Zostanie wyświetlone okno z wybranymi plikami oraz możliwością ich pobrania lub wydruku bezpośrednio (dla plików PDF). Wykonanie każdej z tego typu operacji oznaczy plik jako przetworzony. Ułatwia to wydruk/obsługę plików i widoczność ich statusu w systemie.
Dołączenie załącznika do zasobu/typu elementów można wykonać poprzez menu kontekstowe danego załącznika/ów.
Generator dokumentacji powykonawczej
| Moduł dostępny jest w wybranych wersjach systemu. W celu uzyskania dodatkowych informacji prosimy o kontakt z działem wsparcia lub sprawdzenie dostępności wersji systemu w konfiguracji instancji. |
Generator dokumentacji powykonawczej pozwala na wygenerowanie dokumentacji powykonawczej dla wybranych zasobów. Dokumentacja powykonawcza jest generowana na podstawie danych pochodzących ze źródeł systemu AMAGE. Mogą one pochodzić z zasobów, zleceń pracy, typów elementów lub bezpośrednio ze struktury załączników. Za pomocą tego modułu możemy zbudować drzewo dokumentacji, które następnie może zostać wyeksportowane do archiwum ZIP lub wydrukowane. System ma informację o rewizji danej dokumentacji i ułatwia tworzenie kolejnych wersji dokumentacji poprzez kopiowanie już istniejącego drzewa dokumentacji.
Możliwym zastosowaniem jest przekazywanie kompletnej dokumentacji powykonawczej do klienta po zakończeniu prac serwisowych lub budowlanych. Dokumentacja może zawierać wszystkie niezbędne pliki, rysunki techniczne, instrukcje obsługi oraz inne dokumenty związane z wykonanymi pracami.
Innym zastosowaniem jest przekazywanie dokumentacji projektowej dla podwykonawców odpowiedzialnych za realizację określonego zakresu prac. Dzięki temu podwykonawcy mają dostęp do wszystkich niezbędnych informacji i dokumentów potrzebnych do prawidłowego wykonania zadań.
Dostęp do modułu jest możliwy z menu głównego aplikacji z sekcji Struktura. Wybieramy akcję Dokumentacja aby przejść do listy dostępnych zbiorów dokumentacji.
Widok główny przedstawia podstawowe informacje o poszczególnych zbiorach dokumentacji powykonawczej. W liście pojawia się informacja o nazwie, opisie, wersji (rewizji) danej dokumentacji oraz daty utworzenia/edycji dokumentu. Główny element dokumentacji możemy traktować jako kontener na strukturę dokumentacji, którą będziemy budować w kolejnych krokach. W panelu boczny mamy dostęp do filtrów wyszukiwania dokumentacji według nazwy oraz statusu archiwizacji.
W menu kontekstowym listy dokumentacji (dla już utworzonych zapisów) mamy dostęp do akcji edycji oraz usuwania głównego folderu dokumentacji.
-
Edytuj - otwiera listę rewizji dokumentacji dla danego folderu
-
Usuń - usuwa nieodwracalnie folder dokumentacji z całą jego zawartością
Po przejściu do szczegółów danego folderu dokumentacji otrzymujemy widok w formie dodatkowej zakładki. Za jego pomocą mamy możliwość utworzenia nowych rewizji dokumentacji oraz przeglądania już istniejących wersji dokumentacji. Dodajemy nową rewizję za pomocą przycisku Dodaj w górnym menu.
Dla każdej z rewizji dokumentacji dostępne jest menu kontekstowe z następującymi akcjami:
-
Edytuj - otwiera edytor właściwości dokumentacji oraz przechodzi do edycji drzewa dokumentacji
-
Klonuj - tworzy nową dokumentację na podstawie istniejącej z pełną kopią listy elementów/drzewa dokumentacji. Przydatne do tworzenia nowej rewizji dokumentacji na podstawie istniejącej.
-
Generuj - generuje archiwum ZIP z dokumentacją
-
Drukuj - otwiera formularz wydruku/pobrania dokumentacji
-
Usuń - usuwa nieodwracalnie daną rewizję dokumentacji
Generacja archiwum ZIP z dokumentacją odbywa się poprzez wybranie akcji Generuj z menu kontekstowego danej rewizji dokumentacji. System rozpoczyna proces generowania archiwum ZIP z dokumentacją na podstawie zbudowanego drzewa dokumentacji. Po zakończeniu procesu użytkownik otrzymuje plik archiwum ZIP do pobrania na swój komputer.
Edytor właściwości dokumentacji otwiera się po wybraniu akcji Edytuj z menu kontekstowego danej rewizji dokumentacji lub przy dodawaniu nowej rewizji dokumentacji. W edytorze możemy podać podstawowe informacje o dokumentacji, takie jak nazwa, wersja (rewizja), opis oraz status archiwizacji.
W edytorze podajemy następujące właściwości:
-
Nazwa - nazwa dokumentacji.
-
Wersja - rewizja dokumentacji - numer liczony od 1. Użytkownik ma możliwość dowolnego określania numeru rewizji.
-
Opis - dodatkowy opis zbioru dokumentacji.
-
Zarchiwizowana - flaga informująca o zakończeniu edycji dokumentacji. Po zaznaczeniu tej flagi dokumentacja nie będzie widoczna domyślnie w liście dokumentacji (można ją zobaczyć ustawiając odpowiedni filtr)
Po zapisaniu nowego zbioru dokumentacji możemy przejść do edycji szczegółowego drzewa dokumentacji dla tej rewizji. W tym celu wybieramy przycisk Podgląd (lupka) z listy dokumentacji. Otwiera się nowa zakładka z daną dokumentacją dostępną do edycji.
Edytor dokumentacji podzielony jest na trzy główne sekcje:
-
Drzewo dokumentacji - struktura dokumentacji powykonawczej
-
Lista dokumentów - lista dokumentów (plików) dostępna na danym poziomie
-
Podgląd dokumentu PDF - widok szybkiego podglądu dokumentu PDF
Menu główne nad drzewem dokumentacji pozwala na wykonywanie podstawowych akcji na drzewie dokumentacji.
-
Dodaj - katalog- dodaje katalog w miejscu zaznaczenia lub na najwyższym poziomie -
Dodaj (kreator danych)- otwiera kreator danych do dodawania elementów dokumentacji z zasobów, typów lub plików
Dostępne są również następujące akcje:
-
Re-Inicjalizuj - odświeża pliki/załączniki/dokumentację na podstawie istniejących filtrów powiązanych z elementami drzewa dokumentacji
-
Odśwież - odświeża widok drzewa dokumentacji
-
Usuń - usuwa zaznaczony element drzewa dokumentacji wraz z elementami podrzędnymi
Każdy aktywny element drzewa dokumentacji posiada swoje menu kontekstowe z dostępnymi akcjami.
Dostępne akcje:
-
Właściwości - edytuje właściwości zaznaczonego elementu drzewa dokumentacji - pokazuje albo edytor nazwy katalogu albo uruchamia kreator danych do edycji filtrów zaznaczonego elementu dokumentacji
-
Re-Inicjalizuj - odświeża pliki/załączniki/dokumentację na podstawie istniejących filtrów powiązanych z zaznaczonym elementem drzewa dokumentacji
-
Przenieś - umożliwia przeniesienie zaznaczonego elementu drzewa dokumentacji w inne miejsce struktury po wyborze docelowego elementu
-
Dodaj katalog - dodaje katalog w miejscu zaznaczenia
-
Dodaj (kreator danych) - otwiera kreator danych do dodawania elementów dokumentacji z zasobów, typów lub plików
-
Usuń - usuwa zaznaczony element drzewa dokumentacji wraz z elementami podrzędnymi
W głównym oknie w górym prawym rogu dostępne są przyciski akcji możliwe do wykonania na całej dokumentacji.
-
Zapisz - zapisuje zmiany w drzewie dokumentacji
-
Właściwości - edytuje właściwości całej dokumentacji
-
Generuj - generuje archiwum ZIP z dokumentacją
-
Drukuj - wyświetla formularz drukowania/pobrania wszystkich plików z listy dokumentów
Okno podzielone jest na trzy części. Pomiędzy każdą z nich znajduje się suwak, który umożliwia przesunięcie i zmianę rozmiaru poszczególnych sekcji. Dostępne sekcje to:
-
Drzewo dokumentacji - główne drzewo dokumentacji, tutaj powstaje struktura dokumentacji
-
Lista dokumentów - lista dokumentów (plików) dostępna na danym poziomie dokumentacji (zaznaczenia). Za pomocą checkbox’a
pokaż wszystkie elementy podrzędnemamy możliwość pokazania wszystkich dokumentów znajdujących się w zaznaczonym elemencie drzewa dokumentacji oraz podrzędnych elementach. -
Podgląd dokumentu PDF - widok szybkiego podglądu dokumentu PDF. Po zaznaczeniu dokumentu w liście dokumentów wyświetla się podgląd dokumentu PDF z możliwością szybkiej nawigacji.
Dodawanie elementów do dokumentacji
Uruchomienie kreatora danych do dodawania elementów do dokumentacji następuje po wybraniu przycisku Dodaj (kreator danych) z menu głównego nad drzewem dokumentacji lub z menu kontekstowego zaznaczonego elementu drzewa dokumentacji. Kreator danych składa się z trzech kroków.
Pozwala na wybór typu elementu, który chcemy dodać do dokumentacji oraz podać nazwę danego elementu dokumentacji. Dostępne są następujące typy elementów:
-
Nazwa - nazwa dodawanego elementu dokumentacji
-
Typ: - wybór typu elementu do dodania do dokumentacji:
-
Katalog - dodaje pusty katalog do dokumentacji
-
Lista zasobów - dodaje dokumentację z wielu zasobów
-
Zasób - dodaje dokumentację z pojedynczego zasobu
-
Lista typów elementów - dodaje dokumentację z wielu typów elementów
-
Typ elementu - dodaje dokumentację z pojedynczego typu elementu
-
Lista zleceń pracy - dodaje dokumentację z wielu zleceń pracy
-
Zlecenie pracy - dodaje dokumentację z pojedynczego zlecenia pracy
-
Lista plików - dodaje dokumentację z wielu plików/katalogów
-
Po wybraniu typu elementu przechodzimy do kroku 2 kreatora danych. Wybieramy elementy odpowiadające wybranemu filtrowi. Na przykład, jeśli wybraliśmy Zasób, to w kroku 2 będziemy wybierać pojedynczy zasób z listy zasobów dostępnych w systemie. Jeśli wybraliśmy Lista zasobów, to w kroku 2 będziemy wybierać wiele zasobów z listy zasobów dostępnych w systemie. Za pomocą przycisku Wybierz elementy otwieramy okno dialogowe z listą zasobów/typów/zleceń pracy lub plików do wyboru.
Po wybraniu elementów przechodzimy do kroku 3 kreatora danych. W kroku 3 definiujemy filtry załączników, które mają zostać dodane do dokumentacji z wybranych elementów. Możemy określić filtry na podstawie typu załącznika, kategorii załącznika, nazwy załącznika, wyrażenia regularnego nazwy załącznika oraz rozszerzenia załącznika. Możemy również zaznaczyć opcję Filtruj elementy, aby zastosować filtry do wybranych elementów i zobaczyć podgląd wynikowy danych.
Możemy w tym kroku wybrać:
-
Typ załącznika - typ załącznika
-
Kategoria załącznika - kategoria załącznika
-
Nazwa załącznika - nazwa załącznika
-
Wyrażenie regularne nazwy załącznika - włączenie pozwala na użycie wyrażeń regularnych do filtrowania nazw załączników
-
Rozszerzenie załącznika - rozszerzenie pliku załącznika
-
Filtruj elementy - przycisk pozwalający na zastosowanie filtrów i wyświetlenie podglądu wynikowego danych
Po zakończeniu kreatora system pobiera załączniki z wybranych elementów na podstawie zdefiniowanych filtrów i dodaje je do struktury dokumentacji w zaznaczonym miejscu drzewa dokumentacji. Elementy te pojawiają się jako liczba w nazwie danego elementu dokumentacji w drzewie dokumentacji. Załączniki można przeglądnąć w liście dokumentów po zaznaczeniu danego elementu drzewa dokumentacji.
Po zaznaczeniu pokaż wszystkie elementy podrzędne w liście dokumentów pojawią się również załączniki z elementów podrzędnych zaznaczonego elementu drzewa dokumentacji. Pozwala to na wyświetleniu wszystkich dokumentów dostępnych w danym katalogu wraz z podkatalogami.
|
Generacja archiwum dokumentacji
Po zakończeniu prac nad strukturą dokumentacji mamy możliwość wygenerowania archiwum ZIP z dokumentacją. W tym celu wybieramy przycisk Generuj z menu bocznego widoku dokumentacji. W wyniku tej operacji system wygeneruje archiwum ZIP z dokumentacją, które zostanie pobrane na komputer użytkownika. Zostanie zachowana struktura drzewa dokumentacji w archiwum, czyli każdy katalog z dokumentacją zostanie zachowany w archiwum wraz z załącznikami i dokumentami.
W trakcie generowania archiwum system wyświetla informację o postępie operacji. Po zakończeniu generowania archiwum zostanie wyświetlony komunikat o zakończeniu operacji.
Po zakończeniu operacji użytkownikowi zostanie wysłany plik archiwum ZIP z dokumentacją na komputer. Archiwum zawiera wszystkie pliki i katalogi z drzewa dokumentacji.
Wydruk/pobranie dokumentacji
Alternatywnie użytkownik może skorzystać z formularza wydruku/pobrania dokumentacji. W tym celu zaznacza wybrane pliki z listy dokumentów i wybiera przycisk Drukuj z menu bocznego widoku dokumentacji. System wyświetli okno z wybranymi plikami oraz możliwością ich pobrania lub wydruku bezpośrednio (dla plików PDF). Wykonanie każdej z tego typu operacji oznaczy plik jako przetworzony. Ułatwia to wydruk/obsługę plików i widoczność ich statusu w systemie.
W widoku listy dokumentów do wydruku/pobrania dostępne są następujące akcje:
-
Przycisk pobierz - pobiera wybrane pliki
-
Pobierz element - pobiera wybrany plik
-
Drukuj element - drukuje wybrany plik (dla plików PDF)
Status wykonania operacji zmienia się po wywołaniu którejś z akcji. W przypadku wydruku plików PDF system wyświetla plik, a następnie włącza opcję generacji wydruku. Pojawia się okno dialogowe z wyborem drukarki oraz opcjami drukowania.
