Szablony maili w wersji 2016.1.3.x – formatowanie

WEBCON Autor Procesy
Facebooktwitterpinterestlinkedinmail
dotyczy wersji 2016.1.3.x; autor: Jacek Jezyk

Wstęp

Jedną z podstawowych funkcjonalności WEBCON BPS jest funkcjonalność wysyłania powiadomień e-mail z informacjami dotyczącymi stanu elementu w procesie, bieżącą wartością atrybutów lub też innym dowolnym tekstem będącym częścią wiadomości.

Kształt oraz zawartość maila definiowana jest przez Globalny szablon maila dostępny w Konfiguracji systemu w sekcji Powiadomienie e-mail WEBCON BPS Studio.

Szablon maila może być również zdefiniowany nienależnie dla każdego procesu. W takim przypadku w Konfiguracji procesu w sekcji Powiadomienia email należy stworzyć nowy szablon powiadomień e-mail i dostosować go do konkretnych potrzeb.

Szablon maila a zatem wysyłany do użytkowników e-mail, może zawierać dowolną treść tworzoną dynamicznie na bazie dostępnych w danym kontekście zmiennych (np. wartości atrybutów formularza), uzupełnioną stałymi elementami malia (np. logo, nagłówek maila czy tekst stopki). Swobodnie można również formatować treść wiadomości, zmieniając krój czcionki jej rozmiar czy kolor.

Dla użytkowników zaawansowanych dostępny jest tryb edycji HTML, który pozwala ingerować w kształt maila w na poziomie jego definicji HTML.

 

Predefiniowane elementy szablonu e-mail

Poza możliwością praktycznie dowolnego kształtowania szablonów e-mail, edytor szablonu pozwala skorzystać z elementów predefiniowanych, których zawartość jest narzucona przez system i nie może być zmieniana. Dostępne są one jako zmienne Szablonu email w oknie podpowiedzi edytora szablonu. W grupie Szablon email  dostępne są następujące zmienne:

 

Nazwa zmiennej reprezentującej predefiniowany elementu szablonu Opis zmiennej
[|HeaderMain|] Tytuł nagłówka – definiowany w zakładce „Nagłówek” globalnego szablonu maila lub w zakładce „Podstawowe” szablonu procesu
[|HeaderSub|] Treść nagłówka – definiowana w zakładce „Nagłówek” globalnego szablonu maila lub w zakładce „Podstawowe” szablonu procesu
[|TaskDetails|] Szczegóły zadania – treść ustawiana w zakładce „Tworzenie zadania” na ścieżce przejścia wybranego kroku
[|Recipients|] Lista oryginalnych odbiorców maila
[|ElementAddress|] Link do elementu dla którego wysyłana jest wiadomość
[|WebAddress|] Link do witryny
[|MessageBody|] Treść wiadomości – definiowana w zakładce „Nagłówek” globalnego szablonu maila lub w zakładce „Podstawowe” szablonu procesu
[|SystemFields|] Lista pól systemowych (sygnatura, autor, data utworzenia)
[|Formfields|] Lista atrybutów elementu dla którego wysyłana jest wiadomość

 

Zawartość predefiniowanych elementów szablonu e-mail jest stała, niemniej WEBCON BPS Studio od wersji 2016.1.3.x daje możliwość zmiany styli odpowiedzialnych za formatowanie tych części szablonu a co za tym idzie, do zmiany wyglądu elementów predefiniowanych.

Zmiana styli dla predefiniowanych elementów szablonu wymaga skorzystania z trybu HTML edycji szablonu i modyfikacji styli z poziomu kodu HTML.

 

Wbudowane style

Tryb edycji HTML szablonu maila pozwala operować bezpośrednio na kodzie HTML szablonu. W sekcji <style> nagłówka HTML opisującego wygląd szablonu maila zdefiniowane zostały style, bezpośrednio odpowiadające za wygląd predefiniowanych elementów szablonu:

  • BPS_NormalTable
  • BPS_Normal
  • BPS_NormalTitle
  • BPS_TaskDetail
  • BPS_ATT_TD
  • BPS_ATT_TD_Value
  • BPS_ATT_Name
  • BPS_ATT_Value
  • BPS_Button_Link.

 

