Skip to main content
View Categories

Szablony w bs4 core

Szablony w bs4 core umożliwiają automatyzację tworzenia dokumentów oraz korespondencji z kontrahentami. Administrator może przygotować wcześniej wzory treści, które następnie są wykorzystywane przez użytkowników lub przez mechanizmy automatyzacji programu.

Za pomocą szablonów można między innymi:

  • przygotowywać wiadomości e-mail,
  • generować pisma do wydruku,
  • tworzyć pliki PDF,
  • generować dokumenty Word,
  • generować arkusze Excel,
  • wysyłać wiadomości SMS,
  • tworzyć dokumenty Google,
  • generować pliki tekstowe.

Szablon może mieć określoną szatę graficzną oraz zawierać dynamiczne znaczniki, nazywane również tagami. W momencie generowania dokumentu lub wiadomości znaczniki są zastępowane odpowiednimi danymi pobranymi z bazy bs4 core.

1.1. Przykładowe zastosowania szablonów #

Szablony mogą być wykorzystywane między innymi do przygotowywania:

  • ofert handlowych dla klientów,
  • odpowiedzi na zapytania klientów,
  • potwierdzeń przyjęcia reklamacji,
  • informacji o rozpatrzeniu reklamacji,
  • certyfikatów ukończenia szkolenia,
  • przypomnień o zbliżającym się terminie szkolenia.

Dzięki wykorzystaniu znaczników dynamicznych jeden szablon może być używany wielokrotnie, a dane właściwe dla konkretnego kontrahenta, dokumentu czy zlecenia są uzupełniane automatycznie.

1.2. Redagowanie treści przed wysłaniem #

Szablon może działać na dwa podstawowe sposoby.

1.2.1. Szablon z możliwością redagowania #

Po wygenerowaniu treści użytkownik może otrzymać edytor, w którym przed ostatecznym wysłaniem wiadomości, wydrukiem lub wygenerowaniem pliku może zmodyfikować treść.

Takie rozwiązanie jest przydatne, gdy większość dokumentu jest standardowa, ale w konkretnym przypadku użytkownik powinien mieć możliwość uzupełnienia lub zmiany wybranych informacji.

1.2.2. Szablon wykorzystywany automatycznie #

Szablon może być również używany bez dodatkowej ingerencji użytkownika.

W takim przypadku bs4 core generuje dokument, plik lub wiadomość automatycznie na podstawie wcześniej przygotowanego wzoru i danych znajdujących się w systemie.

Rozwiązanie to może być stosowane między innymi w procesach automatyzacyjnych.

2. Powiązanie szablonu z klasą obiektów #

Jeżeli szablon wykorzystuje dynamiczne znaczniki pobierające dane z bazy, musi być powiązany z odpowiednią klasą obiektów w bs4 core.

Podczas definiowania szablonu określa się, z jakiego rodzaju obiektem będą później powiązane generowane:

  • wiadomości,
  • pisma,
  • dokumenty,
  • pliki.

2.1. Przykład powiązania ze zleceniem serwisowym #

Jeżeli wiadomość e-mail generowana z szablonu ma zawierać dane konkretnego zlecenia serwisowego, podczas tworzenia szablonu należy wskazać, że jest on powiązany z klasą:

Zlecenie serwisowe

Dzięki temu w treści szablonu będzie można stosować znaczniki odwołujące się do danych konkretnego zlecenia serwisowego.

3. Typy szablonów #

bs4 core udostępnia kilka rodzajów szablonów przeznaczonych do różnych zastosowań.

3.1. E-mail #

Szablon typu e-mail służy do tworzenia formatowanych wiadomości.

Treść może być przygotowana w HTML, co pozwala między innymi na:

  • formatowanie tekstu,
  • zmianę wyglądu treści,
  • stosowanie kolorów,
  • osadzanie tabel,
  • dodawanie elementów graficznych.

