Versions Compared

Old Version 37

changes.mady.by.user Agnieszka Bochenek

Saved on

compared with

New Version Current

changes.mady.by.user Joanna Jankowiak

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Image Added

 

Polish

← Powrót do listy dostępnych zadań automatycznych

Info

...

Jeśli masz problem ze zrozumieniem jak działa zadanie automatyczne, sprawdź opisy: Zadanie automatyczne, Wykonanie warunkowe, Parametry komponentów

Instrukcja tworzenia szablonu: Szablony dokumentów 

Panel
titlePodstawowe informacje

Poprzednie nazwy: Generowanie dokumentu (do wersji 1.0.33)

Kategoria: Dokumenty

Panel
titleOpis

Generuje dokument z podanego szablonu na podstawie aktualnych danych procesu. Przygotowanie szablonu dokumentu zostało opisane na stronie: Szablon DOCX do generowania PDF. Szablony w formacie *.doc nie są obsługiwane. Dokument może zostać dołączony do procesu w którym zostało wywołane zadanie automatyczne. Istnieje możliwość ustawienia własnej nazwy dla dokumentu i wybrania jednego z dwóch typów - PDF lub DOCX. Komponent pozwala na ustawienie wartości zmiennych w szablonie przy użyciu mapowania. Jeżeli zmienne w szablonie mają już odpowiadające im zmienne na formularzu, to przy użyciu tego komponentu możemy nadpisać te mapowania.

Panel
titleParametry konfiguracyjne
Nazwa parametruOd wersjiOpisTyp parametruWartość domyślnaRodzaj polaUwagi i ograniczenia
Format*1.0.11Format pliku, w jakim zostanie wygenerowany dokument.TekstPDF

...

Lista rozwijalnaWartości do wyboru: PDF, DOCX
Klasa dokumentów*1.0.11Nazwa klasy dokumentów, do której dodany zostanie wygenerowany dokument. Uwaga - w parametrze musi znaleźć się oryginalna nazwa klasy dokumentów, gdyż tłumaczenia nie są obsługiwane.
Tekst 

...

Lista rozwijalna

Wartości do wyboru: <nazwy klas dokumentów dostępnych w systemie>

Można wpisać własną nazwę, ale jeżeli komponent nie znajdzie klasy w systemie to wyrzuca informację o błędzie.

...

Jeżeli nie znajdzie szablonu w systemie komponent wyrzuca informację o błędzie.

Źródło szablonu*1.0.

...

Parametr*- pole wymagane

Przykładowa konfiguracja

Prosta konfiguracja (bez mappingów i z automatycznie generowaną nazwą):

Image Removed

Zaawansowana konfiguracja:

Image Removed

Przykład zastosowania

Expand
titlePrzykład 1
Panel
borderWidth1
borderStylesolid
titlePrzykład

Niech naszą potrzebą będzie wygenerowanie faktury przy użyciu wartości pobranych z systemu Plusworkflow.

Przygotowanie szablonu dokumentu

W tym celu należy przygotować szablon, który umieścimy w naszym procesie faktur. Dokładny opis budowania szablonu znajduje się na stronie Szablon DOCX do generowania PDF, a w tym przykładzie użyjemy sobie następującego dokumentu:

 Image Removed

Mamy więc do czynienia z prostą fakturą, gdzie uzupełnić musimy identyfikator faktury, nazwę klienta któremu wystawiamy fakturę, kwotę netto, brutto, oraz imię i nazwisko osoby wystawiającej fakturę.

Szablon zapisujemy na dysku.

Dodanie zadania automatycznego i konfiguracja

Następnie na mapie procesu dodajemy zadanie automatyczne, które w odpowiednim momencie będzie generowało nam dokument. Wybieramy zakładkę "Dokumenty" a następnie "Generowanie dokumentu z szablonu".

Image Removed

Czysta konfiguracja komponentu przedstawia się następująco:

Image Removed

