Znaczniki w bs4 core służą do dynamicznego pobierania danych i umieszczania ich w treściach generowanych przez program.

Najczęściej wykorzystuje się je w szablonach. Podczas redagowania pisma, wiadomości e-mail lub innego dokumentu znacznik umieszczony w szablonie jest automatycznie zastępowany odpowiednią wartością pobraną z bazy danych.

Dzięki temu jeden szablon może być wielokrotnie wykorzystywany dla różnych obiektów, a właściwe dane są uzupełniane automatycznie.

1.1. Zastosowanie znaczników #

Podstawowym zastosowaniem znaczników jest wykorzystanie ich w edytorze szablonów.

Znaczniki mogą być jednak stosowane również w innych elementach bs4 core, między innymi:

• w elementach formularzy,
• w komendach triggerów.

Sposób działania znacznika zależy od jego rodzaju i konfiguracji.

2. Rodzaje znaczników #

bs4 core udostępnia różne rodzaje znaczników. Poszczególne typy różnią się przede wszystkim źródłem danych, z którego pobierają wartość, oraz sposobem działania.

2.1. Pole #

Najczęściej wykorzystywanym rodzajem znacznika jest Pole.

Znacznik tego rodzaju zwraca wartość konkretnego pola opisującego obiekt określonej klasy.

Może to być na przykład:

• numer zlecenia serwisowego,
• nazwa kontrahenta,
• rodzaj oferty.

2.1.1. Powiązanie znacznika z klasą #

Znacznik rodzaju Pole musi być powiązany z konkretną klasą obiektów.

Przykładowo, jeżeli znacznik jest powiązany z klasą Zlecenie serwisowe, może zwracać wartości pól opisujących zlecenie serwisowe.

Taki znacznik może następnie zostać użyty w szablonach powiązanych z tą samą klasą obiektów.

Przykładowo szablon powiązany ze zleceniem serwisowym może zawierać znaczniki zwracające:

• numer zlecenia,
• status,
• dane kontrahenta,
• inne pola opisujące konkretne zlecenie.

Szczegółowe definiowanie znaczników rodzaju Pole zostało przewidziane jako osobna część instrukcji.

2.2. Dane zalogowanego użytkownika #

Rodzaj Dane zalogowanego użytkownika działa podobnie do znacznika typu Pole, ale jego źródłem są dane osoby aktualnie zalogowanej do bs4 core.

Znacznik może zwracać między innymi:

• imię,
• nazwisko,
• login,
• stanowisko,
• inne pola opisujące użytkownika programu.

2.2.1. Przykładowe zastosowanie #

Znaczniki tego rodzaju są szczególnie przydatne w treściach, które powinny zawierać dane osoby wykonującej daną operację.

Mogą być wykorzystywane na przykład do automatycznego przygotowania:

• podpisu lub stopki wiadomości e-mail,
• informacji o autorze pisma,
• danych osoby redagującej dokument.

Jeżeli szablon zostanie użyty przez różnych użytkowników, bs4 core każdorazowo pobierze dane osoby aktualnie zalogowanej.

2.3. Dane Twojej firmy #

Znaczniki rodzaju Dane Twojej firmy zwracają informacje opisujące firmę korzystającą z bs4 core.

Źródłem tych informacji są dane głównego działu zdefiniowanego w kartotece Administrator.

Za pomocą takich znaczników można pobierać między innymi:

• nazwę firmy,
• ulicę i inne elementy adresu,
• NIP,
• numer rachunku bankowego.

2.3.1. Automatyczna aktualizacja danych #

Wartość nie jest wpisywana na stałe do szablonu.

Znacznik każdorazowo pobiera aktualną informację z odpowiedniego pola. Jeżeli dane firmy zostaną w przyszłości zmienione w systemie, generowane dokumenty będą automatycznie korzystać z nowych wartości.

Dzięki temu nie trzeba aktualizować każdego szablonu osobno.

2.4. Dane osoby zalogowanej do portalu #

Jeżeli w bs4 core został skonfigurowany portal dla klientów, można korzystać ze znaczników rodzaju Dane osoby zalogowanej do portalu.

Znaczniki te zwracają wartości pól opisujących osobę aktualnie zalogowaną do portalu.

2.4.1. Przykład #

Jeżeli do portalu zalogował się Jan Kowalski, znacznik może zwrócić na przykład jego nazwisko.

Dane są pobierane w sytuacji, gdy treść z szablonu generowana jest w portalu w kontekście aktualnie zalogowanej osoby.

2.5. Data, czas, teraz #

Rodzaj znacznika Data, czas, teraz służy do pobierania bieżącej daty lub czasu.

Podczas konfiguracji można określić format, w jakim wartość ma zostać przedstawiona.

Znacznik może być wykorzystywany wszędzie tam, gdzie dokument powinien automatycznie zawierać datę lub godzinę jego wygenerowania.

2.6. Link mailowy #

Znaczniki rodzaju Link mailowy są przeznaczone do stosowania w wiadomościach e-mail.

Ich wartość jest generowana w momencie wysyłania wiadomości z bs4 core.

Pozwalają tworzyć w wiadomości klikalne linki, których użycie powoduje wykonanie określonej akcji w programie.

2.6.1. Powiązanie z akcją w bs4 core #

Kliknięcie linku przez odbiorcę wiadomości może uruchomić odpowiednio skonfigurowaną operację.

Najczęściej będzie to trigger zdefiniowany w bs4 core.

Pozwala to tworzyć wiadomości zawierające dynamiczne odnośniki, których kliknięcie przez klienta lub inną osobę może powodować określone działanie po stronie systemu.

2.7. Wartość z triggera #