Szablon stanowi wzór wiadomości, który podczas użycia jest uzupełniany danymi właściwymi dla konkretnego obiektu.

3.2. E-mail tekstowy #

Szablon typu e-mail tekstowy również służy do tworzenia wiadomości e-mail, jednak jego treść jest zapisywana jako zwykły tekst.

W tym przypadku nie są dostępne możliwości formatowania graficznego ani osadzania grafiki charakterystyczne dla wiadomości HTML.

3.3. Pismo #

Szablon typu pismo przeznaczony jest przede wszystkim do przygotowywania dokumentów, które mają zostać wydrukowane.

3.4. SMS #

Szablon typu SMS służy do przygotowywania wiadomości SMS.

Aby korzystać z takiego mechanizmu, bs4 core musi posiadać odpowiednią integrację pozwalającą na wysyłkę SMS, na przykład z wykorzystaniem bramki SMS API.

3.5. PDF #

Szablon typu PDF pozwala generować pliki PDF na podstawie zdefiniowanego wzoru.

Wygenerowany plik może następnie zostać pobrany z programu.

3.6. Word #

Szablon typu Word umożliwia tworzenie plików w formacie DOCX, kompatybilnych z programem Microsoft Word.

3.7. Excel #

Szablon typu Excel umożliwia generowanie plików XLSX.

Poszczególne komórki arkusza mogą być uzupełniane dynamicznymi danymi pobieranymi z bs4 core.

3.8. Google Docs #

Szablon typu Google Docs umożliwia tworzenie dokumentów Google i umieszczanie ich na Dysku Google przy wykorzystaniu zsynchronizowanego konta Google.

3.9. Plik tekstowy #

Szablon typu plik tekstowy pozwala generować pliki zawierające zwykły tekst.

Tego rodzaju szablony mogą być wykorzystywane do różnych celów konfiguracyjnych i technicznych. Przykładem może być przygotowywanie danych lub wytycznych przekazywanych do mechanizmów AI.

4. Dodawanie nowego szablonu #

Nowy szablon można utworzyć na dwa sposoby.

4.1. Dodawanie szablonu z kartoteki Administrator #

Aby utworzyć szablon z poziomu kartoteki Administrator:

  1. Przejdź do kartoteki Administrator.
  2. Otwórz zestawienie szablonów.
  3. Kliknij Dodaj nowe.
  4. Wskaż typ tworzonego szablonu.
  5. Podaj jego nazwę.
  6. Przejdź do ustawień i edycji utworzonego szablonu.

4.2. Dodawanie szablonu z poziomu klasy #

Szablon można również utworzyć bezpośrednio dla konkretnej klasy obiektów.

Przykładowo dla klasy Zlecenie serwisowe:

  1. Otwórz kartotekę klasy Zlecenie serwisowe.
  2. Przejdź do zakładki Szablony.
  3. Kliknij Dodaj nowy.
  4. Wybierz typ szablonu.
  5. Podaj jego nazwę.

W takim przypadku tworzony szablon zostanie domyślnie powiązany z klasą Zlecenie serwisowe.

Oznacza to, że będzie przygotowany do używania w kontekście konkretnego zlecenia i może korzystać z danych powiązanych z tym obiektem.

5. Edycja treści szablonu #

Sposób przygotowania treści zależy od typu szablonu.

5.1. Edytor drag and drop #

Dla szablonów wykorzystujących formatowaną treść dostępna jest zakładka:

Edytor → Edytor drag and drop

Znajduje się w niej główne pole służące do przygotowywania treści szablonu.

Edytor umożliwia między innymi:

  • wpisywanie i formatowanie tekstu,
  • zmianę czcionki,
  • stosowanie kolorów,
  • tworzenie tabel,
  • osadzanie grafik,
  • rozmieszczanie elementów treści.

Edytor tego rodzaju jest wykorzystywany między innymi przy szablonach typu e-mail oraz pismo.

Inne rodzaje szablonów mogą posiadać inne zakładki przeznaczone do przygotowania ich zawartości.

