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

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

Więcej informacji o właściwościach komponentu: Wspólne właściwości komponentów

Lista dokumentów do wygenerowania

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

Przykład 1 - Konfiguracja, gdy dane pochodzą z pól formularza

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

Przykład 2 - Konfiguracja, gdy dane pochodzą ze zmiennej xmlDocument

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

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

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.

Ilustracja komponentu

Ilustracja 1. Przykładowy wygląd komponentu na wniosku

Wniosek demo: demoDocuments