(Breaking) Changes in Golden Copy Exports

This document outlines the changes to the Golden Copy Export. Consumers of the data are advised to pay special attention to the breaking changes.

XML Export

The XML exports adhere to the official CDF schemas. Please refer to example Golden Copy XML on the website.

JSON Export

The following fields will be added to the Golden Copy JSON export. Please refer to example Golden Copy JSON export files on the website.

Entity.EntityCreationDate.$

Entity.EntitySubCategory.$

Entity.SuccessorEntity[*].SuccessorLEI.$
Entity.SuccessorEntity[*].SuccessorEntityName.$
Entity.SuccessorEntity[*].SuccessorEntityName.@xml:lang

Entity.LegalEntityEvents.LegalEntityEvent[*].@group_type
Entity.LegalEntityEvents.LegalEntityEvent[*].@group_id
Entity.LegalEntityEvents.LegalEntityEvent[*].@group_sequence_no
Entity.LegalEntityEvents.LegalEntityEvent[*].@event_status
Entity.LegalEntityEvents.LegalEntityEvent[*].LegalEntityEventType.$
Entity.LegalEntityEvents.LegalEntityEvent[*].LegalEntityEventEffectiveDate.$
Entity.LegalEntityEvents.LegalEntityEvent[*].LegalEntityEventRecordedDate.$
Entity.LegalEntityEvents.LegalEntityEvent[*].ValidationDocuments.$
Entity.LegalEntityEvents.LegalEntityEvent[*].AffectedFields.AffectedField[*].@field_xpath
Entity.LegalEntityEvents.LegalEntityEvent[*].AffectedFields.AffectedField[*].$

Breaking Changes

Now-repeating SuccessorEntity

The Entity.SuccessorEntity field is now an array to reflect the change in the CDF standard to now support multiple SuccessorEntity XML elements.

Ensured Arrays

Currently, some of the repeating CDF fields are representated differently depending on whether there is one or more XML elements. This behavior will change to ensure repeating elements will consistently be represented as array.

Example:

Currently, if there is only a single AdditionalAddressLine, the resulting JSON would be:

{
  "AdditionalAddressLine" : {
    "$" : "Line 1"
  },
  // ...
}

In case of multiple AdditionalAddressLine elements, it would instead be an array:

{
  "AdditionalAddressLine" : [
    {
      "$" : "Line 1"
    },
    {
      "$" : "Line 2"
    }
  ],
  // ...
}

Below is a comprehensive list of all fields that will always be represented as an array (the fields marked with "new" will take effect in the upcoming version).

LEI 2.1

OtherEntityName
TransliteratedOtherEntityName
OtherAddress
TransliteratedOtherAddress
SuccessorEntity             # new
AdditionalAddressLine       # new
OtherValidationAuthority    # new

RR 1.1

RelationshipQualifier       # new
RelationshipQuantifier      # new

REPEX 1.1

ExceptionReference          # new
ExceptionReason             # new

CSV Export

The following columns will be added to the Golden Copy CSV export. Please refer to example Golden Copy CSV export files on the website.

Analogous to the already existing repeating CDF fields, the CSV export will always include up to 5 elements and the columns will be left empty if there are less or none.

# EnityCreationDate
Entity.EntitySubCategory

# SubCategory
Entity.EntityCreationDate

# Now-repeating Successor Entities
Entity.SuccessorEntity.1.SuccessorLEI
Entity.SuccessorEntity.1.SuccessorEntityName
Entity.SuccessorEntity.1.SuccessorEntity.xmllang
...

# Entity Events
Entity.LegalEntityEvents.LegalEntityEvent.1.group_type
Entity.LegalEntityEvents.LegalEntityEvent.1.event_status
Entity.LegalEntityEvents.LegalEntityEvent.1.group_id
Entity.LegalEntityEvents.LegalEntityEvent.1.group_sequence_no
Entity.LegalEntityEvents.LegalEntityEvent.1.LegalEntityEventType
Entity.LegalEntityEvents.LegalEntityEvent.1.LegalEntityEventEffectiveDate
Entity.LegalEntityEvents.LegalEntityEvent.1.LegalEntityEventRecordedDate
Entity.LegalEntityEvents.LegalEntityEvent.1.ValidationDocuments
Entity.LegalEntityEvents.LegalEntityEvent.1.ValidationReference
Entity.LegalEntityEvents.LegalEntityEvent.1.AffectedFields.1.AffectedField
Entity.LegalEntityEvents.LegalEntityEvent.1.AffectedFields.1.field_xpath
Entity.LegalEntityEvents.LegalEntityEvent.1.AffectedFields.2.AffectedField
Entity.LegalEntityEvents.LegalEntityEvent.1.AffectedFields.2.field_xpath
Entity.LegalEntityEvents.LegalEntityEvent.1.AffectedFields.3.AffectedField
Entity.LegalEntityEvents.LegalEntityEvent.1.AffectedFields.3.field_xpath
Entity.LegalEntityEvents.LegalEntityEvent.1.AffectedFields.4.AffectedField
Entity.LegalEntityEvents.LegalEntityEvent.1.AffectedFields.4.field_xpath
Entity.LegalEntityEvents.LegalEntityEvent.1.AffectedFields.5.AffectedField
Entity.LegalEntityEvents.LegalEntityEvent.1.AffectedFields.5.field_xpath
...

Breaking Changes

Inserted Columns

Depending on the CSV processing approach, the additional columns that will be inserted between existing columns could lead to unexpected results. See the above section for the newly included fields and refer to example Golden Copy CSV export files on the website.

Now-repeating Successor Entities

As of CDF 3.1, the SuccessorEntity XML element can be repeated. This is reflected in the CSV export as shown below.

Before (LEI 2.1):

Entity.SuccessorEntity.SuccessorLEI
Entity.SuccessorEntity.SuccessorEntityName
Entity.SuccessorEntity.SuccessorEntityName.xmllang

After (LEI 3.1):

Entity.SuccessorEntity.1.SuccessorLEI
Entity.SuccessorEntity.1.SuccessorEntityName
Entity.SuccessorEntity.1.SuccessorEntity.xmllang
...
Entity.SuccessorEntity.5.SuccessorLEI
Entity.SuccessorEntity.5.SuccessorEntityName
Entity.SuccessorEntity.5.SuccessorEntity.xmllang