Zmiana właściwości tych styli wpływa na wygląd predefiniowanych elementów szablonu. Między innymi:

  • szerokości (np. width: 100%)
  • rozmiaru czcionki (np. font-size: 10.0pt)
  • kroju czcionki (np. font-family: Arial; font-weight: bold)
  • koloru (np. color:#000000)
  • wyglądu obramowania i marginesów (np. border: none; padding: 0cm 5.4pt 0cm 5.4pt;)

 

Nie wymienione zostały tu wszystkie ustawienia z których można skorzystać tworząc definicję stylu. Pełną listę właściwości opisuje standard CSS dostępny na stronie http://www.w3schools.com/cssref.

 

Wpływ styli na wygląd predefiniowanych elementów szablonu e-mail

By wyjaśnić jaki wpływ mają konkretne style na poszczególne predefiniowane elementy szablonu e-mail posłużmy się domyślnym szablonem maila dostarczanym wraz ze standardową instalacją WEBCON BPS.

By skorzystać z domyślnego szablonu maila należy w konfiguracji systemu, w sekcji dotyczącej konfiguracji globalnego szablonu maila wybrać opcję „Przywróć domyślny”.

Po tej operacji wygląd i zawartość globalnego szablonu maila zostanie przywrócona do postaci, takiej jaką ma on tuż po instalacji systemu.

Przykładowy wygenerowany i wysłany z systemu e-mail bazujący na domyślnym szablonie będzie wyglądał tak jak na poniższym rysunku. Dodatkowo na rysunku zostały zaznaczone obszary odpowiadające poszczególnym elementom szablonu.

By precyzyjnie wskazać zależność pomiędzy konkretnym stylem a ostatecznym wyglądem maila przeanalizujmy każdy z jego elementów.

[|HeaderMain|]

Zmienna [|HeaderMain|] odpowiada wyłącznie za tekst tytułu nagłówka. Żaden z predefiniowanych styli nie wpływa na wygląd tej części maila.

[|HeaderSub|]

Zmienna [|HeaderSub|] odpowiada za tekst nagłówka. W domyślnym szablonie wygląd tekstu zależy od stylu BPS_Normal.

[|TaskDetails|]

Wygląd tej części maila kontrolowany jest przez styl BPS_TaskDetail, niemniej „nazwa kroku” zawsze wyświetlana jest czcionką pogrubioną i nie ma możliwości zmiany tego zachowania.

[|Recipients|]

 

Ta część maila wyświetlana jest w formie tabeli, zawiera listę oryginalnych odbiorców maila. Każdy wiersz tabeli składa się z nagłówka zawierającego opis adresata (formatowanego stylami  BPS_ATT_TD, BPS_ATT_Name) oraz wartości (formatowanej stylami BPS_ATT_TD_Value, BPS_ATT_Value).

[|ElementAddress|]

[|WebAddress|]

Zmienne [|ElementAddress|] oraz [|WebAddress|] odpowiadają za wyświetlenie linka do elementu w kontekście którego mail został wysłany oraz witryny. Format wyświetlanego tekstu definiowany jest przez styl BPS_Button_Link. Kształt prostokąta otaczającego tekst nie jest narzucony stylem i może być zmieniany bezpośrednio w definicji szablonu.

[|MessageBody|]

Zmienna [|MessageBody|] odpowiada za predefiniowaną treść wiadomości. W domyślnym szablonie wygląd tego tekstu zależy od stylu BPS_Normal.

 

[|SystemFields|]


Nazwy oraz wartości atrybutów systemowych wyświetlane są w formie tabeli. Każdy wiersz tabeli składa się z nagłówka zawierającego nazwę atrybutu (formatowanego stylami  BPS_ATT_TD, BPS_ATT_Name) oraz wartość atrybutu (formatowanej stylami BPS_ATT_TD_Value, BPS_ATT_Value). W przypadku atrybutu „Sygnatura” (widocznego na rysunku w pierwszym wierszu tabeli) wartość zawsze wyświetlana jest w postaci linku do elementu, pozostałe cechy tekstu zależą od styli stylami BPS_ATT_TD_Value oraz BPS_ATT_Value.

[|FormFields|]


W przypadku atrybutów stanowiących grupy (grupa lub zakładka) ich nazwy zawsze wyświetlane są czcionką pogrubioną, pozostałe cechy tekstu zależą od styli stylami BPS_ATT_TD oraz BPS_ATT_Name.

Nazwy oraz wartości atrybutów formularza wyświetlane są w formie tabeli. Każdy wiersz tabeli składa się z nagłówka zawierającego nazwę atrybutu (formatowanego stylami  BPS_ATT_TD, BPS_ATT_Name) oraz wartość atrybutu (formatowanej stylami BPS_ATT_TD_Value, BPS_ATT_Value).

W przypadku atrybutów znajdujących się wewnątrz grup ich tekst zawsze będzie wcięty w stosunku do tekstu grupy. Pozostałe cechy tekstu zależą od styli stylami BPS_ATT_TD oraz BPS_ATT_Name.

 

Sekcja MailApproval

Sekcja MailApproval nie jest bezpośrednio widoczna w szablonie maila, niemniej może być dodana przez system jako ostatni element treści maila. Widoczność sekcji MailApproval w mailu zależy od sposobu skonfigurowania dostępności konkretnych ścieżek poprzez mechanizm MailApproval. Konfiguracji tej dokonuje się dla kroku obiegu z którego wysyłane są wiadomości e-mail.

Mimo iż sekcja MailApproval nie jest dostępna w szablonie maila, w pewnej części również ona podlega zmianom i jest modyfikowalna poprzez zmianę definicji styli dla predefiniowanych elementów szablonu. Z tego powodu została ona ujęta w niniejszym opisie.

Format tekstu komend definiowany jest przez styl BPS_Button_Link. Format tekstu informacji zależy od stylu BPS_NormalTitle. Pozostałe elementy sekcji MailApproval są stałe i nie mogą być zmieniane.

Podsumowanie

Zmieniając definicję wbudowanych styli można w pewnym zakresie sterować wyglądem predefiniowanych elementów szablonu e-mail. Dokonując zmian styli należy brać pod uwagę, że taka zmiana będzie konsekwentna, to znaczy, będzie miała wpływ na wszystkie elementy korzystające z danego stylu.

Należy zaznaczyć, że poza predefiniowanymi elementami szablonu użytkownik ma pełną kontrolę i swobodę kształtowania wyglądu maila. Opisany przykład oparty był na szablonie domyślnym, niemniej nic nie stoi na przeszkodzie by uzupełnić go o dowolne elementy (tekst, grafika, tabele), zgodnie z konkretnymi potrzebami.