Debulker System Events

Overview

The Debulker application uses system events to communicate important information about any issues encountered. Each system event includes a specific reason code that helps identify the exact nature of the issue.

This page details the event schemas and lists all the possible system events raised by Debulker and their associated reason code.

Reason Codes

Reason Code Reason Description Event Name

IPFDBK001

The debulking of the file has failed.

DebulkingFailed

IPFDBK002

The file has been rejected as a duplicate.

DuplicateCheckFailed

IPFDBK003

The file has failed schema validation.

SchemaValidationFailed

IPFDBK004

File operation failed.

FileOperationFailed

IPFDBK005

Component processing initiation failed.

ComponentProcessingInitiationFailed

IPFDBK006

Component store operation failed.

ComponentStoreOperationFailed

IPFDBK007

Check duplicate transaction cache operation failed.

TransactionCacheOperationFailed

System Event Schemas

List of System Events

The below table documents the system events that can be raised by Debulker. Payload schemas are documented as JSON Schema draft 4. Use a tool such as this one for a visual representation of the payload schemas.

All events contain some basic top-level information, and a payload. The top-level information is represented as members of the DebulkerSystemErrorEvent type, and their payloads are documented below.

The schema for the top-level DebulkerSystemErrorEvent type is as follows:

Top-level Schema 
{
  "$schema" : "http://json-schema.org/draft-04/schema#",
  "title" : "Debulker System Error Event",
  "type" : "object",
  "additionalProperties" : false,
  "properties" : {
    "name" : {
      "type" : "string"
    },
    "level" : {
      "type" : "string",
      "enum" : [ "DEBUG", "INFO", "WARN", "ERROR" ]
    },
    "createdAt" : { },
    "version" : {
      "$ref" : "#/definitions/EventVersion"
    },
    "type" : {
      "type" : "string",
      "enum" : [ "TECHNICAL", "FUNCTIONAL" ]
    },
    "processingContext" : {
      "$ref" : "#/definitions/ProcessingContext"
    },
    "source" : {
      "type" : "string"
    },
    "metadata" : {
      "type" : "object",
      "additionalProperties" : {
        "type" : "string"
      }
    },
    "payload" : {
      "$ref" : "#/definitions/Object"
    },
    "reasonCode" : {
      "type" : "string"
    },
    "reasonDescription" : {
      "type" : "string"
    }
  },
  "definitions" : {
    "EventVersion" : {
      "type" : "object",
      "additionalProperties" : false,
      "properties" : {
        "major" : {
          "type" : "integer"
        },
        "minor" : {
          "type" : "integer"
        },
        "patch" : {
          "type" : "integer"
        }
      },
      "required" : [ "major", "minor", "patch" ]
    },
    "ProcessingContext" : {
      "type" : "object",
      "additionalProperties" : false,
      "properties" : {
        "associationId" : {
          "type" : "string"
        },
        "checkpoint" : {
          "type" : "string"
        },
        "unitOfWorkId" : {
          "type" : "string"
        },
        "clientRequestId" : {
          "type" : "string"
        },
        "processingEntity" : {
          "type" : "string"
        }
      }
    },
    "Object" : {
      "type" : "object",
      "additionalProperties" : false,
      "properties" : { }
    }
  }
}

Debulker System Events

Name Description Type Level Payload schema

ComponentProcessingInitiationFailed

Published when an error occurs during component processing initiation

FUNCTIONAL

ERROR

 
{
  "$schema" : "http://json-schema.org/draft-04/schema#",
  "title" : "Payload",
  "type" : "object",
  "additionalProperties" : false,
  "properties" : {
    "configName" : {
      "type" : "string"
    },
    "bulkId" : {
      "type" : "string"
    },
    "description" : {
      "type" : "string"
    }
  }
}

ComponentStoreOperationFailed

Published when an error occurs attempting to access the component store

FUNCTIONAL

ERROR

 
{
  "$schema" : "http://json-schema.org/draft-04/schema#",
  "title" : "Payload",
  "type" : "object",
  "additionalProperties" : false,
  "properties" : {
    "operationType" : {
      "type" : "string",
      "enum" : [ "SAVE", "DELETE", "FIND" ]
    },
    "bulkId" : {
      "type" : "string"
    },
    "componentId" : {
      "type" : "string"
    },
    "parentId" : {
      "type" : "string"
    }
  }
}

DebulkingFailed

Published when debulking into components fails

FUNCTIONAL

ERROR

 
{
  "$schema" : "http://json-schema.org/draft-04/schema#",
  "title" : "Payload",
  "type" : "object",
  "additionalProperties" : false,
  "properties" : {
    "description" : {
      "type" : "string"
    },
    "filename" : {
      "type" : "string"
    },
    "parsedComponentHierarchy" : {
      "type" : "array",
      "items" : {
        "type" : "string"
      }
    },
    "failedAtPath" : {
      "type" : "string"
    }
  }
}

DuplicateCheckFailed

Published when a duplicate check fails

FUNCTIONAL

ERROR

 
{
  "$schema" : "http://json-schema.org/draft-04/schema#",
  "title" : "Payload",
  "type" : "object",
  "additionalProperties" : false,
  "properties" : {
    "filePath" : {
      "type" : "string"
    }
  }
}

FileOperationFailed

Published when an error occurs during any file operation

FUNCTIONAL

ERROR

 
{
  "$schema" : "http://json-schema.org/draft-04/schema#",
  "title" : "Payload",
  "type" : "object",
  "additionalProperties" : false,
  "properties" : {
    "filePath" : {
      "type" : "string"
    },
    "operation" : {
      "type" : "string",
      "enum" : [ "READ", "WRITE", "DELETE" ]
    },
    "step" : {
      "type" : "string"
    },
    "fileSystem" : {
      "type" : "string"
    },
    "description" : {
      "type" : "string"
    }
  }
}

SchemaValidationFailed

Published when an error occurs during schema validation

FUNCTIONAL

ERROR

 
{
  "$schema" : "http://json-schema.org/draft-04/schema#",
  "title" : "Payload",
  "type" : "object",
  "additionalProperties" : false,
  "properties" : {
    "filePath" : {
      "type" : "string"
    },
    "description" : {
      "type" : "string"
    }
  }
}

TransactionCacheOperationFailed

Published when an error occurs with transaction caching during duplicate check

FUNCTIONAL

ERROR

 
{
  "$schema" : "http://json-schema.org/draft-04/schema#",
  "title" : "Payload",
  "type" : "object",
  "additionalProperties" : false,
  "properties" : {
    "fileName" : {
      "type" : "string"
    },
    "contentHash" : {
      "type" : "string"
    }
  }
}