Salesforce CDP API Developer Guide
jMobile Schema Support in Salesforce CDP
To use a unified data model across Salesforce, we recommended using the Mobile
Connector Schema when configuring a Mobile Connector.
Download the Mobile Connector schema.
Event schema mappings:
Translating SDK Events to Mobile Connector Schemas
Understanding how the events from the Salesforce CDP Module for the Engagement Mobile SDK are converted into data that can be ingested into Salesforce CDP can be useful for troubleshooting instrumentation code and for extending your schema to capture extra data not covered by the Recommended Schema.
The Salesforce CDP event beacon requires fields to be present on all events.
| Source Event Property | Target Schema Developer Name | Field Type | Description |
|---|---|---|---|
| <Automatically Assigned> | eventId | text | Required. Typically the primary key for the engagement events. |
| <Automatically Assigned> | dateTime | date | Required. Used for data partitioning for engagement events. ISO8601 supported format. |
| <Automatically Assigned> | eventType | text | Required. The developerName of an event defined in the Web Connector schema. |
| <Automatically Assigned> | sessionId | text | Required. The identifier of the session. |
| <Automatically Assigned> | deviceId | text | Required. Typically the primary key for profile events. |
| <Automatically Assigned> | category | text | Required. Possible values are:
|
The Salesforce CDP Module for the Engagement Mobile SDK automatically sets these fields on events sent to Salesforce CDP.
Automatic Population of Salesforce CDP Module for Engagement Mobile SDK Fields
These fields are automatically attached to all profile and engagement events. To enable attaching location data to events, learn more with Location Tracking.
| Source Event Property | Target Schema Developer Name | Field Type | Description |
|---|---|---|---|
| <Automatically Assigned> | channel | text | The SDK event channel. For Engagement Mobile SDK the value is mobile. |
| <Automatically Assigned> | longitude | number | The longitudinal coordinate in decimal degrees reported by the device at the time the event was captured. |
| <Automatically Assigned> | latitude | number | The latitudinal coordinate in decimal degrees reported by the device at the time the event was captured. |
Schema Field Naming Rules
In order for events to be properly ingested, the data format used with the Salesforce CDP
event beacon is a flattened JSON structure that imposes certain limitations on how fields
are named. The Salesforce CDP Module for the Engagement Mobile SDK transforms all event data
before sending to conform to these naming rules. We recommend keeping field names simple and
avoid nested data, when possible.
- CamelCase: Field names constructed using snake case or all capitalized, the field name is transformed to camel case and the casing is normalized. For instance, the field name PROMO_CODE is referenced in the schema as promoCode.
- Special Characters and Extra Spacing: Field names consist of extra spacing or special characters are removed. For instance, the field name special #size's is transformed to specialSizes.
- Nested Properties: The schema names for nested attribute arrays are attribute is
constructed using the parent child relationship. For instance, the schema name
paperColor
giftWrapOptionsPaperColor.
1"giftWrapOptions": { 2 "paperColor": "green" 3} - Array Values: If an array is a simple string array such as "list": ["aaa", "bbb"], the schema name references the particular elements in numeric order. For instance, "list0": "aaa", "list1": "bbb".