Esta página no está disponible actualmente en Español. Si lo necesita, póngase en contacto con el servicio de asistencia de Icon (correo electrónico)

Refresh Modes

The dynamic config adapter performs refresh of the values on Rules Framework - Dynamic Expressions in below refresh modes.

Refresh Mode Trigger Description

Refresh All

1) Service restart / start-up

2) Periodically

1) Refreshes all the configured dynamic variables on the dynamic expression registry from configured custom processing settings.

2) Refresh all is performed on both entity scoped registry and global dynamic expression registry.

Notifications Refresh

On receiving change notifications from DPS source (custom processing settings)

1) Only refreshes the dynamic expression registry entries that are sourced from updated dynamic configuration.

2) One or more dynamic expression registry entries may be sourced from a single dynamic configuration and all the mapped registry entries will be updated.

4) Custom processing settings are processing entity specific (including the value UNKNOWN). The notification for a changed custom processing setting will update dynamic expression registry values for corresponding the processing entity only. Registry entries that belong to other processing entities will stay unchanged.
Note

  1. It is important to note that the dynamic config adapter will always only get active versions of the dynamic configurations from custom processing settings, irrespective of the refresh mode. Any custom processing settings that are in below category will not find their way to dynamic config adapter

    1. Scheduled to be active in future

    2. Not active anymore

    3. Created but needs approval

    4. Deleted

  2. There are two instances of dynamic expression registry, one is entity scoped registry and another is global registry. When the dynamic configuration being refreshed has the Processing Entity value of "UNKNOWN", the dynamic config adapter refreshes the value to the global dynamic expression registry. When the value of Processing Entity is any other than "UNKNOWN", then the value is refreshed to entity scoped registry with corresponding processing entity value.

Refresh All

On Application Startup / Restart

  1. On application startup or restart, a refresh all trigger is raised. This refreshes all the dynamic config registry entries from configured custom processing settings. The dynamic configurations sourced depend on the static configuration values. Refer to Configurations

  2. The dynamic config adapter secures the custom processing setting values by making an API request to the domain API of /custom-processing-settings. The API request includes configured setting-categories in the request.

  3. All custom processing settings matching static configuration (correlation-entries) will be saved to corresponding dynamic registry depending on processing entity (global or entity scoped).

On Periodic Interval

The adapter also supports periodic refresh to update all dynamic configurations. The periodic refresh performs refresh all as explained above. The interval is set under ipf.dynamic-config-adapter.value-refresh-period. Default value is 1 minute.

Runtime Configuration Updates via Notifications

After the initial configuration load, the adapter continuously listens for Kafka notifications from the Custom Processing Settings service to handle real-time configuration updates.

When a dynamic configuration value is created, updated, or deleted in CPS, the CustomProcessingSettingsKafkaNotificationHandler receives a notification and automatically:

  • Validates that the notification matches the configured correlation entries

  • Updates the appropriate dynamic expression registry (global or scoped based on processing entity).

  • Propagates the changes to the processing service without requiring a restart

This enables dynamic configuration updates at runtime, allowing configuration changes to take effect immediately across all relevant components.

Refer CPS Notifications for more details on notifications.

It is important to note that if there is a need for multiple nodes to be able to receive all of these notifications and update their registries accordingly, consumer group id (in this case ipf.cps-api.client.notification.kafka.consumer.kafka-clients.group.id) needs to be setup differently for each node in deployment. To understand more visit DPS Adapter Deployment.
It is important that custom processing settings that are used to source values for dynamic variables are deleted with caution. This is because a race condition between deletion notification and periodic refresh may reinstate the deleted value on the dynamic expression registry. Please follow below steps. It is also recommended that the notifications should be enabled on Custom Processing Settings for the dynamic config adapter to get the latest changes on custom processing settings.

Deleting Custom Processing Settings:

If a custom processing setting that is configured to source values to rules designer dynamic variables needs to be deleted, below steps should be followed.

  1. Delete the custom processing setting and approve the change.

  2. Restart the IPF service that used the now deleted custom processing setting on correlation entries

  3. If the custom processing setting is being deleted across all processing entities and is not needed on the rules designer anymore, then corresponding correlation entries can be removed before the service restart (and after deletion).