Powered by Smile CDR v2025.02.PRE-04 (build e75afbc13c)

Showing documentation for 2024.08.R01

On this page:

49.20 Channel Import 49.22 Kafka

49.21.1Channel Retry

The Channel Retry configuration category includes the following configurable options:

Failure Channel Name
Retry Delay(ms)
Maximum amount of retry attempts.
Maximum Delay(ms) between attempts.
Retry Channel Name
Retriable Exceptions
Retry Strategy

49.21.2Property: Failure Channel Name

Property Name	Failure Channel Name
Property Key
Property Type	STRING
Description	The name of Kafka topic or ActiveMQ queue where resources are sent after they have exceeded the maximum number of retry attempts, and have still not been successfully processed.
Applies to Modules	Channel Import Realtime Export
Default Value	(no default)
Example Property	`module.[MODULE_ID].config.channel.failed.name =`

49.21.3Property: Retry Delay(ms)

Property Name	Retry Delay(ms)
Property Key
Property Type	POSITIVE_INTEGER
Description	The minimum amount of time to wait (milliseconds) between retry attempts.
Applies to Modules	Channel Import Realtime Export
Default Value	`1000`
Example Property	`module.[MODULE_ID].config.channel.retry.delay_milliseconds = 1000`

49.21.4Property: Maximum amount of retry attempts.

Property Name	Maximum amount of retry attempts.
Property Key
Property Type	POSITIVE_INTEGER
Description	The maximum amount of times to attempt import before considering a message failed. Non-zero value required for retry to be enabled. If set to zero, failed messages will skip the retry channel completely and go directly to the failure channel.
Applies to Modules	Channel Import Realtime Export
Default Value	`1`
Example Property	`module.[MODULE_ID].config.channel.retry.maximum_attempts = 1`

49.21.5Property: Maximum Delay(ms) between attempts.

Property Name	Maximum Delay(ms) between attempts.
Property Key
Property Type	POSITIVE_INTEGER
Description	The maximum amount of time to wait (milliseconds) between retry attempts. This provides an upper limit for exponential backoff.
Applies to Modules	Channel Import Realtime Export
Default Value	`1000`
Example Property	`module.[MODULE_ID].config.channel.retry.maximum_delay_milliseconds = 1000`

49.21.6Property: Retry Channel Name

Property Name	Retry Channel Name
Property Key
Property Type	STRING
Description	The name of Kafka topic or ActiveMQ queue where inbound resources are sent when a failure occurs during processing of an incoming resource. Non-null value required for retry to be enabled.
Applies to Modules	Channel Import Realtime Export
Default Value	(no default)
Example Property	`module.[MODULE_ID].config.channel.retry.name =`

49.21.7Property: Retriable Exceptions

Property Name	Retriable Exceptions
Property Key
Property Type	STRING_MULTILINE
Description	A list of Exception classes that indicate processing should be retried. Add one per line. If left blank, all exceptions will be treated as retriable. Any exceptions that are caught that are non-retriable will cause the message to go directly to the failure channel.
Applies to Modules	Channel Import Realtime Export
Default Value	(no default)
Example Property	`module.[MODULE_ID].config.channel.retry.retriable_exceptions =`

49.21.8Property: Retry Strategy

Property Name	Retry Strategy
Property Key
Property Type	ENUM
Values	`CONSTANT` `EXPONENTIAL`
Description	Which backoff strategy to attempt during retries. Valid options are `CONSTANT` and `EXPONENTIAL`. Non-null value required for retry to be enabled.
Applies to Modules	Channel Import Realtime Export
Default Value	`CONSTANT`
Example Property	`module.[MODULE_ID].config.channel.retry.strategy = CONSTANT`

49.20 Channel Import 49.22 Kafka