Znacznik rodzaju Wartość z triggera umożliwia umieszczenie w treści wartości obliczonej lub przygotowanej przez trigger.

Podczas generowania pisma lub wiadomości:

1. bs4 core uruchamia trigger wskazany w konfiguracji znacznika.
2. Trigger działa w kontekście tego samego obiektu, z którym powiązany jest generowany szablon.
3. Ostatnia komenda triggera powinna zwrócić konkretną wartość.
4. Zwrócona wartość jest podstawiana w miejsce znacznika.

2.7.1. Zastosowanie #

Mechanizm ten pozwala umieszczać w szablonach wartości, których nie można pobrać bezpośrednio z pojedynczego pola, lecz które wymagają wykonania dodatkowej logiki w triggerze.

2.8. Zestawienie #

Znacznik rodzaju Zestawienie pozwala umieścić w generowanej treści tabelę przygotowaną na podstawie skonfigurowanego zestawienia.

Przykładowe zastosowania to:

• tabela pozycji znajdujących się w ofercie,
• zestawienie otwartych zleceń serwisowych,
• zestawienie przeterminowanych faktur.

Szczegółowa konfiguracja tego rodzaju znacznika jest omawiana w dalszej części instrukcji.

3. Dodawanie nowych znaczników #

Nowe znaczniki można tworzyć na dwa sposoby:

• z poziomu kartoteki Administrator,
• bezpośrednio z poziomu konkretnej klasy.

3.1. Dodawanie znacznika z kartoteki Administrator #

Aby dodać znacznik z poziomu administracyjnego:

1. Przejdź do kartoteki Administrator.
2. Otwórz zestawienie Znaczniki.
3. Wybierz opcję dodania nowego znacznika.
4. Wskaż rodzaj znacznika.
5. Przejdź do jego konfiguracji.

Po wybraniu rodzaju bs4 core otwiera odpowiedni edytor znacznika.

Zakres dostępnych ustawień może być różny w zależności od wybranego rodzaju.

3.2. Dodawanie znacznika z poziomu klasy #

Znacznik można utworzyć również bezpośrednio dla konkretnej klasy.

W tym celu:

1. Otwórz kartotekę wybranej klasy.
2. Przejdź do zakładki Znaczniki.
3. Kliknij Dodaj nowe.
4. Wybierz rodzaj znacznika.
5. Skonfiguruj jego ustawienia.

3.2.1. Automatyczne powiązanie z klasą #

Jeżeli znacznik zostanie utworzony z poziomu konkretnej klasy, zostanie domyślnie powiązany właśnie z tą klasą.

Przykładowo znacznik utworzony z poziomu klasy Zlecenie serwisowe zostanie przygotowany do pracy w kontekście obiektów tej klasy.

4. Wykorzystanie znacznika w szablonie #

Po zdefiniowaniu znacznika można umieszczać go w wybranych szablonach.

W treści szablonu znacznik nie jest prezentowany jako ostateczna wartość. Zamiast tego widoczny jest jego specjalny kod.

Podczas generowania właściwej treści kod zostanie zastąpiony wartością wynikającą z konfiguracji znacznika.

4.1. Budowa kodu znacznika #

Znacznik znajdujący się w szablonie jest oznaczony:

• klamrą otwierającą,
• dwukropkiem,
• numerycznym identyfikatorem znacznika,
• klamrą zamykającą.

Schemat można przedstawić następująco:

{:ID_ZNACZNIKA}

gdzie ID_ZNACZNIKA jest numerycznym identyfikatorem konkretnego znacznika zdefiniowanego w bs4 core.

5. Zasady edycji znaczników w szablonie #

Kod znacznika umieszczony w szablonie powinien być traktowany jako jeden, niepodzielny element.

5.1. Nie należy zmieniać zawartości znacznika #

Nie należy ręcznie ingerować w tekst znajdujący się pomiędzy klamrą otwierającą a zamykającą.

Zmiana identyfikatora lub struktury znacznika może spowodować, że bs4 core nie rozpozna go prawidłowo podczas generowania dokumentu.

5.2. Jednolite formatowanie znacznika #

Cały kod znacznika — od klamry otwierającej do klamry zamykającej — powinien mieć jednolite formatowanie.

Nie należy wewnątrz znacznika:

• zmieniać kroju czcionki,
• stosować różnych rozmiarów tekstu,
• zmieniać kolorów poszczególnych fragmentów,
• stosować częściowego formatowania.

Kod musi pozostać spójny jako jeden element.

Ma to znaczenie szczególnie w edytorach formatowanego tekstu, gdzie przypadkowa zmiana stylu tylko fragmentu znacznika może spowodować problemy z jego późniejszym rozpoznaniem.

6. Podsumowanie #

Znaczniki są mechanizmem pozwalającym na dynamiczne uzupełnianie treści generowanych przez bs4 core.

W zależności od rodzaju mogą pobierać:

• wartości pól obiektów,
• dane zalogowanego użytkownika,
• dane firmy korzystającej z bs4 core,
• dane użytkownika portalu,
• bieżącą datę lub czas,
• wartość wyliczoną przez trigger,
• dane w postaci zestawienia.

Mogą również tworzyć specjalne linki używane w wiadomościach e-mail.

Najczęściej znaczniki są wykorzystywane w szablonach dokumentów i wiadomości. Po umieszczeniu w szablonie są reprezentowane przez kod zawierający ich numeryczny identyfikator, a podczas generowania treści kod ten jest zastępowany właściwą wartością.

Przy edycji szablonów należy pamiętać, aby nie modyfikować ręcznie zawartości kodu znacznika ani nie stosować różnego formatowania w jego obrębie.