Narzędzia użytkownika

Narzędzia witryny


lms-notify.php

Różnice

Różnice między wybraną wersją a wersją aktualną.

Odnośnik do tego porównania

Poprzednia rewizja po obu stronachPoprzednia wersja
Nowa wersja
Poprzednia wersja
lms-notify.php [2016/02/02 13:11] chileklms-notify.php [2017/12/04 22:32] (aktualna) chilek
Linia 1: Linia 1:
 ===4.3.1. lms-notify.php=== ===4.3.1. lms-notify.php===
-lms-notify.php jest dobrym sposobem przypominania ludziom o tym że do pracy sieci i łącz konieczne są ich pieniążki. Pozwala on na skonfigurowanie kilku[-nastu] sposobów komunikacji z klientem. Skrypt jest wielofunkcyjnywłączenie określonego zadania następuje poprzez określenie parametrem uruchomieniowym skryptu typów zadań. Do wysyłania poczty i sms-ów używane są standardowe mechanizmy dostępne w LMS.+lms-notify.php umożliwia komunikację z klientami na wiele sposobów wyzwalaną żnymi zdarzeniami. Skrypt jest wielofunkcyjny włączenie określonego zadania następuje poprzez określenie parametrem uruchomieniowym skryptu typów zadań. Do wysyłania poczty i sms-ów używane są standardowe mechanizmy dostępne w LMS.
  
-==4.3.1.1. Treści wiadomości == +==4.3.1.1. Treść i temat wiadomości == 
-W treści wiadomości można używać następujących zmiennych:+W treści i temacie wiadomości można używać następujących zmiennych:
  
   * %bankaccount - zostanie zastąpione numerem rachunku do przelewu   * %bankaccount - zostanie zastąpione numerem rachunku do przelewu
   * %b - saldo z zanegowanym znakiem, np. 107   * %b - saldo z zanegowanym znakiem, np. 107
   * %B - saldo z prawdziwym znakiem, np. -107   * %B - saldo z prawdziwym znakiem, np. -107
 +  * %totalb - podobnie jak %b z uwzględnieniem wszystkich należności
 +  * %totalB - podobnie jak %B z uwzględnieniem wszystkich należności
   * %date-y - zostanie zastąpione aktualnym rokiem, np. 2003   * %date-y - zostanie zastąpione aktualnym rokiem, np. 2003
   * %date-m - zostanie zastąpione aktualnym miesiącem, licząc od 1 poprzedzone 0, np. 02   * %date-m - zostanie zastąpione aktualnym miesiącem, licząc od 1 poprzedzone 0, np. 02
Linia 15: Linia 17:
   * %deadline-d - zostanie zastąpione numerem dnia w którym przypada termin płatności, licząc od 1 poprzedzone 0, np. 02 (tylko w powiadomieniu o fakturze lub nocie obciążeniowej)   * %deadline-d - zostanie zastąpione numerem dnia w którym przypada termin płatności, licząc od 1 poprzedzone 0, np. 02 (tylko w powiadomieniu o fakturze lub nocie obciążeniowej)
   * %saldo - zostanie zastąpione aktualnym saldem klienta, np. 535   * %saldo - zostanie zastąpione aktualnym saldem klienta, np. 535
 +  * %totalsaldo - podobnie jak %saldo z uwzględnieniem wszystkich należności
   * %abonament - zostanie zastąpione kwotą abonamentu jaka jest do danego klienta przypisana, np. 107   * %abonament - zostanie zastąpione kwotą abonamentu jaka jest do danego klienta przypisana, np. 107
   * %pin - numer PIN klienta   * %pin - numer PIN klienta
Linia 66: Linia 69:
     * **sms** - powiadomienia sms-em,     * **sms** - powiadomienia sms-em,
     * **www** - powiadomienia przez przeglądarkę www (skrypt jest w stanie generować listy reguł zawierające adresy IP),     * **www** - powiadomienia przez przeglądarkę www (skrypt jest w stanie generować listy reguł zawierające adresy IP),
