Dokumentacja: ClientDesk
ClientDesk to wtyczka CRM dla Redmine. Zarządza klientami, dealami i produktami w ramach projektu, łączy zgłoszenia z kontaktami i obsługuje pocztę bez osobnego CRM.
Interfejs CRM otwiera się wewnątrz strony Redmine. Otwarty klient, deal lub produkt jest zachowywany w adresie URL strony, więc możesz odświeżyć link lub udostępnić go współpracownikowi.
Kluczowe funkcje
Co jest dodawane do Redmine
- Moduł projektu „ClientDesk” oraz pozycja menu projektu ClientDesk.
- Menu górne i menu aplikacji. Pozycję ClientDesk można włączyć osobno. Otwiera CRM we wszystkich dostępnych projektach.
- Menu administracji. Pozycja ClientDesk otwiera ustawienia wtyczki.
- Issue. Pole kontaktu, karta klienta w panelu bocznym, odpowiedź do klienta, szablony, ocena i sugestia AI.
- Lista Issues. Dodatkowe kolumny i filtry dla kontaktu, firmy, kanału, czasu reakcji, czasu odpowiedzi, czasu rozwiązania i oceny.
- Wyszukiwanie Redmine. Pole wyboru Clientdesk wyszukuje klientów, deale i produkty.
- Pola niestandardowe dla klientów, dealów i produktów.
Klienci, deale i produkty
- Klienci — kontakty i firmy. Kontakt ma firmę, e-mail, telefon, adres, kraj, język, osobę przypisaną i notatki.
- Deale — status, kwota, waluta, termin, notatka oraz pozycje z katalogu.
- Produkty — towary, usługa lub subskrypcja, z cenami w różnych walutach.
- Subskrypcje — pozycje deala z okresem 1 miesiąc lub 1 rok. Karta pokazuje aktywne i wygasłe.
- Dashboard — podsumowanie klientów, dealów i produktów. Bloki zależą od uprawnień użytkownika.
- Dziennik zmian dla klienta, deala i produktu.
E-mail, odpowiedzi i ocena
- IMAP — skrzynki projektu. E-mail tworzy Issue lub komentarz do już otwartego Issue.
- SMTP — profile wychodzące. Projekt wybiera profil do odpowiedzi dla klienta.
- Szablony odpowiedzi z placeholderami dla nazwy klienta, numeru Issue i innych pól.
- Ocena zgłoszenia. Gdy Issue jest zamykane, autor może otrzymać e-mail z linkiem. Link otwiera się bez logowania do Redmine.
- Automatyczne zamykanie zgłoszeń po ustawionej liczbie godzin, z e-mailem do klienta.
- AI. Na stronie Issue możesz wygenerować odpowiedź na podstawie krótkiego promptu.
- Import z RedmineUp — kontakty, firmy, deale i produkty. Łączenie Issues z nowymi kontaktami to osobna akcja.
Dla kogo
- Wsparcie — zgłoszenia e-mail, odpowiedzi do klientów i oceny jakości.
- Sprzedaż — klienci, deale, katalog i subskrypcje.
- Administrator Redmine — statusy dealów, e-mail, szablony i import.
Kompatybilność
Redmine: 6.0 - 7.0
Bazy danych: MySQL, PostgreSQL, SQLite
REST web service musi być włączony w ustawieniach Redmine. W przeciwnym razie strona ustawień wtyczki pokazuje ostrzeżenie „Enable REST web service”.
Instalacja i aktualizacja
-
Usuń starą wersję wtyczki, jeśli jest zainstalowana.
cd redmine/plugins rm -r clientdesk -
Skopiuj folder
clientdeskdoredmine/plugins/. -
Uruchom migracje z katalogu głównego Redmine.
bundle exec rake redmine:plugins:migrate RAILS_ENV=production NAME=clientdesk -
Zatrzymaj i uruchom Redmine. W niektórych konfiguracjach, na przykład Docker, wymagane jest pełne zatrzymanie i uruchomienie, a nie restart.
Deinstalacja
-
Z katalogu głównego Redmine uruchom:
bundle exec rake redmine:plugins:migrate RAILS_ENV=production NAME=clientdesk VERSION=0 -
Usuń folder wtyczki.
cd redmine/plugins rm -r clientdesk -
Zatrzymaj i uruchom Redmine.
Konfiguracja
- Włącz REST web service w ustawieniach Redmine.
- Nadaj uprawnienia w Administration → Roles and permissions, sekcja ClientDesk.
- Włącz moduł ClientDesk w Project → Settings → Modules.
- Otwórz ustawienia wtyczki i utwórz statusy dealów.
- Jeśli potrzebne są odpowiedzi do klienta, utwórz profil SMTP i wybierz go w ustawieniach projektu.
- Jeśli potrzebna jest poczta przychodząca, dodaj skrzynkę IMAP i powiąż ją z projektem.
Administracja
Ustawienia wtyczki są dostępne dla administratora Redmine na dwa sposoby.
- Administration → Plugins → ClientDesk CRM plugin → Configure.
- Administration → ClientDesk.
Zakładka General
- Show in top menu — pozycja ClientDesk w górnym menu Redmine.
- Show in application menu — pozycja ClientDesk w menu aplikacji.
- Contact name format — „First Last”, „First Middle Last”, „Last First” lub „Last First Middle”.
- Default country for new contacts.
- Default language for new contacts.
- Available currencies — lista używana dla waluty deala i cen produktów.
- Automatically close requests after — liczba godzin. Zamykanie wykonuje zadanie w tle, patrz poniżej.
- Send an automatic email to the client — temat i treść e-maila zamykającego. Oba pola są wymagane, gdy opcja jest włączona.
Do tematu i treści e-maila zamykającego możesz wstawić: %{ticket.id}, %{ticket.subject}, %{ticket.project}, %{ticket.author.name}, %{ticket.author.email}, %{client.name}, %{ticket.status}.
Zakładka Mail
Lista skrzynek IMAP. Skrzynka jest powiązana z projektem.
Dla skrzynki ustawiasz host, port, nazwę użytkownika, hasło, metodę uwierzytelniania, zabezpieczenie połączenia i weryfikację SSL. Następnie ustawiasz folder IMAP, folder dla pomyślnie przetworzonych wiadomości oraz folder dla nieudanych wiadomości.
Reguły tworzenia Issue:
- tracker i status nowego Issue;
- Create contacts — nowy kontakt dla nieznanego nadawcy;
- Use issue number from the subject — jeśli temat zawiera numer otwartego Issue, e-mail staje się komentarzem zamiast nowego Issue;
- Sender blacklist — jeden wzorzec na linię; dozwolone są wyrażenia regularne.
Przycisk „Test connection” pokazuje folder, liczbę wiadomości i liczbę nowych wiadomości.
Zakładka SMTP
Profile wychodzące: host, port, konto, hasło, zabezpieczenie połączenia i adres nadawcy. Jeden profil można oznaczyć jako domyślny. W projekcie możesz wybrać ten profil, inny profil lub wspólne ustawienia e-mail Redmine.
Zakładka Deal statuses
Wspólny katalog dla wszystkich projektów. Status ma nazwę, kolor, flagę aktywności i typ: Open, Won lub Lost. Kolejność zmienia się przez przeciąganie wierszy. Statusu już użytego w dealu nie można usunąć.
Zakładka Reply templates
Szablon to nazwa i tekst. Do tekstu można wstawić pola klienta, Issue i autora odpowiedzi:
%{client.name}, %{client.first_name}, %{client.last_name}, %{client.email}, %{ticket.id}, %{ticket.subject}, %{ticket.project}, %{ticket.tracker}, %{ticket.status}, %{response.author}, %{response.author.first_name}, %{response.author.last_name}.
Na stronie Issue szablon wybiera się z listy „Insert template”. Wymaga to uprawnienia do edycji Issue oraz uprawnienia do przeglądania klientów.
Zakładka Communications
Dziennik wiadomości przychodzących i wychodzących. Pokazuje, które e-maile już utworzyły Issue lub komentarz, aby ten sam e-mail nie był przetwarzany dwa razy. Ta zakładka nie ma przycisku zapisu ustawień.
Zakładka AI
Adres usługi, którą wtyczka wywołuje w celu wygenerowania odpowiedzi. Zachowanie na stronie Issue włącza się w ustawieniach projektu.
Zakładka Request rating
Wspólny szablon e-maila z prośbą o ocenę zgłoszenia. Pole wyboru „When closing an issue, ask the author for a rating” włącza szablon. Temat i treść są wymagane.
Poniżej znajduje się tabela projektów z modułem ClientDesk. Dla każdego projektu wybierz tryb: Disabled, Use admin template lub Project template. Tryb szablonu administratora jest dostępny, gdy wspólny szablon jest wypełniony i włączony.
Na tej zakładce zmienne szablonu używają nawiasów klamrowych: {%ticket.id%}, {%ticket.subject%}, {%ticket.project%}, {%ticket.author.name%}, {%ticket.author.email%}, {%client.name%}, {%vote.url%}.
Zakładka Import
Trzy akcje, tylko dla administratorów.
- Import from RedmineUp — tworzy kontakty, deale i produkty. Issues nie są łączone na tym etapie.
- Link issues to new contacts — pobiera powiązania z helpdesk dla już zaimportowanych klientów. Issue, które już ma kontakt ClientDesk, jest pomijane.
- Delete all — trwale usuwa kontakty, firmy, deale, produkty, notatki i powiązania Issues. Statusy dealów, skrzynki i szablony pozostają.
Jeśli w bazie danych brakuje tabel RedmineUp, import zgłasza to i nic nie tworzy.
Role i uprawnienia
W sekcji ClientDesk:
- View clients — lista i karta klienta, notatki, wyszukiwanie, pole kontaktu w Issue.
- Manage clients — tworzenie, edycja i usuwanie klientów oraz notatek; tworzenie kontaktu z karty Issue.
- View deals — deale i subskrypcje.
- Manage deals — tworzenie, edycja i usuwanie dealów.
- View products — katalog.
- Manage products — tworzenie, edycja i usuwanie produktów.
Uprawnienie Manage nie obejmuje uprawnienia View. Nadaj je osobno.
Pozycja menu ClientDesk jest widoczna, gdy moduł jest włączony i istnieje co najmniej jedno uprawnienie View: klientów, dealów lub produktów. Zakładki w CRM są pokazywane zgodnie z ich uprawnieniami.
Ustawienia e-mail projektu zmienia użytkownik z uprawnieniem do edycji projektu. Uprawnienia CRM nie są do tego wymagane.
Zadania w tle
Pobieranie poczty można uruchomić ręcznie z ustawień projektu. Do harmonogramu, z katalogu głównego Redmine:
bundle exec rake clientdesk:fetch_mail
Automatyczne zamykanie zgłoszeń działa tylko z tą komendą:
bundle exec rake clientdesk:auto_close_issues
Ustawienia projektu
Project → Settings → ClientDesk.
IMAP
Lista skrzynek przychodzących dla tego projektu. Projekt może mieć kilka skrzynek. Stąd możesz też uruchomić „Test connection” i „Fetch mail”.
Po pobraniu strona pokazuje, ile e-maili zostało przetworzonych, ile Issues utworzono i ile komentarzy dodano.
SMTP
Profil wychodzący do odpowiedzi dla klientów. Jeśli żaden profil nie jest wybrany, odpowiedź pokazuje ostrzeżenie: ustaw SMTP w Settings → ClientDesk → Mail.
Feedback
When closing an issue, ask the author for a rating:
- Disabled;
- Use admin template;
- Project template — własny temat i treść. Oba pola są wymagane.
Placeholdery szablonu projektu: %{ticket.id}, %{ticket.subject}, %{ticket.project}, %{ticket.author.name}, %{ticket.author.email}, %{client.name}, %{vote.url}.
Ustawienia AI
- Enable AI suggestions for client replies oraz prompt systemowy.
- Enable a prefilled prompt for clients oraz tekst tego promptu.
Użytkowanie
Otwieranie CRM
Project → ClientDesk.
Zakładki:
- Dashboard — liczniki klientów, dealów i produktów. Przy uprawnieniu do dealów pokazywane są też sumy walutowe i subskrypcje.
- Clients.
- Deals.
- Products.
Nagłówek CRM ma wyszukiwanie po klientach, dealach i produktach w bieżącym kontekście. Listy można filtrować i zapisywać jako zapytanie.
Pozycja w menu górnym lub menu aplikacji otwiera ten sam CRM bez powiązania z jednym projektem. Listy obejmują rekordy z projektów, w których moduł jest włączony i istnieje uprawnienie View.
Klienci
Filtr listy: All, Contacts, Companies.
Karta klienta pokazuje dane kontaktowe, powiązane deale, Issues, notatki i pola niestandardowe. Dla kontaktu możesz utworzyć firmę bezpośrednio w polu firmy. Karta firmy pokazuje jej kontakty.
Główne pola kontaktu: imię, drugie imię, nazwisko, e-mail, telefon, stanowisko, firma, urodziny, adres, miasto, region, kraj, język, strona WWW, NIP, źródło, osoba przypisana oraz „Do not contact”. Dla firmy — nazwa, branża i wielkość firmy.
Pliki można dołączać do klienta przez pola niestandardowe typu „file”. Dziennik pokazuje, kto i kiedy zmienił rekord.
Klient należy do projektu głównego. Można go też udostępnić w innych projektach: projektach nadrzędnych i podrzędnych względem głównego, we wszystkich projektach lub na liście „Additionally available in projects”. Powiązanie Issue lub e-maila z projektem klienta samo w sobie nie dodaje klienta do tego projektu.
Jeśli przy tworzeniu kontaktu e-mail już istnieje, wtyczka nie tworzy drugiej karty. Proponuje otwarcie istniejącego kontaktu, dodanie projektu do widoczności lub zmianę projektu głównego. Dostępne akcje zależą od uprawnień.
„Remove from project” ukrywa klienta w bieżącym projekcie i pozostawia go w głównym. Usuwanie karty odbywa się w projekcie głównym. Klienta powiązanego z Issues lub dealami nie można usunąć.
Deale i subskrypcje
Deal jest powiązany z klientem i projektem. Ma nazwę, status, kwotę, walutę, termin, notatkę i pozycje. Pozycja to produkt, ilość, cena i numer kolejny. Produkt pochodzi z katalogu wybranego projektu. Cena używa waluty deala.
Z karty klienta możesz utworzyć deal z już wybranym klientem. Deal można przenieść do innego projektu, jeśli w obu projektach istnieje uprawnienie Manage deals, a klient jest tam widoczny.
Subskrypcja to produkt typu „Subscription” z okresem 1 month lub 1 year. Data rozpoczęcia jest ustawiana w dealu; data zakończenia jest obliczana z okresu. Jeśli termin deala nie pokrywa się z datami zakończenia subskrypcji, wtyczka proponuje zastąpienie terminu.
Na stronie Issue najechanie na nazwę kontaktu otwiera kartę: nazwa, e-mail, deale i subskrypcje. Aktywne i wygasłe subskrypcje są pokazywane osobno. Jeśli kontakt ma firmę, karta pokazuje też jej deale. Deale innych kontaktów tej firmy są zgrupowane pod „Other deals”.
Produkty
Katalog projektu. Typ produktu: Goods, Service lub Subscription. Subskrypcja wymaga okresu. Produkt ma nazwę, opis, SKU i ceny. Walutę ceny wybiera się z „Available currencies”.
Produktu już użytego w dealu nie można usunąć. Karta produktu pokazuje deale, w których jest używany.
Issues
Jeśli moduł jest włączony i istnieje uprawnienie „View clients”:
- W formularzu Issue znajdź pole kontaktu i zacznij wpisywać nazwę. Wyszukiwanie zaczyna się po dwóch znakach.
- Wybierz kontakt i zapisz Issue.
- Na stronie Issue kontakt jest pokazywany w bloku oraz na karcie w panelu bocznym. Możesz zmienić lub wyczyścić kartę bez otwierania CRM.
- Z uprawnieniem „Manage clients” możesz utworzyć kontakt z tej karty.
Issue ma jeden bieżący kontakt. Zmiana kontaktu jest zapisywana w historii zgłoszenia.
Do listy Issues możesz dodać kolumny i filtry: kontakt, firma kontaktu, kanał zgłoszenia, czas pierwszej reakcji, czas pierwszej odpowiedzi, czas rozwiązania, ocena klienta, ostatnia wiadomość i jej data. Kanały: e-mail, telefon, czat, API. Wybrane kolumny są uwzględniane w eksporcie listy Issues.
Odpowiedź do klienta
W komentarzu do Issue z kontaktem jest „Reply to client”. Możesz ustawić To, Cc i Bcc. E-mail jest wysyłany przez SMTP projektu. Dziennik Issue odnotowuje, że wysłano odpowiedź. Odpowiedź klienta z e-maila przychodzi jako komentarz i jest oznaczona jako odpowiedź klienta.
Nad polem komentarza jest „write a reply with AI”, jeśli sugestie są włączone w projekcie. Krótki prompt i dane Issue są wysyłane do usługi AI; wynikowy tekst trafia do pola komentarza.
Ocena zgłoszenia
Jeśli oceny zgłoszeń są włączone w projekcie, gdy Issue jest zamykane, autor otrzymuje e-mail z linkiem. Strona oceny otwiera się bez logowania. Oceny: Excellent, Normal, Poor. Komentarz jest opcjonalny. Zapisywana jest najnowsza ocena. Jest widoczna w Issue oraz w kolumnie listy Issues.
Wyszukiwanie Redmine
Na stronie wyszukiwania oraz w szybkim wyszukiwaniu w nagłówku jest pole wyboru Clientdesk. Wyszukuje klientów, deale i produkty jako jedną grupę. Licznik Clientdesk (N) pozostawia tylko te wyniki.
W jednym projekcie pole wyboru jest pokazywane, gdy moduł jest włączony i istnieje uprawnienie View. Przy wyszukiwaniu w wielu projektach pole wyboru jest zawsze widoczne, ale rekordy z niedostępnych projektów nie są zwracane.
Wyszukiwanie obejmuje nazwę, tytuł, e-mail, telefon, stanowisko, stronę WWW, NIP, nazwę i notatkę deala, opis produktu oraz pola niestandardowe oznaczone „Searchable”. Notatki i załączniki nie są przeszukiwane. „Search titles only” ogranicza wynik do nazw i tytułów.
Link wyniku otwiera kartę w CRM.
Często zadawane pytania
Dlaczego brakuje menu ClientDesk?
Sprawdź trzy warunki.
- Moduł ClientDesk jest włączony w projekcie.
- Rola ma co najmniej „View clients”, „View deals” lub „View products”.
- Dla pozycji poza projektem włączone jest „Show in top menu” lub „Show in application menu”, a to samo uprawnienie View istnieje w co najmniej jednym projekcie.
Dlaczego strona ustawień mówi „Enable REST web service”?
CRM działa przez Redmine REST API. Włącz usługę w Administration → Settings → API.
Czy mogę zaimportować dane CRM i od razu powiązać Issues?
Nie. Najpierw „Import from RedmineUp”, przejrzyj karty, potem „Link issues to new contacts”. Jeśli import się nie powiódł, „Delete all” czyści zaimportowane dane i nie dotyka statusów, poczty ani szablonów.
Dlaczego e-mail nie stał się nowym Issue?
Jeśli temat zawiera numer już otwartego Issue i włączone jest „Use issue number from the subject”, e-mail jest dodawany jako komentarz. E-mail z czarnej listy nie tworzy Issue. Powtórzony e-mail jest widoczny na zakładce „Communications”.
Kto może zobaczyć ocenę klienta?
Autor zgłoszenia ustawia ocenę przez link w e-mailu. W Redmine jest ona widoczna w Issue oraz w kolumnie listy Issues dla użytkowników, którzy mają dostęp do Issue.