debulker Model
Flows
Debulker
Flow Properties
Flow Name: |
Debulker |
Version: |
0 |
Description: |
This is a placeholder for the flow solution. |
Global State Set: |
States
| Name | Description | Global State | Is Terminal | Not Recoverable | Is Passivating |
|---|---|---|---|---|---|
Check if the file is valid compared to schema |
PENDING |
No |
No |
No |
|
Check if the file is already processed |
PENDING |
No |
No |
No |
|
File is being streamed and split into components. |
PENDING |
No |
No |
No |
|
Waiting for external client to process the debulked components. |
PENDING |
No |
No |
No |
|
Configurable step to delete/archive source file and clear component store. |
PENDING |
No |
No |
No |
|
The flow has completed. |
ACCEPTED |
Yes |
No |
No |
|
Debulking rejected |
REJECTED |
Yes |
No |
No |
Events
| Name | Description | Business Data |
|---|---|---|
The flow has been successfully started. |
||
File stream end and all components have been created. |
||
Bulk file successfully archived. |
none |
|
Debulked components have been processed by the external client. |
||
Cleaning finished for debulk that went to processing . |
none |
|
Cleaning finished for debulk that was rejected on schema validation or duplicate check. |
none |
|
Duplicate check completed. |
none |
|
Duplicate check failed. |
none |
|
Validation succeed. |
none |
|
Validation failed. |
||
Attempt to stream file and break down into components failed |
Input Behaviour
| Input | Response Code | Event Selection |
|---|---|---|
none |
||
Accepted |
||
none |
||
none |
||
Accepted |
||
Rejected |
||
Accepted |
||
Rejected |
||
Accepted |
||
Rejected |
||
Rejected |
Event Behaviour
| Given State | Criteria | Events | New State | Perform Actions |
|---|---|---|---|---|
On |
Call Function: Schema Validation |
|||
On |
Call Function: Archive Bulk Call Request: Process Debulk |
|||
On all of |
Call Function: Clean Debulk |
|||
On |
||||
On |
||||
On |
Call Function: Start Debulk |
|||
On |
Call Function: Clean Debulk |
|||
On |
Call Function: Check Duplicate |
|||
On |
Call Function: Clean Debulk |
|||
On |
Call Function: Clean Debulk |
Supporting Libraries
Business Data Libraries
Business Data Library
Business Data Elements
| Name | Description | Data Type | Data Category |
|---|---|---|---|
Provides details required to start a new debulk |
com.iconsolutions.ipf.debulk.domain.InitiateDebulking |
PROCESSING_DATA_STRUCTURE |
|
Result of the debulking process |
com.iconsolutions.ipf.debulk.domain.DebulkingResult |
PROCESSING_DATA_STRUCTURE |
|
Identifies a bulk that is being processed |
java.lang.String |
PROCESSING_DATA_STRUCTURE |
|
Provides details of why a file failed validation |
com.iconsolutions.ipf.debulk.domain.ValidationFailure |
PROCESSING_DATA_STRUCTURE |
|
Checkpoint Value of File Notification Request |
java.lang.String |
PROCESSING_DATA_STRUCTURE |
External Domains
DebulkClient
The client of the debulker, typically a IPF payment flow.
Requests
| Name | Description | Business Data | Response | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Signals to the debulker the the client has finished processing the debulked components and that they can be safely deleted. Passes the root component. |
|
Domain Function Libraries
Schema Validation
Schema validation functions library
Archive Bulk
Archive Bulk
Domain Functions
| Name | Description | Business Data | Response | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Triggers archiving of the bulk |
|
Clean Debulk
Clean Debulk
Duplicate Check
Duplicate Check
Reason Code Libraries
Debulking Reason Codes
Reason Codes
| Name | Description | Text |
|---|---|---|
IPFDBK001 |
The debulking of the file has failed. |
none |
IPFDBK002 |
The file has been rejected as a duplicate. |
none |
IPFDBK003 |
The file has failed schema validation. |
none |
IPFDBK004 |
File operation failed. |
none |
IPFDBK005 |
Component processing initiation failed. |
none |
IPFDBK006 |
Component store operation failed. |
none |
IPFDBK007 |
Check duplicate transaction cache operation failed. |
none |