5.2. Dynamiczne znaczniki w edytorze #

Po prawej stronie edytora znajduje się lista dostępnych znaczników dynamicznych.

Znaczniki reprezentują informacje, które podczas generowania szablonu zostaną pobrane z odpowiednich obiektów znajdujących się w bazie bs4 core.

5.2.1. Dodawanie znacznika metodą drag and drop #

Aby umieścić znacznik w treści:

  1. Odszukaj odpowiedni znacznik na liście.
  2. Kliknij go lewym przyciskiem myszy.
  3. Przytrzymaj przycisk.
  4. Przeciągnij znacznik w odpowiednie miejsce treści.
  5. Zwolnij przycisk myszy.

Znacznik zostanie umieszczony w wybranym miejscu szablonu.

Szczegółowe informacje dotyczące dostępnych znaczników stanowią osobną część instrukcji.

5.3. Edycja kodu HTML #

W razie potrzeby można przejść z edycji wizualnej do bezpośredniej edycji kodu HTML szablonu.

Aby to zrobić, należy wśród ikon edytora wybrać opcję:

Zmień tryb

Po zmianie trybu można bezpośrednio modyfikować kod HTML odpowiadający za treść i wygląd szablonu.

6. Edycja szablonów tekstowych #

Szablony typu:

  • e-mail tekstowy,
  • SMS

są redagowane jako zwykły tekst.

6.1. Edytor tekstowy #

Do ich edycji służy zakładka:

Edytor tekstowy

Znajduje się w niej pole Treść, do którego można wprowadzić wielowierszową zawartość szablonu.

6.2. Wstawianie dynamicznych znaczników #

W edytorze tekstowym dostępna jest również lista znaczników.

Po wybraniu znacznika jego kod jest umieszczany bezpośrednio w treści.

Znacznik jest prezentowany w postaci kodu umieszczonego w nawiasach klamrowych. W transkrypcji podano przykładowo znacznik o ID 7582, którego zapis w treści ma postać odpowiadającą identyfikatorowi znacznika poprzedzonemu dwukropkiem i umieszczonemu w klamrach.

Podczas generowania właściwej wiadomości kod znacznika zostanie zastąpiony dynamiczną wartością.

7. Edycja szablonów plikowych #

Inaczej wygląda konfiguracja szablonów, które generują gotowe pliki, takich jak:

  • PDF,
  • Word,
  • Excel.

7.1. Plik wzorcowy #

W przypadku szablonu plikowego do edytora szablonu wgrywany jest plik wzorcowy.

Plik ten stanowi podstawę dokumentu, który będzie później generowany przez bs4 core.

8. Wykorzystanie zdefiniowanego szablonu w programie #

Po utworzeniu szablonu i przygotowaniu jego treści można wskazać go w różnych miejscach konfiguracji bs4 core.

Szablony mogą być wykorzystywane między innymi:

  • w menu kartoteki,
  • w formularzach,
  • w mechanizmach automatyzacji.

9. Szablony w menu kartoteki #

Jednym z najczęściej stosowanych rozwiązań jest dodanie do menu kartoteki strony pozwalającej użytkownikowi wygenerować treść na podstawie szablonu.

Przykładem może być menu kartoteki Zlecenie serwisowe.

9.1. Opcja „Redaguj z szablonu” #

Aby dodać możliwość przygotowania dokumentu lub wiadomości z możliwością późniejszej edycji:

  1. Otwórz ustawienia odpowiedniej kartoteki.
  2. Przejdź do jej edytora.
  3. Otwórz zakładkę Menu.
  4. Dodaj stronę typu Redaguj z szablonu.
  5. Otwórz konfigurację dodanej pozycji.
  6. Wskaż wcześniej utworzony szablon.

9.1.1. Działanie opcji #

Gdy użytkownik wybierze taką pozycję w kartotece, bs4 core wygeneruje treść na podstawie wskazanego szablonu i otworzy ją w edytorze.

Użytkownik będzie mógł zmienić treść przed wykonaniem ostatecznej operacji, na przykład:

  • wysłaniem e-maila,
  • wydrukiem pisma.

Zmiany dotyczą tylko konkretnego generowanego dokumentu lub wiadomości i nie oznaczają modyfikacji samego wzorca szablonu.

9.2. Opcja „Wydrukuj z szablonu” #

Drugim rozwiązaniem jest typ strony:

Wydrukuj z szablonu

Podczas jej konfiguracji również wskazuje się wcześniej przygotowany szablon.

Może to być między innymi szablon typu:

  • pismo,
  • PDF,
  • Word.

9.2.1. Działanie opcji #

Po wybraniu przez użytkownika tej pozycji program przechodzi bezpośrednio do:

  • drukowania gotowego pisma lub
  • pobrania wygenerowanego pliku.

W przeciwieństwie do opcji Redaguj z szablonu, użytkownik nie otrzymuje po drodze możliwości ręcznej zmiany treści.

10. Szablony jako elementy formularza #

Zdefiniowany szablon może być również wykorzystany bezpośrednio w formularzu.

10.1. Dodawanie elementu formularza #

Jeżeli w kartotece znajduje się strona typu formularz, administrator może dodać do niej odpowiedni element.

Dostępne są między innymi elementy typu:

  • Redaguj z szablonu,
  • Wydruk z szablonu.

10.2. Działanie elementów #

Dla użytkownika elementy te są prezentowane jako przyciski dostępne bezpośrednio w formularzu.

Ich działanie jest analogiczne do odpowiednich opcji znajdujących się w menu kartoteki.

10.2.1. Redaguj z szablonu #

Przycisk powoduje wygenerowanie treści z wybranego szablonu, a następnie przejście do edytora.

Użytkownik może przed wykonaniem końcowej operacji zmodyfikować wygenerowaną treść.

10.2.2. Wydruk z szablonu #

Przycisk powoduje bezpośrednie wygenerowanie wydruku lub pliku na podstawie wskazanego szablonu, bez dodatkowej edycji treści.

11. Szablony w automatyzacji #

Szablony mogą być również wykorzystywane w mechanizmach automatyzacyjnych bs4 core.

Jednym z takich miejsc są komendy triggera.

11.1. Automatyczne wysłanie wiadomości #

W konfiguracji triggera można wskazać, aby po spełnieniu odpowiednich warunków program automatycznie wysłał wiadomość e-mail przygotowaną na podstawie konkretnego szablonu.

Użytkownik nie musi w takim przypadku ręcznie rozpoczynać wysyłki.

11.2. Automatyczne generowanie pliku #

Trigger może również powodować automatyczne wygenerowanie pliku na podstawie wskazanego szablonu.

Pozwala to wykorzystywać ten sam mechanizm szablonów zarówno w operacjach wykonywanych ręcznie przez użytkowników, jak i w procesach realizowanych automatycznie przez system.

12. Podsumowanie #

Szablony w bs4 core pozwalają przygotować jeden wzór treści i wielokrotnie wykorzystywać go dla różnych obiektów znajdujących się w systemie.

Dzięki dynamicznym znacznikom dane mogą być automatycznie pobierane z bazy programu i podstawiane do odpowiednich miejsc dokumentu lub wiadomości.

W zależności od potrzeb szablon może:

  • umożliwiać użytkownikowi końcową edycję treści,
  • generować dokument bez możliwości jego redagowania,
  • być dostępny jako opcja menu kartoteki,
  • być dostępny jako przycisk na formularzu,
  • działać automatycznie w ramach triggera.

Różne typy szablonów pozwalają wykorzystać wspólny mechanizm bs4 core do tworzenia wiadomości e-mail, SMS-ów, pism, plików PDF, dokumentów Word, arkuszy Excel, dokumentów Google oraz plików tekstowych.

Leave a Reply