Skip to content
Identity and Access Management

CDH To IAM Data Synchronization

Accounts and addresses in CDH are set up to sync with IAM. In order for this data to successfully sync with IAM the data needs to be translatable to the IAM data schemas.

Account Synchronization Policy

  • name
    • The CDH name field will map to the name field
    • Any name that is longer than 100 characters will be truncated to the first 100 characters
  • customerType
    • The CDH type field maps to the customerType field
    • It must be one of the valid IAM customerType values
  • type
    • The CDH b2b field maps to the type field
    • It must be one of the valid IAM type values
  • status
    • The CDH accountStatus field maps to the status field
    • The value must be a valid value in IAM
    • The value will default to active
  • country
    • the CDH country will map to the country field
    • If the value is a valid alpha-2 code it will be used
    • If the value is not a valid alpha-2 code the system will attempt to look up a valid alpha-2 code and use that
    • If no valid alpha-2 code can be found the value will not be migrated
  • currency
    • The CDH accountCurrency field maps to the transactionInfo currency field
    • The value must be a valid currency code otherwise it will not be synced
  • ebsAccountNumber
    • The CDH ebsAccountNumber field maps to the transactionInfo ebsAccountNumber field
  • taxExemptionStatus
    • The CDH taxExemption field maps to the transactionInfo taxExemptionStatus field
    • The value must match one of the valid IAM account taxExemptionStatus fields
    • If the value is present but not valid the account will fail to sync
  • taxVatId
    • The CDH attribute9 field maps to the transactionInfo taxVatId field
  • email
    • The CDH ownersEmail field maps to the primaryContactInfo email field
    • The value syntax must be a valid email address
  • phoneNumber
    • The CDH phoneNumber field maps to the primaryContactInfo phoneNumber field

Address Synchronization Policy

  • country
    • The CDH country field maps to the address country field if it is present and valid
    • If country is not present or valid countryName will be mapped if it is present and valid
    • The value of country or countryName is valid if:
      • It is a valid alpha-2 code
      • The system is able to look up a valid alpha-2 code for the value
  • region
    • In order of precedence the address region field will be mapped by the CDH state, province or stateName fields
  • locality
    • the CDH city field will map to the address locality field
  • postalCode
    • The CDH zip field will map to the address postalCode field
  • addressLine1-4
    • Address lines are mapped directly to the corresponding field in IAM. Only addressLine1 is required.
    • If any addressLine2-4 are one of the following values, it will be ignored: [“EMPTY”, ” ”, ""]
  • status
    • The CDH addressStatus field will be mapped to the address status using the following rules
      • If the field is empty then the value will be active
      • If the field is Y the value will be active
      • If the field is N the value will be inactive
      • If the field is not empty but doesn’t meet the above conditions the address sync will fail
  • isShipTo
    • The CDH isShipTo field will be mapped to the address shipping isShipTo field
  • isBillTo
    • The CDH isBillTo field will be mapped to the address billing isBillTo field
  • isValidated
    • The CDH addressValidatedFlag field will map to the address isValidated field
    • if the value is one of [“Yes”, “Y”] then the field will be true otherwise it will be false

External Systems Synchronization

  • In order for the CDH originalSource and sourceSystems to sync the CDH system must match one of the valid externalSystems system values in IAM

    • You can get a list of the valid values via the GET /externalSystems API endpoint.

  • The sourceSystem field in IAM will be mapped according to the following rules:

    • Primary mapping originalSource:
      • If originalSource and originalSourceReference are present and valid, both fields will be mapped to IAM
      • The CDH originalSource field will be mapped to system field
      • The CDH originalSourceReference field will be mapped to refId field
    • Fallback to EBS system:
      • If originalSource and originalSourceReference are missing or invalid, retrieve EBS from CDH sourceSystems
      • The system will be the value EBS
      • The refId will be the reference set for EBS on CDH
    • Fallback to the first system in the CDH sourceSystems:
      • If EBS is not present in the CDH sourceSystems, retrieve the first valid system
      • The system will be the first valid system
      • The refId will be reference from the system on CDH
    • Final fallback:
      • If no system is valid, CDH will be mapped as the source system
      • The system will be the value CDH
      • The id will be the value daf95b20-d9b4-5e45-aef4-c59e3ede44ea
      • The refId for the account source system will be the CDH ID.
      • The refId of the address source system will be a concatenation of the address account ID and address ID
        • format: <addressId>:<accountId>

  • If CDH was not mapped as the source system, CDH will be mapped to the IAM externalSystems references array:

    • The system will be the value CDH
    • The id will be the value daf95b20-d9b4-5e45-aef4-c59e3ede44ea
    • The refId for the account source system will be the CDH ID.
    • The refId of the address source system will be a concatenation of the address account ID and address ID
      • format: <addressId>:<accountId>

  • All other CDH sourceSystems will be mapped to the IAM externalSystems references array.