- 1.1. Powiązanie znacznika z klasą obiektów
- 2. Pobieranie danych z innych klas
- 3. Dodatkowe ustawienia znacznika
- 4. Znaczniki powiązane z polami tekstowymi
- 5. Sposób wyświetlania wartości
- 6. Znaczniki powiązane z polami liczbowymi
- 7. Sprawdzanie użycia znacznika w szablonach
- 8. Umieszczanie znacznika w szablonie
- 9. Inne rodzaje znaczników konfigurowane podobnie jak Pole
- 10. Podsumowanie
Znaczniki rodzaju Pole są najczęściej stosowanym typem znaczników w bs4 core. Służą do pobierania wartości z konkretnych pól obiektów i umieszczania ich między innymi w treści szablonów.
Każdy znacznik tego rodzaju jest powiązany z określoną klasą obiektów, a następnie z odpowiednim polem tej klasy.
1.1. Powiązanie znacznika z klasą obiektów #
Znacznik rodzaju Pole musi być powiązany z konkretną klasą obiektów.
Przykładowo, jeżeli znacznik jest powiązany z klasą Kontrahent, podczas jego konfiguracji można wskazać jedno z pól opisujących kontrahenta.
Znacznik może dzięki temu zwracać na przykład:
- nazwę kontrahenta,
- NIP,
- adres,
- inną informację zapisaną w polu obiektu klasy Kontrahent.
2. Pobieranie danych z innych klas #
Znacznik nie musi ograniczać się wyłącznie do pól klasy, z którą jest bezpośrednio powiązany.
Za pomocą ścieżki podzapytań i kluczy można przechodzić do powiązanych obiektów innych klas i pobierać wartości z ich pól.
2.1. Przykład przejścia między klasami #
Załóżmy, że znacznik jest pierwotnie powiązany z klasą Kontrahent, ale chcemy, aby zwracał nazwisko opiekuna tego kontrahenta.
Jeżeli opiekun jest obiektem innej klasy, na przykład klasy Użytkownik, można za pomocą odpowiedniej ścieżki przejść od kontrahenta do jego opiekuna, a następnie wskazać pole zawierające nazwisko użytkownika.
W efekcie znacznik powiązany pierwotnie z kontrahentem może zwrócić wartość pochodzącą z obiektu innej klasy.
2.2. Zasady przechodzenia między klasami #
Mechanizm przechodzenia pomiędzy klasami działa podobnie jak podczas konfiguracji:
- kolumn,
- filtrów.
Szczegółowe zasady tego mechanizmu zostały opisane w osobnej instrukcji dotyczącej przechodzenia między klasami i korzystania z podzapytań.
3. Dodatkowe ustawienia znacznika #
Zakres ustawień dostępnych w edytorze znacznika zależy od typu pola, z którym znacznik został powiązany.
Inne opcje będą dostępne dla pól tekstowych, a inne dla pól liczbowych.
4. Znaczniki powiązane z polami tekstowymi #
W przypadku pól tekstowych możliwe jest między innymi ograniczenie fragmentu tekstu zwracanego przez znacznik.
4.1. Określenie początku tekstu #
Można określić, od którego znaku ma zostać pobrana wartość.
Pozwala to pominąć początkową część zawartości pola i zwrócić tekst dopiero od wskazanej pozycji.
4.2. Ograniczenie długości tekstu #
Można również określić maksymalną długość zwracanego tekstu.
Pozwala to na przykład:
- pobrać wyłącznie pierwszych 10 znaków,
- rozpocząć pobieranie od wskazanego znaku,
- zwrócić wyłącznie określony fragment dłuższej wartości.
Funkcja jest przydatna, gdy w szablonie potrzebna jest tylko część tekstu przechowywanego w danym polu.
5. Sposób wyświetlania wartości #
Dla niektórych rodzajów pól można określić dodatkowy sposób prezentacji wartości zwracanej przez znacznik.
5.1. Wyświetlanie wartości jako kod QR #
Dla wybranych wartości tekstowych lub liczbowych można ustawić sposób wyświetlania, w którym zamiast zwykłego tekstu program zwróci obraz kodu QR zawierającego daną wartość.
Pozwala to wykorzystać dane zapisane w polach obiektu do automatycznego generowania kodów QR w szablonach.
6. Znaczniki powiązane z polami liczbowymi #
Dla znaczników korzystających z pól liczbowych dostępne są dodatkowe możliwości formatowania wartości.
6.1. Format liczby #
W konfiguracji można określić sposób prezentacji liczby, w tym liczbę wyświetlanych miejsc po przecinku.
Pozwala to ujednolicić sposób prezentowania wartości liczbowych w generowanych dokumentach.
6.2. Uzupełnianie zerami z przodu #
Wartość liczbowa może zostać uzupełniona zerami z lewej strony.
Funkcja może być przydatna przy generowaniu wartości o stałej długości, takich jak niektóre numery lub oznaczenia.
6.3. Prezentacja liczby słownie #
Wartość liczbowa może zostać przekształcona do postaci słownej.
Typowym zastosowaniem jest prezentacja kwoty słownie w generowanym dokumencie.
Zamiast wartości liczbowej znacznik zwróci jej odpowiednik zapisany słowami.
6.4. Konwersja liczby na godziny i minuty #
Liczbę można również skonwertować do postaci czasu wyrażonego w godzinach i minutach.
Przykładowo wartość:
3600
może zostać przedstawiona jako:
1 godzina 00 minut
Funkcja może być wykorzystywana w sytuacji, gdy wartość przechowywana w polu liczbowym reprezentuje czas, ale w dokumencie powinna zostać przedstawiona w bardziej czytelnej formie.
7. Sprawdzanie użycia znacznika w szablonach #
W kartotece znacznika znajduje się zakładka:
Użyty w szablonach
Zakładka pozwala sprawdzić, w których szablonach został wykorzystany aktualnie otwarty znacznik.
Jest to szczególnie przydatne przed zmianą konfiguracji istniejącego znacznika, ponieważ pozwala ustalić, na jakie szablony może wpłynąć dana modyfikacja.
8. Umieszczanie znacznika w szablonie #
Zdefiniowany znacznik można umieścić w treści szablonu na kilka sposobów.
8.1. Metoda drag and drop #
W edytorach obsługujących tę funkcję znacznik można przeciągnąć z listy dostępnych znaczników bezpośrednio do odpowiedniego miejsca w treści szablonu.
8.2. Ręczne wklejenie symbolu znacznika #
Nie w każdym przypadku dostępna jest metoda drag and drop. Wówczas można ręcznie skopiować kod znacznika.
W kartotece znacznika znajduje się pole:
Symbol znacznika do szablonu
Pole zawiera symbol znacznika zapisany w klamrach.
Aby użyć znacznika:
- Otwórz jego kartotekę.
- Odszukaj pole Symbol znacznika do szablonu.
- Skopiuj znajdujący się w nim symbol.
- Przejdź do edycji odpowiedniego szablonu.
- Wklej symbol w miejscu, w którym ma zostać podstawiona dynamiczna wartość.
Podczas generowania dokumentu bs4 core zastąpi symbol rzeczywistą wartością wynikającą z konfiguracji znacznika.
9. Inne rodzaje znaczników konfigurowane podobnie jak Pole #
W sposób zbliżony do znacznika rodzaju Pole konfigurowane są również znaczniki następujących rodzajów:
- Dane zalogowanego użytkownika,
- Dane osoby zalogowanej do portalu,
- Dane Twojej firmy.
9.1. Różnica w wyborze obiektu źródłowego #
W przypadku tych trzech rodzajów znaczników klasa obiektu wyjściowego jest określona z góry.
Administrator nie wskazuje dowolnego obiektu w taki sam sposób jak w przypadku standardowego znacznika rodzaju Pole. Obiekt źródłowy wynika z rodzaju znacznika.
9.1.1. Dane zalogowanego użytkownika #
Źródłem danych jest użytkownik aktualnie zalogowany do bs4 core.
Znacznik może więc pobierać wartości z pól opisujących tę osobę.
9.1.2. Dane osoby zalogowanej do portalu #
Źródłem danych jest osoba aktualnie zalogowana do skonfigurowanego portalu.
9.1.3. Dane Twojej firmy #
Źródłem danych jest główny dział reprezentujący firmę korzystającą z bs4 core.
10. Podsumowanie #
Znaczniki rodzaju Pole pozwalają dynamicznie pobierać wartości z pól obiektów i umieszczać je w szablonach oraz innych elementach konfiguracji bs4 core.
Podstawowa konfiguracja polega na:
- powiązaniu znacznika z klasą obiektów,
- wskazaniu odpowiedniego pola,
- opcjonalnym przejściu do pól powiązanych klas,
- skonfigurowaniu dodatkowego sposobu przetwarzania lub wyświetlania wartości.
W zależności od typu pola znacznik może między innymi:
- zwracać wybrany fragment tekstu,
- ograniczać długość tekstu,
- generować kod QR,
- formatować wartości liczbowe,
- uzupełniać liczby zerami,
- przedstawiać liczby słownie,
- konwertować wartości liczbowe na godziny i minuty.
W kartotece znacznika można również sprawdzić, w których szablonach jest on wykorzystywany, oraz skopiować jego symbol do ręcznego umieszczenia w treści szablonu.