Lista dokumentów - DocumentList
Lista dokumentów do przejrzenia i pobrania. Pozycje listy mogą pochodzić z wydruków generowanych z szablonu, z usługi albo z modelu danych.

Właściwości komponentu
Lista dokumentów
items
Lista dokumentów do zaprezentowania
Klucz modelu danych (sekcja Podstawowe właściwości)
model
Węzeł modelu danych z danymi plików, które lista ma pokazać. Gdy klucz jest ustawiony, lista pokazuje wyłącznie te pliki. Więcej w sekcji Pliki z modelu danych.
Pobierz wszystkie dokumenty (sekcja Podstawowe właściwości)
allowDownloadingOfAllDocuments
Opcja umożliwiająca pobranie wszystkich dokumentów. Domyślna wartość "false". Dostępność funkcjonalności zależy od licencji i może nie być dostępna we wszystkich wdrożeniach.
Prezentowanie loadera podczas generowania dokumentu (sekcja Podstawowe właściwości)
async
Opcja prezentująca loader podczas generowania dokumentu. Domyślna wartość "false".
Dostępność funkcjonalności zależy od licencji i może nie być dostępna we wszystkich wdrożeniach.
Lista dokumentów zwijana (sekcja Pozostałe)
GesDocumentList.foldable
Prezentacja listy dokumentów jest ukryta w sekcji zwijanej.
Dostępność funkcjonalności zależy od licencji i może nie być dostępna we wszystkich wdrożeniach
Więcej informacji o właściwościach komponentu: Wspólne właściwości komponentów

Po dodaniu komponentu z palety pozostałą konfigurację (dotyczącą listy wyświetlanych dokumentów) należy ustalić w zakładce Źródło. Przykładowa konfiguracja dla komponentu:
Najważniejsze w powyższej konfiguracji jest ustalenie:
fileName="my_file.pdf" - w cudzysłowie podajemy nazwę dokumentu prezentowaną na szablonie.
documentTemplate="my_template.xsl-*" - w cudzysłowie podajemy nazwę szablonu xsl w formacie
nazwa-*, gdzie gwiazdka oznacza najwyższą wersję komponentu.
Jeśli artefakt podpięty w komponencie Lista dokumentów zasilany jest danymi z wniosku, należy na komponencie DocumentList dodać nasłuchiwanie np. na currentPageMid (lub inny element, który zmienia się na wniosku przy przechodzeniu między stronami). Pozwoli to uniknąć sytuacji, w której zmiana danych nie zostanie odzwierciedlona w wydruku.
Konfigurowanie właściwości items dla zasilenie listy dokumentów wydrukiem PDF generowanym przy wykorzystaniu XSL template
Nazwa generatora
Generator name
"fop" - jeśli dane zasilające wydruk pochodzą z wniosku. "fopFromVariable" - jeśli dane zasilające wydruk generowane są ze zmiennej xmlDocument (wówczas komponent musi też nasłuchiwać na tę zmienną!)
Nazwa dokumentu
File name
nazwa dokumentu prezentowana na szablonie
Nazwa artefaktu
Document template
nazwa komponentu w formacie nazwa-* gdzie gwiazdka oznacza najwyższą wersję komponentu (istnieje również możliwość wskazania konkretnej wersji)
Zasilenie listy dokumentów danymi z usługi
Komponent można zasilić danymi z usługi podpiętej na komponencie albo na stronie.
Zasilenie listy dokumentów linkami z usługi (zewnętrznymi linkami)
Usługę podpinamy pod komponent standardowo przez ŹRÓDŁO DANYCH ZEWNĘTRZNYCH (External Data Source). Powinna ona zwracać (nazwy endpointów są pogrubione):
documentLink — listę linków lub identyfikatorów dokumentów, które chcemy wyświetlić,
fileName — nazwę pliku do pobrania,
documentLabel — opcjonalnie etykietę wyświetlaną przy pliku (jeżeli jej nie ma, to wyświetla się nazwa pliku),
source — rodzaj źródła (wartości: "externalWeb" lub "internalDoc"), stała, dzięki której platforma będzie wiedziała czy systemem źródłowym jest cms ("externalWeb") czy nemo ("internalDoc").
Należy pamiętać, że jeżeli lista dokumentów ma być prezentowana w innych kanałach niż native to usługa musi zwracać wartości skorelowane z aktualnym kanałem. Np. zwracanie identyfikatorów dokumentów nie ma sensu dla kanału desktop.
Przykładowy kod usługi (Java, komponent OSGI/Charon):
Zasilenie listy dokumentów danymi z dwóch usług
Poniższa usługa zwróci nam dwa dokumenty - zakodowany w Base64 oraz pobrany z zewnętrznego adresu URL:
document_list_example1 - skrypt pobiera parametr wejściowy fileName z wniosku i zwraca dwa dokumenty:
pierwszy dokument ma etykietę
Umowa kredytowai ustawiony parametrsourcenaexternalDocument— zawartość pliku zostanie pobrana ze wskazanego w parametrzedocumentServiceNameskryptu (w tym przypadku jest to skryptdocument_list_example2.js, który zwraca zawarość pliku w Base64).drugi dokument ma ustawiony parametr
sourcenaexternalWeb— zawartość pliku zostanie pobrana bezpośrednio z podanego zewnętrznego adresu URL.
document_list_example2 - skrypt zdefiniowany na potrzeby wywołania go w skrypcie document_list_example1 - pobiera parametry przekazywane z pierwszego skryptu i zwraca zawartość pliku w Base64.
Pierwszą usługę podpinamy pod komponent standardowo przez ŹRÓDŁO DANYCH ZEWNĘTRZNYCH (External Data Source). Powinna ona zwracać (nazwy endpointów są pogrubione):
fileName - nazwa pliku do pobrania, pod którą plik jest zapisywany na urządzeniu użytkownika. Nazwa powinna zawierać rozszerzenie, np.
Umowa kredytowa.pdf— platforma nie dodaje rozszerzenia na podstawie typu pliku,mimeType - typ pliku do pobrania, np.
application/pdf(przykładowy skrypt poniżej zwraca go pod kluczemfileMimeType, który na Ilustracji 1 jest zmapowany na atrybutmimeType),documentLabel - opcjonalna etykieta dokumentu wyświetlana na liście zamiast nazwy pliku, np.
Umowa kredytowa(bez rozszerzenia). Etykieta jest również odczytywana przez czytniki ekranu. Jeżeli etykieta nie zostanie przekazana lub jest pusta, na liście wyświetlana jest wartość fileName,fileContent - warto dodać, jeśli chcemy obsługiwać większą liczbę plików niż 1 - pozwala nam to ustawiać identyfikator pliku i rozróżniać pliki pomiędzy sobą,
source - rodzaj źródła załączonego pliku. Możliwe wartości:
externalDocument— plik pochodzi z zewnętrznego źródła danych,externalWeb— plik pochodzi z zewnętrznego adresu URL,
documentServiceName - nazwa drugiej usługi, która zostaje wywołana aby pobrać zawartość pliku (wypełniane w przypadku, gdy source=externalDocument). Jeśli jest to usługa skryptowa, dodajemy przed jej nazwą przedrostek script: (bez tego przedrostka system będzie szukać usługi Charonowej/OSGI),
documentServiceParams - opcjonalne parametry, które chcemy przekazać do usługi pobierającej zawartość pliku. Mają one postać parametr1=value¶metr2=value...
documentLink - zewnętrzny adres URL (wypełniane w przypadku, gdy source=externalWeb)