Przejdziemy teraz kolejno przez wszystkie parametry konfiguracyjne komponentu.

  • Format - nasz wybór ogranicza się do PDF i DOCX, a w naszym przykładzie zakładamy, że chcemy uzyskać dokument w formacie PDF. Zostawiamy wartość początkową.
  • Klasa dokumentów - musimy wybrać klasę dokumentów odpowiedzialną w naszym systemie za faktury. W tym przykładzie jest to klasa "Faktury".
  • Szablon - nazwa szablonu, na podstawie którego zostanie stworzony dokument. Póki co nie dodaliśmy go jeszcze do procesu, więc mamy wolną rękę w wyborze nazwy. W przykładzie szablon został nazwany "faktura_suncode".
  • Podłącz - Szablon ustala, czy chcemy, żeby nasz dokument został dołączony do procesu. Ustawiamy na "Tak"
  • Nowa wersja - Jeżeli pojawi się nowa wersja dokumentu o tej samej nazwie, to chcemy nadpisać starą wersję dokumentu zamiast dodawać nowy. Ustawiamy na "Tak".
  • Nazwa dokumentu - W tym przykładzie zależy nam na tym, w jaki sposób zostanie nazwany dokument z fakturą. Chcemy, żeby kolejne faktury nazywały się "fakura_suncode_1", "fakura_suncode_2", "fakura_suncode_3" itd., gdzie 1, 2 i 3 to identyfikatory faktur. W tym celu skorzystamy z funkcji concat - łączącej ze sobą dane łańcuchy znaków. Pierwszą częścią łańcucha znaków będzie fraza "fakura_suncode_", a następną wartość ze zmiennej "Id faktury". Finalnie funkcja concat powinna prezentować się tak:
    Image Removed
  • Kolejnym krokiem jest odpowiednie ustawienie mapowań, które przygotowaliśmy w szablonie dokumentu.
    - Id faktury oraz nazwę klienta mamy zapisane na formularzu w odpowiednich zmiennych. Mapowanie przebiega bezproblemowo:Image Removed
    - Kwota netto oraz Kwota brutto występują na formularzu jako wartości zmiennoprzecinkowe. Chcąc wpisać je do parametru musimy je zamienić na łańcuch znaków. Ten problem rozwiązujemy przy użyciu funkcji toString(), która zamieni liczby na tekst.
    Image Removed
    - Ostatnią wartością do ustawienia jest Wystawiający. W szablonie możemy zauważyć nietypową budowę dla tego mappingu:
    Image Removed
    Jest to spowodowane faktem, że w tym konkretnym przypadku chcemy pobrać z formularza login użytkownika, a generator szablonów ma za zadanie zamienić go na imię i nazwisko tej osoby. Taki rezultat otrzymujemy przy użyciu "@fullname#<login użytkownika>@", gdzie w miejscu <login użytkownika> wpisujemy mapping z konfiguracji komponentu. W naszym przypadku mapping nazwany jest login_osoby_wystawiajacej_fakture, więc konfiguracja będzie prezentowała się następująco:
    Image Removed

Finalnie nasza konfiguracja powinna prezentować się następująco:

Image Removed

Taką konfigurację zapisujemy, zadanie automatyczne łączymy odpowiednio z innymi polami na mapie procesu, a następnie eksportujemy proces.

Dodanie szablonu do procesu

Teraz, gdy proces jest już wyeksportowany do systemu możemy przystąpić do dodawania szablonu. Wchodzimy w zakładkę Administracja ->Obieg dokumentów -> Procesy

Image Removed

Na liście dostępnych procesów wyszukujemy proces, w którym umieściliśmy nasze zadanie automatyczne. Klikamy na przycisk "Edytuj" znajdujący się obok nazwy procesu.

W nowym widoku przechodzimy do zakładki "Szablony dokumentów".

Image Removed

Klikamy na przycisk "Nowy szablon". Uzupełniamy wartości w nowym oknie, podając nazwę z konfiguracji i ścieżkę pod którą zapisaliśmy plik z szablonem.

Image Removed

Naciskamy "Dodaj szablon". Gotowe.

Wywołanie zadania automatycznego

Wszystkie kroki niezbędne do skorzystania z zadania automatycznego zostały wykonane. Czas uruchomić proces i zapisać wartości w odpowiednich polach.

Image Removed

Po uzupełnieniu pól przechodzimy do zadania automatycznego, które wygeneruje dokument. W tym przypadku otrzymamy dokument o nazwie faktura_suncode_001.pdf, który zostanie dołączony do procesu. Wnętrze dokumentu powinno prezentować się następująco:

Image Removed

Hide If
special@anonymous

Change log

1.0.11

  • Dodanie komponentu 

1.0.23

  • Zmiana sekcji z "Ogólne" na "Dokumenty" 

1.0.24

  • Dodanie parametru "Nazwa dokumentu" 

1.0.33

  • Zmiana nazwy z "Generowanie dokumentu" na "Generowanie dokumentu z szablonu" 

1.0.43

  • Aktualizacja dynamicznego formularza

Zadania związane z komponentem

Aktualne

JIRA
server192.168.1.52 JIRA
serverId2e6b42a8-62e1-3c71-bfe9-dbf183b33dc1
keyCUFCMP-522

Archwialne

JIRA
server192.168.1.52 JIRA
serverId2e6b42a8-62e1-3c71-bfe9-dbf183b33dc1
keyCUFCMP-51

JIRA
server192.168.1.52 JIRA
serverId2e6b42a8-62e1-3c71-bfe9-dbf183b33dc1
keyCUFCMP-208

JIRA
server192.168.1.52 JIRA
serverId2e6b42a8-62e1-3c71-bfe9-dbf183b33dc1
keyCUFCMP-209

JIRA
server192.168.1.52 JIRA
serverId2e6b42a8-62e1-3c71-bfe9-dbf183b33dc1
keyCUFCMP-141

JIRA
server192.168.1.52 JIRA
serverId2e6b42a8-62e1-3c71-bfe9-dbf183b33dc1
keyCUFCMP-400

Jeżeli nie znajdzie szablonu w systemie komponent wyrzuca informację o błędzie.
Polish

← Powrót do listy dostępnych zadań automatycznych

Info

 Jeśli masz problem ze zrozumieniem jak działa zadanie automatyczne, sprawdź opisy: Zadanie automatyczne, Wykonanie warunkowe, Parametry komponentów

Poprzednie nazwy: Generowanie dokumentu (do wersji 1.0.33)

Kategoria: Dokumenty

Opis

Generuje dokument z podanego szablonu na podstawie aktualnych danych procesu. Przygotowanie szablonu dokumentu zostało opisane na stronie: Szablon DOCX do generowania PDF. Dokument może zostać dołączony do procesu w którym zostało wywołane zadanie automatyczne. Istnieje możliwość ustawienia własnej nazwy dla dokumentu i wybrania jednego z dwóch typów - PDF lub DOCX. Komponent pozwala na ustawienie wartości zmiennych w szablonie przy użyciu mapowania. Jeżeli zmienne w szablonie mają już odpowiadające im zmienne na formularzu, to przy użyciu tego komponentu możemy nadpisać te mapowania.

Parametry konfiguracyjne

Nazwa parametruOd wersjiOpisTyp parametruWartość domyślnaRodzaj polaUwagi i ograniczenia
Format*1.0.11Format pliku, w jakim zostanie wygenerowany dokument.TekstPDFNieedytowalna lista rozwijalnaWartości do wyboru: PDF, DOCX
Klasa dokumentów*1.0.11Nazwa klasy dokumentów, do której dodany zostanie wygenerowany dokument. Uwaga - w parametrze musi znaleźć się oryginalna nazwa klasy dokumentów, gdyż tłumaczenia nie są obsługiwane.
Tekst Edytowalna lista rozwijalna

Wartości do wyboru: <nazwy klas dokumentów dostępnych w systemie>

Można wpisać własną nazwę, ale jeżeli komponent nie znajdzie klasy w systemie to wyrzuca informację o błędzie.

Szablon*1.0.11Nazwa szablonu generowanego dokumentu. Szablon powinien zostać załączony do procesu, w którym używamy zadania automatycznego. Sposób dodania szablonu został opisany tutaj (1.1.3)
Tekst Pole edytowalne
56Określa skąd zostanie pobrany szablon do wygenerowania dokumentu.TekstSzablon z procesuLista rozwijalna

Wartości do wyboru:

Wartość wyświetlanaWartość przekazywana

Szablon z procesu

PROCESS_TEMPLATE 

Szablon z dokumentu podłączonego do procesu

PROCESS_ATTACHED_DOCUMENT_TEMPLATE
Szablon z archiwum dokumentówARCHIVE_TEMPLATE
Nazwa klasy dokumentu - szablonu1.0.56Parametr pojawia się, jeżeli wybrano "Szablon z dokumentu podłączonego do procesu" w parametrze "Źródło szablonu". Określa klasę, z której zostanie pobrany dokument - szablon. W przypadku istnienia kilku dokumentów aplikacja wyrzuci błąd.Tekst Pole edytowalne 
Szablon*1.0.11Nazwa szablonu generowanego dokumentu. Szablon powinien zostać załączony do procesu, w którym używamy zadania automatycznego. Sposób dodania szablonu został opisany tutaj (1.1.3)
Tekst Pole edytowalne

Jeżeli nie znajdzie szablonu w systemie komponent wyrzuca informację o błędzie.

Klasa dokumentów1.0.166Nazwa klasy dokumentów, z której będzie wyszukiwany szablon dokumentu.Tekst Lista rozwijalna 
Nazwa indeksu1.0.166Nazwa indeksu z wybranej klasy dokumentów.Tekst Lista rozwijalna / Pole edytowalne  
Wartość indeksu1.0.166Wartość indeksu z wybranej klasy dokumentów.Tekst Pole edytowalne 
Podłącz*1.0.11Podłącza wygenerowany dokument do procesu. LogicznyNie
Nieedytowalna lista rozwijalna
Pole edytowalne 
Nowa wersja*1.0.11Zapisuje podłączony do procesu dokument jako nową wersję. Działa jedynie w przypadku, gdy do procesu jest dołączony dokładnie jeden dokument z tej samej klasy, z tymi samymi indeksami.
LogicznyNie
Nieedytowalna lista rozwijalna
Pole edytowalne 
Nazwa dokumentu1.0.24Umożliwia podanie własnej nazwy generowanego dokumentu. W przypadku braku uzupełnienia tego parametru, system sam wygeneruje nazwę.Tekst Pole edytowalneJeżeli w nazwie znajdzie się "/" lub "\" komponent wyrzuca informację o błędzie.
Klucze do mapowania1.0.11Klucze z szablonu, które chcemy zmapować na odpowiednie wartości podane w "Wartościach mapujących". Np. dla wartości w szablonie: "@imie@" wpisujemy klucz "imie"Tablica wartości tekstowych Pole edytowalne 
Wartości mapujące1.0.11Wartości, które zapiszemy, bądź którymi nadpiszemy zmienne zadeklarowane w szablonie Tablica wartości tekstowych Pole edytowalne 

Parametr*- pole wymagane

Panel
titlePrzykładowa konfiguracja

Prosta konfiguracja (bez mappingów i z automatycznie generowaną nazwą):

Image Removed

Image Added

Zaawansowana konfiguracja:

Image Removed

Image Added

Panel
titlePrzykład zastosowania
Expand
titlePrzykład 1 - Wygenerowanie faktury przy użyciu wartości pobranych z systemu Plusworkflow

Niech naszą potrzebą będzie wygenerowanie faktury przy użyciu wartości pobranych z systemu Plusworkflow.

Panel
borderWidth1
borderStylesolid
title
Przykład
Przygotowanie szablonu dokumentu

W tym celu należy przygotować szablon, który umieścimy w naszym procesie faktur. Dokładny opis budowania szablonu znajduje się na stronie Szablon DOCX do generowania PDF, a w tym przykładzie użyjemy sobie następującego dokumentu:

 Image Modified

Mamy więc do czynienia z prostą fakturą, gdzie uzupełnić musimy identyfikator faktury, nazwę klienta któremu wystawiamy fakturę, kwotę netto, brutto, oraz imię i nazwisko osoby wystawiającej fakturę.

Szablon zapisujemy na dysku.

Panel
borderWidth1
borderStylesolid
titleDodanie zadania automatycznego i konfiguracja

Następnie na mapie procesu dodajemy zadanie automatyczne, które w odpowiednim momencie będzie generowało nam dokument. Wybieramy zakładkę "Dokumenty" a następnie "Generowanie dokumentu z szablonu".

Image Modified

Czysta konfiguracja komponentu przedstawia się następująco:

Image Modified

Przejdziemy teraz kolejno przez wszystkie parametry konfiguracyjne komponentu.

  • Format - nasz wybór ogranicza się do PDF i DOCX, a w naszym przykładzie zakładamy, że chcemy uzyskać dokument w formacie PDF. Zostawiamy wartość początkową.
  • Klasa dokumentów - musimy wybrać klasę dokumentów odpowiedzialną w naszym systemie za faktury. W tym przykładzie jest to klasa "Faktury".
  • Szablon - nazwa szablonu, na podstawie którego zostanie stworzony dokument. Póki co nie dodaliśmy go jeszcze do procesu, więc mamy wolną rękę w wyborze nazwy. W przykładzie szablon został nazwany "faktura_suncode".
  • Podłącz - Szablon ustala, czy chcemy, żeby nasz dokument został dołączony do procesu. Ustawiamy na "Tak"
  • Nowa wersja - Jeżeli pojawi się nowa wersja dokumentu o tej samej nazwie, to chcemy nadpisać starą wersję dokumentu zamiast dodawać nowy. Ustawiamy na "Tak".
  • Nazwa dokumentu - W tym przykładzie zależy nam na tym, w jaki sposób zostanie nazwany dokument z fakturą. Chcemy, żeby kolejne faktury nazywały się "fakura_suncode_1", "fakura_suncode_2", "fakura_suncode_3" itd., gdzie 1, 2 i 3 to identyfikatory faktur. W tym celu skorzystamy z funkcji concat - łączącej ze sobą dane łańcuchy znaków. Pierwszą częścią łańcucha znaków będzie fraza "fakura_suncode_", a następną wartość ze zmiennej "Id faktury". Finalnie funkcja concat powinna prezentować się tak:
    Image Modified
  • Kolejnym krokiem jest odpowiednie ustawienie mapowań, które przygotowaliśmy w szablonie dokumentu.
    - Id faktury oraz nazwę klienta mamy zapisane na formularzu w odpowiednich zmiennych. Mapowanie przebiega bezproblemowo:Image Modified
    - Kwota netto oraz Kwota brutto występują na formularzu jako wartości zmiennoprzecinkowe. Chcąc wpisać je do parametru musimy je zamienić na łańcuch znaków. Ten problem rozwiązujemy przy użyciu funkcji toString(), która zamieni liczby na tekst.
    Image Modified
    - Ostatnią wartością do ustawienia jest Wystawiający. W szablonie możemy zauważyć nietypową budowę dla tego mappingu:
    Image Modified
    Jest to spowodowane faktem, że w tym konkretnym przypadku chcemy pobrać z formularza login użytkownika, a generator szablonów ma za zadanie zamienić go na imię i nazwisko tej osoby. Taki rezultat otrzymujemy przy użyciu "@fullname#<login użytkownika>@", gdzie w miejscu <login użytkownika> wpisujemy mapping z konfiguracji komponentu. W naszym przypadku mapping nazwany jest login_osoby_wystawiajacej_fakture, więc konfiguracja będzie prezentowała się następująco:
    Image Modified

Finalnie nasza konfiguracja powinna prezentować się następująco:

Image Modified

Taką konfigurację zapisujemy, zadanie automatyczne łączymy odpowiednio z innymi polami na mapie procesu, a następnie eksportujemy proces.

