> 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/model-danych/typy-danych-i-inwentarz-danych.md).

# Typy danych i inwentarz danych

## Wprowadzenie

**Typ danych** opisuje strukturę fragmentu modelu danych, np. dane wnioskodawcy, parametry produktu albo dane nieruchomości. Po przypisaniu typu danych do węzła modelu edytor podpowiada klucze pól wraz z ich opisami i rodzajami wartości, a platforma rozpoznaje typ danych przechowywanych w tym fragmencie modelu.

**Inwentarz danych** to spis informacji przechowywanych w modelu aplikacji biznesowych. Jest podzielony na kategorie, np. dane identyfikacyjne i kontaktowe osób, finanse czy nieruchomości. Każdy typ należy do jednej kategorii inwentarza, a każda jego właściwość jest pozycją w tej kategorii. Dzięki temu dla każdej instancji aplikacji wiadomo, jakiego typu dane zostały zapisane.

Inwentarz obejmuje wszystkie dane opisane typami danych, nie tylko dane osobowe. Uwzględnia również dane produktowe, np. parametry kredytu.

Inwentarz danych służy m.in. do:

* wskazania platformie danych osobowych, które podlegają mechanizmom RODO (depersonalizacja, eksport, usuwanie) - patrz [RODO w modelu danych](https://docs.eximee.com/budowanie-aplikacji/model-danych/rodo-zarzadzanie-danymi-osobowymi.md),
* przekazywania zapisanych danych do systemu ewidencji danych organizacji w ustalonej, wspólnej dla wszystkich aplikacji strukturze,
* kontroli rodzaju wartości zapisywanych w modelu danych - patrz [Rodzaj wartości pola (typowanie)](https://docs.eximee.com/budowanie-aplikacji/model-danych/struktura-modelu-danych.md#rodzaj-wartosci-pola-typowanie).

{% hint style="info" %}
Katalog typów danych jest konfigurowany osobno dla każdego wdrożenia platformy. Jeśli edytor modelu danych nie wyświetla pola **Typ danych**, wdrożenie nie ma skonfigurowanego katalogu typów. Przykłady na tej stronie dotyczą wniosku o kredyt hipoteczny - katalog w danym wdrożeniu może zawierać inne typy.
{% endhint %}

## Podstawowe pojęcia

| Pojęcie                    | Znaczenie                                                                                                                                                             |
| -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Typ danych**             | Opis struktury fragmentu modelu danych: lista właściwości z opisami i rodzajem wartości. Jest wybierany w polu **Typ danych** węzła.                                  |
| **Kategoria inwentarza**   | Grupa danych w inwentarzu, do której należy typ danych, np. *Dane identyfikacyjne osób* albo *Nieruchomości*. O kategorii decyduje typ, a nie klucz węzła w modelu.   |
| **Właściwość typu**        | Pole zdefiniowane w typie danych, np. `firstName` albo `city`. Odpowiada pozycji w kategorii inwentarza.                                                              |
| **Struktura zagnieżdżona** | Właściwość, która sama ma strukturę, np. adres albo lista kanałów kontaktu. Może należeć do innej kategorii inwentarza niż typ nadrzędny, np. *Dane kontaktowe osób*. |
| **Wartość stała**          | Wartość właściwości ustalona w typie danych, np. rodzaj podmiotu albo kod produktu. Uzupełnia ją platforma, więc nie deklaruje się jej w modelu.                      |
| **Pole spoza schematu**    | Pole węzła, którego klucz nie odpowiada żadnej właściwości typu. Jest dozwolone, ale nie trafia do inwentarza.                                                        |

## Ustawianie typu danych na węźle

1. Otwórz model danych aplikacji w trybie edycji.
2. Kliknij **Dodaj pole** i w polu **Klucz** wprowadź nazwę węzła, np. `nieruchomosc`.
3. W polu **Typ danych** wybierz typ z listy, np. **Nieruchomość**. Przy każdym typie lista pokazuje jego opis.

<figure><img src="https://1082717226-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2CssJT0zIo4SJQLbSZ6l%2Fuploads%2Fgit-blob-9ee3394e4ecc25733c5bf7cdd11ea31cdaabebea%2FwyborTypuDanych.png?alt=media" alt="Lista typów danych w karcie węzła modelu danych"><figcaption><p><em><strong>Ilustracja 1.</strong> Wybór typu danych węzła</em></p></figcaption></figure>

Podczas ustawiania typu obowiązują następujące zasady:

* Typ można przypisać tylko do węzła, którego żaden z przodków nie ma przypisanego typu. Węzły potomne dziedziczą typ przodka - pole **Typ danych** nie jest dla nich wyświetlane.
* Przypisanie typu nie dodaje automatycznie pól do węzła. Pola należy dodać osobno, wybierając je z listy właściwości typu.
* Usunięcie typu wymaga wyczyszczenia pola **Typ danych**. Pola węzła pozostają bez zmian.
* Ten sam typ można przypisać do kilku węzłów modelu, np. opisujących kredytobiorcę i współkredytobiorcę. Wszystkie te węzły są uwzględniane w tej samej kategorii inwentarza danych.

## Dodawanie pól z typu danych

1. W węźle z ustawionym typem kliknij **Dodaj pole**.
2. Rozwiń pole **Klucz** i wybierz właściwość typu z listy, np. `propertyKind`. Przy każdej właściwości lista pokazuje jej opis i rodzaj wartości. Aby znaleźć właściwość, wpisz fragment jej nazwy w pole **Szukaj lub wpisz nazwę**.
3. Powtórz kroki 1-2 dla każdej danej, którą aplikacja musi przechowywać w modelu.

<figure><img src="https://1082717226-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2CssJT0zIo4SJQLbSZ6l%2Fuploads%2Fgit-blob-2d13a48bd88f168aa6de4cfe5bfb2aaf03d9635e%2FwyborKluczaZTypu.png?alt=media" alt="Lista właściwości typu danych w polu Klucz"><figcaption><p><em><strong>Ilustracja 2.</strong> Wybór klucza pola z listy właściwości typu</em></p></figcaption></figure>

Lista zawiera tylko właściwości, które nie zostały jeszcze przypisane do innych pól tego samego węzła. Wybranie właściwości listowej, np. listy kanałów kontaktu, automatycznie oznacza pole jako **Tablicę**.

Po wpisaniu klucza spoza listy edytor oznacza pole etykietą **Pole spoza schematu**. Działanie pola nie ulega zmianie, ale nie należy ono do inwentarza i nie jest objęte mechanizmami, które z niego korzystają, np. obsługą danych osobowych.

{% hint style="warning" %}
Do węzła należy dodawać tylko właściwości potrzebne aplikacji. Każda dodana właściwość poszerza zakres inwentarza danych, a jeśli zawiera dane osobowe - także zakres danych objętych mechanizmami RODO.
{% endhint %}

## Wartości stałe

W definicji typu danych można określić stałą wartość właściwości. Przykładowo w typie **Wnioskodawca** rodzaj podmiotu ma wartość *osoba fizyczna*, a w typie **Parametry kredytu** określony jest stały kod produktu. Taka wartość jest identyczna dla każdego węzła tego typu, dlatego:

* edytor nie podpowiada tej właściwości na liście kluczy,
* platforma przekazuje wartość stałą przy każdym zapisie danych węzła, nawet jeśli zapis nie zawiera innych wartości tego węzła,
* wartość stała nie jest przechowywana w modelu danych i nie jest zwracana przy odczycie modelu.

Jeśli mimo to do węzła zostanie dodane pole o kluczu właściwości ze stałą wartością, edytor oznaczy je jako **Pole spoza schematu**, a platforma przekaże wartość wynikającą z typu - wartość zapisana w polu jest pomijana.

## Inwentarz danych w działającej aplikacji

{% hint style="info" %}
Przekazywanie informacji o inwentarzu jest włączane osobno dla każdego wdrożenia platformy. Jeśli nie jest włączone, typy danych nadal porządkują model w edytorze, ale zapis danych nie niesie informacji o kategoriach inwentarza.
{% endhint %}

Gdy przekazywanie informacji o inwentarzu jest włączone, platforma przy każdym zapisie wartości do modelu danych:

1. Ustala dla każdego zapisywanego pola najbliższy węzeł z ustawionym typem danych.
2. Na podstawie typu i ścieżki pola względem tego węzła ustala kategorię i pozycję inwentarza.
3. Dołącza tę informację do każdej zapisanej wartości w zdarzeniu zapisu modelu danych, razem z wartościami stałymi typu.

System odbierający zdarzenia, np. system ewidencji danych organizacji albo komponent realizujący depersonalizację, nie musi znać definicji modelu danych aplikacji - informacje zawarte w zdarzeniu pozwalają określić, jakie dane zostały zapisane i do jakiej kategorii należą. Ponieważ kategoria wynika z typu, a nie z klucza, ten sam typ użyty pod różnymi kluczami lub w różnych aplikacjach trafia do inwentarza w ten sam sposób.

## Przykład

Aplikacja obsługuje wniosek o kredyt hipoteczny. Model danych zawiera trzy węzły z ustawionymi typami:

| Węzeł           | Typ danych            | Kategoria inwentarza      |
| --------------- | --------------------- | ------------------------- |
| `kredytobiorca` | **Wnioskodawca**      | Dane identyfikacyjne osób |
| `kredyt`        | **Parametry kredytu** | Parametry kredytu         |
| `nieruchomosc`  | **Nieruchomość**      | Nieruchomości             |

Tak wygląda ten fragment modelu w widoku źródła (pominięto atrybuty bez znaczenia dla przykładu):

```json
{
  "items": [
    {
      "key": "kredytobiorca",
      "type": "applicant",
      "items": [
        { "key": "firstName", "items": [] },
        { "key": "lastName", "items": [] },
        { "key": "pesel", "items": [] },
        {
          "key": "contacts",
          "multiplicityMax": null,
          "items": [
            { "key": "channel", "items": [] },
            { "key": "value", "items": [] }
          ]
        }
      ]
    },
    {
      "key": "kredyt",
      "type": "mortgage-terms",
      "items": [
        { "key": "amount", "items": [] },
        { "key": "periodMonths", "items": [] }
      ]
    },
    {
      "key": "nieruchomosc",
      "type": "real-estate",
      "items": [
        { "key": "propertyKind", "items": [] },
        { "key": "city", "items": [] },
        { "key": "landRegisterNumber", "items": [] }
      ]
    }
  ]
}
```

W tej konfiguracji:

* atrybut `type` występuje tylko na węzłach `kredytobiorca`, `kredyt` i `nieruchomosc` - ich potomkowie nie mają własnego typu,
* pola `contacts.channel` i `contacts.value` należą do kategorii *Dane kontaktowe osób*, bo właściwość `contacts` typu **Wnioskodawca** ma własną strukturę zagnieżdżoną,
* model nie zawiera pól z rodzajem podmiotu ani kodem produktu - platforma przekazuje je jako wartości stałe typów **Wnioskodawca** i **Parametry kredytu**.

## Skąd pochodzą typy danych

Katalog typów danych przygotowuje zespół wdrożeniowy platformy na podstawie potrzeb organizacji. Typy danych, ich właściwości i kategorie inwentarza są wspólne dla wszystkich aplikacji w danym wdrożeniu. Edytor modelu danych umożliwia ich wybór, ale nie pozwala na ich tworzenie ani modyfikowanie. Brak potrzebnego typu lub właściwości należy zgłosić zespołowi wdrożeniowemu.

{% hint style="warning" %}
Jeśli w nowej wersji katalogu właściwość zostanie usunięta lub zmieni się jej nazwa, powiązane z nią pola modelu danych zostaną oznaczone jako **Pole spoza schematu** i nie będą uwzględniane w inwentarzu danych. Platforma nie aktualizuje tych pól automatycznie. W takiej sytuacji należy dostosować klucze pól do właściwości dostępnych w nowej wersji katalogu oraz zaktualizować formularze i skrypty odwołujące się do tych pól.
{% endhint %}

## Dobre praktyki

* Typy danych warto przypisywać już na etapie projektowania modelu danych, zanim formularze i skrypty zaczną odwoływać się do jego kluczy.
* Klucze pól należy wybierać z listy właściwości typu zamiast wpisywać je ręcznie - pole spoza schematu nie trafia do inwentarza.
* Nie należy dodawać do modelu pól przeznaczonych na wartości stałe zdefiniowane w typie - uzupełnia je platforma.
* Nie należy przechowywać w modelu informacji, które można pobierać dynamicznie z systemów źródłowych za pomocą [źródeł danych](https://docs.eximee.com/budowanie-aplikacji/model-danych/edycja-modelu-danych.md#zrodlo-danych).

## Powiązane informacje

* [Struktura modelu danych](https://docs.eximee.com/budowanie-aplikacji/model-danych/struktura-modelu-danych.md) - węzły, liście i rodzaj wartości pola.
* [Edycja modelu danych](https://docs.eximee.com/budowanie-aplikacji/model-danych/edycja-modelu-danych.md) - praca z edytorem modelu danych w Designerze.
* [RODO w modelu danych](https://docs.eximee.com/budowanie-aplikacji/model-danych/rodo-zarzadzanie-danymi-osobowymi.md) - obsługa danych osobowych w modelu danych.


---

# 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/model-danych/typy-danych-i-inwentarz-danych.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.
