| 1 | = Powiadamianie o niezałatwionych etapach procedur = |
| 2 | |
| 3 | Począwszy od wersji 3.6.113 system eDokumenty umożliwia skonfigurowanie funkcji automatycznego powiadamiania użytkowników wiadomościami email o etapach procedur, które nie zostały jeszcze załatwione. |
| 4 | |
| 5 | == Jak to działa == |
| 6 | |
| 7 | Uruchomienie wbudowanego w system eDokumenty, dedykowanego skryptu php powoduje wysłanie do każdego użytkownika, który posiada niezałatwione zadania workflow, emaila zawierającego zestawienie tych zadań. Przykładowa treść generowanego emaila przedstawiona została na rysunku 1. |
| 8 | |
| 9 | |
| 10 | [[Image(powiadomienie.jpg)]][[BR]] (''Rys.1'') |
| 11 | |
| 12 | == Konfiguracja == |
| 13 | |
| 14 | Podstawowym wymaganiem dla prawidłowego działania skryptu jest skonfigurowanie w systemie eDokumenty tzw. systemowego konta pocztowego, z którego wysyłane będą powiadomienia. Aby to zrobić należy przejść do ''Panelu sterowania'' i kliknąć link ''Systemowe konto pocztowe'', a następnie wprowadzić poprawne dane (wpisując adres email w polu ''Wyślij testowy email'' można też sprawdzić czy konto zostało prawidłowo skonfigurowane). |
| 15 | |
| 16 | {{{ |
| 17 | Ustawienia >> Panel sterowania >> Sekcja Ogólne >> Systemowe konto pocztowe |
| 18 | }}} |
| 19 | |
| 20 | Wiadomości z powiadomieniami wysyłane są na adresy email przypisane pracownikom w module ''Konta pracowników''. Zalecane jest więc zweryfikowanie, czy wszyscy pracownicy mają określony właściwy adres email. |
| 21 | |
| 22 | Sam skrypt natomiast, znajduje się w katalogu ''public_html/apps/edokumenty/scripts/''. Oryginalna wersja skryptu zapisana jest w pliku IncompleteWorkflowStagesToEmail.php_default. Do utworzenia treści emaila wykorzystywany jest szablon HTML/Flexy, który znajduje się w tym samym katalogu i posiada taka samą nazwę ale z rozszerzeniem .tpl_default. Pliki te należy skopiować do tego samego katalogu, ale usuwając z rozszerzenia "_default" (czyli odpowiednio jako IncompleteWorkflowStagesToEmail.php i IncompleteWorkflowStagesToEmail.tpl). Tak przygotowany skrypt będzie działał prawidłowo. Jeśli jednak okaże się, że potrzebne są pewne zmiany (np. w zapytaniu źródłowym, czy też w treści wysyłanego emaila) pliki te można wyedytować i dostosować do potrzeb. |
| 23 | |
| 24 | == Automatyzacja wykonywania skryptu == |
| 25 | |
| 26 | W typowym zastosowaniu zalecamy konfigurację automatycznego wykonywania skryptu na serwerze codziennie, od poniedziałku do piątku, o godzinie 12:00. Poniżej zamieszczona została informacja w jaki sposób dodać takie zadanie na serwerach linux i windows. |
| 27 | |
| 28 | === Linux === |
| 29 | |
| 30 | Na serwerach linux automatycznie wykonywane zadania najczęściej konfiguruje się poprzez edycję pliku /etc/cron.d/crontab. W pliku tym należy dodać poniższy wiersz. |
| 31 | |
| 32 | {{{ |
| 33 | 0 22 * * 1-5 www-data php -f /home/edokumenty/public_html/apps/edokumenty/scripts/WorkflowStagesToEmail.php |
| 34 | }}} |
| 35 | |
| 36 | === Windows === |
| 37 | |
| 38 | Na serwerach Windows należy wykonać z konsoli poniższe polecenie, które doda nowe zadanie do systemowego Harmonogramu Zadań. |
| 39 | |
| 40 | {{{ |
| 41 | schtasks /CREATE /sc WEEKLY /d MON,TUE,WED,THU,FRI /st "12:00:00" /tn "WorkflowStagesToEmail" /tr "php -f \"(ścieżka_instalacyjna)\eDokumenty\public_html\apps\edokumenty\scripts\WorkflowStagesToEmail.php"" |
| 42 | }}} |
| 43 | |
| 44 | W zależności od obsługiwanej składni, dla parametru /sc zamiast ''WEEKLY'' może być wymagane użycie wartości ''Cotygodniowo'', a dla parametru /d wartości ''Pn,Wt,Śr,Cz,Pt''. Można to sprawdzić za pomocą polecenia: |
| 45 | |
| 46 | {{{ |
| 47 | schtasks /CREATE /? |
| 48 | }}} |
| 49 | |
| 50 | == Diagnozowanie problemów == |
| 51 | |
| 52 | Domyślnie skrypt loguje do pliku tekstowego każde uruchomienie oraz liczbę wysłanych wiadomości email. Logowane są także błędy jakie pojawiły się podczas jego działania. Pliki z logami znajdują się w katalogu ''public_html/apps/edokumenty/var/log/'' i są to odpowiednio pliki ''workflow_stages_to_email_stat.log'' i ''workflow_stages_to_email_error.log''. |
| 53 | |
| 54 | |
| 55 | W celach testowych można uruchomić skrypt z konsoli za pomocą polecenia: |
| 56 | |
| 57 | {{{ |
| 58 | php -f (ścieżka_instalacyjna)\eDokumenty\public_html\apps\edokumenty\scripts\WorkflowStagesToEmail.php |
| 59 | }}} |
| 60 | |
| 61 | Bądź też po prostu z przeglądarki używając adresu: |
| 62 | |
| 63 | {{{ |
| 64 | https://{domena}/public_html/apps/edokumenty/scripts/WorkflowStagesToEmail.php |
| 65 | }}} |