-    * **blocking** - specjalny kanał powodujący zablokowanie komputerów abonenckich.+    * **block** - specjalny kanał powodujący zablokowanie komputerów, wyłączenie przy zobowiązaniach flagi "faktura" oraz zmianę statusu klienta na **windykacja**, 
 +    * **unblock** - specjalny kanał powodujący odblokowanie komputerów, włączenie przy zobowiązaniach flagi "faktura" oraz zmianę statusu klienta na **podłączony**.
   * **-t**, **--type**=typy_powiadomień_oddzielone_przecinkami      lista dostępnych typów powiadomień (domyślnie: **wszystkie typy**):   * **-t**, **--type**=typy_powiadomień_oddzielone_przecinkami      lista dostępnych typów powiadomień (domyślnie: **wszystkie typy**):
-    * **contracts** - powiadomienia o upływających terminach umów abonenckich,+    * **documents** - powiadomienia o upływających terminach umów/aneksów abonenckich (liczone w oparciu o datę "do" obowiązywania dokumentu), 
 +    * **contracts** - powiadomienia o upływających terminach umów/aneksów abonenckich (liczone w oparciu o maksymalną datę obowiązywania "do" dla wszystkich zobowiązań klienta),
     * **debtors** - powiadomienia o zadłużeniu abonentów,     * **debtors** - powiadomienia o zadłużeniu abonentów,
     * **reminder** - powiadomienia abonentów o nieopłaconych fakturach,     * **reminder** - powiadomienia abonentów o nieopłaconych fakturach,
     * **invoices** - powiadomienia o wystawionych fakturach,     * **invoices** - powiadomienia o wystawionych fakturach,
     * **notes** - powiadomienia o wystawionych notach odsetkowych,     * **notes** - powiadomienia o wystawionych notach odsetkowych,
-    * **warnings** - powiadomienia do abonentów, których komputery mają włączone ostrzeżenia, +    * **warnings** - powiadomienia abonentów, których komputery mają włączone ostrzeżenia
-    * **messages** - powiadomienia o wiadomościach nadanych do klientów +    * **events** - powiadomienia abonentów i użytkowników o aktywnych zdarzeniach w terminarzu (temat i treść są kopiowane bezpośrednio ze zdarzenia)
-  * **-s**, **--section**=nazwa_sekcji_konfiguracyjnej    nazwa sekcji konfiguracyjnej LMS z której ładowane są ustawienia skryptu (najpierw pod uwagę brane są ustawienia przechowywane w bazie danych/interfejsie użytkownika LMS, zaś w drugiej kolejności z pliku lms.ini)+    * **messages** - powiadomienia o wiadomościach nadanych do klientów (ma zastosowanie wyłącznie dla kanału **www**) 
 +  * **-s**, **--section**=nazwa_sekcji_konfiguracyjnej    nazwa sekcji konfiguracyjnej LMS z której ładowane są ustawienia skryptu (najpierw pod uwagę brane są ustawienia przechowywane w bazie danych/interfejsie użytkownika LMS, zaś w drugiej kolejności z pliku lms.ini) - domyślnie: **notify**
  
-==4.3.1.2. Konfiguracja==+==4.3.1.3. Konfiguracja==
 Konfigurację konta SMTP oraz backendu SMS określamy standardowymi sekcjami konfiguracyjnymi LMS, tj. odpowiednio **mail** i **sms**. Konfigurację konta SMTP oraz backendu SMS określamy standardowymi sekcjami konfiguracyjnymi LMS, tj. odpowiednio **mail** i **sms**.
 +Wszystkie ustawienia składają się z dwóch członów oddzielonych znakiem podkreślenia ("_"):
 +  * nazwy typu powiadomienia,
 +  * ustawienia.
 +Przykład: ustawienie wiadomości używanej przy powiadomieniach o wystawieniu faktur będzie miało postać **invoices_message**.
 +
 +Poniżej opisano obsługiwane ustawienia w postaci drugiego członu nazwy ustawienia).
  
 ^Nazwa ^Opis ^Wartość domyślna ^Przykład^ ^Nazwa ^Opis ^Wartość domyślna ^Przykład^
