V2 Migration Guide

Schema differences

The V1 and V2 IPF Processing Data schemas are structurally similar. In most cases migration is straightforward and is simply a case of handling the data in the new POJOs. There is one small exception; Custom Objects have been streamlined for the V2 IPF Processing Data model. The V1 CustomObjectWrapper and CustomObjectType POJOs have been removed. The new CustomObjectContainer2 uses String fields of key and value as a replacement.

Custom objects are currently not exported by IPF Processing Data Egress.

Example of differences between Custom object schemas

CustomObjectContainer v1Container = CustomObjectContainer.builder()
        .object(CustomObjectWrapper.builder()
                .name("ClientCustomObject")
                .content("Custom object value")
                .build())
        .objectType(CustomObjectType.KEY_VALUE)
// Remaining fields are functionally identical
//        .primaryAssociation(...)
//        .uniqueId(...)
//        .createdAt(...)
//        .processObjectReference(..)
//        .processingContext(...)
        .build();

CustomObjectContainer2 v2Container = new CustomObjectContainer2()
        .key("ClientCustomObject")
        .value("Custom object value");
// Remaining fields are functionally identical
//        .primaryAssociation(...)
//        .uniqueId(...)
//        .createdAt(...)
//        .processObjectReference(..)
//        .processingContext(...);