> 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/7-komponenty-specjalne/oswiadczenia-statements/oswiadczenia-zasilane-z-uslugi-fedstatements.md).

# Oświadczenia zasilane z usługi - FedStatements

Komponent wyświetlający oświadczenia

![](https://1082717226-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2CssJT0zIo4SJQLbSZ6l%2Fuploads%2Fgit-blob-8a439ba25bc7a088968843acdffc7fcd0b0588c2%2Ffedstatements-01.png?alt=media)

## Właściwości komponentu

| **Właściwość Eximee Designer**                                        | Nazwa atrybutu w Źródle      | **Opis**                                                                                                                                                                                                                                                                                |
| --------------------------------------------------------------------- | ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Grupowanie oświadczeń według wymagalności** (sekcja **Stylizacja**) | groupByRequired              | Opcja grupowania oświadczeń wg wymaganych i niewymaganych. Jeśli opcja zostanie zaznaczona, master checkbox będzie widoczny, a jego zaznaczenie będzie wpływało na zaznaczenie oświadczeń wymaganych. Domyślna wartość 'false'. Sortowanie oświadczeń należy wykonać po stronie usługi. |
| **Grupowanie wszystkich oświadczeń** (sekcja **Stylizacja**)          | groupAll                     | Opcja grupowania wszystkich oświadczeń. Jeśli opcja zostanie zaznaczona, master checkbox będzie widoczny, a jego zaznaczenie będzie wpływało na zaznaczenie wszystkich oświadczeń. Domyślna wartość 'false'.                                                                            |
| -                                                                     | masterCheckboxDescriptionKey | Klucz tłumaczenia zawierającego etykietę master checkboxa                                                                                                                                                                                                                               |

{% hint style="warning" %}
Uwaga! Jeśli zaznaczone będą obie opcje grupowania: groupByRequired i groupAll, to brana pod uwagę będzie tylko opcja Grupowanie wszystkich oświadczeń.
{% endhint %}

> 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 oświadczeń zasilona jest z usługi. Usługa musi udostępniać jeden endpoint, którego zawartością jest json definiujący strukturę oświadczeń. Obiekt json jest tutaj tablicą oświadczeń, gdzie każde oświadczenie jest opisane atrybutami:

| **Atrybut**                   | **Opis**                                                                                                                                                                                                                      |
| ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| id                            | unikalny identyfikator oświadczenia, który będzie zwracany w value komponentu. Musi być unikalny wśród oświadczeń obu poziomów                                                                                                |
| content                       | treść oświadczenia                                                                                                                                                                                                            |
| description                   | opcjonalny opis oświadczenia widoczny po rozwinięciu                                                                                                                                                                          |
| required                      | wymagalność oświadczenia, domyślnie false                                                                                                                                                                                     |
| showMoreTextLabel             | opcjonalny atrybut umożliwiający nadpisanie treści przycisku rozwijającego opis oświadczenia albo linku do dokumentu oświadczenia                                                                                             |
| showMoreInPopup               | flaga mówiąca, czy opis oświadczenia ma być pokazany w popupie, zamiast domyślnego rozwijania, domyślnie false                                                                                                                |
| subStatements                 | opcjonalna lista oświadczeń podrzędnych, opisanych tymi samymi atrybutami. Dozwolona tylko w oświadczeniu najwyższego poziomu: lista subStatements wewnątrz oświadczenia podrzędnego jest pomijana razem z jej oświadczeniami |
| descriptionBelowSubStatements | flaga oświadczenia z oświadczeniami podrzędnymi: opis (description) pokazuje się pod ostatnim oświadczeniem podrzędnym zamiast pod treścią, domyślnie false                                                                   |
| documentSource                | opcjonalna nazwa źródła zewnętrznego, z którego platforma pobiera dokument oświadczenia, np. regulamin. Źródło musi być dostępne w instalacji, tak jak w komponencie PdfViewer                                                |
| externalDocumentId            | identyfikator dokumentu w źródle `documentSource`. Oświadczenie ma dokument, gdy oba atrybuty są niepuste                                                                                                                     |
| documentFileName              | opcjonalna nazwa pobieranego pliku, domyślnie `<id>.pdf`                                                                                                                                                                      |

## Oświadczenia podrzędne

* Dopóki oświadczenie nadrzędne nie jest zaznaczone, jego oświadczeń podrzędnych nie da się zaznaczyć.
* Odznaczenie nadrzędnego odznacza podrzędne. Zaznaczenie nadrzędnego nie zaznacza podrzędnych.
* required oświadczenia podrzędnego obowiązuje tylko wtedy, gdy nadrzędne jest zaznaczone.
* value zawiera id zaznaczonych oświadczeń obu poziomów.

{% hint style="info" %}
Hierarchię oświadczeń pokazują tylko wybrane szaty. Pozostałe szaty pokazują oświadczenia obu poziomów jako jedną listę, a powyższe reguły zaznaczania i wymagalności obowiązują je tak samo.
{% endhint %}

W szatach, które pokazują hierarchię:

* oświadczenia podrzędne są wcięte względem oświadczenia nadrzędnego i wyłączone, dopóki nadrzędne nie jest zaznaczone,
* master checkbox przy opcji **Grupowanie wszystkich oświadczeń** obejmuje oświadczenia obu poziomów,
* master checkbox przy opcji **Grupowanie oświadczeń według wymagalności** obejmuje wymagane oświadczenia najwyższego poziomu razem z ich oświadczeniami podrzędnymi; wymagane oświadczenie podrzędne niewymaganego oświadczenia nadrzędnego zostaje poza nim.

## Dokument oświadczenia

Oświadczenie, także podrzędne, może mieć dokument ze źródła zewnętrznego, na przykład regulamin z repozytorium dokumentów organizacji. Usługa wskazuje dokument atrybutami `documentSource` i `externalDocumentId`, a platforma pobiera go po stronie serwera, tak jak dokument w komponencie [PdfViewer](https://docs.eximee.com/budowanie-aplikacji/interfejs-uzytkownika/formularze/biblioteka-komponentow-bazowych/5-dokumenty-i-zaloczniki/podglad-pdf-pdfviewer.md#dokument-ze-zrodla-zewnetrznego).

* W miejscu przycisku rozwijającego opis oświadczenie pokazuje link do pobrania dokumentu. Opis (`description`) takiego oświadczenia nie jest wyświetlany.
* Etykietą linku jest `showMoreTextLabel`, a bez niego tłumaczenie klucza `iew.fed.statements.document.download` (domyślnie „Pobierz dokument”).
* Link stoi pod treścią oświadczenia. W oświadczeniu z oświadczeniami podrzędnymi i flagą `descriptionBelowSubStatements` link stoi pod ostatnim oświadczeniem podrzędnym.
* Link działa także w nieaktywnym oświadczeniu podrzędnym. Kliknięcie linku nie zmienia zaznaczenia oświadczenia.
* Plik ma nazwę z atrybutu `documentFileName`, a bez niego nazwę `<id>.pdf`. We wniosku otwartym w przeglądarce link otwiera nowe okno, w którym zaczyna się pobieranie. We wniosku osadzonym jako web component plik pobiera się bez otwierania okna.
* Identyfikator dokumentu nie jest przekazywany do przeglądarki. Ponowne zasilenie listy oświadczeń z usługi zmienia odnośniki do dokumentów, a odnośnik sprzed zasilenia przestaje działać.
* Gdy źródło zwróci błąd albo nie ma w nim dokumentu, pobranie się nie udaje, a wniosek działa dalej.

{% hint style="info" %}
Link do dokumentu pokazują tylko wybrane szaty. Pozostałe szaty pomijają atrybuty dokumentu i pokazują oświadczenie tak jak bez nich.
{% endhint %}

## Przykłady usług

Przykładowy wynik działania usługi, zwracającej 4 oświadczenia:

```json
[
    {
        "id": 1,
        "content": "wymagane, bez opisu Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
        "required": true
    },
    {
        "id": 3,
        "content": "wymagane, z opisem Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
        "description": "Opis 3 Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
        "required": true
    },
    {
        "id": 5,
        "content": "opcjonalne, z opisem w popupie Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
        "description": "Opis 5 Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
        "showMoreInPopup": true,
        "required": false
    },
    {
        "id": 10,
        "content": "link w tytule <a href=\"http://google.pl\" target=\"_blank\">Link</a>"
    }
]
```

Przykład serwisu skryptowego, zwracającego konfigurację z powyższego przykładu:

```js
function callService(context) {

    const statements = [
        {
            "id": 1,
            "content": "wymagane, bez opisu Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
            "required": true
        },
        {
            "id": 3,
            "content": "wymagane, z opisem Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
            "description": "Opis 3 Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
            "required": true
        },
        {
            "id": 5,
            "content": "opcjonalne, z opisem w popupie Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
            "description": "Opis 5 Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
            "showMoreInPopup": true,
            "required": false
        },
        {
            "id": 10,
            "content": "link w tytule <a href=\"http://google.pl\" target=\"_blank\">Link</a>"
        }
    ];

    return [{ output: JSON.stringify(statements) }];
}
```

{% hint style="warning" %}
W przypadku zasilania komponentu przez serwis skryptowy wynik przekazywany do parametru `output` powinien być tekstem zawierającym JSON z listą oświadczeń. Nie należy zwracać tablicy JavaScript bezpośrednio jako `output`, np. `output: statements`.

Poprawny format: `return [{ output: JSON.stringify(statements) }];`
{% endhint %}

Przykładowy wynik działania usługi zwracającej 1 oświadczenie z dwoma oświadczeniami podrzędnymi

```json
[
    {
        "id": "MARKETING",
        "content": "Zgoda na kontakt marketingowy",
        "description": "Zgodę można odwołać w każdej chwili.",
        "descriptionBelowSubStatements": true,
        "required": true,
        "subStatements": [
            { "id": "MARKETING_EMAIL", "content": "e-mail" },
            { "id": "MARKETING_SMS", "content": "SMS", "required": true }
        ]
    }
]  
```

Przykładowy wynik działania usługi zwracającej oświadczenie z dokumentem (`repozytoriumDokumentow` to przykładowa nazwa źródła):

```json
[
    {
        "id": "REGULAMIN",
        "content": "Akceptuję regulamin usługi.",
        "required": true,
        "showMoreTextLabel": "Pobierz regulamin",
        "documentSource": "repozytoriumDokumentow",
        "externalDocumentId": "ABD0083270086",
        "documentFileName": "Regulamin usługi.pdf"
    }
]
```

## Platformowe klucze tłumaczeń

| Klucz                                 | Opis                                                                                                       | Wartość domyślna |
| ------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------- |
| iew\.rollable.roll                    | Etykieta przycisku do zwinięcia dodatkowego opisu oświadczenia                                             | Zwiń             |
| iew\.fed.statements.content.toggle    | Etykieta przycisku do rozwinięcia dodatkowego opisu oświadczenia, bądź zaprezentowania popupa z tą treścią | Rozwiń           |
| iew\.fed.statements.document.download | Etykieta linku do pobrania dokumentu oświadczenia, gdy usługa nie poda `showMoreTextLabel`                 | Pobierz dokument |

{% hint style="info" %}
Wniosek demo: demoFedStatements
{% 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/7-komponenty-specjalne/oswiadczenia-statements/oswiadczenia-zasilane-z-uslugi-fedstatements.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.