Przykładowe kody serwisów skryptowych:
Pliki z modelu danych
Lista dokumentów może pokazać pliki, których dane zapisano w modelu danych instancji aplikacji. Przykład: użytkownik załącza pliki w komponencie Załączniki na pierwszym kroku procesu, a na kolejnym formularzu tej samej aplikacji ten sam użytkownik albo pracownik obsługujący wniosek przegląda i pobiera te pliki z listy dokumentów.
W polu Klucz modelu danych należy wskazać węzeł wielokrotny z danymi plików, np. ten sam węzeł, który ustawiono w komponencie Załączniki. Lista korzysta z pól:
formstoreId
Identyfikator pliku. Pole jest wymagane. Element węzła bez wartości w tym polu nie pojawia się na liście.
originalName
Oryginalna nazwa pliku, np. dowod.pdf. Jest etykietą pozycji na liście.
fileName
Nazwa pliku nadana przez platformę. Dla pliku z komponentu Załączniki jest to wygenerowana nazwa, np. b787e626-da21-4ff3-b0b5-a6da88553e24.pdf. Jest etykietą pozycji tylko wtedy, gdy pole originalName jest puste.
Lista z ustawionym kluczem modelu danych działa w następujący sposób:
Pozycje listy powstają raz, przy otwarciu formularza, w takiej samej kolejności jak elementy węzła.
Lista pomija dokumenty wpisane we właściwości Lista dokumentów (
items), a pozycje pochodzą tylko z modelu danych.Lista jest pusta, gdy pod kluczem nie ma danych plików, gdy pod węzłem nie ma pola
formstoreIdalbo gdy formularz działa poza kontekstem aplikacji.Lista odczytuje z modelu danych tylko dane o plikach i niczego do niego nie zapisuje.
Przykład: na pierwszym formularzu w komponencie Załączniki ustawiono Klucz modelu danych wniosek.zalaczniki. Użytkownik załącza pliki dowod.pdf i zaswiadczenie.pdf, a po wysłaniu wniosku model zawiera:
Na kolejnym formularzu dodano Listę dokumentów z tym samym kluczem:
Lista pokazuje dwie pozycje: dowod.pdf i zaswiadczenie.pdf.
Ostatnia aktualizacja
Czy to było pomocne?
