> For the complete documentation index, see [llms.txt](https://docs.eximee.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.eximee.com/budowanie-aplikacji/interfejs-uzytkownika/formularze/biblioteka-komponentow-bazowych/5-dokumenty-i-zaloczniki/generator-dokumentow-documentgenerator.md).

# Generator dokumentów - DocumentGenerator

Komponent służy do generowania dokumentów (PDF) na podstawie szablonów XSL-FO. Pozwala również na zapis wygenerowanych dokumentów do systemu DMS, a także przekazywanie ich zawartości jako zakodowanego ciągu znaków base64.

## Właściwości komponentu

<table><thead><tr><th width="240.683349609375">Właściwość Eximee Designer</th><th width="183.1165771484375">Nazwa atrybutu w Źródle</th><th>Opis</th></tr></thead><tbody><tr><td><strong>Lista dokumentów</strong></td><td>items</td><td>Lista dokumentów do wygenerowania.</td></tr><tr><td><strong>Zapis do DMS</strong></td><td>saveToDms</td><td>Flaga określająca, czy dokument należy zapisać do DMS (domyślna wartość "true").</td></tr><tr><td><strong>Zapis do DMS po porzuceniu wniosku</strong></td><td>saveToDmsOnAbandon</td><td>Flaga określająca, czy dokument należy zapisać do DMS po porzuceniu wniosku (domyślna wartość "false").</td></tr><tr><td><strong>Przekazywanie zawartości dokumentu w </strong><em><strong>base64 String</strong></em></td><td>fileContentInValue</td><td>Flaga określająca, czy w wartości komponentu przekazywana będzie zawartość wygenerowanego pliku w postaci <em>base64 String</em>.</td></tr></tbody></table>

> Więcej informacji o właściwościach komponentu: [Wspólne właściwości komponentów](https://docs.eximee.com/budowanie-aplikacji/interfejs-uzytkownika/formularze/praca-z-komponentami-bazowymi/wspolne-wlasciwosci-komponentow.md)

## Lista dokumentów do wygenerowania

Konfigurację komponentu dodajemy w zakładce **Źródło**. Przykładowe konfiguracje:

{% code title="Przykład 1 - Konfiguracja, gdy dane pochodzą z pól formularza" %}

```xml
<p1:GesDocumentGenerator id="GesDocumentGenerator1" inheritLayout="true">
  <p1:GesDocumentGenerator.layoutData>
    <GridData horizontalAlignment="FILL" horizontalSpan="16"/>
  </p1:GesDocumentGenerator.layoutData>
  <data:DocumentGeneratorItems>
    <data:DocumentGeneratorItem generatorName="fop" fileName="my_file.pdf" documentTemplate="my_temp.xsl-*"/>
  </data:DocumentGeneratorItems>
</p1:GesDocumentGenerator>
```

{% endcode %}

{% code title="Przykład 2 - Konfiguracja, gdy dane pochodzą ze zmiennej xmlDocument" %}

```xml
<p1:GesDocumentGenerator id="GesDocumentGenerator1" inheritLayout="false">
  <data:ListeningOn>
    <data:ListenField id="xmlDocument"/>
  </data:ListeningOn>
  <data:ClearOn/>
  <p1:GesDocumentGenerator.layoutData>
    <ns6:GridData horizontalAlignment="LEFT" horizontalSpan="6" verticalAlignment="CENTER"/>
  </p1:GesDocumentGenerator.layoutData>
  <data:DocumentGeneratorItems>
    <data:DocumentGeneratorItem generatorName="fopFromVariable" fileName="my_file.pdf" documentTemplate="my_template.xsl-*"/>
  </data:DocumentGeneratorItems>
</p1:GesDocumentGenerator>
```

{% endcode %}

Powyżej przedstawiono przykładowe konfiguracje dokumentów do wygenerowania. Parametr **generatorName** określa nazwę generatora dokumentów, który ma być użyty do wygenerowania dokumentu, w kolejnym parametrze określamy nazwę pliku (**fileName**), która zostanie zaprezentowana użytkownikowi, a ostatni nazwę szablonu dokumentu dostępnego w repozytorium (**documentTemplate** w formacie NAZWA\_SZABLONU-WERSJA).

{% hint style="warning" %}
Generowanie dokumentów odbywa się zgodnie z przepływem grafu zależności — należy zatem pamiętać, aby ustawić odpowiednio listę nasłuchiwań.

Jeśli komponent znajduje się na ostatniej stronie wniosku, na której są także pola przekazywane do generowanego dokumentu, to komponent musi nasłuchiwać na coś, co się zmienia na wyjście ze strony. Przykłady:

* Utworzenie Exit Service ze zwykłym Echo Service (np. dającym wartość true) i przypisanie wyniku Echo Service do zmiennej, na którą potem dokument generator będzie nasłuchiwał.
* Dodanie w GesDocumentGenerator nasłuchiwania na zmienną predefiniowaną **currentPageMid**.
  {% endhint %}

## Model danych

Dla każdego wygenerowanego dokumentu w modelu danych zapisywane są dane o dokumencie, np. jego nazwa. W zakładce **Źródło** należy ustawić w atrybucie `model` komponentu [węzeł wielokrotny](https://docs.eximee.com/budowanie-aplikacji/model-danych/struktura-modelu-danych.md#strukturamodeludanychbudowanieiuzywanie-definiowanietablicowychpolmodeludanych) o liczebności bez górnego limitu, np. `0..null`. Dane pierwszego dokumentu trafiają do elementu `[0]` tego węzła, a kolejnych do elementów `[1]`, `[2]` itd. Pod węzłem należy utworzyć pola, które mają być przechowywane:

| Pole             | Co zawiera                                                                                                       |
| ---------------- | ---------------------------------------------------------------------------------------------------------------- |
| **formstoreId**  | Identyfikator dokumentu. Na jego podstawie platforma pokazuje dokument na Liście dokumentów i pozwala go pobrać. |
| **fileName**     | Nazwa dokumentu podana w konfiguracji komponentu, np. `umowa.pdf`.                                               |
| **originalName** | Taka sama nazwa jak w polu `fileName`.                                                                           |
| **fileSize**     | Rozmiar dokumentu w bajtach.                                                                                     |

Pola są opcjonalne – więcej informacji w [Model danych na interfejsie](https://docs.eximee.com/budowanie-aplikacji/interfejs-uzytkownika/formularze/praca-z-komponentami-bazowymi/model-danych-na-interfejsie.md#komponenty-o-wartosci-zlozonej).

Przykład konfiguracji:

{% code title="Przykład 3 - Zapis wygenerowanego dokumentu w modelu danych" %}

```xml
<p1:GesDocumentGenerator id="GesDocumentGenerator1" inheritLayout="true" model="wniosek.umowa">
  <p1:GesDocumentGenerator.layoutData>
    <GridData horizontalAlignment="FILL" horizontalSpan="16"/>
  </p1:GesDocumentGenerator.layoutData>
  <data:DocumentGeneratorItems>
    <data:DocumentGeneratorItem generatorName="fop" fileName="umowa.pdf" documentTemplate="umowa.xsl-*"/>
  </data:DocumentGeneratorItems>
</p1:GesDocumentGenerator>
```

{% endcode %}

W modelu pod węzłem `wniosek.umowa` utworzono pola `formstoreId` i `fileName`. Po zapisaniu wniosku model zawiera:

```
wniosek.umowa[0].formstoreId = 5d21e0c7
wniosek.umowa[0].fileName = umowa.pdf
```

{% hint style="info" %}
Dane dokumentu trafiają do modelu danych tylko wtedy, gdy dokument jest zapisywany do DMS, czyli gdy włączona jest właściwość **Zapis do DMS**. Po porzuceniu wniosku dane dokumentu trafiają do modelu, gdy włączona jest właściwość **Zapis do DMS po porzuceniu wniosku**.
{% endhint %}

{% hint style="warning" %}
Wartości pól z danymi pliku nie należy wpisywać w inny sposób niż przez komponent na formularzu, np. skryptem, integracją albo wartością domyślną. Takie działanie nie jest wspierane i może powodować błędy.
{% endhint %}

## Ilustracja komponentu

![Ilustracja 1. Przykładowy wygląd komponentu na wniosku](https://content.gitbook.com/content/2CssJT0zIo4SJQLbSZ6l/blobs/89iAl2jjmvG6NASpueeJ/5k_files/image2025-5-29_8-15-6.png)

{% hint style="info" %}
Wniosek demo: demoDocuments
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.eximee.com/budowanie-aplikacji/interfejs-uzytkownika/formularze/biblioteka-komponentow-bazowych/5-dokumenty-i-zaloczniki/generator-dokumentow-documentgenerator.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
