[ZADANIE AUTOMATYCZNE] Generowanie dokumentu z szablonu

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:

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".

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

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:
  
• 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:
  - 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.
  
  - Ostatnią wartością do ustawienia jest Wystawiający. W szablonie możemy zauważyć nietypową budowę dla tego mappingu:
  
  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:
  

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

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

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".

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.

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.

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:

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:

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".

Empty configuration of the component is as follows:

• 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:
  
  
• 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:  
  - 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,
  
  - The last value to be set is the Issuer. In the template, we can see an unusual construction for this mapping:
  
  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:
  

Finally the configuration should look like this:

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

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.

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.

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.

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: