Recipient address – XML contact mapping

Contact data is often transferred from third-party systems, which in some cases requires contact mapping.

Note

There are two different types of contact mapping:

XML contact mapping (documented on this page)
XML contact mapping configuration have about this form:

<ContactMapping>
  <ContactItemXPath>Contact</ContactItemXPath>
  <ContactElement id="Person_LastName">lastNameSource</ContactElement>
</ContactMapping>

Default contact mapping (Link)
Standard contact mapping configurations have approximately this form:

<Mapping>
  <Map Source="lastNameSource" Target="Person_LastName" />
</Mapping>

For these mapping types, different names must be used for the contact target fields.

Address providers that use the XML contact mapping:

Configuration:

<ContactMapping>
  <!-- Default setting, see the documentation for corresponding AddressProvider in each case -->
  <ContactItemXPath>Contact<//ContactItemXPath>.
  <!-- Mapping of address provider date with key "PERSON_LASTNAME" (possible keys: see documentation from corresponding AddressProvider) -->
  <ContactElement id="Person_LastName">PERSON_LASTNAME</ContactElement>
  <!-- Mapping from defined value "FIXED VALUE" -->
  <ContactElement id="Person_Title">"FIXED VALUE"</ContactElement>
  <!-- Mapping of address provider date with key "STREET", but only if address provider date with key "TYPE" has content "INTERNAL ADDRESS" -->
  <ContactElement id="Company_Street" when="TYPE = 'Internal Address'">STREET</ContactElement>.
</ContactMapping>

All possible contact target fields are listed below.

  • Person
    (All person target fields require Person_LastName or Person_FirstName.)
    • Person_LastName
    • Person_FirstName
    • Person_Title
    • Person_SecondName
    • Person_NickName
    • Person_Initials
    • Person_Profession
    • Person_Position
    • Person_SalutationShort
    • Person_Salutation
    • Person_Greeting
    • Address
      • Person_Street
      • Person_CareOf
      • Person_Apartment
      • Person_Floor
      • Person_City
      • Person_ZipCode
      • Person_PostOfficeBox
      • Person_PostOfficeBoxCity
      • Person_PostOfficeBoxCityZipCode
      • Person_Country
      • Person_CountryShortCode
    • Communication
      • Person_Language
      • Person_Phone
      • Person_Email
      • Person_Fax
      • Person_Mobile
      • Person_Homepage
  • Company
    • Company_Name
    • Company_Supplement
    • Company_Department
    • Address
      • Company_Street
      • Company_CareOf
      • Company_Apartment
      • Company_Floor
      • Company_City
      • Company_ZipCode
      • Company_PostOfficeBox
      • Company_PostOfficeBoxCity
      • Company_PostOfficeBoxCityZipCode
      • Company_Country
      • Company_CountryShortCode
    • Communication
      • Company_Language
      • Company_Mobile
      • Company_Homepage
      • Company_PhoneDirect
      • Company_PhoneCentral
      • Company_EmailDirect
      • Company_EmailCentral
      • Company_FaxDirect
      • Company_FaxCentral
  • Options
    • Options_SelectedAddress (Value Business or Private)
    • Options_AddressingType (Value To, Cc or Bcc)
    • Options_PersonOverFirm (Value true or false)
    • Options_CountryView (Value true or false)
    • Options_CountryCodeView (Value true or false)
    • Options_SalutationView (Value true or false)
    • Options_SalutationSeparatetLine (Value true or false)
    • Options_SecondNameView (Value true or false)
    • Options_PositionView (Value true or false)
    • Options_InterneAddress (Value true or false)
  • Provider
    • Provider_ID
    • Provider_Name
    • Provider_Updated (Date, e.g. 2023-01-24)
    • Provider_Published (Date, e.g. 2023-01-24)
    • Provider_AddressLabel
    • Provider_URL
  • ExtendedField
    (The names of ExtendedFields can be chosen freely, the prefix Dynamic. is added in each case. Below are some examples).
    • ExtendedField_Field1 (creates ExtendedField Dynamic.Field1)
    • ExtendedField_CustomerNumber (creates ExtendedField Dynamic.CustomerNumber)
    • ExtendedField_MaritalStatus (creates ExtendedField Dynamic.MaritalStatus)
Note

The AdditionalPerson cannot be mapped to with this.