-|debtors_template (opcjonalny)|Lokalizacja pliku z szablonem wiadomości wysyłanej do zadłużonych klientów. Pozostawienie tej opcji pustej wyłączy powiadomienia o zadłużeniu.|puste|debtors_template /etc/lms/debtors.txt+|limit|Limit salda klienta wyzwalający powiadomienia|0|debtors_limit=-50
-|debtors_subject (opcjonalny)|Temat wiadomości o zadłużeniu.|'Debtors notification'|debtors_subject 'Powiadomienie o zadłużeniu'+|message|Treść wiadomości z powiadomieniem|... notification|invoices_message=Powiadomienie| 
-|invoices_template (opcjonalny)|Lokalizacja pliku z szablonem wiadomości z informacją o wystawieniu fakturyPod uwagę brane są faktury wystawione w ciągu ostatnich 24 godzin od uruchomienia skryptuPozostawienie tej opcji pustej wyłączy powiadomienia o nowych fakturach.|puste|invoices_template /etc/lms/new_invoice.txt+|subject|Temat wiadomości z powiadomieniem|... notification|reminder_subject=to jest temat listu
-|invoices_subject (opcjonalny)|Temat wiadomości nowej fakturze.|'New invoice notification'|invoices_subject 'Powiadomienie o wystawieniu faktury'+|days|Liczba dni wyzwalająca powiadomienia, np. dla contracts liczba dni od dnia dzisiejszego za które upływa ważność zobowiązania klienta najpóźniejsze dacie obowiązywania do|0|contracts_days=31
-|notes_template (opcjonalny)|Lokalizacja pliku z szablonem wiadomości z informacją o wystawieniu noty obciążeniowej. Pod uwagę brane są noty wystawione w ciągu ostatnich 24 godzin od uruchomienia skryptu. Pozostawienie tej opcji pustej wyłączy powiadomienia o nowych notach.|pusta|notes_template = /etc/lms/new_note.txt| +|file|Nazwa pliku do której zapisywane są reguły z adresami IP (ma zastosowanie dla kanału powiadomień **www**)|/etc/rc.d/messages.sh|messages_file=/etc/rc.d/rc.messages.sh
-|notes_subject (opcjonalny)|Temat wiadomości o nowej nocie obciążeniowej.|'New debit note notification'|notes_subject = 'Powiadomienie o wystawieniu noty obciążeniowej'+|header|Wiersz nagłówka pliku w którym są zapisywane reguły adresami IP (ma zastosowanie dla kanału powiadomień **www**)|#!/bin/bash\n\nipset flush $type\n|messages_header=#!/bin/bash\n\nPATH="/bin:/sbin:/usr/bin:/usr/sbin"\n\nipset create messages_tmp hash:net\n"
-|deadline_template (opcjonalny)|Lokalizacja pliku z szablonem wiadomości wysyłanej do zadłużonych klientów, posiadających przeterminowane (nierozliczonefaktury. Pozostawienie tej opcji pustej wyłączy powiadomienia.|pusta|deadline_template = /etc/lms/deadline.txt+|rule|Reguła z adresem IP - symbol specjalny %i za który podstawiany jest adres IP komputera klienckiego (ma zastosowanie dla kanału powiadomień **www**)|ipset add ..%i\n|messages_rule=ipset add messages_tmp %i\n
-|deadline_subject (opcjonalny)|Temat wiadomości o przeterminowanych fakturach.|'Invoice deadline notification'|deadline_subject 'Powiadomienie o zaległości'+|footer|(ma zastosowanie dla kanału powiadomień **www**)|pusty|messages_footer=ipset swap messages_tmp messages\nipset destroy messages_tmp\n|
-|limit (opcjonalny)|Pozwala na ustalenie limitu bilansu poniżej którego do klienta zostanie wysłana wiadomość z informacją o zadłużeniu.|0|limit -20| +
- +
-Poniżej przedstawiono opcje dotyczące wyłącznie wiadomości e-mail.+
  
 +Poniżej przedstawiono ustawienia niezależne od typu powiadomienia.
 ^Nazwa ^Opis ^Wartość domyślna ^Przykład^ ^Nazwa ^Opis ^Wartość domyślna ^Przykład^
-|mailfrom (wymagana)|Adres e-mail z którego zostanie wysłany e-mail. Proszę pamiętać, że na niektórych MTA (np. exim) konto to musi istnieć w systemie.|pusta|mailfrom = staff@domain.pl| +|mailfrom (wymagana dla kanału **mail**)|Adres e-mail z którego zostanie wysłany e-mail. Proszę pamiętać, że na niektórych MTA (np. exim) konto to musi istnieć w systemie.|pusta|mailfrom=info@firma.pl| 
-|mailfname|Nazwa nadawcy maila.|pusta|mailfname = Administratorzy| +|mailfname (opcjonalny)|Nazwa nadawcy maila.|pusta|mailfname=Administratorzy| 
-|smtp_host|Serwer SMTP, przez który ma zostać wysłana wiadomość.|localhost|smtp_host = smtp.mydomain.pl| +|smtp_host (opcjonalny)|Serwer SMTP, przez który ma zostać wysłana wiadomość.|pusty|smtp_host=smtp.firma.pl
-|smtp_auth|Sposób autoryzacji. Dozwolone wartości: LOGIN, PLAIN, CRAM-MD5, NTLM.|pusta (brak autoryzacji)|smtp_auth = LOGIN+|smtp_port (opcjonalny)|Port serwera SMTP|pusty|smtp_port = 25
-|smtp_user|Login do autoryzacji SMTP.|pusty|smtp_user = admin| +|smtp_auth (opcjonalny)|Sposób autoryzacji. Dozwolone wartości: LOGIN, PLAIN, CRAM-MD5, NTLM.|pusta|smtp_auth=PLAIN
-|smtp_pass|Hasło do konta zdefiniowanego w opcji smtp_user.|puste|smtp_pass = password| +|smtp_user (opcjonalny)|Login do autoryzacji SMTP.|pusty|smtp_user=admin| 
-|debug_email (opcjonalny)|Adres e-mail do debugowania. Gdy ustawiony, cała poczta zostaje wysłana na dany email zamiast do klientów. Przydatne do debugowania i sprawdzania czy wszystko działa OK.|nie ustawiony|debug_email = lexx@domain.pl|+|smtp_pass (opcjonalny)|Hasło do konta zdefiniowanego w opcji smtp_user.|puste|smtp_pass=password| 
 +|debug_email (opcjonalny)|Adres e-mail do debugowania. Gdy ustawiony, cała poczta zostaje wysłana na dany email zamiast do klientów. Przydatne do debugowania i sprawdzania czy wszystko działa OK.|nie ustawiony|debug_email=user@firma.pl| 
 +|service (opcjonalny)|Nazwa backendu sms, który ma być używany do wysyłki sms-ów|pusty|service=smstools| 
 +|debug_phone (opcjonalny)|Numer telefonu na który mają być wysyłane wszystkie sms-y (zamiast do klientów)|pusty|debug_phone=666666666| 
 + 
 +**Uwaga!** Brak ustawień **smtp_...** powoduje użycie ustawień z sekcji konfiguracyjnej **mail**.\\ Brak ustawienia **service** powoduje wysyłkę sms-ów w oparciu o domyślny backend sms-owy określony w sekcji konfiguracyjnej **sms**.
  
lms-notify.php.1454415102.txt.gz · ostatnio zmienione: 2016/02/02 13:11 przez chilek