On this page:
   35.14    Channel Import 35.16    Cluster Manager Maintenance   

35.15Channel 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

35.15.1Property: 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 = 

35.15.2Property: 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

35.15.3Property: 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

35.15.4Property: 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

35.15.5Property: 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 = 

35.15.6Property: 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 = 

35.15.7Property: 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
   35.14    Channel Import 35.16    Cluster Manager Maintenance