Data Ingestion System Events

Processing Complete Event

ProcessingComplete event is raised when ProcessedEntryResponses have outcome SUCCESS and size of responses is greater than zero. When this event is raised, metric named ipf_file_ingestion_processing_finished with outcome SUCCESS is exposed with processName and fileName.

Fields

The following table explains the fields in the ProcessingCompleteEvent.Payload class:

Field Name Description

processName

The name of the process associated with the event.

fileName

The name of the file associated with the event.

Tags

The getTags() method generates the following key-value tags for the event:

Tag Key Tag Value/Source

type

A fixed value indicating the type of event: ipf_file_ingestion_processing_finished.

outcome

A fixed value reflecting the processing outcome: SUCCESS.

file_name

Retrieved dynamically from getPayload().getFileName().

process_name

Retrieved dynamically from getPayload().getProcessName().

Metadata

Additional metadata for the event:

Property Value

EventLevel

INFO (Indicates the informational level of the event.)

EventType

TECHNICAL (Indicates the type of the event.)

Processing Failed Event

ProcessingFailedEvent is raised when error occurred while executing processing definition. When this event is raised, metric named ipf_file_ingestion_processing_finished with outcome FAILED is exposed, along with processName and fileName.

Fields

The following table explains the fields in the ProcessingFailedEvent.Payload class:

Field Name Description

processName

The name of the process associated with the event.

fileName

The name of the file associated with the event.

Tags

The getTags() method generates the following key-value tags for the event:

Tag Key Tag Value/Source Description

type

ipf_file_ingestion_processing_finished

A fixed value indicating the type of event.

outcome

FAILED

A fixed value reflecting that processing failed.

file_name

Dynamically retrieved via getPayload().getFileName() or defaults to no_filename_set if absent.

The name of the file associated with the processing event.

process_name

Dynamically retrieved via getPayload().getProcessName() or defaults to no_process_name_set if absent.

The name of the process associated with the event.

Metadata

Additional metadata for the event:

Property Value

EventLevel

ERROR (Indicates the error level of the event.)

EventType

TECHNICAL (Indicates the type of the event.)

Processing Skipped Event

Processing Skipped Event is raised when ingestion of a non-corrupted file has been attempted from a directory not meant for the file being ingested (e.g. a Bank Directory Plus ingestion attempted from directory meant for IBANPlus). In the scenario, the file ingestion does not proceed, and the file is moved to Archive directory and Processing Skipped Event is raised.

Fields

The following table explains the fields in the ProcessingSkippedEvent.Payload class:

Field Name Description

fileName

The name of the file that was skipped during processing.

Tags

The getTags() method generates the following key-value tags for the event:

Tag Key Tag Value/Source Description

type

ipf_file_ingestion_processing_skipped

A fixed value indicating the type of the event.

file_name

Dynamically retrieved via getPayload().getFileName().

The name of the file that was skipped during processing.

Metadata

Additional metadata for the event:

Property Value

EventLevel

INFO (Indicates the informational level of the event.)

EventType

TECHNICAL (Indicates the type of the event.)

File Entry Processed Event

FileEntryProcessedEvent is raised for each entry is successfully processed. When this event is raised, metric named ipf_file_ingestion_file_entry_processed is exposed, along with entryId and fileName.

Overview

This event is raised during data ingestion when an ingested entry is processed.

Fields

The following table explains the fields in the FileEntryProcessedEvent.Payload class:

Field Name Description

fileName

The name of the file associated with the processed entry.

entryId

The identifier of the entry being processed.

Tags

The getTags() method generates the following key-value tags for the event:

Tag Key Tag Value/Source Description

type

ipf_file_ingestion_file_entry_processed

A fixed value indicating the type of the event.

file_name

Dynamically retrieved via getPayload().getFileName().

The name of the file associated with the processed entry.

Metadata

Additional metadata for the event:

Property Value

EventLevel

DEBUG (Indicates the debug-level nature of the event.)

EventType

TECHNICAL (Indicates the type of the event.)

File Entry Skipped Event

FileEntrySkippedEvent is raised when BankMasterConcatenated entry with bankMasterConcatenated.getIid() doesn’t have an associated Bank Master type entry. When this event is raised, metric named ipf_file_ingestion_file_entry_processed is exposed with bankMasterConcatenatedIid, fileName and proper message. It is raised only for BankMaster files.

Fields

The following table explains the fields in the FileEntrySkippedEvent.Payload class:

Field Name Description

fileName

The name of the file associated with the skipped entry.

message

A message explaining why the entry was skipped.

entryId

The identifier of the entry that was skipped.

Tags

The getTags() method generates the following key-value tags for the event:

Tag Key Tag Value/Source Description

type

ipf_file_ingestion_file_entry_skipped

A fixed value indicating the type of the event.

file_name

Dynamically retrieved via getPayload().getFileName().

The name of the file associated with the skipped entry.

Metadata

Additional metadata for the event:

Property Value

EventLevel

WARN (Indicates a warning level event.)

EventType

TECHNICAL (Indicates the type of the event.)