Panel
borderWidth1
borderStylesolid
titleDodanie szablonu do procesu

Teraz, gdy proces jest już wyeksportowany do systemu możemy przystąpić do dodawania szablonu. Wchodzimy w zakładkę Administracja ->Obieg dokumentów -> Procesy

Image Modified

Na liście dostępnych procesów wyszukujemy proces, w którym umieściliśmy nasze zadanie automatyczne. Klikamy na przycisk "Edytuj" znajdujący się obok nazwy procesu.

W nowym widoku przechodzimy do zakładki "Szablony dokumentów".

Image Modified

Klikamy na przycisk "Nowy szablon". Uzupełniamy wartości w nowym oknie, podając nazwę z konfiguracji i ścieżkę pod którą zapisaliśmy plik z szablonem.

Image Modified

Naciskamy "Dodaj szablon". Gotowe.

Panel
borderWidth1
borderStylesolid
titleWywołanie zadania automatycznego

Wszystkie kroki niezbędne do skorzystania z zadania automatycznego zostały wykonane. Czas uruchomić proces i zapisać wartości w odpowiednich polach.

Image Modified

Po uzupełnieniu pól przechodzimy do zadania automatycznego, które wygeneruje dokument. W tym przypadku otrzymamy dokument o nazwie faktura_suncode_001.pdf, który zostanie dołączony do procesu. Wnętrze dokumentu powinno prezentować się następująco:

Image Modified

Hide Ifpanel
specialtitle@anonymousChange log

1.0.11

  • Dodanie komponentu 

1.0.23

  • Zmiana sekcji z "Ogólne" na "Dokumenty" 

1.0.24

  • Dodanie parametru "Nazwa dokumentu" 

1.0.33

  • Zmiana nazwy z "Generowanie dokumentu" na "Generowanie dokumentu z szablonu" 

1.0.43

  • Aktualizacja dynamicznego formularza

1.0.56

  • Dodanie parametru "Źródło szablonu"

1.0.166

  • Dodanie możliwości wybrania na podstawie indeksów szablonu dokumentu z archiwum
Panel
titlePakiet z przykładowym formularzem wykorzystującym aplikację

View file
nameTesty komponentów - aplikacje - [APLIKACJA] Generowanie dokumentu z szablonu 2019-10-17 13_28_58.zip
height250
 

Hide If
special@anonymous

Zadania związane z komponentem

Aktualne

Archwialne

JIRA
server192.168.1.52 JIRA
serverId2e6b42a8-62e1-3c71-bfe9-dbf183b33dc1
keyCUFCMP-52251

Archwialne

JIRA
server192.168.1.52 JIRA
serverId2e6b42a8-62e1-3c71-bfe9-dbf183b33dc1
keyCUFCMP-51208

JIRA
server192.168.1.52 JIRA
serverId2e6b42a8-62e1-3c71-bfe9-dbf183b33dc1
keyCUFCMP-208209

JIRA
server192.168.1.52 JIRA
serverId2e6b42a8-62e1-3c71-bfe9-dbf183b33dc1
keyCUFCMP-209141

JIRA
server192.168.1.52 JIRA
serverId2e6b42a8-62e1-3c71-bfe9-dbf183b33dc1
keyCUFCMP-141400

JIRA
server192.168.1.52 JIRA
serverId2e6b42a8-62e1-3c71-bfe9-dbf183b33dc1
keyCUFCMP-400522


Uwagi i ograniczenia

Description

Generates a document from the given template based on the current process data. Preparation of the document template is described here: DOCX template for generating PDF. The document can be attached to the process in which the automatic task was run. You can set your own name for the document and choose from one of two types - PDF or DOCX. The component allows you to set variable values in the template using the mapping. If the variables in the template already have the corresponding variables on the form, then using this component we can overwrite these mappings.

Configuration parameters

English

← Powrót do listy dostępnych zadań automatycznych

Info

 Jeśli masz problem ze zrozumieniem jak działa zadanie automatyczne, sprawdź opisy: Zadanie automatyczne, Wykonanie warunkowe, Parametry komponentów

