14.0:documentation:modules_extras:sync_code_list_items

Synchronization of code list's items

Since extras 3.2.0

Purpose of this LRT is to enable synchronization of code list's items. Native suport for this is not in product yet. Please check the state of this ticket https://redmine.czechidm.com/issues/2857 if this feature is already in product use native support instead.

This LRT is using "classic" system configuration. In IdM go to tab Systems and create new system. Choose the right connector (depends on the type of system from which you want to load data). Typical usage will be database connector

Connector must support synchronization operation, otherwise the LRT end with error

Fill configuration according to used connector and test connection on Configuration tab. Now you need to go to Schema tab a generate schema. That's all you don't need to create mapping and synchroniation, because there is no entity as Code List right now.

Next step is to create empty Code List in IdM.
Finally we can configure this LRT. It has few parameters.

  • System - Required - System will be used for loading data. Configuration and schema must be prepared.
  • Code of code list - Required - Code list has to already exist. Item's will be created/updated/deleted in this code list.
  • Attribute with name - Required - Value, which will be used as item name.

Supported operations

  • Create - If item with specific code is not in code list it will be created.
  • Update - If item with specific code is in code list. The name of this item will be updated.
  • Delete - If item is in code list, but no in source system, it will deleted from code list
As a safety feature. If zero items is returned from end system. No items will be deleted in IdM. If you wand to delete all item's do it manually in IdM