Process management All available processes in the system are managed in the Processes tab in Administration -> Document workflow. The main view is a table with all process definitions in the system. Image AddedFigure 5.3.1 Processes tab view
The table contains the name and description of the process. Use the "Edit" button to enter the edition of the selected process. Image Added
Figure 5.3.2 Process editing The upper table contains information about the edited process. The following tabs are available below: "Tasks", "Notifications", "Document Templates", "Protection", "Settings", Document Views "," Process Map "and" Process Variables ". Tasks"Tasks" tab contains a table with all defined tasks in the process. In the table we have information about the name and description of the task. Image Added Image Added
Figure 5.3.3 Process edition - Tasks tab
In the Action column we have the ability to edit settings regarding the visibility of tabs. Image Added
Figure 5.3.4 The window for changing task settings Notifications In the notification tab you can define the e-mail notifications for the process. Image Added
Figure 5.3.5 Process edition - Notifications tab
The table shows already defined notifications. The definition of an existing notification from the table in the figure specifies that the user with the position "Manager" will receive an email one day after creating the task "Holiday application submission". The subject of the e-mail will be "The task has been created" and its content has been defined in the "template.xml" file. After pressing the "New notification" button, the form of adding email notification will open. Image Added
Figure 5.3.6 Add notification window It consists of the following fields: - Name - the name of the notification being defined.
- Subject - the subject of the email you send.
- Template path - the full path to the file with the email template. Creating a template is described in Notification configuration..
- Type of sending condition - a drop-down list from which we can choose when the notification should be sent. We can choose between "Creation", "End" and "Exceeding the deadline".
- Delay of sending in days - enter here the number of days after which the e-mail should be sent from the time the defined action was performed. Holidays are not included.
- For a task - we define what task the sending condition type should apply to.
- Recipient type - to whom the e-mail should be sent. Choose from: "User", "User (Variable)", "Group", "Position", "Executor", "Executor's Supervisor Position".
- Receiver:
- User, Group, Job title, Executor - specific value (e.g. user login or group name)
- User (Variable) - identifier of the process variable that contains the user's login (or logins separated by a semicolon).
- Executor, executor's supervisor position - none (depends on the task defined in the "For a task" field)
- Only own tasks - defines whether defined recipients are to be notified about the task only if they are its executors.
The completed form is confirmed with the "Add notification" button. Defined notifications can be removed using the "Delete" button in the table next to the notification and can be edited using the "Change" button. In the notification edition, we can make changes to all the fields in the notification form. Translation of email notifications You can also translate email notifications. The system can send an email notification to each recipient in the user's language (configured individually in the account configuration). To do this, you do not need to change the notification configuration above. The notification template should be translated into the user's language, add the language abbreviation preceded by an underscore to the user's file name, and place in the same directory as the default notification template file. E.g. for the "template.xml" notification template in English, Hungarian and Polish: - create the "template_en.xml", "template_hu.xml" and "template_pl.xml" files accordingly
- include the content of the email in the appropriate language
- put all 3 translated files next to the file "template.xml"
To translate the subject of the email, add to the implementation file the entry, where the value is the translated subject of the email and the key is the subject of the email, as in the configuration (replace spaces with underscores). E.g. for the subject of email "Subject of email notification" in English: - find the implementation translation file "customMessages_en.i18n"
- add an entry to it
Code Block |
---|
| Temat_powiadomienia_email=Email notification subject |
Przy każdej próbie wysłania pliku system będzie szukał, czy istnieje tłumaczenie treści maila oraz tematu maila w języku takim, jaki ma ustawiony docelowy użytkownik. Jeżeli nie istnieje plik z przetłumaczoną treścią, system wyśle wiadomość z domyślnego szablonu. Jeżeli nie istnieje tłumaczenie tematu maila, system wyśle wiadomość z tematem takim, jaki został wpisany w konfiguracji w systemie. Szablony dokumentówW tej zakładce mamy możliwość definiowania szablonów, które mogą być wykorzystywane w procesie do generowania plików pdf, Image Removed
Rysunek 5.3.7 Edycja procesu - zakładka Szablony dokumentów W tabeli zawarte są istniejące już szablony. Każdy szablon ma swoją nazwę oraz ścieżko do pliku z szablonem. Po wciśnięciu przycisku "Nowy szablon" otworzy się formularz dodawania nowego szablonu dokumentu. Należy w nim wpisać nazwę szablonu oraz pełną ścieżkę do pliku z szablonem. Na koniec należy zatwierdzić przyciskiem "Dodaj szablon". Szablony wykorzystywane są podczas generowania plików pdf. Image Removed
Rysunek 5.3.8 Okno dodawania szablonu dokumentu Zdefiniowane szablony możemy usunąć za pomocą przycisku "Usuń", znajdującym się przy każdym szablonie. OchronaW tej zakładce możemy definiować uprawnienia odnośnie konkretnych procesów. Widok przedstawia się następująco: Image Removed
Rysunek 5.3.9 Edycja procesu - zakładka Ochrona Uprawnienia do procesów podzielone są na następujące typy: - Podgląd procesu - umożliwia wyszukiwanie procesu.
- Tworzenie procesu - umożliwia tworzenie procesu.
- Usuwanie procesu - umożliwia usuwanie procesu.
- Statystyki - umożliwia podgląd statystyk procesu.
W tabeli na rysunku mamy przedstawione dodane uprawnienia dotyczące edytowanego procesu. Kolumna "Grupa" określa, czy uprawnienie dotyczy grupy, czy użytkownika. Natomiast kolumna "Akcja" umożliwia usuwanie uprawnień, dodanych tylko z tego poziomu, za pomocą przycisku "Usuń". Dla uprawnień dodanych globalnie (patrz Zarządzanie uprawnieniami) mamy informację w postaci "Administracja -> Uprawnienia". Z takimi uprawnieniami nie możemy w tym miejscu nic zrobić, gdyż są one jedynie informacyjne. W tabeli widać, że użytkownik "anowak" ma uprawnienie do podglądu procesu, nadane mu w uprawnieniach globalnych oraz do tworzenia procesu, które zostało mu nadane w tym miejscu. Takie uprawnienie można usunąć. Ostatnim uprawnieniem są pełne uprawnienie odnośnie edytowanego procesu dla grupy "SharkGroup". Zostały one nadane w uprawnieniach globalnych. Pod tabelą znajduje się formularz dodawania uprawnienia do edytowanego procesu. W pierwszym polu należy wybrać użytkownika bądź grupę. Wybór ten odbywa się za pomocą przycisków "Użytkownicy" bądź "Grupy". Po naciśnięciu pierwszego przycisku ukaże nam się okno z wyborem użytkowników (patrz rysunek 2.3 oraz jego opis w Zarządzanie grupami). Po naciśnięciu przycisku "Grupy" otworzy się okno z wyborem grup (patrz rysunek 3.2 i jego opis w Zarządzanie użytkownikami). Następnie checkboxami zaznaczamy typy uprawnień jakie chcemy nadać do tego procesu. Na koniec dodajemy uprawnienie za pomocą przycisku "Dodaj uprawnienie". UstawieniaPo wejściu w zakładkę ustawienia otrzymamy następujący widok: Image Removed
Rysunek 5.3.10 Edycja procesu - zakładka Ustawienia Dostępne mamy tutaj następujące opcje: - Akceptacja zadań w procesie z hasłem - zaznaczenie tej opcji spowoduje, że każdy użytkownik w momencie akceptacji zadania będzie musiał dokonać ponownej autoryzacji, czyli będzie musiał podać swoje dane do logowania do systemu. Po pomyślnej autoryzacji zadanie zostanie zaakceptowane.
- Wyświetlaj następujące zakładki w formularzu zadania - pierwsze 5 checkboxów pozwala zdefiniować, czy takie zakładki mają być wyświetlane na formularzu zadań edytowanego procesu. Kolejny chceckbox definiuje, czy mają być aktywne powiadomienia użytkowników dla zadań. Za pomocą ostatniej opcji określamy, czy zadania z tego procesu mają być wyświetlane w kalendarzu podczas wyszukiwania przyszłych zadań.
Widoki dokumentów Info |
---|
Widok dokumentów jest to widok na formularzu zadania, wyświetlający zdefiniowane dokumenty. |
Image Removed
Rysunek 5.3.11 Edycja procesu - zakładka Widoki dokumentów Na rysunku przedstawiona jest tabela zawierająca wszystkie zdefiniowane widoki dla edytowanego procesu. W tabeli zawarte są kolumny odzwierciedlające formularz dodawania nowego widoku dokumentów. Image Removed
Rysunek 5.3.12 Okno dodawania nowego widoku Formularz składa się z następujących pól: Nazwa - nazwa widoku dokumentów.Opis - opis widoku dokumentów.Proces - nazwa procesu, którego dotyczy widok dokumentów. Pole jest już uzupełnione edytowanym procesem i nie jest do edycji.Zadanie - zadanie, którego będzie dotyczyć widok dokumentów. Opcja "Każde" dotyczy wszystkich zadań procesu.Użytkownik - użytkownik, dla którego tworzymy widok. Wybór użytkownika odbywa się za pomocą przycisków "Użytkownicy". Po naciśnięciu ukaże nam okno z wyborem użytkowników (patrz rysunek 2.3 oraz jego opis w Zarządzanie grupami).Klasa dokumentów - określa z jakiej klasy dokumentów mają być dokumenty. Opcja "Każda" dotyczy wszystkich klas dokumentów.Najnowsze - Czy dokumenty mają być wyświetlane od najnowszego.Ilość - liczba dokumentów jakie mają być wyświetlane w widoku dokumentów.Wyrażenie regularne - Za pomocą wyrażenia regularnego możemy filtrować wyświetlane dokumenty na podstawie nazwy pliku. Wyświetlane będą tylko takie pliki, których nazwa spełnia wyrażenie regularne np: ^.*\.(jpg Each time you try to send a file, the system will look to see if there is a translation of the e-mail content and e-mail subject in the language the target user has set. If no translated content file exists, the system will send a message from the default template. If there is no translation of the subject of the email, the system will send a message with the subject as entered in the system configuration. Document templates In this tab we have the ability to define templates that can be used in the process to generate pdf files, Image Added
Figure 5.3.7 Process edition - Document templates tab The table contains existing templates. Each template has its own name and path to the template file. After pressing the "New template" button, the form for adding a new document template will open. Enter the template name and the full path to the template file. Finally, confirm with the "Add template" button. Templates are used when generating pdf files. Image Added
Figure 5.3.8 The window for adding a document template Defined templates can be removed using the "Delete" button next to each template. ProtectionIn this tab, we can define permissions for specific processes. The view is as follows: Image Added
Figure 5.3.9 Process edition - Protection tab Process permissions are divided into the following types: - Process preview - allows you to search for a process.
- Process creation - allows you to create a process.
- Process Deletion - allows you to delete a process.
- Statistics - allows you to view process statistics.
The table in the figure shows the added rights for the edited process. The "Group" column indicates whether the permission applies to the group or the user. The "Action" column, on the other hand, allows you to delete rights added only from this level using the "Delete" button. For globally added permissions (see Permission Management ), we have information in the form "Administration -> Permissions". We cannot do anything with such permissions here, because they are only informative. The table shows that the user "anowak" has the right to view the process, assigned to him in global authority, and to create the process that has been assigned to him here. This permission can be removed. The last permission is full permission for the edited process for the "SharkGroup" group. They were granted in global permissions. Below the table there is a form for adding permission to the edited process. In the first field, select a user or group. This selection is done using the "Users" or "Groups" buttons. After pressing the first button, a window will appear showing the selection of users (see Figure 2.3 and its description in Group management). After pressing the "Groups" button a window with group selection will open (see Figure 3.2 and its description in Users management ). Then we check the types of permissions we want to give to this process. Finally, we add the permission using the "Add Permission" button. Settings After entering the settings tab we will receive the following view: Image Added
Figure 5.3.10 Process edition - Settings tab We have the following options available here: - Task acceptance in the process with a password - checking this option will cause that every user will have to reauthorize when accepting the task, i.e. they will have to enter their system login details. After successful authorization, the task will be accepted.
- Display the following tabs in the task form - the first 5 checkboxes allow you to define whether such tabs should be displayed on the task form of the edited process. Another chceckbox defines whether user notifications for tasks should be active. Using the last option, we determine whether tasks from this process are to be displayed in the calendar when searching for future tasks.
Document views
Info |
---|
Document view is a view on the task form that displays the defined documents. |
Image Added
Figure 5.3.11 Process edition - Document views tab The figure shows a table containing all defined views for the edited process. The table contains columns reflecting the form for adding a new document view. Image Added
Figure 5.3.12 The window for adding a new view The form consists of the following fields: - Name - the name of the document view.
- Description - description of the document view.
- Process - the name of the process to which the document view applies. The field is already completed by the edited process and is not editable.
- Task - the task to which the document view will apply. The "Any" option applies to all process tasks.
- User - the user for whom we create the view. User selection is carried out by means of the "Users" buttons. After pressing it will show us a window with the selection of users (see Figure 2.3 and its description in Group management).
- Document class - specifies which document class should be used for documents. The "Each" option applies to all document classes.
- Latest - Whether the documents should be displayed from the most recent.
- Quantity - the number of documents to be displayed in the document view.
- Regular expression - Using the regular expression, you can filter the displayed documents based on the file name. Only files whose name meets the regular expression will be displayed, e.g. ^. * \. (Jpg | JPG | gif | GIF | pdf | PDF) $ (wyświetla tylko pliki z rozszerzeniami only displays files with the extensions pdf, gif i and jpg)
Po wypełnieniu formularza należy dodać widok dokumentów za pomocą przycisku "Dodaj". Mapa procesu
Zakładka jest dostępna tylko w przypadku, gdy zainstalowany jest moduł PlusWorkflowEditor. Dostarcza ona podgląd mapy edytowanego procesu w formie w graficznej. Image Removed Rysunek After completing the form, add the document view using the "Add" button. Process mapThe tab is only available if the PlusWorkflowEditor module is installed. It provides a preview of the map of the edited process in graphical form. Image Added
Zmienne procesu Image Removed Rysunek Figure 5.3.13 Edycja procesu - zakładka Mapa procesu Process edition - Process map tab Process variables Image Added
Figure 5.3. 14 Edycja procesu - zakładka Zmienne procesuKlasy dokumentów (w trakcie realizacji)W zakładce "Klasy dokumentów" możemy ustalić, które klasy dokumentów mają być dostępne w danym procesie. Image Removed
Rysunek 5.3.14 Edycja procesu - zakładka Klasy dokumentów Opcje do wyboru: - Wszystkie - w procesie będą dostępne wszystkie klasy dokumentów zdefiniowane w systemie.
- Żadne - w procesie nie będzie dostępna żadna z klas dokumentów zdefiniowanych w systemie.
- Wybrane - mamy możliwość wybrania, które klasy dokumentów mają być dostępne w procesie.
Image RemovedRysunek 5.3.14 Edycja procesu - zakładka Klasy dokumentów - wybrana opcja "Wybrane" Po wciśnięciu przycisku "Dodaj klasę dokumentów" otworzy się formularz dodawania klasy dokumentu do procesu. Należy w nim wybrać jedną z klas dokumentów zdefiniowanych w bazie i zatwierdzić przyciskiem "Dodaj klasę dokumentów". Image RemovedRysunek 5.3.12 Okno dodawania nowej klasy dokumentu do procesu Przypisane klasy dokumentów możemy odpiąć od procesu za pomocą przycisku "Usuń", znajdującym się przy każdej przypisanej klasie dokumentu. 14 Process edition - Process variables tab
Document classes (in progress) In the "Document classes" tab we can determine which document classes are to be available in a given process. Image Added
Figure 5.3.15 Process edition - Document classes tab Options to choose: - All - all document classes defined in the system will be available in the process.
- None - none of the document classes defined in the system will be available in the process.
- Selected - we have the option of choosing which document classes are to be available in the process.
Image AddedFigure 5.3.16 Process edition - Document classes tab - "Selected" option selected
After clicking the "Add document class" button, the form for adding the document class to the process will open. Choose one of the document classes defined in the database and confirm with the "Add document class" button. Image AddedFigure 5.3.17 Window for adding a new document class to the process Assigned document classes can be disconnected from the process using the "Delete" button located next to each assigned document class. In the "Assigning variables to user information" tab we can determine which process variables are to be replaced in case of replacement of users in a given process. Image Added
Figure 5.3.18 Process edition - Assigning variables to user information tab
Options to choose: - All - in case of replacement of users, all process variables matched to user login or user name will be replaced.
- None - in case of replacement of users, no variables will be replaced.
- Selected - we have the option of choosing which process variables will be replaced in case of replacement of users.
Image AddedFigure 5.3.19 Process edition - Assigning variables to user information tab - "Selected" option selected
After clicking the "New assignment" button, the form for adding the variable assignment to the process will open. Choose one of the process variables and type of information that will be used in variable replacement. Available information types are Login and First and last name. Confirm adding using "Add assignment" button.
Image AddedFigure 5.3.20 Window for adding a new variable assignment to the process
Assigned variables can be deleted from the process using the "Delete" button located next to each assigned variable. Changing selected type from "Selected" to another type triggers dialog window asking user for confirmation of change. Confirming dialog window causes deletion of all selected assigned variables.
Image AddedFigure 5.3.21 Dialog window confirming change of assignment type from "Selected" to another type |