Poprzednie nazwy: Generowanie dokumentu (do wersji

Back to the available automatic tasks list

Info

 In case of any problems with understanding how the automatic task works, check: Automatic task, Conditional execution, Component parameters

Previous names: Document generation (till version 1.0.33) 

Kategoria

Category:

Dokumenty

Documents 

Opis

Generuje dokument z podanego szablonu na podstawie aktualnych danych procesu. Przygotowanie szablonu dokumentu zostało opisane na stronie: Szablon DOCX do generowania PDF. Dokument może zostać dołączony do procesu w którym zostało wywołane zadanie automatyczne. Istnieje możliwość ustawienia własnej nazwy dla dokumentu i wybrania jednego z dwóch typów - PDF lub DOCX. Komponent pozwala na ustawienie wartości zmiennych w szablonie przy użyciu mapowania. Jeżeli zmienne w szablonie mają już odpowiadające im zmienne na formularzu, to przy użyciu tego komponentu możemy nadpisać te mapowania.

Parametry konfiguracyjne

Nazwa parametruOd wersjiOpisTyp parametruWartość domyślnaRodzaj pola
Wartości do wyboruSzablonNazwa szablonu generowanego dokumentu. Szablon powinien zostać załączony do procesu, w którym używamy zadania automatycznego. Sposób dodania szablonu został opisany tutaj TekstPodłączNowa wersjaNazwa dokumentuKlucze do mapowaniaWartości mapujące

Parameter Name

From version

Description

Parameter type

Default value

Field type

Comments and restricitons

Format*

1.0.11

Format pliku, w jakim zostanie wygenerowany dokument.TekstPDFNieedytowalna lista rozwijalna

The file format in which the document will be generated.

Text

PDF

Non-editable dropdown list

Values to choose from: PDF, DOCX

Klasa dokumentów

Document class*

1.0.11

Nazwa klasy dokumentów, do której dodany zostanie wygenerowany dokument. Uwaga - w parametrze musi znaleźć się oryginalna nazwa klasy dokumentów, gdyż tłumaczenia nie są obsługiwane.
Tekst Edytowalna lista rozwijalna

Wartości do wyboru: <nazwy klas dokumentów dostępnych w systemie>

Można wpisać własną nazwę, ale jeżeli komponent nie znajdzie klasy w systemie to wyrzuca informację o błędzie.

The name of the document class to which the generated document will be added. Note - the parameter must contain the original name of the document class, because translations are not supported.

Text

 

Editable dropdown list

Values to choose from: <names of document classes available in the system>

You can enter your own name, but if the component does not find a class in the system, it shows an error message.

Template*

1.0.11

The name of the template of the generated document. The template should be attached to the process in which we use the automatic task. The method of adding the template has been described tutaj (1.1.3) 

Text

 

Pole edytowalne

Jeżeli nie znajdzie szablonu w systemie komponent wyrzuca informację o błędzie.

Editable field

If it does not find a template in the system, the component throws the error information.

Attach*

1.0.11

Podłącza wygenerowany dokument do procesu. LogicznyNieNieedytowalna lista rozwijalna 

Attaches the generated document to the process.

Logical

No

Non-editable dropdown list

 

New version*

1.0.11

Zapisuje podłączony do procesu dokument jako nową wersję. Działa jedynie w przypadku, gdy do procesu jest dołączony dokładnie jeden dokument z tej samej klasy, z tymi samymi indeksami.
LogicznyNieNieedytowalna lista rozwijalna 

Saves the document connected to the process as a new version. It works only when exactly one document with the same indexes from the same class is attached to the process

Logical

No

Non-editable dropdown list

 

Document names

1.0.24

Umożliwia podanie własnej nazwy generowanego dokumentu. W przypadku braku uzupełnienia tego parametru, system sam wygeneruje nazwę.Tekst Pole edytowalneJeżeli w nazwie znajdzie się "/" lub "\" komponent wyrzuca informację o błędzie.

Allows you to enter your own name for the generated document. If this parameter is not filled in, the system will generate the name itself.

Text

 

Editable field

If "/" or "\" is found in the name, the component shows an error message.

Key fields for mapping

1.0.11

Klucze z szablonu, które chcemy zmapować na odpowiednie wartości podane w "Wartościach mapujących". Np. dla wartości w szablonie: "@imie@" wpisujemy klucz "imie"Tablica wartości tekstowych Pole edytowalne 

The keys from the template that we want to map to the appropriate values given in "Mapping Values". For example, for the values in the template: "@ name @" enter the key "name"

Table of text values

 

Editable field

 

Mapping values

1.0.11

Wartości, które zapiszemy, bądź którymi nadpiszemy zmienne zadeklarowane w szablonie Tablica wartości tekstowych Pole edytowalne 

Parametr*- pole wymagane

Przykładowa konfiguracja

Prosta konfiguracja (bez mappingów i z automatycznie generowaną nazwą

Values that we write, or over which we overwrite the variables declared in the template.

Table of text values

 

Editable field

 

Parameter*- mandatory field

Configuration example

Simple configuration (no mappings and with automatically generated name):

Zaawansowana konfiguracja

Advanced configuration:

Przykład zastosowania

Application example

Expand
titlePrzykład Example 1

Niech naszą potrzebą będzie wygenerowanie faktury przy użyciu wartości pobranych z systemu Plusworkflow.

Przygotowanie szablonu dokumentu

W tym celu należy przygotować szablon, który umieścimy w naszym procesie faktur. Dokładny opis budowania szablonu znajduje się na stronie Szablon DOCX do generowania PDF, a w tym przykładzie użyjemy sobie następującego dokumentu:

 Image Removed

Mamy więc do czynienia z prostą fakturą, gdzie uzupełnić musimy identyfikator faktury, nazwę klienta któremu wystawiamy fakturę, kwotę netto, brutto, oraz imię i nazwisko osoby wystawiającej fakturę.

Szablon zapisujemy na dysku.

Dodanie zadania automatycznego i konfiguracja

Następnie na mapie procesu dodajemy zadanie automatyczne, które w odpowiednim momencie będzie generowało nam dokument. Wybieramy zakładkę "Dokumenty" a następnie "Generowanie dokumentu z szablonu".

Image Removed

Czysta konfiguracja komponentu przedstawia się następująco:

Image Removed

Przejdziemy teraz kolejno przez wszystkie parametry konfiguracyjne komponentu.

  • Format - nasz wybór ogranicza się do PDF i DOCX, a w naszym przykładzie zakładamy, że chcemy uzyskać dokument w formacie PDF. Zostawiamy wartość początkową.
  • Klasa dokumentów - musimy wybrać klasę dokumentów odpowiedzialną w naszym systemie za faktury. W tym przykładzie jest to klasa "Faktury".
  • Szablon - nazwa szablonu, na podstawie którego zostanie stworzony dokument. Póki co nie dodaliśmy go jeszcze do procesu, więc mamy wolną rękę w wyborze nazwy. W przykładzie szablon został nazwany "faktura_suncode".
  • Podłącz - Szablon ustala, czy chcemy, żeby nasz dokument został dołączony do procesu. Ustawiamy na "Tak"
  • Nowa wersja - Jeżeli pojawi się nowa wersja dokumentu o tej samej nazwie, to chcemy nadpisać starą wersję dokumentu zamiast dodawać nowy. Ustawiamy na "Tak".
  • Nazwa dokumentu - W tym przykładzie zależy nam na tym, w jaki sposób zostanie nazwany dokument z fakturą. Chcemy, żeby kolejne faktury nazywały się "fakura_suncode_1", "fakura_suncode_2", "fakura_suncode_3" itd., gdzie 1, 2 i 3 to identyfikatory faktur. W tym celu skorzystamy z funkcji concat - łączącej ze sobą dane łańcuchy znaków. Pierwszą częścią łańcucha znaków będzie fraza "fakura_suncode_", a następną wartość ze zmiennej "Id faktury". Finalnie funkcja concat powinna prezentować się tak:
    Image Removed
  • Kolejnym krokiem jest odpowiednie ustawienie mapowań, które przygotowaliśmy w szablonie dokumentu.
    - Id faktury oraz nazwę klienta mamy zapisane na formularzu w odpowiednich zmiennych. Mapowanie przebiega bezproblemowo:Image Removed
    - Kwota netto oraz Kwota brutto występują na formularzu jako wartości zmiennoprzecinkowe. Chcąc wpisać je do parametru musimy je zamienić na łańcuch znaków. Ten problem rozwiązujemy przy użyciu funkcji toString(), która zamieni liczby na tekst.
    Image Removed
    - Ostatnią wartością do ustawienia jest Wystawiający. W szablonie możemy zauważyć nietypową budowę dla tego mappingu:
    Image Removed
    Jest to spowodowane faktem, że w tym konkretnym przypadku chcemy pobrać z formularza login użytkownika, a generator szablonów ma za zadanie zamienić go na imię i nazwisko tej osoby. Taki rezultat otrzymujemy przy użyciu "@fullname#<login użytkownika>@", gdzie w miejscu <login użytkownika> wpisujemy mapping z konfiguracji komponentu. W naszym przypadku mapping nazwany jest login_osoby_wystawiajacej_fakture, więc konfiguracja będzie prezentowała się następująco:
    Image Removed

Finalnie nasza konfiguracja powinna prezentować się następująco:

Image Removed

Taką konfigurację zapisujemy, zadanie automatyczne łączymy odpowiednio z innymi polami na mapie procesu, a następnie eksportujemy proces.

Dodanie szablonu do procesu

Teraz, gdy proces jest już wyeksportowany do systemu możemy przystąpić do dodawania szablonu. Wchodzimy w zakładkę Administracja ->Obieg dokumentów -> Procesy

Image Removed

Na liście dostępnych procesów wyszukujemy proces, w którym umieściliśmy nasze zadanie automatyczne. Klikamy na przycisk "Edytuj" znajdujący się obok nazwy procesu.

W nowym widoku przechodzimy do zakładki "Szablony dokumentów".

Image Removed

Klikamy na przycisk "Nowy szablon". Uzupełniamy wartości w nowym oknie, podając nazwę z konfiguracji i ścieżkę pod którą zapisaliśmy plik z szablonem.

Image Removed

Naciskamy "Dodaj szablon". Gotowe.

Wywołanie zadania automatycznego

Wszystkie kroki niezbędne do skorzystania z zadania automatycznego zostały wykonane. Czas uruchomić proces i zapisać wartości w odpowiednich polach.

Image Removed

Po uzupełnieniu pól przechodzimy do zadania automatycznego, które wygeneruje dokument. W tym przypadku otrzymamy dokument o nazwie faktura_suncode_001.pdf, który zostanie dołączony do procesu. Wnętrze dokumentu powinno prezentować się następująco
Panel
borderWidth1
borderStylesolid
titlePrzykład
Example

Let our need be to generate an invoice using values taken from the Plusworkflow system.

Document template preparation

Prepare a template that will be placed in our invoice process. A detailed description of building a template can be found on the DOCX Template page for generating PDF, and in this example we will use the following document:

 Image Added

We deal with a simple invoice, where we have to complete the invoice's identifier, the name of the customer to whom we issue the invoice, net, gross amount, and the name and surname of the person issuing the invoice.

The template is saved to the disk.

Adding an automatic task and configuration

On the process map add an automatic task that will generate the document at the right time. Choose the tab "Documents" and then "Generating a document from a template".

Image Added

Empty configuration of the component is as follows:

Image Added

  • We will now walkthrough all of the configuration parameters of the component:

    • Format - our choice is limited to PDF and DOCX, and in our example we assume that we want to get a PDF document. We leave the initial value.
    • Document class - we must select the class of documents responsible for invoices in our system. In this example, this is the "Invoices" class.
    • Template - the name of the template on the basis of which the document will be created. So far, we have not added it yet to the process, so we have a free hand in choosing the name. In the example, the template was named "invoice_suncode".
    • Attach - The template determines whether we want our document to be included in the process. Set to "Yes"
    • New version - If a new version of the document with the same name appears, we want to overwrite the old version of the document instead of adding a new one. Set to "Yes".
    • Document name - In this example, we want to know how the document with the invoice will be named. We want the next invoices to be called "invoice_suncode_1", "invoice_suncode_2", "invoice_suncode_3", etc., where 1, 2 and 3 are invoice IDs. To do this, we will use the concat function - which concatenates the given character strings. The first part of the string will be the phrase "invoice_suncode_", and the next value from the variable "Invoice Id". Finally, the concat function should look like this:

    Image Added
  • The next step is to properly set the mappings that we have prepared in the document template.
    - Invoice ID and customer name are saved on the form in the correct variables. Mapping works without any problems:      Image Added
    - The net amount and the gross amount appear on the form as floating point values. If you want to enter them into the parameter, you must replace them with a string. We solve this problem using the toString () function, which will convert numbers into text,
    Image Added
    - The last value to be set is the Issuer. In the template, we can see an unusual construction for this mapping:
    Image Added
    This is due to the fact that in this particular case we want to download from the form the user's login and the template generator is tasked to replace it with the name and surname of this person. This result is obtained using "@ fullname # <user login> @", where in the place <user login> you need to enter the mapping from the component configuration. In our case mapping is named issuer_login, so the configuration will be as follows:
    Image Added

Finally the configuration should look like this:

Image Added

Save this configuration, connect the automatic task with other fields on the process map, and then export the process.

Adding a template to the process

Now that the process has been exported to the system, we can start adding the template. Go to the Administration -> Document flow -> Processes tab

Image Added

In the list of available processes, we search for a process in which we placed automated task. Click on the "Edit" button next to the process name.

In the new view, go to the "Document templates" tab.

Image Added

Click on the "New template" button. Fill in the values in a new window, giving the name from the configuration and the path under which we saved the template file.

Image Added

We press "Add template". Ready.

Calling an automatic task

All steps necessary to use the automatic task have been completed. Time to start the process and save the values in the appropriate fields.

Image Added

After filling the fields, we go to the automatic task that will generate the document. In this case, we will receive a document called “faktura_suncode_001.pdf”, which will be attached to the process. The body of the document should look like this:

Hide If
special@anonymous

Change log

1.0.11

  • Dodanie komponentu Component adding

1.0.23

  • Zmiana sekcji z "Ogólne" na "Dokumenty" Changing the section from "General" to "Documents"

1.0.24

  • Dodanie parametru "Nazwa dokumentu" Adding the "Document name" parameter

1.0.33

  • Zmiana nazwy z "Generowanie dokumentu" na "Generowanie dokumentu z szablonu" Changing the name from "Generating a document" to "Generating a document from a template"

1.0.43

  • Aktualizacja dynamicznego formularza

Zadania związane z komponentem

Aktualne
  • Update of the dynamic form

Tasks related to the component

Current

JIRA
server192.168.1.52 JIRA
serverId2e6b42a8-62e1-3c71-bfe9-dbf183b33dc1
keyCUFCMP-522

Archwialne

Archive

JIRA
server192.168.1.52 JIRA
serverId2e6b42a8-62e1-3c71-bfe9-dbf183b33dc1
keyCUFCMP-51

JIRA
server192.168.1.52 JIRA
serverId2e6b42a8-62e1-3c71-bfe9-dbf183b33dc1
keyCUFCMP-208

JIRA
server192.168.1.52 JIRA
serverId2e6b42a8-62e1-3c71-bfe9-dbf183b33dc1
keyCUFCMP-209

JIRA
server192.168.1.52 JIRA
serverId2e6b42a8-62e1-3c71-bfe9-dbf183b33dc1
keyCUFCMP-141

JIRA
server192.168.1.52 JIRA
serverId2e6b42a8-62e1-3c71-bfe9-dbf183b33dc1
keyCUFCMP-400