Przejdź do głównej zawartości

Zmienne

Sprawdź w aplikacji

Zmienne to symbole zastępcze w szablonie, zapisywane w nawiasach klamrowych — {zmienna}. Podczas generowania dokumentu z szablonu każda zmienna jest zastępowana konkretną wartością. To właśnie dzięki temu jeden szablon służy do wielu dokumentów.

Zmienne użytkownika a systemowe​

TypKto uzupełniaPrzykład
Zmienna użytkownikaTy — wpisujesz ręcznie podczas generowania dokumentu{clientName}, {clientEmail}
Zmienna systemowaAplikacja — rozpoznawana po kluczu, uzupełniana automatycznie (część podajesz Ty){date.today}, {supplier.name}, {amount.total}

Każdy {klucz}, który nie jest znaną zmienną systemową, traktowany jest jako zmienna użytkownika. Edytor szablonu klasyfikuje zmienne automatycznie i wyświetla je w panelu bocznym (zob. Tworzenie szablonu).

Typy danych​

Każda zmienna ma typ danych, który określa sposób interpretacji wartości:

TypZnaczenie
STRINGTekst
DATEData w formacie RRRR-MM-DD
NUMBERWartość liczbowa (całkowita lub dziesiętna)
BOOLEANtrue / false

Zmienne systemowe — katalog​

Uzupełniane automatycznie​

Rozwiązywane przez aplikację podczas generowania dokumentu — nie wpisujesz ich.

ZmiennaTypWartość
{date.today}STRINGDzisiejsza data
{date.yesterday}STRINGWczorajsza data
{date.tomorrow}STRINGJutrzejsza data
{supplier.name}STRINGNazwa kontrahenta
{supplier.firstname}STRINGImię kontrahenta
{supplier.nip}STRINGNIP kontrahenta
{supplier.business}STRINGOznaczenie/typ działalności
{supplier.accountNumber}STRINGNumer rachunku bankowego
{supplier.email}STRINGE-mail
{supplier.phone}STRINGTelefon
{supplier.supplierAddress.city}STRINGAdres — miasto
{supplier.supplierAddress.street}STRINGAdres — ulica
{supplier.supplierAddress.postalCode}STRINGAdres — kod pocztowy
{supplier.supplierAddress.number}STRINGAdres — numer
{supplier.supplierAddress.country}STRINGAdres — kraj
supplier.* wymaga kontrahenta

Zmienne supplier.* są uzupełniane z kontrahenta, którego wybierzesz podczas generowania dokumentu. Kontrahentami zarządzasz w sekcji Kontrahenci.

Podajesz wartość​

Te zmienne systemowe są rozpoznawane przez aplikację, ale ich wartość wpisujesz podczas generowania dokumentu (razem ze zmiennymi użytkownika):

ZmiennaTyp
{date.start}DATE
{date.end}DATE
{date.payment_due}DATE
{amount.total}NUMBER
{status.external}STRING
{is.priority}BOOLEAN

Ekran „Zmienne systemowe”​

Aplikacja ma dedykowany ekran Zmienne systemowe — listę referencyjną wszystkich zmiennych systemowych, z czytelną etykietą i przyciskiem kopiowania dla każdego klucza. Otwórz go z pozycji Zmienne systemowe w menu bocznym.

Ekran Zmienne systemowe

Każda pozycja pokazuje czytelną etykietę (np. Dzisiejsza data, Kwota całkowita, NIP) oraz klucz wstawiany w szablonie (np. date.today, amount.total, supplier.nip). Kliknij ikonę kopiowania, aby skopiować {klucz} i wkleić go do edytora.

Jak zmienne są uzupełniane przy generowaniu dokumentu​

  1. Aplikacja skanuje szablon w poszukiwaniu zmiennych {...}.
  2. Dzieli je na:
    • uzupełniane automatycznie zmienne systemowe (daty, supplier.*) — wyliczane z bieżącej daty i wybranego kontrahenta;
    • do uzupełnienia — Twoje zmienne użytkownika oraz powyższe edytowalne zmienne systemowe — prezentowane jako formularz do wypełnienia.
  3. Dokument końcowy jest generowany z podstawionymi wszystkimi wartościami.

Zobacz też​

  • Tworzenie szablonu — dodawanie zmiennych w edytorze.
  • Kontrahenci — zarządzanie kontrahentami zasilającymi zmienne supplier.*.
notatka

Powyższy katalog zmiennych systemowych odzwierciedla aktualny backend (autodocuments-be). Wersja źródłowa jest odnotowana w planie dokumentacji.