Documentation for a newer release is available. View Latest
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)

Notifications

Clients can optionally enable notifications for when files produced by SEPA CT are ready for consumption. When enabled, subscribe to the applicable Kafka topic (configurable as per below) to receive the following notifications generated by the SEPA CT STEP2 CSM service:

  • BulkFileReadyNotification

  • InboundValidationFailureNotification

Configuration

The following configuration property allows you to define the name of the Kafka topic the notifications are published to.

Config

Type

Default

ipf.csm.sepa.notification.kafka.producer.topic

String

SEPA_CSM_SERVICE_NOTIFICATION

ipf.csm.sepa.notification.enabled

Boolean

true

BulkFileReadyNotifications

A BulkFileReadyNotification is generated when a bulk file has been written to the configured file system location and is ready for further processing by the Client.

Content

The BulkFileReadyNotification contents are:

Field Type Comment

name

String

Canonical name of the notification class

bulkId

String

Unique identifier for the bulk file

createdAt

java.time.Instant

Timestamp when the notification was generated

payload.filename

String

Filename of the bulk file

payload.path

String

Path to the bulk file

payload.unitOfWorkIds

List<String>

A list of all the UnitOfWorkIds that were in the bulk

payload.processingEntity

String

The processing entity associated with this bulk

BulkFileReady Notification Scenarios

The following scenarios describe the conditions under which the system generates and sends a BulkFileReadyNotification to the configured Kafka topic.

As indicated in the table below, if a file is successfully produced but archiving fails, an error is logged in the application logs but a BulkFileReadyNotification is still sent as a failure to archive should not prevent processing by SEPA
Bulk File Validation Outcome Bulk File Archiving Outcome BulkFileReadyNotification Sent

Passed

Passed

Yes

Passed

Disabled

Yes

Disabled

Passed

Yes

Disabled

Disabled

Yes

Failed

Will not be triggered due to file validation failure

No

Passed

Failed

Yes

Disabled

Failed

Yes

InboundValidationFailureNotification

A InboundValidationFailureNotification is generated when a failure has occurred during validation of the inbound message, for example a schema validation failure.

Content

The InboundValidationFailureNotification contents are:

Field Type Comment

name

String

Canonical name of the notification class

bulkId

String

Unique identifier for the bulk file

createdAt

java.time.Instant

Timestamp when the notification was generated

payload.content

String

The content of the message that was input to the inbound USM flow

payload.errorMessage

String

The error message that caused the validation failure.