====== Modul notifikací ======

===== Popis a účel modulu =====

Modul notifikací (modulový název ''idm-ntf'') je **placený modul**, který není standardně součástí základních balíčků ani výchozích instalací v projektech. Jeho cílem je umožnit snadné vytváření a konfiguraci notifikací bez nutnosti implementace složitých struktur. Zaměřuje se především na tyto oblasti:

  * Snadné vytvoření nové notifikace.
  * Jednoduchá konfigurace existujících notifikací (zapínání, vypínání, úprava nastavení).
  * Propojení s existujícím mechanismem notifikací v IdM (šablony, topicy, ...).

Modul se do IdM nasazuje standardně nahráním JAR souboru do appliance (///data/volumes/czechidm/modules///) a následným restartem IdM. Poté je nutné modul aktivovat přes standardní aktivaci modulu v sekci **Settings → Modules → ACTIVATE**.

<note important>U deaktivovaného modulu **nebudou** odesílány ani kontrolovány žádné notifikace.</note>

===== Podporované verze IdM produktu =====

Modul je aktuálně podporován pouze v následujících verzích produktu:

  * 12.x.x
  * 14.x.x

Použití ve starších verzích IdM **nemusí** fungovat správně a není oficiálně podporováno.

===== Základní konfigurace =====

Modul aktuálně **neobsahuje** žádnou novou agendu ani vlastní stránku s definicí v notifikací. Jeho konfigurace se nyní nachází v číselnících. Tyto číselníky jsou předpřipravané automaticky s prvním startem aplikace a jejich nastavení se kontroluje s každým restartem aplikace IdM. Jedná se o následující čísleníky:
  * Entity events (ntf-entity-event).
  * Entity types (ntf-entity-type).
  * Notification code list (ntf-notification).

<note tip>Číselníky jsou vytvořeny automaticky. Pro číselníky Entity events a Entity types dojde automaticky i k naplnění hodnotami.</note>

Veškerá konfigurace modulu probíhá v číselníku Notification code list (ntf-notification). Ostatní číselníky slouží především k ulehčení práce s konfigurací a omezení jaké objekty a události je možné použít. Detailnější popis je v následujících sekcích.

Pro konfiguraci nové notifikace využijte vložení nového záznamu do číselníku Notification code list (ntf-notification).


==== Codelist: Entity events (ntf-entity-event) ====

Číselník obsahuje dynamicky generované typy událostí (entity events), pro které je možné vytvářet a konfigurovat notifikace. Aktuálně podporované události jsou:

  * CREATE
  * DELETE
  * UPDATE

<note important>Číselník **neupravujte** manuálně. Hodnoty jsou spravovány a kontrolovány IdM.</note>

==== Codelist: Entity types (ntf-entity-type) ====

Číselník obsahuje dynamicky generované typy entit, pro které je možné vytvářet a konfigurovat notifikace. Aktuálně podporované typy entit jsou:

  * Uživatel / identita – ''eu.bcvsolutions.idm.core.api.dto.IdmIdentityDto''
  * Provisioning – ''eu.bcvsolutions.idm.acc.dto.SysProvisioningOperationDto''

<note important>Číselník **neupravujte** manuálně. Hodnoty jsou spravovány a kontrolovány IdM.</note>

Pro doplnění dalších typů entit je **nutná programátorská implementace** v kódu modulu notifikací.

==== Codelist: Notification code list (ntf-notification) //(hlavní)// ====

Hlavní číselník ve kterém je možné provádět přidávání a editovat konfigurace notifikací. V tomto číselníku naleznete všechny aktuální definice. Každá definice notifikace obsahuje následující konfigurační položky:

  * Entity type,
  * Event type,
  * Form projection,
  * System,
  * Rules,
  * Rules by script,
  * Topic,
  * Level,
  * Send to identity itself
  * Send to manager
  * Send to identities
  * Send to roles
  * Recipients by script
  * Disable

==== Pravidla ====
==== Parametry šablon ====
==== Přístupová práva a oprávnění ====
==== Nastavení šablon a textací ====
===== Příklady použití (scénáře) =====
===== (DEVELOPER) Technická dokumentace vývojaře =====
==== Technické detaily ====
==== Implementace/Podpora nového objektu ====
==== Konfigurační volby modulu ====
===== Známé problémy =====