Supported mapping configurations

Destinations built with Destination SDK support specific identity namespace and attribute mapping configurations, based on the destination type.

This article describes all the supported mapping configurations that you can use when configuring your destination.

WARNING
Any mapping configuration that is not described in this article is not supported by Destination SDK.

When building your destination, configure your schema and identity namespaces according to one of the mapping configurations described in this page.

IMPORTANT
All parameter names and values supported by Destination SDK are case sensitive. To avoid case sensitivity errors, please use the parameters names and values exactly as shown in the documentation.

Supported mappings for streaming destinations streaming-mappings

Real-time (streaming) destinations built with Destination SDK support the mapping configurations described in the table below.

Source field
Target field
XDM attribute
Custom attribute
Identity namespace
Identity namespace

The configuration example below allows customers to use both mappings in the table above.

"schemaConfig":{
   "profileRequired":true,
   "segmentRequired":true,
   "identityRequired":true
},
"identityNamespaces":{
   "Customer_contact":{
      "acceptsAttributes":false,
      "acceptsCustomNamespaces":true,
      "acceptedGlobalNamespaces":{
         "Email":{

         },
         "Phone":{

         }
      }
   }
},

Map XDM attributes to custom attributes streaming-xdm-to-custom

Users can map attributes from their source XDM profile to custom attributes on your destination’s side.

Users must manually enter the name of the target custom attribute when selecting the target field mapping.

Platform UI screenshot showing customa attribute selection.

The resulting UI experience is shown in the image below.

Platform UI screenshot showing XDM attribute mapping to custom attributes for streaming destinations.

Map identity namespaces to partner identity namespaces streaming-identity-to-identity

Users can map custom or global identity namespaces from Platform to identity namespaces that you defined.

The resulting UI experience is shown in the image below.

Platform UI screenshot showing identity mapping to identity for streaming destinations.

Supported mappings for file-based destinations batch-mappings

File-based destinations built with Destination SDK support the mapping configurations described in the table below. See the next sections for detailed mapping examples.

Source field
Target field
XDM attribute
Attribute / Custom attribute
Identity namespace
Attribute / Custom attribute
Identity namespace
Identity namespace

The configuration example below allows customers to use all the mappings from the table above.

"schemaConfig":{
   "profileRequired":true,
   "segmentRequired":true,
   "identityRequired":true
},
"identityNamespaces":{
   "Customer_contact":{
      "acceptsAttributes":false,
      "acceptsCustomNamespaces":true,
      "acceptedGlobalNamespaces":{
         "Email":{
         },
         "Phone":{
         }
      }
   }
},

Map XDM attributes to custom attributes batch-xdm-to-custom

Users can map attributes from their source XDM profile to custom attributes on your destination’s side.

For file-based destinations, the target field is automatically populated with a default attribute of the same name as the source field.

The resulting UI experience is shown in the image below.

Platform UI screenshot showing XDM mapping to custom attributes for file-based destinations.

Users can leave the default name in place or enter a custom attribute name in the target field selection screen.

Platform UI screenshot showing custom target attribute selection for file-based destinations.

Map identity namespaces to custom attributes batch-identity-to-custom

Users can map custom or global identity namespaces from Platform to custom attributes on your destination’s side.

When selecting an identity namespace as a source field, the target field is automatically populated with an equivalent identity namespace. To replace the target field with a custom attribute, users must enter a custom attribute name in the target field selection screen.

Platform UI screenshot showing custom target attribute selection for file-based destinations.

The resulting UI experience is shown in the image below.

Platform UI screenshot showing identity mapping to custom attributes for file-based destinations.

Map identity namespaces to partner identity namespaces batch-identity-to-identity

Users can map custom or global identity namespaces from Platform to equivalent identity namespaces.

When selecting an identity namespace as a source field, the target field is automatically populated with an equivalent identity namespace.

The resulting UI experience is shown in the image below.

Platform UI screenshot showing identity mapping to identity for file-based destinations.

Next steps next-steps

After reading this article, you should have a better understanding of what mappings are supported by destinations built with Destination SDK.

To learn more about the other destination components, see the following articles:

recommendation-more-help
7f4d1967-bf93-4dba-9789-bb6b505339d6