Data Cloud Reference Guide Summer 2024 API Version 61.0
Uploaded by
gfariel97Data Cloud Reference Guide Summer 2024 API Version 61.0
Uploaded by
gfariel97Data Cloud Reference Guide
Version 61.0, Summer ’24
Last updated: August 23, 2024
© Copyright 2000–2024 Salesforce, Inc. All rights reserved. Salesforce is a registered trademark of Salesforce, Inc., as are other
names and marks. Other marks appearing herein may be trademarks of their respective owners.
CONTENTS
Chapter 1: Data Cloud Reference Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Additional Developer Resources for Data Cloud . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Data Cloud Extensibility Readiness Matrix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
API End-of-Life Policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Chapter 2: Connect Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Capture Web Interactions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Event Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
API Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Data Cloud Module of the Salesforce Interactions SDK . . . . . . . . . . . . . . . . . . . . . . . . 50
Integrate Your Mobile Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
API Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Event Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Schema Mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
Connect MuleSoft with Data Cloud . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
Chapter 3: Ingest Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Ingest Data into Data Cloud . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
Get Started with Ingestion API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
Streaming Ingestion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
Bulk Ingestion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
Create an Amazon S3 Data Stream . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
Post Data from an Amazon S3 Data Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
Rotation of S3 Credentials with Metadata API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
Retrieve S3 Connector Metadata with Salesforce CLI . . . . . . . . . . . . . . . . . . . . . . . . . 158
Deploy S3 Connector Metadata with Salesforce CLI . . . . . . . . . . . . . . . . . . . . . . . . . . 159
Chapter 4: Model Data in Data Cloud . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
Standard Data Model Objects (DMOs) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Account DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
Account Contact DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
Affiliation DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180
Agent Service Presence DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
Agent Work DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
Agent Work Skill DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
Authorization Form DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
Authorization Form Consent DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188
Authorization Form Data Use DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
Contents
Authorization Form Text DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
Benefit Action DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192
Benefit Type DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194
Brand DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
Card Account DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
Case DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
Case Update DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
Communication Subscription DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
Communication Subscription Channel Type DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
Communication Subscription Consent DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
Communication Subscription Timing DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
Consent Action DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
Consent Status DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
Contact Point Address DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
Contact Point App DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215
Contact Point Consent DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
Contact Point Email DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
Contact Point Phone DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
Contact Point Social DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 227
Conversation Entry Transcript Excerpt DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
Conversation Reason DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
Conversation Reason Category DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
Conversation Reason Report Definition DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
Conversation Reason Report Segment Def DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
Data Use Legal Basis DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
Data Use Purpose DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239
Deposit Account DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
Data Use Purpose Consent Action DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242
Device DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243
Device Application Engagement DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
Device Application Template DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
Email Engagement DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
Email Message DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
Email Publication DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259
Email Template DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
Engagement Channel Type DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
Engagement Channel Type Consent DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 268
Engagement Topic DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 270
Financial Account Balance DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
Financial Account DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274
Financial Account Fee DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
Financial Account Interest Rate DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278
Financial Account Limit DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
Financial Account Party DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
Contents
Financial Account Transaction DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
Financial Customer DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
Financial Goal DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
Financial Goal Party DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
Financial Holding DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 290
Financial Security DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
Flow DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294
Flow Element DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
Flow Element Run DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296
Flow Run DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
Flow Version DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
Goods Product DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
Individual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
Insurance Policy DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 316
Interest Tag Definition DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
Investment Account DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 319
Knowledge Article Engagement DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 320
Lead DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328
Loan Account DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330
Loyalty Benefit DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332
Loyalty Benefit Type DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334
Loyalty Journal Subtype DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336
Loyalty Journal Type DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337
Loyalty Ledger DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 338
Loyalty Member Currency DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340
Loyalty Member Tier Data Model Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343
Loyalty Partner Product DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344
Loyalty Program DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346
Loyalty Program Currency DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348
Loyalty Program Member Data Model Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350
Loyalty Program Member Promotion DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353
Loyalty Program Partner DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355
Loyalty Tier DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 357
Loyalty Tier Benefit DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358
Loyalty Tier Group DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360
Loyalty Transaction Journal DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362
Market Journey Activity DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 367
Master Product DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368
Market Segment DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374
Member Benefit DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 376
Message Engagement DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 377
Operating Hours DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382
Opportunity DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 384
Opportunity Product DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387
Contents
Order Delivery Method DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389
Party Consent DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390
Party DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392
Party Financial Asset DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395
Party Financial Liability DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397
Party Identification DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398
Party Interest Tag DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400
Payment Method DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402
Person Life Event DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404
Privacy Consent Log DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406
Product Browse Engagement DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408
Product Catalog DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 414
Product Catalog Category DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415
Product Category DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 416
Product Category Product DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418
Product Order Engagement DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420
Promotion DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 425
Record Alert DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429
Promotion Loyalty Partner Product DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430
Sales Order DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432
Sales Order Product DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437
Sales Store DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443
Service Presence Status DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444
Shopping Cart Engagement DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 445
Shopping Cart Event Type DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451
Shopping Cart Product Engagement DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 452
Skill DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455
SMS Publication DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456
SMS Template DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458
Software Application DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461
Survey DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462
Survey Invitation DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463
Survey Question DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465
Survey Question Response DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466
Survey Question Section DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468
Survey Response DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469
Survey Subject DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471
Survey Version DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472
User DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 474
User Group DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476
Voucher DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478
Voucher Definition DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480
Web Search Engagement DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 482
Website Engagement DMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 488
Contents
Starter Data Bundles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 493
B2C Commerce: Bundles Product Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 503
B2C Commerce: Goods Product Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 504
B2C Commerce: Master Product Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 505
B2C Commerce: Product Catalog Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 505
B2C Commerce: Product Category Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 506
B2C Commerce: Product Category Product Mapping . . . . . . . . . . . . . . . . . . . . . . . . 506
B2C Commerce: Sales Order Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 507
B2C Commerce: Sales Order Customer Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . 508
B2C Commerce: Sales Order Product Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . 509
Commerce: Account Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 510
Commerce: Coupon Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 510
Commerce: Fulfillment Order Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511
Commerce: Fulfillment Order Line Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 512
Commerce: Fulfillment Order Item Adjustment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 513
Commerce: Fulfillment Order Item Tax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 514
Commerce: Location Group Product Exclusion Change Mapping . . . . . . . . . . . . . . . . . 515
Commerce: Location Group Product Inventory Change Mapping . . . . . . . . . . . . . . . . . 515
Commerce: Location Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 516
Commerce: Location Product Inventory Change Mapping . . . . . . . . . . . . . . . . . . . . . 517
Commerce: Order Adjustment Group Summary Mapping . . . . . . . . . . . . . . . . . . . . . 518
Commerce: Order Delivery Method Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 519
Commerce: Order Delivery Group Summary Mapping . . . . . . . . . . . . . . . . . . . . . . . 520
Commerce: Order Item Adjustment Line Summary Mapping . . . . . . . . . . . . . . . . . . . 521
Commerce: Order Item Summary Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 521
Commerce: Order Item Summary Change Mapping . . . . . . . . . . . . . . . . . . . . . . . . . 523
Commerce: Order Item Tax Line Item Summary Mapping . . . . . . . . . . . . . . . . . . . . . 524
Commerce: Order Payment Summary Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . 525
Commerce: Order Summary Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 525
Commerce: Payment Method Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 527
Commerce: Process Exception Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 528
Commerce: Product Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 528
Commerce: Product Attribute Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 529
Commerce: Product Catalog Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 529
Commerce: Product Category Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 530
Commerce: Product Category Product Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . 530
Commerce: Promotion Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 531
Commerce: Return Order Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 532
Commerce: Return Order Item Adjustment Mapping . . . . . . . . . . . . . . . . . . . . . . . . 533
Commerce: Return Order Item Tax Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 534
Commerce: Return Order Line Item Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 534
Commerce: Sales Channel Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 535
Commerce: Web Store Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 536
Commerce: Web Store Catalog Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 536
Contents
Marketing Cloud Account Engagement: Email Activity Mapping . . . . . . . . . . . . . . . . . 537
Marketing Cloud Engagement: Campaigns and Journeys Mappings . . . . . . . . . . . . . 538
Marketing Cloud Engagement: Contact Mappings . . . . . . . . . . . . . . . . . . . . . . . . . . 541
Marketing Cloud Engagement: Engagement Mappings . . . . . . . . . . . . . . . . . . . . . . 544
Salesforce CRM: Account Mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 556
Salesforce CRM: Agent Work Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 558
Salesforce CRM: Agent Work Skill Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 559
Salesforce CRM: Alert Mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 560
Salesforce CRM: Benefit Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 561
Salesforce CRM: Benefit Type Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 561
Salesforce CRM: Business Hours . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 562
Salesforce CRM: Card Mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 563
Salesforce CRM: Case Mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 564
Salesforce CRM: Case Article Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 565
Salesforce CRM: Case History 2 Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 566
Salesforce CRM: Category Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 567
Salesforce CRM: Contact Mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 567
Salesforce CRM: Conversation Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 572
Salesforce CRM: ConversationParticipant Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . 573
Salesforce CRM: ConversationReason Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574
Salesforce CRM: ConversationReasonExcerpt Mapping . . . . . . . . . . . . . . . . . . . . . . . 575
Salesforce CRM: ConversationReasonGroup Mapping . . . . . . . . . . . . . . . . . . . . . . . 576
Salesforce CRM: ConversationReasonReportDefinition Mapping . . . . . . . . . . . . . . . . . 577
Salesforce CRM: ConvReasonReportSegmentDefinition Mapping . . . . . . . . . . . . . . . . 578
Salesforce CRM: Data Category Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 579
Salesforce CRM: Email Message Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 580
Salesforce CRM: Data Category Group Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . 581
Salesforce CRM: Financial Account Mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 581
Salesforce CRM: Financial Account Role Mappings . . . . . . . . . . . . . . . . . . . . . . . . . . 584
Salesforce CRM: Financial Goal Mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 584
Salesforce CRM: Financial Goal Party Mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . 585
Salesforce CRM: Financial Holding Mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 586
Salesforce CRM: Group Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 586
Salesforce CRM: Group Member Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 587
Salesforce CRM: Journal Subtype Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 588
Salesforce CRM: Journal Type Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 588
Salesforce CRM: Knowledge Article Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 589
Salesforce CRM: Knowledge Article Engagement Mapping . . . . . . . . . . . . . . . . . . . . 589
Salesforce CRM: Knowledge Article Version Mapping . . . . . . . . . . . . . . . . . . . . . . . . 590
Salesforce CRM: Knowledge Data Category Selection Mapping . . . . . . . . . . . . . . . . . 592
Salesforce CRM: Linked Article Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 592
Salesforce CRM: Lead Mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 593
Salesforce CRM: Loyalty Aggregated Point Expiration Ledger Mapping . . . . . . . . . . . . 596
Salesforce CRM: Loyalty Ledger Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 596
Contents
Salesforce CRM: Loyalty Member Currency Mapping . . . . . . . . . . . . . . . . . . . . . . . . 597
Salesforce CRM: Loyalty Member Tier Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . 598
Salesforce CRM: Loyalty Partner Product Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . 599
Salesforce CRM: Loyalty Program Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 600
Salesforce CRM: Loyalty Program Badge Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . 600
Salesforce CRM: Loyalty Program Currency Mapping . . . . . . . . . . . . . . . . . . . . . . . . . 601
Salesforce CRM: Loyalty Program Engagement Attribute Mapping . . . . . . . . . . . . . . . 602
Salesforce CRM: Loyalty Program Engagement Attribute Promotion Mapping . . . . . . . . 603
Salesforce CRM: Loyalty Program Group Member Relationship Mapping . . . . . . . . . . . 604
Salesforce CRM: Loyalty Program Member Mapping . . . . . . . . . . . . . . . . . . . . . . . . 605
Salesforce CRM: Loyalty Program Member Attribute Value Mapping . . . . . . . . . . . . . . 606
Salesforce CRM: Loyalty Program Member Badge Mapping . . . . . . . . . . . . . . . . . . . . 607
Salesforce CRM: Loyalty Program Member Case Mapping . . . . . . . . . . . . . . . . . . . . . 607
Salesforce CRM: Loyalty Program Member Promotion Mapping . . . . . . . . . . . . . . . . . 608
Salesforce CRM: Loyalty Program Partner Mapping . . . . . . . . . . . . . . . . . . . . . . . . . 609
Salesforce CRM: Loyalty Program Partner Promotion Mapping . . . . . . . . . . . . . . . . . . 610
Salesforce CRM: Loyalty Tier Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 610
Salesforce CRM: Loyalty Tier Benefit Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 611
Salesforce CRM: Loyalty Tier Group Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 611
Salesforce CRM: Member Benefit Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 612
Salesforce CRM: Participant Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 613
Salesforce CRM: Person Life Event Mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 614
Salesforce CRM: Product Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 614
Salesforce CRM: Promotion Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 615
Salesforce CRM: Promotion Loyalty Partner Product Mapping . . . . . . . . . . . . . . . . . . . 616
Salesforce CRM: Promotion Market Segment Mapping . . . . . . . . . . . . . . . . . . . . . . . 617
Salesforce CRM: Securities Mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 617
Salesforce CRM: Segment Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 618
Salesforce CRM: Service Presence Status Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . 618
Salesforce CRM: Skill Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 619
Salesforce CRM: Survey Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 619
Salesforce CRM: Survey Invitation Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 620
Salesforce CRM: Survey Page Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 621
Salesforce CRM: Survey Question Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 622
Salesforce CRM: Survey Question Response Mapping . . . . . . . . . . . . . . . . . . . . . . . . 623
Salesforce CRM: Survey Response Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 624
Salesforce CRM: Survey Subject Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 625
Salesforce CRM: Survey Version Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 626
Salesforce CRM: Topic Mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 627
Salesforce CRM: Transaction Journal Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . 627
Salesforce CRM: Unit of Measure Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 629
Salesforce CRM: User Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 629
Salesforce CRM: User Role Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 630
Salesforce CRM: User Service Presence Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . 631
Contents
Salesforce CRM: Voucher Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 631
Salesforce CRM: Voucher Definition Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 632
Chapter 5: Extract Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 634
Retrieve Metadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 635
Query Data Graph Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 639
GET /api/v1/dataGraph/metadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 639
GET /api/v1/dataGraph/metadata?entityName={dataGraphName} . . . . . . . . . . . . . . 640
GET /api/v1/dataGraph/{dataGraphName}/{dataGraphRecordId} . . . . . . . . . . . . . . . 643
GET /api/v1/dataGraph/{dataGraphName}?lookupKeys=[] . . . . . . . . . . . . . . . . . . . . 644
Query Customer Profile Information with Profile API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 645
GET /api/v1/profile/metadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 647
GET /api/v1/profile/metadata/{dataModelName} . . . . . . . . . . . . . . . . . . . . . . . . . . 649
GET /api/v1/profile/{dataModelName} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 651
GET /api/v1/profile/{dataModelName}/{Id} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 652
GET /api/v1/profile/{dataModelName}/{Id}/{childDataModelName} . . . . . . . . . . . . . . 655
GET /api/v1/profile/{dataModelName}/{Id}/calculated-insights/{ci-name} . . . . . . . . . . 657
Query Data using Query API V2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 660
POST /api/v2/query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 662
GET /api/v2/query/{nextBatchId} . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 667
Query Data using Query API V1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 671
POST /api/v1/query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 672
Query Services Status Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 675
Query Unified Record ID . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 675
GET
/api/v1/universalIdLookup/{entity_name}/{DataSourceId__c}/{DataSourceObjectId__c}/{SourceRecordId__c}. 675
Query Calculated Insights . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 677
GET /api/v1/insight/metadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 677
GET /api/v1/insight/metadata/(ci-name) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 679
GET /api/v1/insight/calculated-insights/(ci-name) . . . . . . . . . . . . . . . . . . . . . . . . . . . 681
CDP Python Connector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 683
API Limits for Profile, Query, and Calculated Insights . . . . . . . . . . . . . . . . . . . . . . . . . . . . 686
Webhook Data Action Targets in Data Cloud . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 687
Generate a Secret Key for Signature Validation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 687
Regenerate a Secret Key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 688
Payload Signature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 688
Validating the Signature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 688
CHAPTER 1 Data Cloud Reference Guide
In this chapter ... Salesforce provides programmatic access to Data Cloud information using simple, robust, and secure
RESTful APIs. You can also integrate your web and mobile applications using Data Cloud SDKs.
• Getting Started
For information about Data Cloud architecture and the app development process, see Data Cloud
• Additional Developer
Developer Guide.
Resources for Data
Cloud
• Data Cloud Integrate and Extend Your Data Cloud Applications
Extensibility
Readiness Matrix Use the RESTful APIs to:
• API End-of-Life Policy
• Ingest external datasets and maintain them in Data Cloud.
• Extend Data Cloud and build your own custom integrations to support your business needs better.
• Clean, enrich, and augment the Data Cloud data.
You can make most of the API calls from within the Data Cloud application interface, or you can call
these methods externally using an auto-generated endpoint. To refer to the documentation of individual
APIs and understand their utility in more detail, click the links at the end of the document.
With the Data Cloud Web interactions SDK and Mobile SDK, you can integrate your web or mobile
applications with Data Cloud to capture customer events and engagements.
Supported Salesforce Editions and API Limits
To use Data Cloud APIs, your org must use Enterprise Edition, Corporate Edition, or Developer Edition.
If you’re an existing Salesforce customer and want to upgrade, contact your account executive.
API rate limits are enforced using:
• Daily requests
• Concurrent requests
The limits vary depending on the Salesforce Editions. Refer to these links for individual API-specific limits.
• API Limits for Profile, Query, and Calculated Insights
• Ingest Bulk and Streaming API Limits on page 131
For guidance on the overall limits, see Data Cloud Limits and Guidelines.
SEE ALSO:
Data Cloud Limits and Guidelines
1
Data Cloud Reference Guide Getting Started
Getting Started
Use this section to understand the prerequisites required to get started with Data Cloud API libraries and SDKs.
Familiarize Yourself with Data Cloud
Explore the Data Cloud Online Help, if you're unfamiliar with the application.
Set Up Data Cloud
Before you can use Data Cloud APIs, you must configure the application. The steps for setting up the application are included within
PDF Guide: Data Cloud Implementation Overview Guide. If you’re using an existing instance, then confirm with your admin that your
user profile has permissions to use Data Cloud APIs.
Set Up Data Sources
After you create your Data Cloud instance, you can control the scope of data ingestion and activation from within the instance.
Set up your data sources by creating an app connector within the user interface to tell the application where to ingest data for data
mapping and segments.
Create a Connected App
Set up a connected app to authenticate and request access to Data Cloud APIs. The connected app enables standard OAuth protocols
for authentication and authorization. Follow the instructions in Salesforce Help Create a Connected App, and configure the app as needed.
In your connected app, make sure Enable OAuth Settings and necessary OAuth scopes are selected. The possible scopes are:
• Perform ANSI SQL queries on Data Cloud data (cdp_query_api): The cdp_query_api scope allows ANSI SQL queries of Data Cloud
data on behalf of the user.
• Manage Data Cloud profile data (cdp_profile_api): The cdp_profile_api scope allows access to Data Cloud REST API data. Use this
scope to manage profile records.
• Perform requests at any time (refresh_token): This scope allows a refresh token to be returned when the requesting client is eligible
to receive one. With a refresh token, the app can interact with the user’s data while the user is offline.
• Manage user data via APIs (api): This scope allows access to the current, logged-in user’s account using APIs, such as REST API and
Bulk API 2.0.
Important: Your orgs must be provisioned with Data Cloud licenses and the users must be assigned to appropriate roles for
having full access to objects in the Data Cloud. Refer to User Roles and Permission Sets in Data Cloud before setting up the Connected
App.
Acquire the Access Token
Send a request for acquiring the Salesforce access token. Here’s how the request is going to look like.
POST https://login.salesforce.com/services/oauth2/token
Content-Type : x-www-form-urlencoded
grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer
&
a
se
r
t
io
n
=
ey
J
0
eX
A
i
Oi
J
K
V1
Q
i
LC
J
h
bG
c
i
Oi
J
S
Uz
I
1
Ni
J
9
.e
y
J
pc
3
M
iO
i
I
zT
V
Z
HO
U
F
Pc
D
R
rY
n
J
pW
k
9
JZ
m
g
0e
W
Z
PQ
V
l
QU
j
F
pY
z
J
qb
1
J
DQ
k
h
wZ
F
Z
ta
X
B
XU
0
5
sb
X
N
wT
2
V
ib
1
V
tc
W
d
Md
H
J
Ic
D
l
RV
F
R
QM
G
p
Wc
3
g
0S
H
l
zU
W
4
xL
k
1
Sa
z
F
yI
i
w
ic
3
V
iI
j
o
ic
3
V
ka
G
V
lc
k
B
vc
m
d
tY
W
l
uM
i
5
jb
2
0
iL
C
J
hd
W
Q
iO
i
J
od
H
R
wO
i
8
vc
3
V
rd
W
1
hc
i
1
sd
G
0
ua
W
5
0Z
X
J
uY
W
w
uc
2
F
sZ
X
N
mb
3
J
jZ
S
5
jb
2
0
iL
C
J
le
H
A
iO
j
E
2M
D
Q
2M
z
c
4M
T
k
yN
T
d
9.
W
k
Ec
m
a
Gj
_
j
hJ
p
y
Fq
X
w
EU
t
w
-b
k
e
XY
u
x
kq
c
2
c3
l
k
wb
G
j
g3
G
D
o7
s
S
tI
T
h
t_
O
_
dS
N
a
nS
0
x
k2
q
9
AR
A
6
Uo
m
-
ua
i
y
Nw
_
GG
K
5
L3
j
B
Qj
K
-
yt
r
G
um
u
J
As
u
jf
S
m
Ld
Y
S
tx
P
V
nj
U
2
zy
u
P
SW
M
Q
Jm
e
D
eg
x
D
gm
e
h
t3
U
Q
yl
u
j
0q
4
l
X3
r
a
yx
0
O
l-
v
Z
fT
u
z
r4
Y
l
xm
d
O
KT
N
r
PJ
C
Q
8h
2
6
uM
S
P
Fr
Q
mq
c
sr
S
g
1D
R
g
m3
k
M
h1
5
V
KM
3
y
Zy
N
A
g4
3
E
Pw
1
B
fn
c
P
WI
x
O
ms
G
t
2J
x
Uc
l
B
ER
3
e
nT
L
M
2c
J
K
r9
f
D
x1
6
S
se
s
j
2U
K
q
XG
b
w
N6
8
g
CF
5
r
Zx
D
6
yG
N
5
B0
V
e
ZI
Z
V
Jr
Y
5
cT
t
E
xq
B
p
3L
j
8
UO
c
q
Uj
6
e
sy
C
Q
2
Data Cloud Reference Guide Additional Developer Resources for Data Cloud
Note: Refer to OAuth 2.0 JWT Bearer Flow for Server-to-Server Integration for creating a JWT assertion.
Response Format
{
"access_token":
"00Dxx0000006JFr!AQEAQL7SvQ1t..2yYtyM0jfXtMNriivdMpTYE3mThqATnm5YqPIX.xnzUC45zd0HEIU3tc9GdHLqWOFVprsgszWdYMPRUnOy",
"scope": "cdpquery api cdpprofile",
"instance_url": "http://orgmain2.localhost.internal.salesforce.com:6109",
"id":
"http://sukumar-ltm.internal.salesforce.com:6109/id/00Dxx0000006JFrEAM/005xx000001X9hBAAS",
"token_type": "Bearer"
}
Exchanging Access Token for Data Cloud Token
Now that you've acquired the Salesforce access token, use the following request to get the access token to invoke the APIs.
POST <Instance URL>/services/a360/token
Content-Type : x-www-form-urlencoded
grant_type=urn:salesforce:grant-type:external:cdp
&subject_token=<CORE ACCESS TOKEN>
&subject_token_type=urn:ietf:params:oauth:token-type:access_token
{
"access_token":
"
e
y
J
ra
W
Q
iO
i
J
D
T1
J
F
Lj
A
w
R
Hh
4
M
DA
w
M
D
Aw
N
k
pG
c
i
4
xN
j
A
zM
j
M
5
Nz
I
2
Nj
I
5
I
iw
i
d
Hl
w
I
j
oi
S
l
dU
I
i
w
iY
W
x
nI
j
o
i
Ul
M
y
NT
Y
i
f
Q.
e
y
Jz
d
W
I
iO
i
J
od
H
R
w
Oi
8
v
c3
V
r
d
W1
h
c
i1
s
d
G
0u
a
W
50
Z
X
J
uY
W
w
uc
2
F
s
ZX
N
m
b3
J
j
Z
S5
j
b
20
6
N
j
Ew
O
S
9p
Z
C
8
wM
E
R
4e
D
A
w
MD
A
w
MD
Z
K
R
nJ
F
Q
U0
v
M
D
A1
e
H
gw
M
D
A
wM
D
F
YO
W
h
C
QU
F
T
Ii
w
i
Y
XV
k
I
jo
i
Y
T
M2
M
C
Is
I
n
N
jc
C
I
6I
m
N
k
cH
B
y
b2
Z
p
b
GU
g
Y
2R
w
c
X
Vl
c
n
ki
L
C
J
uY
m
Y
iO
j
E
2
MD
Q
1
NT
E
3
N
zY
s
I
nN
m
b
2
lk
I
j
oi
M
D
B
Ee
H
g
wM
D
A
w
MD
A
2
Sk
Z
y
I
iw
i
a
XN
z
I
j
oi
a
H
R0
c
D
o
vL
3
N
1a
3
V
t
YX
I
t
bH
R
t
L
ml
u
d
GV
y
b
m
Fs
L
n
Nh
b
G
V
zZ
m
9
yY
2
U
u
Y2
9
t
Oj
Y
x
M
Dk
v
I
iw
i
c
2
Z1
a
W
Qi
O
i
I
wM
D
V
4e
D
A
w
MD
A
w
MV
g
5
a
EI
i
L
CJ
l
e
H
Ai
O
j
E2
M
D
Q
1N
T
k
wM
j
g
s
Im
l
h
dC
I
6
M
TY
w
N
DU
1
M
T
gz
N
i
wi
a
n
R
pI
j
o
iY
j
k
1
OD
A
1
ZD
U
t
M
2M
z
Y
S0M
D
N
k
LW
J
i
Nj
g
t
N
jB
k
N
TJ
l
N
m
M4
O
T
Bj
I
i
w
ic
2
Z
hc
H
B
p
ZC
I
6
Ij
NV
k
c
5
QU
9
w
NG
t
i
c
ml
a
T
0l
m
a
D
R5
Z
k
9B
W
V
B
SM
W
l
jM
m
p
v
Uk
N
C
SH
B
k
V
m1
p
c
Fd
Tm
x
t
c
3B
P
Z
WJ
v
V
W
1x
Z
0
x0
c
k
h
wO
V
F
UV
F
A
w
al
Z
z
eD
R
I
e
XN
R
b
jE
u
T
V
Jr
M
X
Ii
f
Q
.
GA
W
q
iP
p
V
J
oD
i
g
-a
d
G
t
D4
d
5
cO
7
L
7
Ja
I
n
2m
O
Y
H
9G
y
D7
o
O
7
Ay
r
s
nv
_
k
0
5Q
R
P
p-
B
1
g
Sd
4
U
8l
q
E
_
cu
C
0
MT
E
9
L
6l
z
J
A"
,
"instance_url": "https://a360.cdp.cdp001.dev1-uswest2.aws.sfdc.cl",
"token_type": "Bearer",
"issued_token_type": "urn:ietf:params:oauth:token-type:jwt",
"expires_in": 7191
}
Use the access token you get here as the instance_url. This is the Data Cloud URL.
Auto-Generated Endpoints
The Data Cloud application assigns a unique, system-generated endpoint to each of your organizations.
After you've acquired your endpoints in Data Cloud, use them for your organization's API calls. No other Data Cloud customer can use
your endpoint for their API requests.
You can only use your endpoint with the c360a.salesforce.com endpoint structure.
Additional Developer Resources for Data Cloud
In addition to the resources documented in this guide, there are additional Salesforce REST API resources and metadata types to use
when you work with Data Cloud.
3
Data Cloud Reference Guide Data Cloud Extensibility Readiness Matrix
Data Cloud Parameters for Salesforce API Calls
Use these Data Cloud parameters with the Salesforce REST API Consent and Query calls.
Salesforce Consent API
Salesforce Query API
Salesforce Metadata API Types for Data Cloud
Metadata types for Data Cloud are documented alphabetically within the reference section of the Metadata API developer documentation.
Metadata Types
Data Cloud Extensibility Readiness Matrix
The table lists the Data Cloud configuration elements that you can deploy.
To deploy Data Cloud features, first add them to a data kit. Then add that data kit to a package.
Feature/Function Data Kit Support Via 1GP Data Kit Support Via 2GP
Activation Ecosystem False False
Activation Target False False
Calculated Insights True True
Commerce Connector True True
CRM Connector True True
Data Actions False False
Data Lake Objects True True
Data Model Mappings True True
Data Model Objects True True
Data Spaces False False
Data Transforms - Batch True True
Data Transforms - Streaming True True
GCP Connector True True
Identity Resolution False False
Ingestion API True True
Marketing Cloud Data Extensions (MC DE) False False
Mobile SDK True True
Profile Explorer Components False False
Relationships True True
4
Data Cloud Reference Guide API End-of-Life Policy
Feature/Function Data Kit Support Via 1GP Data Kit Support Via 2GP
S3 Connector True True
Segments False False
Web SDK True True
SEE ALSO:
Data Cloud Developer Guide: Packages and Data Kits
Second-Generation Managed Packaging Developer Guide: First-Generation Managed Packages
Connect REST API Developer Guide: Data Cloud Resources
API End-of-Life Policy
See which REST API versions are supported, unsupported, or unavailable.
Salesforce is committed to supporting each API version for a minimum of 3 years from the date of first release. To improve the quality
and performance of the API, versions that are over 3 years old sometimes are no longer supported.
Salesforce notifies customers who use an API version scheduled for deprecation at least 1 year before support for the version ends.
Salesforce API Versions Version Support Status Version Retirement Info
Versions 31.0 through 61.0 Supported.
Versions 21.0 through 30.0 As of Summer ’22, these versions have been Salesforce Platform API Versions 21.0 through 30.0
deprecated and no longer supported by Retirement
Salesforce.
Starting Summer ’25, these versions will be
retired and unavailable.
Versions 7.0 through 20.0 As of Summer ’22, these versions are retired Salesforce Platform API Versions 7.0 through 20.0
and unavailable. Retirement
If you request any resource or use an operation from a retired API version, REST API returns the 410:GONE error code.
To identify requests made from old or unsupported API versions, use the API Total Usage event type.
5
CHAPTER 2 Connect Data
In this chapter ... Connect external sources to transmit data into Data Cloud.
• Capture Web
Interactions
• Integrate Your Mobile
Applications
• Connect MuleSoft
with Data Cloud
6
Connect Data Capture Web Interactions
Capture Web Interactions
Salesforce Interactions SDK is an extensible data capture and collection framework that you can use to track different user interactions
on your website and send that information to Salesforce. This information can then be used to build behavior profiles for web visitors,
audience segmentation, or Salesforce integrations.
The SDK consists of a base SDK and product-specific modules for Data Cloud on page 50 and Marketing Cloud Personalization. The SDK
uses a unified event data model shared across both modules. This unified data model allows for capturing and integrating key business
objects and user and behavioral data through event capture in a consistent format across Data Cloud and Personalization. The unified
data model also enables you to use a single SDK to integrate with either Data Cloud, Personalization, or both together.
Salesforce Interactions SDK uses the SalesforceInteractions namespace, which encapsulates all of the SDK’s components.
To learn more about the SDK, see Salesforce Interactions SDK on Salesforce Help. For information about setting up the Salesforce
Interactions SDK in Data Cloud, see Set Up the Salesforce Interactions SDK.
Salesforce Interactions SDK provides:
• Tracking of customer interactions
• Identity and cookie management for anonymous and named identity tracking
• Consent management integration hooks
• Configuration-driven instrumentation with sitemaps
• Integration hooks for adding custom functionality
Requirements
Your website customers need a browser capable of running ES6-compatible code.
Tracking User Interactions
The sendEvent API call is how you capture interactions and collect associated data from a website customer. An interaction event
has a named identifier, like View Catalog Object, required values, like catalogObject or order, and tracked user-defined
values. For example, here’s a View Catalog Object event:
SalesforceInteractions.sendEvent({
interaction : {
name : "View Catalog Object",
catalogObject: {
type : "Product",
id : "65e4e737",
attributes: {
description: "Shoes"
}
}
}
})
Salesforce Interactions SDK also comes with ready to use event data models to use across Salesforce.
7
Connect Data Event Specifications
Identity and Cookie Management
Salesforce Interactions SDK supports anonymous and named identity tracking using first-party cookies or by being passed identity
information from the website. Cookies are prefixed with _sfid and end with a string of characters unique to the domain to which
the cookie belongs. You can customize cookie and identity behavior either through configuration or through calling the Identity on
page 28 APIs in Salesforce Interactions SDK.
Consent Management
Not all website visitors and customers consent to cookie tracking. To support consent management, Salesforce Interactions SDK is
designed to send events only if a customer has consented to tracking. When consent is revoked, the Web SDK captures this preference
and then immediately stops emitting events. For example, this method passes consent into Salesforce Interactions SDK.
SalesforceInteractions.init({
consents: [{
provider: 'ExampleProvider',
purpose: 'Tracking',
status: 'Opt In'
}]
})
Capturing customer consent can be handled either through configuration or through calling the Consent on page 29 API in Salesforce
Interactions SDK.
Sitemap
Salesforce Interactions SDK Sitemap is a configuration-driven integration layer that executes within and is deployed with the Web SDK.
A Sitemap is developed to integrate with a specific site using the API provided by the Web SDK that maps key business objects to
interaction events.
Event Specifications
Event specifications for Salesforce Interactions SDK.
API Reference
This section provides guidance around references provided with the Salesforce Interactions Web SDK.
Data Cloud Module of the Salesforce Interactions SDK
The Data Cloud Module of the Salesforce Interactions SDK is an extension that adds features to the SDK. You can convert the Event
Structure into a compatible format for ingestion by Data Cloud and authenticate and deliver events over HTTP to a Data Cloud Web
Connector.
Event Specifications
Event specifications for Salesforce Interactions SDK.
Event Structure
An event collected by Salesforce Interactions Web SDK contains properties that are automatically set by the system and optional
properties that are set by you.
8
Connect Data Event Specifications
Cart Interaction
A cart interaction is where a customer modifies the contents of their online shopping cart.
Catalog Interaction
Use a catalog interaction to capture when a customer interacts with various tracking items. For example, a product or a blog post.
Order Interaction
An order interaction is an ecommerce event that captures actions performed by a user to manage new, in progress, or completed
orders.
Line Item Data
Line items are intended to describe purchasable items and are used in cart and order interactions.
User Data
Track profile data for a user with or without an associated interaction using Salesforce Interactions Web SDK.
Account Data
Account data represent user information at the account level. The account fields allow you to capture data for many customers in
one account.
Consent Data
Consent data is used to either grant or revoke consent in Salesforce Interactions SDK. When a customer chooses to opt in to tracking
these consent details are attached to the Event Structure of the first tracked event.
Event Structure
An event collected by Salesforce Interactions Web SDK contains properties that are automatically set by the system and optional properties
that are set by you.
Fields Provided By About Description
account Developer Account Captures profile event data for
an account.
consents SDK Consents Contains a list of consent values
attached to the first event
captured after a customer
consents to tracking or when a
customer revokes consent.
interaction Developer Interaction Captures customer engagement
event data.
pageView SDK Page View Indicates if the event was
captured during a page load.
source SDK Source Contains event metadata about
the page.
time SDK Time Shows the timestamp of the
event in milliseconds elapsed
since the UNIX epoch.
user Developer User Captures profile event data for
of a customer.
9
Connect Data Event Specifications
Developer Provided Data
The interaction field is for capturing customer engagement data. At a minimum, an interaction requires a valid name value.
Salesforce Interactions Web SDK come with several specialized interaction types, such as:
• Cart Interaction on page 11
• Catalog Interaction on page 14
• Order Interaction on page 16
The user field captures the customer’s user on page 20 profile data.
The account field captures profile data at the account on page 22 level. The account fields allow you to capture data for many
customers in one account.
Example: Salesforce Interactions Web SDK is used to instrument a site to capture events containing both behavioral and profile
data.
SalesforceInteractions.sendEvent({
interaction: {
name: "View Catalog Object",
catalogObject: {
type: "Product",
id: "product-1"
}
},
user: {
attributes: {
email: "[email protected]"
}
}
})
Here’s what the captured results look like for this event structure.
{
interaction: {
name: "View Catalog Object",
catalogObject: {
type: "Product",
id: "product-1"
}
},
source: {
pageType: "homepage",
url: "https://my.domain.com/home",
urlReferrer: "https://my.domain.com/search",
channel: "Web",
locale: "en_US"
},
10
Connect Data Event Specifications
user: {
anonymousId: "aa19dc4fcdc636d8",
attributes: {
email: "[email protected]"
}
},
consents: [{
purpose: 'Tracking',
provider: 'Example Provider',
status: 'Opt In'
}]
pageView: 0,
time: 1628700769593,
}
SEE ALSO:
Translation of SDK Events to Web Connector Schemas
Custom Events
Cart Interaction
A cart interaction is where a customer modifies the contents of their online shopping cart.
Cart interactions come in two forms:
• Single Line Item: For modifying individual line items in the customer’s cart.
• Multiple Line Items: For bulk operations against the customer’s cart.
Single Line Item
The interaction names are used for cart interactions that affect individual line items.
Interaction Name Value
SalesforceInteractions.CartInteractionName.AddToCart Add To Cart
SalesforceInteractions.CartInteractionName.RemoveFromCart Remove From Cart
{
interaction: {
name: "Add To Cart",
lineItem: {
catalogObjectType: "Product",
catalogObjectId: "product-1",
quantity: 1,
price: 9.99,
currency: "USD",
11
Connect Data Event Specifications
attributes: {
giftWrapping: 1
}
}
}
}
The fields for a single line cart interaction.
Field Name Field Type Description
lineItem Line Item Data on page 19 Required. A single Line Item Data value.
name string Required. The event names.
Multiple Line Items
The interaction names used for cart interactions that affect all the line items in a cart.
Interaction Name Value
SalesforceInteractions.CartInteractionName.ReplaceCart Replace Cart
{
interaction: {
name: "Replace Cart",
lineItems: [{
catalogObjectType: "Product",
catalogObjectId: "product-1",
quantity: 1,
price: 9.99,
currency: "USD",
attributes: {
giftWrapping: 1
}
}, {
catalogObjectType: "Product",
catalogObjectId: "product-2",
quantity: 3,
price: 20,
currency: "USD",
attributes: {
giftWrapping: 0
}
}]
}
}
The fields for multi-line cart interaction.
12
Connect Data Event Specifications
Field Names Field Type Description
lineItems array Required. An array of zero to many Line Item
Data on page 19 values
name string Required. The event names.
Example: Here’s an example of capturing a cart interaction using the Web SDK.
SalesforceInteractions.sendEvent({
interaction: {
name: "Add To Cart",
lineItem: {
catalogObjectType: "Product",
catalogObjectId: "product-1",
quantity: 1,
price: 9.99,
currency: "USD",
attributes: {
giftWrapping: 1
}
}
}
})
Here’s an example of capturing a cart interaction using the Sitemap.
SalesforceInteractions.init().then(() => {
const sitemapConfig = {
global: {},
pageTypes: [{
name: 'product_detail_page',
isMatch: () => true,
listeners: [
SalesforceInteractions.listener("click", ".add-to-cart-button", () =>
{
SalesforceInteractions.sendEvent({
interaction: {
name: SalesforceInteractions.CartInteractionName.AddToCart,
lineItem: {
catalogObjectType: "Product",
catalogObjectId: "product-1",
quantity: 1,
price: 9.99,
currency: "USD",
attributes: {
giftWrapping: 1
}
}
}
})
}
]
13
Connect Data Event Specifications
}]
}
SalesforceInteractions.initSitemap(sitemapConfig)
})
SEE ALSO:
Translation of SDK Events to Web Connector Schemas
Custom Events
Catalog Interaction
Use a catalog interaction to capture when a customer interacts with various tracking items. For example, a product or a blog post.
The interaction names are treated as a catalog interaction.
Interaction Name Value
SalesforceInteractions.CatalogObjectInteractionName.CommentCatalogObject Comment Catalog Object
SalesforceInteractions.CatalogObjectInteractionName.FavoriteCatalogObject Favorite Catalog Object
SalesforceInteractions.CatalogObjectInteractionName.QuickViewCatalogObject Quick View Catalog Object
SalesforceInteractions.CatalogObjectInteractionName.ReviewCatalogObject Review Catalog Object
SalesforceInteractions.CatalogObjectInteractionName.ShareCatalogObject Share Catalog Object
SalesforceInteractions.CatalogObjectInteractionName.ViewCatalogObject View Catalog Object
SalesforceInteractions.CatalogObjectInteractionName.ViewCatalogObjectDetail View Catalog Object Detail
{
interaction: {
name: 'View Catalog Object',
catalogObject: {
type: 'Product',
id: 'product-xyz',
attributes: {
name: 'Product XYZ',
category: 'Clothing',
color: 'Red',
sku: 'product-xyz-sku'
},
relatedCatalogObjects: [{
Sizes: ["S", "M", "L"]
}]
}
}
}
Catalog interaction fields:
14
Connect Data Event Specifications
Field Name Description
catalogObject.attributes Field Type
object
Description
A dictionary of user-supplied values.
catalogObject.id Field Type
string
Description
Required.
A unique id representing the catalog object.
catalogObject.relatedCatalogObjects Field Type
object
Description
A dictionary of related catalog objects.
catalogObject.type Field Type
string
Description
Required.
A type name representing the catalog object.
name Field Type
string
Description
Required.
The event names.
Example: Here’s how a catalog interaction is captured using the Web SDK.
SalesforceInteractions.sendEvent({
interaction: {
name: 'View Catalog Object',
catalogObject: {
type: 'Product',
id: 'product-xyz',
attributes: {
name: 'Product XYZ',
category: 'Clothing',
color: 'Red',
sku: 'product-xyz-sku'
},
15
Connect Data Event Specifications
relatedCatalogObjects: [{
Sizes: ["S", "M", "L"]
}]
}
}
})
Here’s how a catalog interaction is captured using the sitemap.
SalesforceInteractions.init().then(() => {
const sitemapConfig = {
global: {},
pageTypes: [{
name: 'product_detail',
isMatch: () => true,
interaction: {
name: SalesforceInteractions.CatalogObjectInteractionName.ViewCatalogObject,
catalogObject: {
type: 'Product',
id: 'product-xyz',
attributes: {
name: 'Product XYZ',
category: 'Clothing',
color: 'Red',
sku: 'product-xyz-sku'
},
relatedCatalogObjects: [{
Sizes: ["S", "M", "L"]
}]
}
}
}]
}
SalesforceInteractions.initSitemap(sitemapConfig)
})
SEE ALSO:
Translation of SDK Events to Web Connector Schemas
Custom Events
Order Interaction
An order interaction is an ecommerce event that captures actions performed by a user to manage new, in progress, or completed orders.
The interaction names are treated as an order interaction:
Name Value
SalesforceInteractions.OrderInteractionName.Cancel Cancel
SalesforceInteractions.OrderInteractionName.Deliver Deliver
16
Connect Data Event Specifications
Name Value
SalesforceInteractions.OrderInteractionName.Exchange Exchange
SalesforceInteractions.OrderInteractionName.Preorder Preorder
SalesforceInteractions.OrderInteractionName.Purchase Purchase
SalesforceInteractions.OrderInteractionName.Ship Ship
SalesforceInteractions.OrderInteractionName.Return Return
{
interaction: {
name: 'Purchase',
order: {
id: '9432',
totalValue: 9.99,
currency: "USD",
lineItems: [{
catalogObjectType: 'Product',
catalogObjectId: 'product-xyz',
quantity: 1,
price: 9.99,
attributes: {
giftWrapping: 1
}
}]
},
attributes: {
promoCode: "SAVE10"
}
}
}
Order interaction fields:
Field Name Field Type Description
name string Required. The event names.
order.attributes object A user-supplied value.
order.currency string The currency of the order.
order.lineItems Line Item Data on page 19 An array of Line Item Data values.
order.id string Required. A unique identifier representing
the order.
order.totalValue number Required. The total value of the order.
17
Connect Data Event Specifications
Example: Here’s how an order interaction is captured using the Web SDK.
SalesforceInteractions.sendEvent({
interaction: {
name: 'Purchase',
order: {
id: '9432',
totalValue: 9.99,
currency: "USD",
lineItems: [{
catalogObjectType: 'Product',
catalogObjectId: 'product-xyz',
quantity: 1,
price: 9.99,
attributes: {
giftWrapping: 1
}
}]
},
attributes: {
promoCode: "SAVE10"
}
}
})
Here’s how an order interaction is captured using the Sitemap.
SalesforceInteractions.init().then(() => {
const sitemapConfig = {
global: {},
pageTypes: [{
name: 'product_detail',
isMatch: () => true,
interaction: {
name: SalesforceInteractions.OrderInteractionName.Purchase,
order: {
id: '9432',
totalValue: 9.99,
currency: "USD",
lineItems: [{
catalogObjectType: 'Product',
catalogObjectId: 'product-xyz',
quantity: 1,
price: 9.99,
attributes: {
giftWrapping: 1
}
}]
},
attributes: {
promoCode: "SAVE10"
}
}
}]
}
18
Connect Data Event Specifications
SalesforceInteractions.initSitemap(sitemapConfig)
})
SEE ALSO:
Translation of SDK Events to Web Connector Schemas
Custom Events
Line Item Data
Line items are intended to describe purchasable items and are used in cart and order interactions.
Line item fields:
Field Name Field Type Description
attributes object A user-supplied value.
catalogObjectId string Required. A unique identifier representing
the catalog object referenced in the line
item.
catalogObjectType string Required. A name representing the catalog
object referenced in the line item.
currency string The currency of the price field.
price number The price of the catalog object referenced
in the line item.
quantity number Required. The number of catalog objects in
this line item.
Example: Here’s a basic structure of a line item used within an Interaction using the Sitemap.
{
catalogObjectType: "Product",
catalogObjectId: "product-1",
quantity: 1,
price: 9.99,
currency: "USD",
attributes: {
giftWrapping: 1
}
}
SEE ALSO:
Translation of SDK Events to Web Connector Schemas
Custom Events
19
Connect Data Event Specifications
User Data
Track profile data for a user with or without an associated interaction using Salesforce Interactions Web SDK.
{
user: {
anonymousId: '<Set by SDK>',
identities: {
loyaltyId: "885627312393"
},
attributes: {
firstName: 'Joe',
lastName: 'Smith',
email: '[email protected]'
}
}
}
User object fields:
Field Name Field Type Description
anonymousId string This field is managed by the SDK and is
automatically attached to every event.
user.attributes object A user-supplied value.
user.identities object A user-supplied value to link the anonymous
user with a known user.
Example: Here’s how a user profile data is captured using the Web SDK without Interaction.
SalesforceInteractions.sendEvent({
user: {
identities: {
loyaltyId: "885627312393"
},
attributes: {
firstName: 'Joe',
lastName: 'Smith',
email: '[email protected]'
}
}
})
Here’s how a user profile data is captured using the Web SDK with Interaction.
SalesforceInteractions.sendEvent({
interaction: {
name: 'View Catalog Object',
catalogObject: {
type: 'Product',
id: 'product-xyz',
attributes: {
name: 'Product XYZ',
20
Connect Data Event Specifications
category: 'Clothing',
color: 'Red'
}
}
},
user: {
identities: {
loyaltyId: "885627312393"
},
attributes: {
firstName: 'Joe',
lastName: 'Smith',
email: '[email protected]'
}
}
})
Here’s how a user profile data is captured using a Sitemap.
SalesforceInteractions.init().then(() => {
const sitemapConfig = {
global: {
onActionEvent: (event) => {
const email = window.user_info && window.user_info.email;
if (email) {
event.user = event.user || {};
event.user.attributes = event.user.attributes || {};
event.user.attributes.emailAddress = email;
}
return event;
},
},
pageTypes: [{
name: 'product_detail',
isMatch: () => true,
interaction: {
name: SalesforceInteractions.InteractionName.ViewCatalogObject,
catalogObject: {
type: 'Product',
id: 'product-xyz',
attributes: {
name: 'Product XYZ',
category: 'Clothing',
color: 'Red'
}
}
}
}]
}
21
Connect Data Event Specifications
SalesforceInteractions.initSitemap(sitemapConfig)
})
SEE ALSO:
Translation of SDK Events to Web Connector Schemas
Custom Events
Account Data
Account data represent user information at the account level. The account fields allow you to capture data for many customers in one
account.
{
account: {
id: '43296241300',
attributes: {
role: 'Subscriber'
}
}
}
User object fields:
Field Name Field Type Description
account.attributes object A user-supplied value.
account.id string Required. An account identifier for the user.
Example: Here’s how account data is captured using the Web SDK without Interaction.
SalesforceInteractions.sendEvent({
account: {
id: '43296241300',
attributes: {
role: 'Subscriber'
}
}
})
Here’s how account data is captured using the Web SDK with Interaction.
SalesforceInteractions.sendEvent({
interaction: {
name: 'View Catalog Object',
catalogObject: {
type: 'Product',
id: 'product-xyz',
attributes: {
name: 'Product XYZ',
category: 'Clothing',
22
Connect Data Event Specifications
color: 'Red'
}
}
},
account: {
id: '43296241300',
attributes: {
role: 'Subscriber'
}
}
})
Here’s how account data is captured using the Sitemap.
SalesforceInteractions.init().then(() => {
const sitemapConfig = {
global: {
onActionEvent: (event) => {
const accountId = window.accountId;
if (accountId) {
event.account = event.user || {};
event.account.id = accountId;
}
return event;
},
},
pageTypes: [{
name: 'product_detail',
isMatch: () => true,
interaction: {
name: SalesforceInteractions.InteractionName.ViewCatalogObject,
catalogObject: {
type: 'Product',
id: 'product-xyz',
attributes: {
name: 'Product XYZ',
category: 'Clothing',
color: 'Red'
}
}
}
}]
}
SalesforceInteractions.initSitemap(sitemapConfig)
})
SEE ALSO:
Translation of SDK Events to Web Connector Schemas
Custom Events
23
Connect Data API Reference
Consent Data
Consent data is used to either grant or revoke consent in Salesforce Interactions SDK. When a customer chooses to opt in to tracking
these consent details are attached to the Event Structure of the first tracked event.
Consent on page 24 object fields:
Fields Type Description
provider string Required. A named identifier indicating the
consent management system providing the
consent to the SDK.
purpose string Required. What the customer consented to.
For example, Tracking.
status string Required. Values: Opt In or Opt Out
Here’s a basic structure of the consent data attached to an event.
{
provider: "Example Provider",
purpose: "Tracking",
status: "Opt In"
}
The following consent purpose and status names are provided:
Name Value
SalesforceInteractions.ConsentPurpose.Tracking Tracking
SalesforceInteractions.ConsentStatus.OptIn Opt In
SalesforceInteractions.ConsentStatus.OptOut Opt Out
SEE ALSO:
Translation of SDK Events to Web Connector Schemas
Custom Events
API Reference
This section provides guidance around references provided with the Salesforce Interactions Web SDK.
Initialization
The recommended initialization flow for the Salesforce Interactions SDK follows a general pattern.
Data Collection
Before the Salesforce Interactions SDK can begin capturing data, initialize the Salesforce Interactions SDK and gain the user’s consent
to track the data.
24
Connect Data API Reference
Identity
The Salesforce Interactions SDK supports identification of new and returning customer using the first-party cookie
_sfid_${domainHash}. Also, the domainHash is produced by running the website’s domain through a hashing function.
Consent
The Salesforce Interactions SDK has been designed to respect user privacy and doesn’t store or transmit data collected until it has
been granted consent. If your site has existing consent management features, those features must integrate with the SDK to signal
when the user has given consent to track.
Sitemap
Salesforce Interactions SDK Sitemap provides the ability to extract data during page navigation. Also, the sitemap can share data
capture logic across multiple pages, and it can separate data capture logic from web page presentation logic.
Integrations
The Salesforce Interactions SDK features built-in CustomEvents that you can use to bind listeners to events that are specific to the
Web SDK. Data that these events pass are in the detail properties of the event object passed to a listener’s callback function.
Debugging
When configured, the Salesforce Interaction SDK can output messages to the browser console for debugging purposes. By default,
the logger is configured with a log level of none. The logger used by the Web SDK wraps the standard browser console.log
function and can be accessed at SalesforceInteractions.log.
Initialization
The recommended initialization flow for the Salesforce Interactions SDK follows a general pattern.
SalesforceInteractions.init({
consents: [...],
cookieDomain: '...'
}).then(() => {
SalesforceInteractions.initSitemap({
global: { ... },
pageTypeDefault: { ... },
pageTypes: [...]
})
})
This method initializes the Web SDK with Consent, Identity, and Sitemap features enabled.
Initialization Methods
init(sdkConfig: SdkConfig): Promise<void>
Arguments:
Field Name Description
consents Field Type
Consent[] Promise<Consent[]>
Description
Required.
25
Connect Data API Reference
Field Name Description
A list of consent data values or a promise that resolves a list of
consent data values.
cookieDomain Field Type
string
Description
The domain to use for the first-party cookies that stores identity
data. Defaults to the domain of the current site.
• sdkConfig — An object with consent and cookieDomain fields.
// initialize with consent provided by a user interaction
SalesforceInteractions.init({
cookieDomain: 'domain.com',
consents: new Promise(resolve => {
// user clicks button that grants consent
document.getElementById('opt-in')
.addEventListener('click', () => {
resolve([{
provider: 'Test Provider',
purpose: 'Tracking',
status: SalesforceInteractions.ConsentStatus.OptIn
}])
}, { once: true })
// user clicks button that revokes consent
document.getElementById('opt-out')
.addEventListener('click', () => {
resolve([{
provider: 'Test Provider',
purpose: 'Tracking',
status: SalesforceInteractions.ConsentStatus.OptOut
}])
}, { once: true })
})
})
// initialize with consent preconfigured
SalesforceInteractions.init({
cookieDomain: 'domain.com',
consents: [{
provider: 'Test Provider',
purpose: 'Tracking',
status: SalesforceInteractions.ConsentStatus.OptIn
}]
})
// initialize with no consent
SalesforceInteractions.init({
cookieDomain: 'domain.com',
26
Connect Data API Reference
consents: []
})
reinit(): void
Reinitializes the Web SDK and reevaluates which rules to apply from the configured sitemap.
SalesforceInteractions.init({...}).then(() => {
let href = window.location.href
// monitor the url for changes and reinitialize when detected
setInterval(() => {
if (href !== window.location.href) {
href = window.location.href
SalesforceInteractions.reinit()
}
}, 200)
SalesforceInteractions.initSitemap({...})
})
Data Collection
Before the Salesforce Interactions SDK can begin capturing data, initialize the Salesforce Interactions SDK and gain the user’s consent to
track the data.
Use this function for Initialization on page 25 and consent on page 29.
SalesforceInteractions.init({
consents: [{
purpose: "Tracking",
provider: "OneTrust",
status: "Opt In"
}]
})
If your site has existing consent management features, integrate those features with the Salesforce Interactions SDK to signal when the
user gives consent to track.
Capturing User Engagement Data
To capture a customer interaction, call the sendEvent function.
SalesforceInteractions.sendEvent({
interaction : {
name : "View Catalog Object",
catalogObject: {
type : "Product",
id : "65e4e737",
attributes: {
description: "Shoes"
}
}
}
})
27
Connect Data API Reference
Capturing Profile Data
Capturing profile data occurs in the same sendEvent function.
SalesforceInteractions.sendEvent({
user: {
attributes: {
email: '[email protected]'
}
}
})
Capturing Profile and Engagement Data
When capturing profile data, you aren’t limited to that minimal interaction format. You can combine any of the interaction data models
with profile information to collect as much context for an event as possible.
SalesforceInteractions.sendEvent({
interaction : {
name : "View Catalog Object",
catalogObject: {
type : "Product",
id : "65e4e737",
attributes: {
description: "Shoes"
}
}
},
user: {
attributes: {
email: '[email protected]'
}
}
})
Identity
The Salesforce Interactions SDK supports identification of new and returning customer using the first-party cookie
_sfid_${domainHash}. Also, the domainHash is produced by running the website’s domain through a hashing function.
• New customers receive a randomly generated anonymousId, which is persisted to the first-party cookie
• Returning customers use the anonymousId already stored in the first-party cookie
Sharing a Cookie Across Multiple Domains
If you must share cookies across multiple domains, configure the Salesforce Interactions Web SDK with the shared domain name. This
can be done through either configuration passed to SalesforceInteractions.init or in a function call to
SalesforceInteractions.setCookieDomain.
For example, to share a cookie between these two domains:
• abc.domain.com
• xyz.domain.com
28
Connect Data API Reference
The cookie domain can be configured with:
SalesforceInteractions.init({
cookieDomain: 'domain.com'
})
The cookie domain could also be set using the setCookieDomain function.
Identity Methods
getCookieDomain(): string
Returns the value of the cookie domain used to generate the first-party cookie. The first party cookie stores the anonymous customer
identity.
SalesforceInteractions.getCookieDomain()
// => "domain.com"
setCookieDomain(newDomain:string): void
Sets the value of the cookie domain used to generate the first-party cookie. The first party cookie stores the anonymous customer identity.
SalesforceInteractions.setCookieDomain('domain.com')
Note: Setting the cookie via the setCookieDomain function doesn’t take effect if the Salesforce Web Interactions SDK is
already initialized. Ideally, this function call happens before initialization but it’s also possible to call
SalesforceInteractions.reinit() to force the cookie changes to take effect.
getAnonymousId():string
Returns the value of the anonymous customer identity persisted in the first-party cookie.
SalesforceInteractions.getAnonymousId()
// => "efc9953d6515dc7f"
setAnonymousId(newAnonymousId:string): void
Sets the value of the anonymous customer identity persisted in the first-party cookie.
SalesforceInteractions.setAnonymousId(`id_${Date.now()}`)
resetAnonymousId():void
Removes the first-party cookie and generates a brand new cookie with a newly generated anonymous customer identity.
SalesforceInteractions.resetAnonymousId()
Consent
The Salesforce Interactions SDK has been designed to respect user privacy and doesn’t store or transmit data collected until it has been
granted consent. If your site has existing consent management features, those features must integrate with the SDK to signal when the
user has given consent to track.
Providing the user’s consent to the Salesforce Interactions SDK can happen either:
• During Initialization on page 25
• Calling updateConsents = (consents: Consent | Consent[]): void
29
Connect Data API Reference
The recommended approach is to provide a Promise for the consent during Initialization that resolves with an array of Consent Data
values as shown in the example:
SalesforceInteractions.init({
consents: new Promise(resolve => {
// user clicks button that grants consent
document.getElementById('opt-in')
.addEventListener('click', () => {
resolve([{
provider: 'Test Provider',
purpose: SalesforceInteractions.ConsentPurpose.Tracking,
status: SalesforceInteractions.ConsentStatus.OptIn
}])
}, { once: true })
// user clicks button that revokes consent
document.getElementById('opt-out')
.addEventListener('click', () => {
resolve([{
provider: 'Test Provider',
purpose: SalesforceInteractions.ConsentPurpose.Tracking,
status: SalesforceInteractions.ConsentStatus.OptOut
}])
}, { once: true })
})
})
Consent Methods
getConsents: ConsentWithMetadata[]
Returns Consent Data on page 24 with last updated and sent times.
updateConsents = (consents: Consent | Consent[]): void
To update consent after Initialization. For example, to call directly from your OneTrust code:
// when the user opts in
SalesforceInteractions.updateConsents({
purpose: SalesforceInteractions.ConsentPurpose.Tracking,
provider: "OneTrust",
status: SalesforceInteractions.ConsentStatus.OptIn
})
// when the user opts out
SalesforceInteractions.updateConsents({
purpose: SalesforceInteractions.ConsentPurpose.Tracking,
provider: "OneTrust", status:
SalesforceInteractions.ConsentStatus.OptOut
})
Sitemap
Salesforce Interactions SDK Sitemap provides the ability to extract data during page navigation. Also, the sitemap can share data capture
logic across multiple pages, and it can separate data capture logic from web page presentation logic.
30
Connect Data API Reference
A sitemap can be configured immediately after initializing the Web SDK. A general pattern is:
SalesforceInteractions.init().then(() => {
SalesforceInteractions.initSitemap({
global: { ... },
pageTypeDefault: { ... },
pageTypes: [...]
})
}))
In each section of the sitemap you can define:
• Multiple listeners to capture specific customer events that occur on a page
• An onActionEvent hook that can be used to intercept and modify data captured
• A name to identify the page configuration
• The locale to capture for the page
• An interaction to capture after the page loads
GlobalPageConfig
The global configuration is merged into the PageConfig or DefaultPageConfig that is applied to a target web page. If there are no
matching configurations for the target web page, the global configuration isn’t applied.
Field Name Description
listeners Field Type
listener
Description
An array of event listeners created using the
SalesforceInteractions.listener function.
These events listen for customer interactions that trigger events
to send through the Web SDK.
locale Field Type
string
Description
The locale of the current page as an ISO 639 alpha-2 language
code and ISO 3166 alpha-2 country code. For example, en_US,
or de_DE.
onActionEvent FieldType
(event: ActionEvent) => ActionEvent
31
Connect Data API Reference
Field Name Description
Description
A callback that executes when an ActionEvent object is
passed into the Web SDK. This call provides a hook to insert or
modify properties of an event before it’s sent out.
SalesforceInteractions.init().then(() => {
const {
listener,
CatalogObjectInteractionName,
resolvers
} = SalesforceInteractions
const global = {
locale: 'en_US',
listeners: [
listener('click', '[title="Log In"]', (event) => {
console.log(event)
})
],
onActionEvent: (actionEvent) => {
console.log(actionEvent)
}
}
const pageTypeDefault = {...}
const pageTypes = [...]
SalesforceInteractions.initSitemap({
global,
pageTypes,
pageTypeDefault
})
})
DefaultPageConfig
The default page configuration is activated when no registered PageConfig matches are found on a target web page.
Field Name Description
listeners Field Type
listener
Description
An array of event listeners created using the
SalesforceInteractions.listener function.
These events listen for customer interactions that trigger events
to send through the Web SDK.
32
Connect Data API Reference
Field Name Description
locale Field Type
string
Description
The locale of the current page as an ISO 639 alpha-2 language
code and ISO 3166 alpha-2 country code. For example, en_US,
or de_DE
name Field Type
string
Description
A name that identifies the default page configuration.
onActionEvent (event:ActionEvent) => ActionEvent A callback
that executes when an ActionEvent object is passed into the
Web SDK. This call provides a hook to insert or modify properties
of an event before it’s sent out.
SalesforceInteractions.init().then(() => {
const {
listener,
CatalogObjectInteractionName,
resolvers
} = SalesforceInteractions
const global = {...}
const pageTypeDefault = {
name: 'default',
locale: 'en_US',
listeners: [
listener('click', '.example-selector', (event) => {
console.log(event)
})
],
onActionEvent: (actionEvent) => {
console.log(actionEvent)
}
}
const pageTypes = [...]
SalesforceInteractions.initSitemap({
global,
pageTypes,
pageTypeDefault
})
})
33
Connect Data API Reference
PageConfig
Field Name Description
interaction Field Type
Cart Interaction on page 11 | Catalog Interaction on page 14
| Order Interaction on page 16
Description
The interaction to capture from the page. These fields are
automatically extracted and sent when a page configuration
matches. Sometimes the data to extract isn’t fully rendered
when the sitemap is configured, so provide static values or
values wrapped by a function to ensure that they’re evaluated
lazily.
isMatch Field Type
() => Boolean
Description
Required.
A function that tests whether to apply the given page
configuration.
listeners Field Type
listener
Description
An array of event listeners created using the
SalesforceInteractions.listener function.
These events listen for customer interactions that trigger events
to send through the Web SDK.
locale Field Type
string
Description
The locale of the current page as an ISO 639 alpha-2 language
code and ISO 3166 alpha-2 country code. For example, en_US,
or de_DE.
name Field Type
string
Description
Required.
A unique name identifying the page configuration.
onActionEvent Field Type
(event:ActionEvent) => ActionEvent
34
Connect Data API Reference
Field Name Description
Description
A callback that executes when an ActionEvent object is
passed into the Web SDK. This call provides a hook to insert or
modify properties of an event before it’s sent out.
SalesforceInteractions.init().then(() => {
const {
listener,
CatalogObjectInteractionName,
resolvers
} = SalesforceInteractions
const global = {...}
const pageTypeDefault = {...}
const homePage = {
name: 'home',
locale: 'en_US',
isMatch: () => {
return window.location.pathname === '/'
},
listeners: [
listener('click', '#promo', (event) => {
console.log(event)
})
],
onActionEvent: (actionEvent) => {
console.log(actionEvent)
}
}
const productPage = {
name: 'product',
isMatch: () => {
return /product\/\d+/.test(window.location.pathname),
},
interaction: {
name: CatalogObjectInteractionName.ViewCatalogObject,
catalogObject: {
type: 'Product',
id: resolvers.fromSelectorAttribute('.product', 'data-id')
}
}
}
const pageTypes = [homePage, productPage]
SalesforceInteractions.initSitemap({
global,
35
Connect Data API Reference
pageTypes,
pageTypeDefault
})
})
Sitemap Methods
initSitemap(siteMapConfig: SiteMapConfig): boolean
Field Name Description
global Field Type
GlobalPageConfig
Description
Required
The global configuration is merged into the PageConfig or
DefaultPageConfig that is applied to a target web page. If there
are no matching configurations for the target web page, the
global configuration isn’t applied.
pageTypes Field Type
PageConfig[]
Description
Required
An array of page configurations that specify whether data
collection rules execute on any page that matches a specified
criteria for a target web page. Multiple page configurations
can match a single page. These configurations are merged
together along with the GlobalPageConfig, if provided.
pageTypeDefault Field Type
DefaultPageConfig
Description
The default page configuration is activated when no registered
PageConfig matches are found on a target web page.
Extract the Canonical Link From an HTML Document
resolvers.fromCanonical(
transform?: (value: string | undefined) => string | undefined
): () => string | undefined
Creates a resolver that extracts the canonical link from an HTML document. Transform is an optional function that transforms the resolved
value into a new value.
36
Connect Data API Reference
For example, giving the HTML:
<link rel="canonical" href="/some/url">
You could extract the value of the canonical href with:
const fromCanonical = SalesforceInteractions.resolvers.fromCanonical
const toUpperCase = (value) => value.toUpperCase()
fromCanonical()()
// => "/some/url"
// extract and transform the value
fromCanonical(toUpperCase)()
// => "/SOME/URL"
Extract the Href Value from the HTML Document Location Object
resolvers.fromHref(
transform?: (value: string | undefined) => string |
undefined
): () => string | undefined
Creates a resolver that extracts the href value from the HTML document’s Location object. Transform is an optional function that
transforms the resolved value into a new value.
For example, giving an HTML document at the URL:
https://site.domain.com/search.html?page=3
You could extract the href with:
const fromHref = SalesforceInteractions.resolvers.fromHref
const toUpperCase = (value) => value.toUpperCase()
fromHref()()
// => "https://site.domain.com/search.html?page=3"
// extract and transform the value
fromHref(toUpperCase)()
// => "HTTPS://SITE.DOMAIN.COM/SEARCH.HTML?PAGE=3"
Extract the Content Attribute from the First Element
resolvers.fromItemProp(
itemProp: string,
transform?: (value: string | undefined) => string | undefined
): () => string | undefined
Creates a resolver that extracts the content attribute from the first element matching the target itemprop attribute value in an HTML
document.
Arguments:
• itemProp — The value of the itemprop attribute to match against
• transform — An optional function that transforms the resolved value into a new value
37
Connect Data API Reference
For example, giving the HTML:
<ul>
<li itemprop="name" content="first">First</li>
<li itemprop="name" content="second">Second</li>
</ul>
You could extract values from the <meta> element with:
const fromItemProp = SalesforceInteractions.resolvers.fromItemProp
const toUpperCase = (value) => value.toUpperCase()
fromItemProp("name")()
// => "first"
// extract and transform the value
fromItemProp("name", toUpperCase)()
// => "FIRST"
Extracts JSON Linked Data
resolvers.fromJsonLd(
path?: string,
transform?: (value: string | undefined) => string | undefined
): () => string | undefined
Creates a resolver that extracts JSON Linked Data (JSON-LD) from the first <script> element with a type attribute of
application/ld+json in an HTML document.
Arguments:
• path — A path of the property to get
• transform — An optional function that transforms the resolved value into a new value
For example, giving the HTML:
<script type="application/ld+json">
{
"@context": "https://json-ld.org/contexts/person.jsonld",
"@id": "http://dbpedia.org/resource/John_Smith",
"name": "John Smith",
"born": "1940-10-09",
"spouse": "http://dbpedia.org/resource/Cynthia_Smith",
"gr:includes": {
"@type": [
"gr:Individual"
]
}
}
</script>
You could extract values from the <meta> element with:
const fromJsonLD = SalesforceInteractions.resolvers.fromJsonLD
const toUpperCase = (value) => value.toUpperCase()
fromJsonLD()()
// => {@context: "https://json-ld.org/contexts/person.jsonld", @id: …}
38
Connect Data API Reference
// extract a property
fromJsonLD("@id")()
// => "http://dbpedia.org/resource/John_Smith"
// extract a nested property
fromJsonLD("gr:includes.@type")()
// => ["gr:Individual"]
// extract and transform the value
fromJsonLD("name", toUpperCase)()
// => "JOHN SMITH"
Extract the Content Attribute from the First Meta Element
resolvers.fromMeta(
name: string,
transform?: (value: string | undefined) => string | undefined
): () => string | undefined
Creates a resolver that extracts the content attribute from the first <meta> element that matches the given name attribute in an HTML
document.
Arguments:
• name — The value of the name attribute to match against
• transform — An optional function that transforms the resolved value into a new value
For example, giving the HTML:
<meta name="id" content="product-1">
You could extract values from the <meta> element with:
const fromMeta = SalesforceInteractions.resolvers.fromMeta
const toUpperCase = (value) => value.toUpperCase()
fromMeta("id")()
// => "product-1"
// extract and transform the value
fromMeta("id", toUpperCase)()
// => "PRODUCT-1"
Extract the Text from the First Element
resolvers.fromSelector(
selector: string,
transform?: (value: string | undefined) => string | undefined
): () => string | undefined
Creates a resolver that extracts the text from the first element that matches the given CSS Selector in an HTML document.
Arguments:
• selector — A target CSS Selector to match against
• transform — An optional function that transforms the resolved value into a new value
39
Connect Data API Reference
For example, giving the HTML:
<div id="product-1">
<h1 class="name">Product XYZ</h1>
</div>
You could extract the text of every <h1> element with:
const fromSelector = SalesforceInteractions.resolvers.fromSelector
const toUpperCase = (value) => value.toUpperCase()
fromSelector("#product-1 .name")()
// => "Product XYZ"
// extract and transform the value
fromSelector("#product-1 .name", toUpperCase)()
// => "PRODUCT XYZ"
Extract the Text from the First Element
resolvers.fromSelectorMultiple(
selector: string,
transform?: (value: string[] | undefined) => string[] | undefined
): () => string[] | undefined
Creates a resolver that extracts the text from each element that matches the given CSS Selector in an HTML document.
Arguments:
• selector — A target CSS Selector to match against
• transform — An optional function that transforms the resolved value into a new value
For example, giving the HTML:
<ul class="products">
<li class="name">Product 1</li>
<li class="name">Product 2</li>
<li class="name">Product 3</li>
</ul>
You could extract the text of every <h1> element with:
const fromSelectorMultiple = SalesforceInteractions.resolvers.fromSelectorMultiple
const mapToUpperCase = (values) => values.map(v => v.toUpperCase())
fromSelectorMultiple(".name")()
// => ["Product 1", "Product 2", "Product 3"]
// extract and transform the values
fromSelectorMultiple(".name", mapToUpperCase)
// => ["PRODUCT 1", "PRODUCT 2", "PRODUCT 3"]
Extract the Value From of the Target Attribute From the First Element
resolvers.fromSelectorAttribute(
selector: string,
attribute: string,
transform?: (value: string | undefined) => string | undefined
): () => string | undefined
40
Connect Data API Reference
Creates a resolver that extracts the value of the target attribute from the first element that matches the given CSS Selector in an HTML
document.
Arguments:
• selector — A target CSS Selector to match against
• attribute — The target attribute to extract the value from
• transform — An optional function that transforms the resolved value into a new value
For example, giving the HTML:
<div id="product">
<h1 class="name" data-id="product-1">Product 1</h1>
</div>
You could extract the value of the data-id attribute with:
const fromSelectorAttribute = SalesforceInteractions.resolvers.fromSelectorAttribute
const toUpperCase = (value) => value.toUpperCase()
fromSelectorAttribute("#product .name", "data-id")()
// => "product-1"
// extract and transform the value
fromSelectorAttribute("#product .name", "data-id", toUpperCase)()
// => "PRODUCT-1"
Extract the Value of the Target Attribute
resolvers.fromSelectorAttributeMultiple(
selector: string,
attribute: string,
transform?: (value: string[] | undefined) => string[] | undefined
): () => string[] | undefined
Creates a resolver that extracts the value of the target attribute from each element that matches the given CSS Selector in an HTML
document.
Arguments:
• selector — A target CSS Selector to match against
• attribute — The target attribute to extract the value from
• transform — An optional function that transforms the resolved value into a new value
For example, giving the HTML:
<ul class="products">
<li class="name" data-id="product-1">Product 1</li>
<li class="name" data-id="product-2">Product 2</li>
<li class="name" data-id="product-3">Product 3</li>
</ul>
You could extract the values of every data-id attribute with:
const fromSelectorAttributeMultiple =
SalesforceInteractions.resolvers.fromSelectorAttributeMultiple;
const mapToUpperCase = (values) => values.map(v => v.toUpperCase())
41
Connect Data API Reference
fromSelectorAttributeMultiple(".name", "data-id")()
// => ["Product 1", "Product 2", "Product 3"]
// extract and transform the value
fromSelectorAttributeMultiple(".name", "data-id", mapToUpperCase)()
// => ["PRODUCT 1", "PRODUCT 2", "PRODUCT 3"]
Extract the Value of an Object
resolvers.fromWindow(
path: string,
transform?: (value: string[] | undefined) => string[] | undefined
): () => string[] | undefined
Creates a resolver that extracts the value of an object, usually a global variable, attached to the window object.
Arguments:
• path — A string representing the path to the object in the window object. Uses dot notation.
• transform — An optional function that transforms the resolved value into a new value
For example, giving the window object:
window = {
shop: {
name: "SHOP 1",
products: [
"PRODUCT 1",
"PRODUCT 2"
]
},
...
}
You can extract data from the shop global object:
const fromWindow = SalesforceInteractions.resolvers.fromWindow;
fromWindow("shop.name")()
// => "SHOP 1"
fromWindow("shop.products[1]")()
// => "PRODUCT 2"
Sample Ecommerce Sitemap
Review this sample sitemap.
Sample Ecommerce Sitemap
Review this sample sitemap.
Example:
SalesforceInteractions.init({
consents: new Promise(resolve => {
const { OptIn, OptOut } = SalesforceInteractions.ConsentStatus
42
Connect Data API Reference
const purpose = SalesforceInteractions.ConsentPurpose.Tracking
const provider = 'Test Provider'
// user clicks button that grants consent
document.getElementById('opt-in')
.addEventListener(
'click',
() => resolve([{ purpose, provider, status: OptIn }]),
{ once: true }
)
// user clicks button that revokes consent
document.getElementById('opt-out')
.addEventListener(
'click',
() => resolve([{ purpose, provider, status: OptOut }]),
{ once: true }
)
})
}).then(() => {
// set the log level during sitemap development to see potential problems
SalesforceInteractions.log.level = 'debug'
const {
cashDom,
listener,
resolvers,
sendEvent,
util,
CartInteractionName,
CatalogObjectInteractionName,
OrderInteractionName,
} = SalesforceInteractions
const global = {
listeners: [
// capture email address when a user signs up
listener('submit', '.user-signup-form', (actionEvent) => {
const emailAddress = cashDom("#user_email").val()
if (emailAddress) {
sendEvent({
interaction: {
name: 'Email Sign Up'
},
user: {
attributes: {
email: emailAddress,
eventType: 'contactPointEmail' }
}
})
}
})
],
43
Connect Data API Reference
// attach optional data to every actionEvent that is sent out
onActionEvent: (actionEvent) => {
const email = window && window._userInfo && window._userInfo.email
if (email) {
actionEvent.user = actionEvent.user || {}
actionEvent.user.attributes = actionEvent.user.attributes || {}
actionEvent.user.attributes.emailAddress = email
}
return actionEvent
}
}
const productIdResolver = resolvers.fromSelectorAttribute('.product', 'data-id')
const productPage = {
name: 'product',
isMatch: () => /products/.test(window.location.pathname),
// capture the product being viewed when the page is opened
interaction: {
name: CatalogObjectInteractionName.ViewCatalogObject,
catalogObject: {
type: 'Product',
id: productIdResolver,
attributes: {
name: resolvers.fromSelector('.product-title'),
url: resolvers.fromHref(),
imageUrl: resolvers.fromSelectorAttribute('.product img', 'src')
},
relatedCatalogObjects: {
Color: resolvers.fromSelectorAttributeMultiple('.color-value',
'data-attr-value')
}
}
},
listeners: [
// capture when the user adds this product to their cart
listener('click', '.add-to-cart', () => {
sendEvent({
interaction: {
name: CartInteractionName.AddToCart,
lineItem: {
catalogObjectType: 'Product',
catalogObjectId: productIdResolver(),
quantity: parseInt(cashDom('.product .quantity input').val(), 10),
price: parseFloat(cashDom('.product .price').text().trim())
}
}
})
}),
// capture when the user shares the product to social media
listener('click', '.share', () => {
sendEvent({
interaction: {
name: CatalogObjectInteractionName.ShareCatalogObject,
44
Connect Data API Reference
catalogObject: {
type: 'Product',
id: productIdResolver()
}
}
})
})
]
}
const cartPage = {
name: 'Cart',
isMatch: () => /^\/cart/.test(window.location.href),
listeners: [
// capture when a user removes an item from their cart
listener('click', '.remove-from-cart', (event) => {
const $cartItem = cashDom(event.target).parents('.cart-item').first()
sendEvent({
interaction: {
name: CartInteractionName.RemoveFromCart,
lineItem: {
catalogObjectType: 'Product',
catalogObjectId: $cartItem.attr('data-id'),
quantity: parseInt($cartItem.find('.quantity').text().trim(), 10),
}
}
})
})
]
}
const orderConfirmationPage = {
name: 'Order Configuration',
isMatch: /\/confirmation/.test(window.location.href),
// capture when a user completes an order
interaction: {
name: OrderInteractionName.Purchase,
order: {
id: resolvers.fromSelectorAttribute('.order', 'data-id'),
totalValue: parseFloat(resolvers.fromSelector('.order .total').trim()),
lineItems: () => cashDom('.order .line-items').map((index, el) => {
const $lineItem = cashDom(el)
return {
catalogObjectType: 'Product',
catalogObjectId: $lineItem.attr('data-id'),
quantity: parseInt($lineItem.find('.quantity').text().trim(), 10)
}
})
}
}
}
const pageTypeDefault = {
name: 'default'
45
Connect Data API Reference
SalesforceInteractions.initSitemap({
global,
pageTypeDefault,
pageTypes: [cartPage, orderConfirmationPage, productPage]
})
})
Sample for Profile Events
To implement profile events like Identity, ContactPointEmail, and ContactPointPhone refer this example.
Example:
SalesforceInteractions.listener('click', '#register', () => {
SalesforceInteractions.reinit()
const email = window.email
const phone = window.phonenumber
const firstname = window.firstname
const lastname = window.lastname
if (email) {
SalesforceInteractions.sendEvent({
user: {
attributes: {
email: email,
eventType: 'contactPointEmail'
}
}
})
}
if (phone) {
SalesforceInteractions.sendEvent({
user: {
attributes: {
phoneNumber: phone,
eventType: 'contactPointPhone'
}
}
})
}
SalesforceInteractions.sendEvent({
user: {
attributes: {
firstName: firstname || '',
lastName: lastname || '',
eventType: 'identity',
isAnonymous: 0
}
}
})
})
46
Connect Data API Reference
Integrations
The Salesforce Interactions SDK features built-in CustomEvents that you can use to bind listeners to events that are specific to the Web
SDK. Data that these events pass are in the detail properties of the event object passed to a listener’s callback function.
The Salesforce Interactions SDK built-in custom events.
SalesforceInteractions.CustomEvents = {
OnBeforeEventSend: "interactions:onBeforeEventSend",
OnClearPersistedIdentities: "interactions:onClearPersistedIdentities",
OnConsentRevoke: "interactions:onConsentRevoke",
OnEventSend: "interactions:onEventSend",
OnException: "interactions:onException",
OnInit: "interactions:onInit",
OnInitSitemap: "interactions:onInitSitemap",
OnPageMatchStatusUpdated: "interactions:onPageMatchStatusUpdated",
OnResetAnonymousId: "interactions:onResetAnonymousId",
OnSetAnonymousId: "interactions:onSetAnonymousId",
OnShutDown: "interactions:onShutDown"
}
Custom Event Description
OnBeforeEventSend This event on page 9 shows before data passed to
SalesforceInteractions.sendEvent is distributed
to consuming modules.
OnClearPersistedIdentities This event shows when
SalesforceInteractions.clearPersistedIdentities
is invoked.
OnConsentRevoke This event is dispatched when a user gives consent on page 24
but later revokes that consent.
OnEventSend This event is dispatched whenever a request to the Event API sends
via SalesforceInteractions.sendEvent. This event
contains the actionEvent payload processed in the event
pipeline.
ActionEvent
OnException This event is dispatched when an operation fails and contains
information about the error and its context. You can use the
OnException event for debugging and logging runtime errors.
{
error: Error,
context: string
}
OnInit This event is dispatched when the Web SDK is initialized. You can
use the OnInit event for debugging single-page applications
(SPA) where the beacon and the sitemap usually reinitialize without
a page load event.
47
Connect Data API Reference
Custom Event Description
OnInitSitemap This event is dispatched whenever the Web SDK sitemap is
initialized via the
SalesforceInteractions.initSitemap function.
{
currentKey: string,
global: GlobalConfig,
pageTypeDefault?: DefaultPageConfig
pageTypes: pageTypeConfig[],
settings: object
}
OnPageMatchStatusUpdated This event is dispatched whenever the match status of a sitemap’s
page type is updated. The matchStatus array accumulates
every time an event is dispatched, in the order the match statuses
are updated. If the status is running, the PageMatchStatus
includes the start time. Conversely, if the status is selected,
rejected, or matched, the PageMatchStatus includes
the end time. The selected page type is the first page type to
be matched. The sitemap doesn’t evaluate other matched page
types.
[{
pageName: string;
status: MatchStatus;
startTime?: number;
endTime?: number;
_reject?: any;
}]
OnResetAnonymousId This event shows when
SalesforceInteractions.resetAnonymousId is
invoked.
OnSetAnonymousId OnSetAnonymousId This event shows anytime the Web SDK
assigns a new tracking identity to a customer.
OnShutDown This event is dispatched when the Web SDK receives the signal to
shut down.
Example:
document.addEventListener('salesforce:onEventSend', (customEvent) => {
console.log('On Event Send: ', customEvent.detail)
});
SalesforceInteractions.sendEvent({
interaction: {
name: 'integration_hook_test'
48
Connect Data API Reference
}
})
Debugging
When configured, the Salesforce Interaction SDK can output messages to the browser console for debugging purposes. By default, the
logger is configured with a log level of none. The logger used by the Web SDK wraps the standard browser console.log function
and can be accessed at SalesforceInteractions.log.
Logging Level
Logging levels can be set to control the amount of debug output.
Level Description
trace Used for finer-grained informational messages than debug. Value:
5
debug Used for informational messages at a fine-grained level useful for
debugging. Value: 4
info Used for informational messages at a course-grained level. Value:
3
warn Used for potential issues with the Web SDK that can affect
functionality. Value: 2
error Used for error events that can indicate the Web SDK isn’t
functioning properly. Value: 1
none Indicates disabling logging. Value: 0
The table orders the log levels from highest, trace, to lowest, none. A log level outputs any message at that same log level or lower.
Debugging Methods
getLoggingLevel(): LoggingLevel
Returns the numeric value of the current logging level used in the Web SDK.
SalesforceInteractions.getLoggingLevel()
// => 0
setLoggingLevel(level?: LoggingLevel | keyof typeof LoggingLevel): void
Set the logging level used in the Web SDK.
// using the logging level name
SalesforceInteractions.setLoggingLevel('error')
49
Connect Data Data Cloud Module of the Salesforce Interactions SDK
// using the logging level value
SalesforceInteractions.setLoggingLevel(1)
log.info(...args: any[]): void
Prints out a message at the info level.
SalesforceInteractions.log.info("hello!")
log.debug(...args: any[]): void
Prints out a message at the debug level.
SalesforceInteractions.log.debug("hello!")
log.error(...args: any[]): void
Prints out a message at the error level.
SalesforceInteractions.log.error("hello!")
log.trace(...args: any[]): void
Prints out a message at the trace level.
SalesforceInteractions.log.trace("hello!")
log.warn(...args: any[]): void
Prints out a message at the warn level.
SalesforceInteractions.log.warn("hello!")
Data Cloud Module of the Salesforce Interactions SDK
The Data Cloud Module of the Salesforce Interactions SDK is an extension that adds features to the SDK. You can convert the Event
Structure into a compatible format for ingestion by Data Cloud and authenticate and deliver events over HTTP to a Data Cloud Web
Connector.
The extension module is automatically included and configured with the instrumentation script provided when setting up a web
connector in Data Cloud. There are some important details to know:
• Translation of SDK Events to Web Connector Schemas on page 51
• Profile Event Routing on page 67
• Custom Events on page 70
Recommended Schema
To use the power of a unified data model across Salesforce, use this schema when configuring a Web Connector:
This schema contains mappings for:
• Engagement Events
– Cart Interaction Mapping
– Catalog Interaction Mapping
50
Connect Data Data Cloud Module of the Salesforce Interactions SDK
– Order Interaction Mapping
– Consent Event Mapping
• Profile Events
– Contact Point Email Mapping
– Contact Point Phone Mapping
– Identity Mapping
– Party Identification Mapping
Translation of SDK Events to Web Connector Schemas
Understanding how the Event Structure from the Salesforce Interactions SDK is converted into data that can be ingested into Data
Cloud can be useful for troubleshooting instrumentation code. Knowing this can extend your schema to capture extra data not
covered by the recommended schema.
Profile Event Routing
Profile Events described in a Web Connector Schema are mapped to individual data streams when deployed. To route profile data
collected in Salesforce Interactions SDK to the proper data stream, add the eventType field to any user.attributes data
captured.
Custom Events
Use the recommended Cart Interaction, Catalog Interaction, and Order Interaction data models provided by the Salesforce Interactions
SDK to use the unified data model across Salesforce. You can create and capture custom events in addition to the recommended
interaction data models.
SEE ALSO:
Translation of SDK Events to Web Connector Schemas
Translation of SDK Events to Web Connector Schemas
Understanding how the Event Structure from the Salesforce Interactions SDK is converted into data that can be ingested into Data Cloud
can be useful for troubleshooting instrumentation code. Knowing this can extend your schema to capture extra data not covered by
the recommended schema.
Automatic Population of Required Data Cloud Fields
The Data Cloud event beacon currently requires six mandatory fields to be present on all events.
Source Event Property Target Schema Developer Field Type Description
Name
- category text Required. Use to define if the
category is Engagement or
Profile.
- dateTime datetime Required. Supports
yyyy-MM-ddTHH:mm:ss.SSSZ
format only. Important for
engagement events since
51
Connect Data Data Cloud Module of the Salesforce Interactions SDK
Source Event Property Target Schema Developer Field Type Description
Name
they’re used for data
partitioning.
- deviceId text Required. The primary key for
profile events.
- eventId text Required. The primary key for
engagement events.
- eventType text Required. The developerName
of an event defined in the Web
Connector schema.
- sessionId text Required. An identifier for a
session.
The Data Cloud Module automatically sets these fields on events sent to Data Cloud. You don’t have to specify them except in certain
cases like Profile Event Routing or Custom Events when eventType can’t automatically be determined.
Automatic Population of Salesforce Web SDK Fields
The Salesforce Interactions SDK automatically captures several fields as part of its Event Structure on page 9. These fields are automatically
attached to all profile and engagement events.
Source Event Property Target Schema Developer Field Type Description
Name
interaction.name interactionName text Required. A descriptive name for
the interaction.
pageView pageView number The Salesforce Interactions SDK
assigns a value of either 1 (true)
or 0 (false). The value indicates
if an event was triggered as part
of a page load or from the user
interacting with the page.
source.channel sourceChannel text The SDK channel the event was
collected with. For the Salesforce
Interactions SDK, this value is
Web.
source.locale sourceLocale text The locale of the current page
as an ISO 639 alpha-2 language
code and ISO 3166 alpha-2
country code. For example,
en_US or de_DE.
52
Connect Data Data Cloud Module of the Salesforce Interactions SDK
Source Event Property Target Schema Developer Field Type Description
Name
source.pageType sourcePageType text When an event is collected via
the sitemap, this is the pageType
of the matching configuration
that triggered the event.
source.url sourceUrl text The URL of the page the event
is being sent from.
source.urlReferrer sourceUrlReferrer text The previous URL visited by the
user.
Cart Interaction Mapping
An Event Structure containing a Cart Interaction on page 11 is mapped to the following schema:
Source Event Property Target Schema Developer Field Type Description
Name
- category = "Engagement" text Required. Use to define if the
category is Engagement or
Profile.
- dateTime datetime Required. Supports
yyyy-MM-ddTHH:mm:ss.SSSZ
format only. Important for
engagement events since
they’re used for data
partitioning.
- deviceId text Required. The primary key for
profile events.
- eventId text Required. The primary key for
engagement events.
- eventType = "cart" text Required. The developerName
of an event defined in the Web
Connector schema.
- sessionId text Required. An identifier for a
session.
interaction.name interactionName text Required. A descriptive name for
the interaction.
pageView pageView number The Salesforce Interactions SDK
assigns a value of either 1 (true)
or 0 (false). The value indicates
if an event was triggered as part
53
Connect Data Data Cloud Module of the Salesforce Interactions SDK
Source Event Property Target Schema Developer Field Type Description
Name
of a page load or from the user
interacting with the page.
source.channel sessionId text The SDK channel the event was
collected with. For the Salesforce
Interactions SDK, this value is
Web.
source.locale sourceLocale text The locale of the current page
as an ISO 639 alpha-2 language
code and ISO 3166 alpha-2
country code. For example,
en_US or de_DE.
source.pageType sourcePageType text When an event is collected via
the sitemap, this is the pageType
of the matching configuration
that triggered the event.
source.url sourceUrl text The URL of the page the event
is being sent from.
source.urlReferrer sourceUrlReferrer text The previous URL visited by the
user.
Each Line Item Data on page 19contained in the Cart Interaction on page 11 fields interaction.lineItem or
interaction.lineItems gets mapped to a child event where cartEventId is set to the eventId of the parent cart
event:
Source Event Property Target Schema Developer Field Type Description
Name
- cartEventId text Required. The eventId of the
Cart Event containing this line
item.
- category = "Engagement" text Required. Use to define if the
category is Engagement or
Profile.
- dateTime datetime Required. Supports
yyyy-MM-ddTHH:mm:ss.SSSZ
format only. Important for
engagement events since
they’re used for data
partitioning.
- deviceId text Required. The primary key for
profile events.
54
Connect Data Data Cloud Module of the Salesforce Interactions SDK
Source Event Property Target Schema Developer Field Type Description
Name
- eventId text Required. The primary key for
engagement events.
- eventType = "cartItem" text Required. The developerName
of an event defined in the Web
Connector schema.
- sessionId text Required. An identifier for a
session.
lineItem.attributes.customFieldN attributeCustomFieldN any A user-supplied value.
lineItem.attributes.customField0 attributeCustomField0 any A user-supplied value.
lineItem.catalogObjectId catalogObjectId text Required. A unique identifier
representing the catalog object
referenced in the line item.
lineItem.catalogObjectType catalogObjectType text Required. A type name
representing the catalog object
referenced in the line item.
lineItem.currency currency text The currency for the price field.
lineItem.price price number The price of the catalog object
referenced in the line item.
lineItem.quantity quantity number The number of catalog objects
in this line item.
Note: Properties added to lineItem.attributes aren’t automatically defined in the recommended schema. To capture
this data, manually add these properties to the schema. These properties are shown here just to demonstrate how the source
properties are mapped to the target schema.
Catalog Interaction Mapping
An Event Structure on page 9 containing a Catalog Interaction on page 14 is mapped to the following schema:
Source Event Property Target Schema Developer Field Type Description
Name
- category = "Engagement" text Required. Use to define if the
category is Engagement or
Profile.
- dateTime datetime Required. Supports
yyyy-MM-ddTHH:mm:ss.SSSZ
format only. Important for
engagement events since
55
Connect Data Data Cloud Module of the Salesforce Interactions SDK
Source Event Property Target Schema Developer Field Type Description
Name
they’re used for data
partitioning.
- deviceId text Required. The primary key for
profile events.
- eventId text Required. The primary key for
engagement events.
- eventType = "catalog" text Required. The developerName
of an event defined in the Web
Connector schema.
- sessionId text Required. An identifier for a
session.
interaction.catalogObject.attributes.customFieldN attributeCustomFieldN any A user-supplied value.
interaction.catalogObject.attributes.customField0 attributeCustomField0 any A user-supplied value.
interaction.catalogObject.id id text Required. A unique id
representing the catalog object.
interaction.catalogObject.relatedCatalogObjects.Example relatedCatalogObjectExample0 any The first value in a list of related
catalog object ids.
interaction.catalogObject.type type text Required. A type name
representing the catalog object.
interaction.name interactionName text Required. A descriptive name for
the interaction.
pageView pageView number The Salesforce Interactions SDK
assigns a value of either 1 (true)
or 0 (false). The value indicates
if an event was triggered as part
of a page load or from the user
interacting with the page.
source.channel sessionId text The SDK channel the event was
collected with. For the Salesforce
Interactions SDK, this value is
Web.
source.locale sourceLocale text The locale of the current page
as an ISO 639 alpha-2 language
code and ISO 3166 alpha-2
country code. For example,
en_US or de_DE.
source.pageType sourcePageType text When an event is collected via
the sitemap, this is the pageType
56
Connect Data Data Cloud Module of the Salesforce Interactions SDK
Source Event Property Target Schema Developer Field Type Description
Name
of the matching configuration
that triggered the event.
source.url sourceUrl text The URL of the page the event
is being sent from.
source.urlReferrer sourceUrlReferrer text The previous URL visited by the
user.
... relatedCatalogObjectExampleN any The nth value in a list of related
catalog object ids.
Note: Properties added to interaction.catalogObject.attributes and
interaction.catalogObject.relatedCatalogObjects aren’t automatically defined in the recommended
schema. To capture this data, manually add these properties to the schema. These properties are shown here just to demonstrate
how the source properties are mapped to the target schema.
Order Interaction Mapping
An Event Structure on page 9 containing an Order Interaction on page 16 is mapped to the following schema:
Source Event Property Target Schema Developer Field Type Description
Name
- category = "Engagement" text Required. Use to define if the
category is Engagement or
Profile.
- dateTime datetime Required. Supports
yyyy-MM-ddTHH:mm:ss.SSSZ
format only. Important for
engagement events since
they’re used for data
partitioning.
- deviceId text Required. The primary key for
profile events.
- eventId text Required. The primary key for
engagement events.
- eventType = "order" text Required. The developerName
of an event defined in the Web
Connector schema.
- sessionId text Required. An identifier for a
session.
interaction.name interactionName text Required. A descriptive name for
the interaction.
57
Connect Data Data Cloud Module of the Salesforce Interactions SDK
Source Event Property Target Schema Developer Field Type Description
Name
interaction.order.currency orderCurrency text The currency of the total value
for the order.
interaction.order.attributes.customFieldN attributeCustomFieldN any A user-supplied value.
interaction.order.attributes.customField0 attributeCustomField0 any A user-supplied value.
interaction.order.id orderId text A unique identifier representing
the order.
interaction.order.totalValue orderTotalValue number The total value of the order.
pageView pageView number The Salesforce Interactions SDK
assigns a value of either 1 (true)
or 0 (false). The value indicates
if an event was triggered as part
of a page load or from the user
interacting with the page.
source.channel sessionId text The SDK channel the event was
collected with. For the Salesforce
Interactions SDK, this value is
Web.
source.locale sourceLocale text The locale of the current page
as an ISO 639 alpha-2 language
code and ISO 3166 alpha-2
country code. For example,
en_US or de_DE.
source.pageType sourcePageType text When an event is collected via
the sitemap, this is the pageType
of the matching configuration
that triggered the event.
source.url sourceUrl text The URL of the page the event
is being sent from.
source.urlReferrer sourceUrlReferrer text The previous URL visited by the
user.
Each Line Item Data on page 19 contained in the Order Interaction on page 16 field interaction.order.lineItems gets
mapped to a child event where orderEventId is set to the eventId of the parent order order event:
Source Event Property Target Schema Developer Field Type Description
Name
- category = "Engagement" text Required. Use to define if the
category is Engagement or
Profile.
58
Connect Data Data Cloud Module of the Salesforce Interactions SDK
Source Event Property Target Schema Developer Field Type Description
Name
- dateTime datetime Required. Supports
yyyy-MM-ddTHH:mm:ss.SSSZ
format only. Important for
engagement events since
they’re used for data
partitioning.
- eventId text Required. The primary key for
engagement events.
- eventType = "order" text Required. The developerName
of an event defined in the Web
Connector schema.
- deviceId text Required. The primary key for
profile events.
- orderEventId text Required. The eventId of the
Order Event containing this line
item.
- sessionId text Required. An identifier for a
session.
lineItem.attributes.customFieldN attributeCustomFieldN any A user-supplied value.
lineItem.attributes.customField0 attributeCustomField0 any A user-supplied value.
lineItem.catalogObjectId catalogObjectId text Required. A unique identifier
representing the catalog object
referenced in the line item.
lineItem.catalogObjectType catalogObjectType text Required. A type name
representing the catalog object
referenced in the line item.
lineItem.currency currency text The currency for the price field.
lineItem.price price number The price of the catalog object
referenced in the line item.
lineItem.quantity quantity number The number of catalog objects
in this line item.
Note: The properties added to lineItem.attributes aren’t automatically defined in the recommended schema. To
capture this data, manually add these properties to the schema.These properties are shown here just to demonstrate how the
source properties are mapped to the target schema.
Consent Event Mapping
Each Consent Data on page 24 contained in the Event Structure on page 9 consents field are mapped to the following schema:
59
Connect Data Data Cloud Module of the Salesforce Interactions SDK
Source Event Property Target Schema Developer Field Type Description
Name
- category = "Engagement" text Required. Use to define if the
category is Engagement or
Profile.
- dateTime datetime Required. Supports
yyyy-MM-ddTHH:mm:ss.SSSZ
format only. Important for
engagement events since
they’re used for data
partitioning.
- deviceId text Required. The primary key for
profile events.
- eventId text Required. The primary key for
engagement events.
- eventType = "consentLog" text Required. The developerName
of an event defined in the Web
Connector schema.
- sessionId text Required. An identifier for a
session.
consent.provider provider text Required. A named identifier
indicating the consent
management system providing
the consent to the SDK.
consent.purpose purpose text What the user is consenting to.
For example, tracking.
consent.status status text Values: Opt In or Opt Out
Profile Event Mapping
An Event Structure on page 9 containing a User Data on page 20 is mapped to the following schema:
Source Event Property Target Schema Developer Field Type Description
Name
- category = "Profile" text Required. Use to define if the
category is Engagement or
Profile.
- dateTime datetime Required. Supports
yyyy-MM-ddTHH:mm:ss.SSSZ
format only. Important for
engagement events since
60
Connect Data Data Cloud Module of the Salesforce Interactions SDK
Source Event Property Target Schema Developer Field Type Description
Name
they’re used for data
partitioning.
- deviceId text Required. The primary key for
profile events.
- eventId text Required. The primary key for
engagement events.
- sessionId text Required. An identifier for a
session.
interaction.name interactionName text Required. A descriptive name for
the interaction
pageView pageView text The Salesforce Interactions SDK
sets a true or false value. The
value indicates if an event was
triggered as part of a page load
or from the user interacting with
the page.
source.channel sessionId text The SDK channel the event was
collected with. For the Salesforce
Interactions SDK, this value is
Web.
source.locale sourceLocale text The locale of the current page
as an ISO 639 alpha-2 language
code and ISO 3166 alpha-2
country code. For example,
en_US or de_DE.
source.pageType sourcePageType text When an event is collected via
the sitemap, this is the pageType
of the matching configuration
that triggered the event.
source.url sourceUrl text The URL of the page the event
is being sent from.
source.urlReferrer sourceUrlReferrer text The previous URL visited by the
user.
user.attributes.customFieldN customFieldN any A user-supplied value.
user.attributes.customField0 customField0 any A user-supplied value.
user.attributes.eventType eventType text Required. The developerName
of an event defined in the Web
Connector schema.
61
Connect Data Data Cloud Module of the Salesforce Interactions SDK
Note: Properties added to the user.attributes.eventType field are required.
Contact Point Email Mapping
Source Event Property Target Schema Developer Field Type Description
Name
- dateTime datetime Required. Supports
yyyy-MM-ddTHH:mm:ss.SSSZ
format only. Important for
engagement events since
they’re used for data
partitioning.
- eventId text Required. The primary key for
engagement events.
user.attributes.eventType eventType = text Required. The developerName
"contactPointEmail" of an event defined in the Web
Connector schema.
- sessionId text Required. An identifier for a
session.
- deviceId text Required. The primary key for
profile events.
- category = "Profile" text Required. Use to define if the
category is Engagement or
Profile.
interaction.name interactionName text Required. A descriptive name for
the interaction
pageView pageView number The Salesforce Interactions SDK
assigns a value of either 1 (true)
or 0 (false). The value indicates
if an event was triggered as part
of a page load or from the user
interacting with the page.
source.channel sessionId text The SDK channel the event was
collected with. For the Salesforce
Interactions SDK, this value is
Web.
source.locale sourceLocale text The locale of the current page
as an ISO 639 alpha-2 language
code and ISO 3166 alpha-2
country code. For example,
en_US or de_DE.
62
Connect Data Data Cloud Module of the Salesforce Interactions SDK
Source Event Property Target Schema Developer Field Type Description
Name
source.pageType sourcePageType text When an event is collected via
the sitemap, this is the pageType
of the matching configuration
that triggered the event.
source.url sourceUrl text The URL of the page the event
is being sent from.
source.urlReferrer sourceUrlReferrer text The previous URL visited by the
user.
user.attributes.email email text The email address of the user.
user.attributes.eventType eventType = text Required. The developerName
"contactPointEmail" of an event defined in the Web
Connector schema.
Contact Point Phone Mapping
Source Event Property Target Schema Developer Field Type Description
Name
- category = "Profile" text Required. Use to define if the
category is Engagement or
Profile.
- dateTime datetime Required. Supports
yyyy-MM-ddTHH:mm:ss.SSSZ
format only. Important for
engagement events since
they’re used for data
partitioning.
- deviceId text Required. The primary key for
profile events.
- eventId text Required. The primary key for
engagement events.
- sessionId text Required. An identifier for a
session.
interaction.name interactionName text Required. A descriptive name for
the interaction
pageView pageView number The Salesforce Interactions SDK
assigns a value of either 1 (true)
or 0 (false). The value indicates
if an event was triggered as part
63
Connect Data Data Cloud Module of the Salesforce Interactions SDK
Source Event Property Target Schema Developer Field Type Description
Name
of a page load or from the user
interacting with the page.
source.channel sessionId text The SDK channel the event was
collected with. For the Salesforce
Interactions SDK, this value is
Web.
source.locale sourceLocale text The locale of the current page
as an ISO 639 alpha-2 language
code and ISO 3166 alpha-2
country code. For example,
en_US or de_DE.
source.pageType sourcePageType text When an event is collected via
the sitemap, this is the pageType
of the matching configuration
that triggered the event.
source.url sourceUrl text The URL of the page the event
is being sent from.
source.urlReferrer sourceUrlReferrer text The previous URL visited by the
user.
user.attributes.eventType eventType = text Required. The developerName
"contactPointPhone" of an event defined in the Web
Connector schema.
user.attributes.phoneNumber phoneNumber text Required. The phone number for
the user.
Identity Mapping
Source Event Property Target Schema Developer Field Type Description
Name
- category = "Profile" text Required. Use to define if the
category is Engagement or
Profile.
- dateTime datetime Required. Supports
yyyy-MM-ddTHH:mm:ss.SSSZ
format only. Important for
engagement events since
they’re used for data
partitioning.
- deviceId text Required. The primary key for
profile events.
64
Connect Data Data Cloud Module of the Salesforce Interactions SDK
Source Event Property Target Schema Developer Field Type Description
Name
- eventId text Required. The primary key for
engagement events.
- sessionId text Required. An identifier for a
session.
interaction.name interactionName text Required. A descriptive name for
the interaction
pageView pageView number The Salesforce Interactions SDK
assigns a value of either 1 (true)
or 0 (false). The value indicates
if an event was triggered as part
of a page load or from the user
interacting with the page.
source.channel sessionId text The SDK channel the event was
collected with. For the Salesforce
Interactions SDK, this value is
Web.
source.locale sourceLocale text The locale of the current page
as an ISO 639 alpha-2 language
code and ISO 3166 alpha-2
country code. For example,
en_US or de_DE.
source.pageType sourcePageType text When an event is collected via
the sitemap, this is the pageType
of the matching configuration
that triggered the event.
source.url sourceUrl text The URL of the page the event
is being sent from.
source.urlReferrer sourceUrlReferrer text The previous URL visited by the
user.
user.attributes.eventType eventType = "identity" text Required. The developerName
of an event defined in the Web
Connector schema.
user.attributes.firstName firstName text Required. The user’s first name.
user.attributes.isAnonymous isAnonymous text Required. A value that indicates
whether this profile event
identifies a known user or an
anonymous user. For example,
a value of 0 to indicate an
anonymous user and 1 to
indicate a known user.
65
Connect Data Data Cloud Module of the Salesforce Interactions SDK
Source Event Property Target Schema Developer Field Type Description
Name
user.attributes.lastName lastName text Required. The user’s last name.
Party Identification Mapping
Source Event Property Target Schema Developer Field Type Description
Name
- category = "Profile" text Required. Use to define if the
category is Engagement or
Profile.
- dateTime datetime Required. Supports
yyyy-MM-ddTHH:mm:ss.SSSZ
format only. Important for
engagement events since
they’re used for data
partitioning.
- deviceId text Required. The primary key for
profile events.
- eventId text Required. The primary key for
engagement events.
- sessionId text Required. An identifier for a
session.
interaction.name interactionName text Required. A descriptive name for
the interaction
pageView pageView number The Salesforce Interactions SDK
assigns a value of either 1 (true)
or 0 (false). The value indicates
if an event was triggered as part
of a page load or from the user
interacting with the page.
source.channel sessionId text The SDK channel the event was
collected with. For the Salesforce
Interactions SDK, this value is
Web.
source.locale sourceLocale text The locale of the current page
as an ISO 639 alpha-2 language
code and ISO 3166 alpha-2
country code. For example,
en_US or de_DE.
source.pageType sourcePageType text When an event is collected via
the sitemap, this is the pageType
66
Connect Data Data Cloud Module of the Salesforce Interactions SDK
Source Event Property Target Schema Developer Field Type Description
Name
of the matching configuration
that triggered the event.
source.url sourceUrl text The URL of the page the event
is being sent from.
source.urlReferrer sourceUrlReferrer text The previous URL visited by the
user.
user.attributes.eventType eventType = text The developerName of an event
"partyIdentification" defined in the Web Connector
schema
user.attributes.IDNameWeb IDNameWeb text Required. The party
identification name.
user.attributes.IDType IDType text Required. The party
identification type.
user.attributes.userId userId text Required. The user identifier in
the party.
Profile Event Routing
Profile Events described in a Web Connector Schema are mapped to individual data streams when deployed. To route profile data
collected in Salesforce Interactions SDK to the proper data stream, add the eventType field to any user.attributes data
captured.
Match the value of eventType to developerName of a profile event specified in the Web Connector Schema. Any schema-required
fields listed for that profile event must be captured.
Example: For example, you receive this schema with contactPointEmail event.
{
"records": [
{
"developerName": "contactPointEmail",
"masterLabel": "Contact Point Email",
"category": "Profile",
"externalDataTranFields": [
{
"masterLabel": "eventId",
"dataType": "Text",
"developerName": "eventId",
"isDataRequired": true
},
{
"masterLabel": "category",
67
Connect Data Data Cloud Module of the Salesforce Interactions SDK
"dataType": "Text",
"developerName": "category",
"isDataRequired": true
},
{
"masterLabel": "dateTime",
"dataType": "DateTime",
"developerName": "dateTime",
"isDataRequired": true
},
{
"masterLabel": "deviceId",
"dataType": "Text",
"developerName": "deviceId",
"isDataRequired": true,
"primaryIndexOrder": 1
},
{
"masterLabel": "email",
"dataType": "Text",
"developerName": "email",
"isDataRequired": true
},
{
"masterLabel": "eventType",
"dataType": "Text",
"developerName": "eventType",
"isDataRequired": true
},
{
"masterLabel": "interactionName",
"dataType": "Text",
"developerName": "interactionName",
"isDataRequired": true
},
{
"masterLabel": "pageView",
"dataType": "Number",
"developerName": "pageView",
"isDataRequired": false
},
{
"masterLabel": "sessionId",
"dataType": "Text",
68
Connect Data Data Cloud Module of the Salesforce Interactions SDK
"developerName": "sessionId",
"isDataRequired": true
},
{
"masterLabel": "sourceChannel",
"dataType": "Text",
"developerName": "sourceChannel",
"isDataRequired": false
},
{
"masterLabel": "sourceLocale",
"dataType": "Text",
"developerName": "sourceLocale",
"isDataRequired": false
},
{
"masterLabel": "sourcePageType",
"dataType": "Text",
"developerName": "sourcePageType",
"isDataRequired": false
},
{
"masterLabel": "sourceUrl",
"dataType": "Text",
"developerName": "sourceUrl",
"isDataRequired": false
},
{
"masterLabel": "sourceUrlReferrer",
"dataType": "Text",
"developerName": "sourceUrlReferrer",
"isDataRequired": false
}
]
}
]
}
You would instrument the capture of the contactPointEmail profile event in Salesforce Interactions SDK.
SalesforceInteractions.sendEvent({
user: {
attributes: {
eventType: 'contactPointEmail',
email: '[email protected]'
}
69
Connect Data Data Cloud Module of the Salesforce Interactions SDK
}
})
SEE ALSO:
Translation of SDK Events to Web Connector Schemas
Data Collection
User Data
Custom Events
Use the recommended Cart Interaction, Catalog Interaction, and Order Interaction data models provided by the Salesforce Interactions
SDK to use the unified data model across Salesforce. You can create and capture custom events in addition to the recommended
interaction data models.
Define the shape of the custom event in the Web Connector schema. For example:
{
"records": [
{
"developerName": "myCustomEvent",
"masterLabel": "My Custom Event",
"category": "Engagement",
"externalDataTranFields": [
{
"masterLabel": "My Custom Field",
"dataType": "Text",
"developerName": "myCustomField",
"isDataRequired": true
},
{
"masterLabel": "My Custom Num Attribute",
"dataType": "Number",
"developerName": "attributesMyCustomNum",
"isDataRequired": true
},
{
"masterLabel": "My Custom Text Attribute",
"dataType": "Text",
"developerName": "attributesMyCustomText",
"isDataRequired": true
},
{
"masterLabel": "eventId",
"dataType": "Text",
"developerName": "eventId",
"isDataRequired": true,
"primaryIndexOrder": 1
},
{
"masterLabel": "category",
"dataType": "Text",
"developerName": "category",
70
Connect Data Data Cloud Module of the Salesforce Interactions SDK
"isDataRequired": true
},
{
"masterLabel": "dateTime",
"dataType": "DateTime",
"developerName": "dateTime",
"isDataRequired": true
},
{
"masterLabel": "deviceId",
"dataType": "Text",
"developerName": "deviceId",
"isDataRequired": true
},
{
"masterLabel": "eventType",
"dataType": "Text",
"developerName": "eventType",
"isDataRequired": true
},
{
"masterLabel": "sessionId",
"dataType": "Text",
"developerName": "sessionId",
"isDataRequired": true
}
]
}
]
}
Then, in Salesforce Interactions SDK, specify the eventType or name field, and required fields that aren’t set via Automatic Population
of Required Fields to capture this event.
SalesforceInteractions.sendEvent({
interaction: {
name: 'myCustomEvent',
eventType: 'myCustomEvent',
myCustomField: 'some value'
attributes: {
myCustomNum: 1234,
myCustomText: "abcd"
}
})
This drives the SDK to emit an event such as this to Data Cloud:
{
"events": [{
"eventType": "myCustomEvent",
"myCustomField": "some value",
"attributesMyCustomNum": 1234,
"attributesMyCustomText": "abcd",
"eventId": "100d237b-e464-44df-9556-7481bbf52685",
"dateTime": "2022-10-18T18:25:26.680Z",
71
Connect Data Integrate Your Mobile Applications
"sessionId": "6b6c33bfcfee93f4",
"deviceId": "6b6c33bfcfee93f4",
"interactionName": "myCustomEvent",
"sourceUrl": "https://{my site}",
"sourceUrlReferrer": "https://{my site}",
"sourceChannel": "Web",
"sourcePageType": "test",
"category": "Engagement"
}]
}
Note: If eventType isn’t provided but name is, then eventType defaults to the value of name.
Integrate Your Mobile Applications
Data Cloud Module for the Engagement Mobile SDK makes it possible for you to integrate your mobile applications with Data Cloud.
This integration allows you to capture rich behavioral and demographic data from customers, and app lifecycle and screen navigation
events. Events collected by Data Cloud create a unified profile of a customer to enable hyper-personalized engagement across multiple
clouds, including Marketing, Commerce, and Service.
Prerequisites
To use the Data Cloud Module, create a Salesforce data source connector and copy your tenant-specific endpoint. Log in to Data Cloud
and navigate to Websites and Mobile Apps. Set up your data sources by creating an app connector.
The appSourceId and tenant-specific endpoint from your web data connector is required for the initialization of the Data Cloud Module.
Install the SDK
iOS
Use Swift Package Manager to install and manage the Data Cloud Module for the Engagement Mobile SDK.
• In Xcode, with your app project open, navigate to File > Add Packages.
• Enter the package URL for the Engagement Mobile SDK repository.
https://github.com/salesforce-marketingcloud/sfmc-sdk-ios
• Select the SDK version that you want to use. The latest version is recommended.
• Enter the package URL for the Data Cloud Module for the Engagement Mobile SDK repository:
https://github.com/salesforce-marketingcloud/mobile-sdk-cdp-ios
• Select the SDK version that you want to use. The latest version is recommended.
XCode resolves and downloads the dependencies in the background.
Android
• Update the module-level build.gradle file.
repositories {
maven {
72
Connect Data API Reference
url "https://salesforce-marketingcloud.github.io/MarketingCloudSDK-Android/repository"
}
maven {
url "https://salesforce-marketingcloud.github.io/mobile-sdk-cdp-android/repository"
}
}
• Add the SDK dependency.
dependencies {
implementation 'com.salesforce.marketingcloud:cdp:2.0.2'
implementation 'com.salesforce.marketingcloud:sfmcsdk:1.0.2'
}
Download the SDK
Download the binaries for the Data Cloud Module:
• Android
• iOS
Additional Resources
API Reference
This section provides guidance around references provided with the Engagement Mobile SDK.
Event Specifications
Event specifications for the Engagement Mobile SDK.
Schema Mappings
A schema is a collection of event definitions. Use these standard schema mappings for ecommerce use cases and review the
descriptions of each event definition.
API Reference
This section provides guidance around references provided with the Engagement Mobile SDK.
Initialization
Before the Data Cloud Module for the Engagement Mobile SDK can be used to invoke web services using the API, the SDK must be
configured. Use the CdpConfigBuilder for iOS or CdpConfig.Builder for Android helper class to build your SDK
configuration by providing required settings appId and endpoint that can be obtained from your Mobile Connector. Optionally,
configuration can be provided for the settings trackScreens, trackLifecycle, and sessionTimeoutInSeconds.
Capturing Engagement Data
The Data Cloud Module for the Engagement Mobile SDK enables collection of granular data about the customer’s mobile app
interactions through event tracking.
73
Connect Data API Reference
Capturing Profile Data
The Data Cloud Module for the Engagement Mobile SDK enables collection of profile data through the SDK’s Identity APIs.
Capturing Behavior Data
The Data Cloud Module for the Engagement Mobile SDK enables the collection of granular data about a customer’s mobile app
interactions through event tracking.
Consent Management
Engagement Mobile SDK offers a managed solution for allowing and restricting collection of event data. Your mobile application is
responsible for presenting the device owner with the choice to opt in or opt out of data collection and for setting the Data Cloud
Module consent property accordingly.
Location Tracking
The Data Cloud Module for the Engagement Mobile SDK supports location tracking for all events. Enable this functionality using the
setLocation method on the Data Cloud Module to set coordinates and expiresIn.
Logging and Debugging
Logging is optional, yet critical, SDK feature that allows the mobile application developer to select the verbosity of the Data Cloud
Module for the Engagement Mobile SDK’s output. By default, logging is disabled and must be enabled using the setLogger for
iOS or setLogging for Android method on the SFMCSdk instance. Define the desired logging level and output destination.
Enabling logging results in log capture using the native unified logging system.
Initialization
Before the Data Cloud Module for the Engagement Mobile SDK can be used to invoke web services using the API, the SDK must be
configured. Use the CdpConfigBuilder for iOS or CdpConfig.Builder for Android helper class to build your SDK configuration
by providing required settings appId and endpoint that can be obtained from your Mobile Connector. Optionally, configuration can be
provided for the settings trackScreens, trackLifecycle, and sessionTimeoutInSeconds.
Setting Field Type Description
appId string Required. The appId setting uniquely
identifies your mobile application to Data
Cloud and must be in a valid universally
unique identifier, UUID, format. An invalid
appID results in an error.
endpoint string Required. The endpoint setting tells the
SDK where to send the events being created
and tracked.
sessionTimeoutInSeconds integer The sessionTimeoutInSeconds
setting represents the number of seconds
the mobile application can remain in the
background before the current session is
expired. When a customer launches the
mobile application, the SDK starts a new
session that is maintained while the app is
in the foreground. If the customer sends the
mobile application to the background, the
SDK starts a timer to expire the current
session. If the customer brings the mobile
74
Connect Data API Reference
Setting Field Type Description
app back to the foreground before the
session expiration, the timer is cleared and
the session is continued. Otherwise the
session expires. This field is set to 600 by
default.
trackLifecycle boolean Enable trackLifecycle to
automatically track AppForegrounded,
AppBackgrounded, and
AppVersionChanged behavior events.
This field is set to false by default.
trackScreens boolean Enable trackScreens to automatically
track the mobile app ScreenEntry behavior
event. This field is set to false by default.
Set Up the Data Cloud Module
1. (Optional) To capture debug information and track SDK initialization progress, set up logging before initializing the SDK. For iOS, use
the setLogger method. For Android, use the setLogging method. For more information and example usage, see Logging
and Debugging on page 84.
2. Configure the Data Cloud Module.
3. Initialize the Engagement Mobile SDK with the Data Cloud Module.
Configuration happens during the initialization routine of the Mobile application being instrumented.
iOS Example
import Cdp
import SFMCSDK
...
let appId = "{appIdFromMobileConnector}"
let endpoint = "https://{endpointFromMobileConnector}"
// 1. (Optional) Enable logging. In this example, the logger is set to show debug messages
and higher.
SFMCSdk.setLogger(LogLevel.debug)
// 2. Configure the Data Cloud module
let cdpModuleConfig = CdpConfigBuilder(appId: appId, endpoint: endpoint)
.trackScreens(false)
.trackLifecycle(false)
.sessionTimeout(600)
.build()
75
Connect Data API Reference
// 3. Initialize the Engagement Mobile SDK
SFMCSdk.initializeSdk(ConfigBuilder().setCdp(config: cdpModuleConfig).build())
Android Example
import com.salesforce.marketingcloud.cdp.CdpConfig
import com.salesforce.marketingcloud.sfmcsdk.SFMCSdk
import com.salesforce.marketingcloud.sfmcsdk.SFMCSdkModuleConfig
// Optional, import SDK components needed to enable logging
import com.salesforce.marketingcloud.sfmcsdk.components.logging.LogLevel
import com.salesforce.marketingcloud.sfmcsdk.components.logging.LogListener.AndroidLogger
...
val appId = "{appIdFromMobileConnector}"
val endpoint = "https://{endpointFromMobileConnector}"
// 1. (Optional) Enable logging. In this example, the logger is set to show debug messages
and higher.
SFMCSdk.setLogging(LogLevel.DEBUG, AndroidLogger())
// 2. Configure the Data Cloud module
val cdpModuleConfig = CdpConfig.Builder(this, appId, endpoint)
.trackScreens(false)
.trackLifecycle(false)
.sessionTimeout(600)
.build()
// 3. Initialize the Engagement Mobile SDK
SFMCSdk.configure(this, SFMCSdkModuleConfig.build {
this.cdpModuleConfig = cdpModuleConfig
})
Capturing Engagement Data
The Data Cloud Module for the Engagement Mobile SDK enables collection of granular data about the customer’s mobile app interactions
through event tracking.
Before engagement data can be sent to Data Cloud:
1. The Data Cloud Module for the Engagement Mobile SDK must be configured and initialized. on page 74
2. Consent on page 82 to track must be granted.
The Engagement Mobile SDK comes with support for creating both structured and unstructured events:
• Structured
– Cart Event
76
Connect Data API Reference
– Catalog Event
– Order Event
• Unstructured
– Custom Event
Structured events have strict requirements on the types of information that can be provided. They also come pre-defined with the
suggested Mobile Connector schema for Data Cloud and can also be extended to capture extra data.
Unstructured events have no requirement on the information that can be provided. Custom event definitions must be created and
added to the Mobile Connector schema to be ingested in Data Cloud.
Both event types are collected by calling the SFMCSdk.track(event) function.
iOS Example
import SFMCSDK
import Cdp
...
// collecting the structured AddToCartEvent
SFMCSdk.track(AddToCartEvent(
lineItem: LineItem(
catalogObjectType: "Product",
catalogObjectId: "product-1",
quantity: 1,
price: 20.0,
currency: "USD",
// attributes can contain any custom field data
// as long as the schema is modified to define them
attributes: [
"gift_wrap": false
]
)
))
// collecting an unstructured CustomEvent
SFMCSdk.track(CustomEvent(
name: "CartAbandonment",
attributes: [
"sku": "COFFEE-NTR-06",
"price": 19.99
]
))
Android Example
import com.salesforce.marketingcloud.sfmcsdk.components.events.CartEvent
import com.salesforce.marketingcloud.sfmcsdk.components.events.EventManager
import com.salesforce.marketingcloud.sfmcsdk.SFMCSdk
...
77
Connect Data API Reference
// collecting the structured AddToCartEvent
SFMCSdk.track(CartEvent.add(
lineItem = LineItem(
catalogObjectId = "product-1",
catalogObjectType = "Product",
quantity = 1,
price = 20.0,
currency = "USD",
// attributes can contain any custom field data
// as long as the schema is modified to define them
attributes = mapOf(
"gift_wrap" to false
)
)
))
// collecting an unstructured CustomEvent
SFMCSdk.track(EventManager.customEvent(
"CartAbandonment",
mapOf(
"sku" to "COFFEE-NTR-06",
"price" to 19.99
)
))
Capturing Profile Data
The Data Cloud Module for the Engagement Mobile SDK enables collection of profile data through the SDK’s Identity APIs.
Before profile data can be sent to Data Cloud:
1. The Data Cloud Module for the Engagement Mobile SDK must be configured and initialized. on page 74
2. Consent on page 82 to track must be granted.
Setting Profile Attributes
iOS
import Cdp
import SFMCSDK
...
let profileAttributes = [
"email": "[email protected]",
"username": "user01"
]
SFMCSdk.identity.setProfileAttributes([.cdp: profileAttributes])
Android
import com.salesforce.marketingcloud.sfmcsdk.SFMCSdk
import com.salesforce.marketingcloud.sfmcsdk.modules.ModuleIdentifier.CDP
78
Connect Data API Reference
...
val profileAttributes = mapOf(
"email" to "[email protected]",
"username" to "user01"
)
SFMCSdk.requestSdk { sdk ->
sdk.identity.setProfileAttributes(profileAttributes, CDP)
}
When a profile attribute changes, the Data Cloud Module triggers an identity profile event containing all the attributes that have
been set. These attributes can be set to any name and value pair.
Supported Customer 360 Data Model
The Identity Schema provided by the recommended Mobile Connector schema for Data Cloud contains profile attributes that support
identity resolution features in Data Cloud when mapped to the appropriate Customer 360 Data Model.
Each identity event contains fields that can be mapped.
• Individual
– firstName
– lastName
• Software Application
– registrationId
– softwareApplicationName
• Device
– advertiserId
– deviceType
– osName
• Contact Point App
– registrationId
Device advertiserId
Starting with Android 13 (API level 33), permission is required to request the device’s advertiserId. In Data Cloud 2.0.2, this permission is
included by default. To prevent this permission from getting merged into your app, add this element to your AndroidManifest.xml:
<uses-permission android:name="com.google.android.gms.permission.AD_ID" tools:node="remove"/>
Contact Points
Each supported contact point has a set of required attributes that must be provided to the SDK’s Identity API. After all attributes have
been provided, the Data Cloud Module triggers a profile event contacting points along with an identity event. The contact points and
required attributes that trigger them are:
• Contact Point Email Schema
– email
• Contact Point Phone Schema
79
Connect Data API Reference
– phoneNumber
• Contact Point Address Schema
– addressLine1
– city
– postalCode
– stateProvince
– country
Anonymous and Known Users
In the Data Cloud Module, all customers are considered known by default. To mark a customer as anonymous, set the isAnonymous
profile attribute to “1”. Conversely, setting isAnonymous to “0” ensures that customers are considered known.
iOS
import Cdp
import SFMCSDK
...
// treat a profile as anonymous
SFMCSdk.identity.setProfileAttributes([.cdp: ["isAnonymous": “1”]])
// or use this convenience function
CdpModule.shared.setProfileToAnonymous()
// treat a profile as known
SFMCSdk.identity.setProfileAttributes([.cdp: ["isAnonymous": “0”]])
// or use this convenience function
CdpModule.shared.setProfileToKnown()
Android
// treat a profile as anonymous
SFMCSdk.requestSdk { sdk ->
sdk.identity.setProfileAttribute("isAnonymous", “1”, CDP)
}
// treat a profile as known
SFMCSdk.requestSdk { sdk ->
sdk.identity.setProfileAttribute("isAnonymous", “0”, CDP)
}
Shared Party Identifiers
The Engagement Mobile SDK also supports sharing identifiers between modules that support other Salesforce systems for integration
use cases. For example, match an individual using a mobile application that has Data Cloud and the MobilePush modules to send a push
notification to a specific anonymous mobile user.
Anonymous MobilePush User
The identity event contains fields that can be mapped to the Party Identification model.
• registrationId — Identification Number
80
Connect Data API Reference
Known MobilePush User
When the MobilePush module obtains a resolved identity for a mobile customer, it sets a profileId using the SDK’s Identity API.
The Data Cloud Module is notified of this change and sends a partyIdentification event with these fields.
• userId — Identification Number
• IDName — Party Identification Name
• IDType — Party Identification Type
Capturing Behavior Data
The Data Cloud Module for the Engagement Mobile SDK enables the collection of granular data about a customer’s mobile app interactions
through event tracking.
Before behavior data can be sent to Data Cloud:
• The Data Cloud Module for the Engagement Mobile SDK must be configured and initialized on page 74.
– To enable Lifecycle Events, set trackLifecycle to true.
– To enable Screen Events, set trackScreens to true.
• Consent on page 82 to track must be granted.
Behavioral lifecycle and screen events are disabled by default in the Data Cloud Module.
Each of the behaviors generates an engagement event with eventType="appEvents" and fields relevant to the behavior
populated.
Lifecycle Events
Lifecycle behaviors are triggered when a mobile application transitions to the foreground or background on a mobile device, or when
the mobile application is updated.
On Application Foregrounded
For example, when the mobile application is foregrounded, an event is generated.
{
"behaviorType": "AppLaunch",
"appName": "MyAppName",
"appVersion": "1.0.0",
"eventType": "appEvents",
"category": "Engagement",
// + all automatically assigned fields like deviceId, sessionId, dateTime, etc.
}
The first time the application launches, behaviorType="AppFirstLaunch" is set.
On Application Backgrounded
For example, when the mobile application is backgrounded an event is generated.
{
"behaviorType": "AppBackgrounded",
"appName": "MyAppName",
"appVersion": "1.0.0",
"eventType": "appEvents",
"category": "Engagement",
81
Connect Data API Reference
// + all automatically assigned fields like deviceId, sessionId, dateTime, etc.
}
On Application Version Changed
For example, when the mobile application is updated, an event is generated.
{
"behaviorType": "AppUpdate",
"previousAppVersion": "1.0.0",
"appName": "MyAppName",
"appVersion": "1.2.3",
"eventType": "appEvents",
"category": "Engagement",
// + all automatically assigned fields like deviceId, sessionId, dateTime, etc.
}
Screen Events
On-Screen View
For example, when a customer is navigating through Activity views in an Android application, or as UIViewControllers are added to a
view hierarchy in iOS, an event is generated.
{
"behaviorType": "ScreenView",
"screenName": "MyScreenName",
"appName": "MyAppName",
"appVersion": "1.0.0",
"eventType": "appEvents",
"category": "Engagement",
// + all automatically assigned fields like deviceId, sessionId, dateTime, etc.
}
Send Behavior Data
After you’ve configured the Data Cloud Module and enabled the desired behavioral events, the SDK automatically sends those events
to Data Cloud as they occur in your app. You don't need to manually send these events.
Consent Management
Engagement Mobile SDK offers a managed solution for allowing and restricting collection of event data. Your mobile application is
responsible for presenting the device owner with the choice to opt in or opt out of data collection and for setting the Data Cloud Module
consent property accordingly.
Consent States
This table describes the Data Cloud Module consent states.
iOS Values Android Values Description
Consent.optIn Consent.OPT_IN In this state, events are transmitted to the
configured Data Cloud endpoint for
82
Connect Data API Reference
iOS Values Android Values Description
collection. If queued events are present, the
Data Cloud Module transmits them
immediately to Data Cloud.
Consent.optOut Consent.OPT_OUT In this state, events created by the mobile
application are ignored by the SDK. The
events are never queued or transmitted off
the device. If queued events are present, the
Data Cloud Module deletes them from
memory.
Consent.pending Consent.PENDING The default consent value for a newly
initialized Data Cloud Module is pending. In
this state, events are collected locally until
an opt-in or opt-out state is set.
Granting or Revoking Consent
The Data Cloud Module can’t transmit events from a mobile device to Data Cloud until the mobile application has collected customer
consent for data collection.
If no prior consent has been set, then the initial state is pending. In this state, events are queued locally until consent is granted or
revoked. If consent is granted, the queued events are transmitted to Data Cloud. If revoked, they’re deleted from the queue.
iOS
import Cdp
...
// when a user consents to data collection
CdpModule.shared.setConsent(consent: Consent.optIn)
// when a user does not consent to data collection
CdpModule.shared.setContent(consent: Consent.optOut)
Android
import com.salesforce.marketingcloud.cdp.CdpSdk
import com.salesforce.marketingcloud.cdp.consent.Consent.OPT_IN
import com.salesforce.marketingcloud.cdp.consent.Consent.OPT_OUT
...
// when a user consents to data collection
CdpSdk.requestSdk { sdk -> sdk.consent = OPT_IN }
// when a user does not consent to data collection
CdpSdk.requestSdk { sdk -> sdk.consent = OPT_OUT }
83
Connect Data API Reference
Reading Consent State
Access the current state of consent in the Data Cloud Module:
iOS
let consent = CdpModule.shared.getConsent()
Android
CdpSdk.requestSdk { sdk ->
let consent = sdk.consent
}
Location Tracking
The Data Cloud Module for the Engagement Mobile SDK supports location tracking for all events. Enable this functionality using the
setLocation method on the Data Cloud Module to set coordinates and expiresIn.
iOS
// prepare the coordinates, use the CdpCoordinates wrapper
let coordinates = CdpCoordinates(latitude: 54.187738, longitude: 15.554440)
// set the location coordinates and expiration time in seconds
CdpModule.shared.setLocation(coordinates: coordinates, expiresIn: 60)
Android
CdpSdk.requestSdk { sdk >
// prepare the coordinates, use the Coordinates wrapper
val coordinates = Coordinates(latitude = 54.187738, longitude = 15.554440)
// set the location coordinates and expiration time in seconds
sdk.setLocation(coordinates = coordinates, expiresIn = 60)
}
Given that the SDK has non-expired location coordinates, the location attributes are automatically appended to the event attributes key
value pairs with key names latitude and longitude.
When the expiration interval has been exceeded, the SDK location coordinates are cleared and longer attached to events. To prevent
location from being attached to events before the coordinates expire, call setLocation and pass nil values as the coordinates.
Note: You’re responsible for handling location tracking permission from the customer, requesting location permission, fetching
the location, and ensuring the desired accuracy range.
Logging and Debugging
Logging is optional, yet critical, SDK feature that allows the mobile application developer to select the verbosity of the Data Cloud Module
for the Engagement Mobile SDK’s output. By default, logging is disabled and must be enabled using the setLogger for iOS or
setLogging for Android method on the SFMCSdk instance. Define the desired logging level and output destination. Enabling logging
results in log capture using the native unified logging system.
84
Connect Data API Reference
Log Levels
Log Level Description
Error This log level provides details about unrecoverable errors associated
with inability to complete valuable business use cases.
Warn This log level indicates the SDK integration has a problem or it
encountered an unusual situation. Warnings are associated with
potentially harmful, but recoverable errors.
Debug This log level provides granular, low-level information about how
the SDK processes tasks, events, and error details. Debug logging
enables developers to perform diagnostics on their application to
troubleshoot issues.
Logging Example
iOS
import SFMCSDK
...
// set the logger to show debug messages and higher
SFMCSdk.setLogger(LogLevel.debug)
// example usage
let CATEGORY = LoggerCategory.module
SFMCSdkLogger.shared.d(category: CATEGORY, message: "Logs a debug message.")
SFMCSdkLogger.shared.w(category: CATEGORY, message: "Logs a warning message.")
SFMCSdkLogger.shared.e(category: CATEGORY, message: "Logs an error message.")
Android
import com.salesforce.marketingcloud.sfmcsdk.SFMCSdk
import com.salesforce.marketingcloud.sfmcsdk.components.logging.LogLevel
import com.salesforce.marketingcloud.sfmcsdk.components.logging.LogListener.AndroidLogger
...
// set the logger to show debug messages and higher
SFMCSdk.setLogging(LogLevel.DEBUG, AndroidLogger())
// example usage
val TAG = "Example Application"
val ERROR = IllegalStateException("Example Failure")
SFMCSdkLogger.d(TAG) { "Logs a debug message." }
SFMCSdkLogger.d(TAG, ERROR) { "Logs a debug message along with the error." }
85
Connect Data Event Specifications
SFMCSdkLogger.w(TAG) { "Logs a warning message." }
SFMCSdkLogger.w(TAG, ERROR) { "Logs a warning message along with the error." }
SFMCSdkLogger.e(TAG) { "Logs an error message." }
SFMCSdkLogger.e(TAG, ERROR) { "Logs an error message along with the error." }
SDK State Example
The state property on the Data Cloud Module returns operational information containing current configuration settings, session
details, event queue size, and consent state. This information is critical for debugging and troubleshooting purposes.
iOS
SFMCSdk.state()
Android
SFMCSdk.requestSdk { sdk -> sdk.getSdkState() }
SDK State is a tool to assist development and troubleshooting. Always inspect the SDK state when debugging to confirm expected
configuration.
Example Engagement Mobile SDK State:
{
"modules": {
"cdp": {
"compatibility": "1.9.0 - 2.9.9",
"name": "cdp",
"pendingOperations": "0",
"properties": {
"appId": "YOUR_APP_ID
",
"consent": "opt_in",
"endpoint": "YOUR_ENDPOINT",
"version": "2.0.1"
},
"status": "operational",
"version": "2.0.1"
},
"push": {
"compatibility": "8.0.3 - 8.9.9",
"name": "push",
"pendingOperations": "undefined",
"status": "inactive",
"version": "unavailable"
}
},
"registrationId": "YOUR_APPLICATION_REGISTRATION_ID",
"version": "1.0.2"
}
Event Specifications
Event specifications for the Engagement Mobile SDK.
86
Connect Data Event Specifications
Cart Event
Use a cart event interaction to capture when a customer modifies the contents of their online shopping cart.
Catalog Event
Use a catalog event interaction to capture when a customer interacts with various tracking items. For example, a product or a blog
post.
Order Event
An order event interaction is an ecommerce event that captures actions performed by a customer to manage new, in progress, or
completed orders.
Custom Event
To capture user-defined attributes in the mobile SDK, define the source properties in a custom event. You can then map the fields
to a Custom Event Schema using the Mobile Schema naming conventions.
Line Item Attribute
Line items are intended to describe purchasable items and are used in cart and order interactions.
Order Attribute
An order attribute is contained within the event structure of Order Event and mapped in accordance with the order schema.
Cart Event
Use a cart event interaction to capture when a customer modifies the contents of their online shopping cart.
Field Name Field Type Description
lineItem Line Item Attribute on page 102 Required. A single line item attribute value.
Add To Cart Example
iOS
AddToCartEvent(
lineItem: LineItem(
catalogObjectType: "Product",
catalogObjectId: "product-1",
quantity: 1,
price: 20.0,
currency: "USD",
attributes: [
"gift_wrap": false
]
)
)
Android
CartEvent.add(
lineItem = LineItem(
catalogObjectId = "product-1",
catalogObjectType = "Product",
quantity = 1,
price = 20.0,
87
Connect Data Event Specifications
currency = "USD",
attributes = mapOf(
"gift_wrap" to false
)
)
)
Remove from Cart Example
Field Name Field Type Description
lineItem Line Item Attribute on page 102 Required. A single Line Item Attribute value.
iOS
RemoveFromCartEvent(
lineItem: LineItem(
catalogObjectType: "Product",
catalogObjectId: "product-1",
quantity: 1
)
)
Android
CartEvent.remove(
lineItem = LineItem(
catalogObjectId = "product-1",
catalogObjectType = "Product",
quantity = 1
)
)
Replace Cart Example
Field Name Field Type Description
lineItem Line Item Attribute on page 102 Required. A single Line Item Attribute value.
iOS
ReplaceCartEvent(
lineItems: [
LineItem(
catalogObjectType: "Product",
catalogObjectId: "product-1",
quantity: 1
),
LineItem(
catalogObjectType: "Product",
88
Connect Data Event Specifications
catalogObjectId: "product-2",
quantity: 1,
price: 20.0,
currency: "USD",
attributes: [
"gift_wrap": false
]
)
]
)
Android
CartEvent.replace(
lineItems = listOf(
LineItem(
catalogObjectType = "Product",
catalogObjectId = "product-1",
quantity = 1
),
LineItem(
catalogObjectType = "Product",
catalogObjectId = "product-2",
quantity = 1,
price = 20.0,
currency = "USD",
attributes = mapOf(
"gift_wrap" to false
)
)
)
)
Catalog Event
Use a catalog event interaction to capture when a customer interacts with various tracking items. For example, a product or a blog post.
Field Name Field Type Description
catalogObject.attributes object A dictionary of user-supplied values.
catalogObject.id string Required. A unique ID representing the
catalog object.
catalogObject.relatedCatalogObjects object A dictionary of related catalog objects.
catalogObject.type string Required. A type name representing the
catalog object.
89
Connect Data Event Specifications
View Catalog Event Example
iOS
ViewCatalogObjectEvent(
catalogObject: CatalogObject(
type: "Product",
id: "product-12",
attributes: [
"PROMO_CODE": "WINTER2022"
],
relatedCatalogObjects: [
"size": ["S", "M", "L"],
"sku": ["1234", "5678"]
]
)
)
Android
CatalogEvent.view(
CatalogObject(
id = "product-1",
type = "Product",
attributes = mapOf(
"PROMO_CODE" to "FALL2021"
),
relatedCatalogObjects = mapOf(
"product's size" to listOf("S", "M", "L"),
"product-sku" to listOf("1234", "5678")
)
)
)
Comment Catalog Event Example
iOS
CommentCatalogObjectEvent(
catalogObject: CatalogObject(
type: "Product",
id: "product-12",
attributes: [
"PROMO_CODE": "WINTER2022"
],
relatedCatalogObjects: [
"size": ["S", "M", "L"],
"sku": ["1234", "5678"]
]
)
)
Android
CatalogEvent.comment(
CatalogObject(
90
Connect Data Event Specifications
id = "product-1",
type = "Product",
attributes = mapOf(
"PROMO_CODE" to "FALL2021"
),
relatedCatalogObjects = mapOf(
"product's size" to listOf("S", "M", "L"),
"product-sku" to listOf("1234", "5678")
)
)
)
Favorite Catalog Event Example
iOS
FavoriteCatalogObjectEvent(
catalogObject: CatalogObject(
type: "Product",
id: "product-12",
attributes: [
"PROMO_CODE": "WINTER2022"
],
relatedCatalogObjects: [
"size": ["S", "M", "L"],
"sku": ["1234", "5678"]
]
)
)
Android
CatalogEvent.favorite(
CatalogObject(
id = "product-1",
type = "Product",
attributes = mapOf(
"PROMO_CODE" to "FALL2021"
),
relatedCatalogObjects = mapOf(
"product's size" to listOf("S", "M", "L"),
"product-sku" to listOf("1234", "5678")
)
)
)
Quick View Catalog Event Example
iOS
QuickViewCatalogObjectEvent(
catalogObject: CatalogObject(
type: "Product",
id: "product-12",
91
Connect Data Event Specifications
attributes: [
"PROMO_CODE": "WINTER2022"
],
relatedCatalogObjects: [
"size": ["S", "M", "L"],
"sku": ["1234", "5678"]
]
)
)
Android
CatalogEvent.quickView(
CatalogObject(
id = "product-1",
type = "Product",
attributes = mapOf(
"PROMO_CODE" to "FALL2021"
),
relatedCatalogObjects = mapOf(
"product's size" to listOf("S", "M", "L"),
"product-sku" to listOf("1234", "5678")
)
)
)
Review Catalog Event Example
iOS
ReviewCatalogObjectEvent(
catalogObject: CatalogObject(
type: "Product",
id: "product-12",
attributes: [
"PROMO_CODE": "WINTER2022"
],
relatedCatalogObjects: [
"size": ["S", "M", "L"],
"sku": ["1234", "5678"]
]
)
)
Android
CatalogEvent.review(
CatalogObject(
id = "product-1",
type = "Product",
attributes = mapOf(
"PROMO_CODE" to "FALL2021"
),
relatedCatalogObjects = mapOf(
"product's size" to listOf("S", "M", "L"),
92
Connect Data Event Specifications
"product-sku" to listOf("1234", "5678")
)
)
)
Share Catalog Event Example
iOS
ShareCatalogObjectEvent(
catalogObject: CatalogObject(
type: "Product",
id: "product-12",
attributes: [
"PROMO_CODE": "WINTER2022"
],
relatedCatalogObjects: [
"size": ["S", "M", "L"],
"sku": ["1234", "5678"]
]
)
)
Android
CatalogEvent.share(
CatalogObject(
id = "product-1",
type = "Product",
attributes = mapOf(
"PROMO_CODE" to "FALL2021"
),
relatedCatalogObjects = mapOf(
"product's size" to listOf("S", "M", "L"),
"product-sku" to listOf("1234", "5678")
)
)
)
View Detail Catalog Event Example
iOS
ViewCatalogObjectDetailEvent(
catalogObject: CatalogObject(
type: "Product",
id: "product-12",
attributes: [
"PROMO_CODE": "WINTER2022"
],
relatedCatalogObjects: [
"size": ["S", "M", "L"],
"sku": ["1234", "5678"]
]
93
Connect Data Event Specifications
)
)
Android
CatalogEvent.viewDetail(
CatalogObject(
id = "product-1",
type = "Product",
attributes = mapOf(
"PROMO_CODE" to "FALL2021"
),
relatedCatalogObjects = mapOf(
"product's size" to listOf("S", "M", "L"),
"product-sku" to listOf("1234", "5678")
)
)
)
Order Event
An order event interaction is an ecommerce event that captures actions performed by a customer to manage new, in progress, or
completed orders.
Purchase Order Example
Field Name Field Type Description
order Order Attribute on page 103 Required. A single order attribute value.
iOS
PurchaseOrderEvent(
order: Order(
id: "order-1",
totalValue: 9.99,
currency: "USD",
attributes: [
"PROMO_CODE": "HELLO"
],
lineItems: [
LineItem(
catalogObjectType: "Product",
catalogObjectId: "product-11",
quantity: 1,
price: 20,
currency: "USD",
attributes: [
"gift_wrap": true
]
)
]
94
Connect Data Event Specifications
)
)
Android
OrderEvent.purchase(
order = Order(
id = "order-1",
totalValue = 9.99,
currency = "USD",
attributes = mapOf(
"PROMO_CODE" to "HELLO"
),
lineItems = listOf(
LineItem(
catalogObjectId = "product-1",
catalogObjectType = "Product",
quantity = 1,
price = 20.0,
currency = "USD",
attributes = mapOf(
"gift_wrap" to true
)
)
)
)
)
Preorder Order Example
Field Name Field Type Description
order Order Attribute on page 103 Required. A single order attribute value.
iOS
PreOrderEvent(
order: Order(
id: "order-1",
totalValue: 9.99,
currency: "USD",
attributes: [
"PROMO_CODE": "HELLO"
],
lineItems: [
LineItem(
catalogObjectType: "Product",
catalogObjectId: "product-11",
quantity: 1,
price: 20,
currency: "USD",
attributes: [
"gift_wrap": true
95
Connect Data Event Specifications
]
)
]
)
)
Android
OrderEvent.preorder(
order = Order(
id = "order-1",
totalValue = 9.99,
currency = "USD",
attributes = mapOf(
"PROMO_CODE" to "HELLO"
),
lineItems = listOf(
LineItem(
catalogObjectId = "product-1",
catalogObjectType = "Product",
quantity = 1,
price = 20.0,
currency = "USD",
attributes = mapOf(
"gift_wrap" to true
)
)
)
)
)
Cancel Order Example
Field Name Field Type Description
order Order Attribute on page 103 Required. A single order attribute value.
iOS
CancelOrderEvent(
order: Order(
id: "order-1",
totalValue: 9.99,
currency: "USD",
attributes: [
"PROMO_CODE": "HELLO"
],
lineItems: [
LineItem(
catalogObjectType: "Product",
catalogObjectId: "product-11",
quantity: 1,
price: 20,
96
Connect Data Event Specifications
currency: "USD",
attributes: [
"gift_wrap": true
]
)
]
)
)
Android
OrderEvent.cancel(
order = Order(
id = "order-1",
totalValue = 9.99,
currency = "USD",
attributes = mapOf(
"PROMO_CODE" to "HELLO"
),
lineItems = listOf(
LineItem(
catalogObjectId = "product-1",
catalogObjectType = "Product",
quantity = 1,
price = 20.0,
currency = "USD",
attributes = mapOf(
"gift_wrap" to true
)
)
)
)
)
Ship Order Example
Field Name Field Type Description
order Order Attribute on page 103 Required. A single order attribute value.
iOS
ShipOrderEvent(
order: Order(
id: "order-1",
totalValue: 9.99,
currency: "USD",
attributes: [
"PROMO_CODE": "HELLO"
],
lineItems: [
LineItem(
catalogObjectType: "Product",
97
Connect Data Event Specifications
catalogObjectId: "product-11",
quantity: 1,
price: 20,
currency: "USD",
attributes: [
"gift_wrap": true
]
)
]
)
)
Android
OrderEvent.ship(
order = Order(
id = "order-1",
totalValue = 9.99,
currency = "USD",
attributes = mapOf(
"PROMO_CODE" to "HELLO"
),
lineItems = listOf(
LineItem(
catalogObjectId = "product-1",
catalogObjectType = "Product",
quantity = 1,
price = 20.0,
currency = "USD",
attributes = mapOf(
"gift_wrap" to true
)
)
)
)
)
Deliver Order Example
Field Name Field Type Description
order Order Attribute on page 103 Required. A single order attribute value.
iOS
DeliverOrderEvent(
order: Order(
id: "order-1",
totalValue: 9.99,
currency: "USD",
attributes: [
"PROMO_CODE": "HELLO"
],
98
Connect Data Event Specifications
lineItems: [
LineItem(
catalogObjectType: "Product",
catalogObjectId: "product-11",
quantity: 1,
price: 20,
currency: "USD",
attributes: [
"gift_wrap": true
]
)
]
)
)
Android
OrderEvent.deliver(
order = Order(
id = "order-1",
totalValue = 9.99,
currency = "USD",
attributes = mapOf(
"PROMO_CODE" to "HELLO"
),
lineItems = listOf(
LineItem(
catalogObjectId = "product-1",
catalogObjectType = "Product",
quantity = 1,
price = 20.0,
currency = "USD",
attributes = mapOf(
"gift_wrap" to true
)
)
)
)
)
Return Order Example
Field Name Field Type Description
order Order Attribute on page 103 Required. A single order attribute value.
iOS
ReturnOrderEvent(
order: Order(
id: "order-1",
totalValue: 9.99,
currency: "USD",
99
Connect Data Event Specifications
attributes: [
"PROMO_CODE": "HELLO"
],
lineItems: [
LineItem(
catalogObjectType: "Product",
catalogObjectId: "product-11",
quantity: 1,
price: 20,
currency: "USD",
attributes: [
"gift_wrap": true
]
)
]
)
)
Android
OrderEvent.returnOrder(
order = Order(
id = "order-1",
totalValue = 9.99,
currency = "USD",
attributes = mapOf(
"PROMO_CODE" to "HELLO"
),
lineItems = listOf(
LineItem(
catalogObjectId = "product-1",
catalogObjectType = "Product",
quantity = 1,
price = 20.0,
currency = "USD",
attributes = mapOf(
"gift_wrap" to true
)
)
)
)
)
Exchange Order Example
Field Name Field Type Description
order Order Attribute on page 103 Required. A single order attribute value.
iOS
ExchangeOrderEvent(
order: Order(
100
Connect Data Event Specifications
id: "order-1",
totalValue: 9.99,
currency: "USD",
attributes: [
"PROMO_CODE": "HELLO"
],
lineItems: [
LineItem(
catalogObjectType: "Product",
catalogObjectId: "product-11",
quantity: 1,
price: 20,
currency: "USD",
attributes: [
"gift_wrap": true
]
)
]
)
)
Android
OrderEvent.exchange(
order = Order(
id = "order-1",
totalValue = 9.99,
currency = "USD",
attributes = mapOf(
"PROMO_CODE" to "HELLO"
),
lineItems = listOf(
LineItem(
catalogObjectId = "product-1",
catalogObjectType = "Product",
quantity = 1,
price = 20.0,
currency = "USD",
attributes = mapOf(
"gift_wrap" to true
)
)
)
)
)
Custom Event
To capture user-defined attributes in the mobile SDK, define the source properties in a custom event. You can then map the fields to a
Custom Event Schema using the Mobile Schema naming conventions.
101
Connect Data Event Specifications
Custom Event Example
iOS
CustomEvent(
name: "Custom Event",
attributes: [
"giftWrap" : true,
"giftMessage" : "Happy Birthday",
"giftWrapOptions": [
"paperColor": "green",
"ribbon": false
]
]
)
Android
EventManager.customEvent(
name = "Custom Event",
attributes = mapOf(
"gift" to mapOf(
"message" to "Happy Birthday",
"wrap" to true,
"wrapOptions" to mapOf(
"paper-color" to "green",
"ribbon" to false
)
)
)
)
Line Item Attribute
Line items are intended to describe purchasable items and are used in cart and order interactions.
Field Name Field Type Description
attributes object A dictionary of user-supplied
values.
catalogObjectType string Required. A type name
representing the catalog object
referenced in the line item.
catalogObjectId string Required. A unique ID
representing the catalog object
referenced in the line item.
currency string The currency for the price field.
price number The price of the catalog object
referenced in the line item.
102
Connect Data Event Specifications
Field Name Field Type Description
quantity number Required. The number of catalog
objects in this line item.
Line Item Attribute Example
iOS
LineItem(
catalogObjectType: "Product",
catalogObjectId: "product-11",
quantity: 1,
price: 20.0,
currency: "USD",
attributes: [
"gift_wrap: true
]
)
Android
LineItem(
catalogObjectId = "product-1",
catalogObjectType = "Product",
quantity = 1,
price = 20.0,
currency = "USD",
attributes = mapOf(
"gift_wrap" to true
)
)
Order Attribute
An order attribute is contained within the event structure of Order Event and mapped in accordance with the order schema.
Field Name Description
name Field Type
string
Description
Required.
An event name described from the order event.
order.attributes Field Type
object
Description
A dictionary of user-supplied values.
103
Connect Data Event Specifications
Field Name Description
order.currency Field Type
string
Description
The currency of the order’s total value.
order.id Field Type
string
Description
Required.
A unique order ID.
order.lineItems Field Type
Line Item Attribute on page 102
Description
An array of line item attribute values.
order.totalValue Field Type
number
Description
Required.
The order’s total value.
Order Attribute Example
iOS
Order(
id: "order-1",
totalValue: 9.99,
currency: "USD",
attributes: [
"PROMO_CODE": "HELLO"
]
lineItems: [
LineItem(
catalogObjectType: "Product",
catalogObjectId: "product-1",
quantity: 1,
price: 20,
currency: "USD",
attributes: [
"gift_wrap": true,
"gift card": "Dearly Beloved"
]
),
104
Connect Data Schema Mappings
LineItem(
catalogObjectType: "Product",
catalogObjectId: "product-2",
quantity: 2,
price: 5,
currency: "USD",
attributes: [
"gift_wrap": false
]
)
]
)
Android
Order(
id = "order-1",
totalValue = 30.00,
currency = "USD",
attributes = mapOf(
"PROMO_CODE" to "HELLO"
),
lineItems = listOf(
LineItem(
catalogObjectId = "product-1",
catalogObjectType = "Product",
quantity = 1,
price = 20.00,
currency = "USD",
attributes = mapOf(
"gift_wrap" to true,
"gift card" to "Dearly Beloved"
)
),
LineItem(
catalogObjectId = "product-2",
catalogObjectType = "Product",
quantity = 2,
price = 5.00,
currency = "USD",
attributes = mapOf(
"gift_wrap" to false
)
)
)
)
Schema Mappings
A schema is a collection of event definitions. Use these standard schema mappings for ecommerce use cases and review the descriptions
of each event definition.
105
Connect Data Schema Mappings
Mobile Schema Support in Data Cloud
To use a unified data model across Salesforce, we recommended using the Mobile Connector Schema when configuring a Mobile
Connector.
Engagement
Descriptions for how the Data Cloud Module for Engagement Mobile SDK events map to each engagement event definition from
the recommended mobile schema.
Profile
Descriptions for how the Data Cloud Module for the Engagement Mobile SDK profile changes map to each profile event definition
in the recommended mobile schema within
Mobile Schema Support in Data Cloud
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:
• Engagement
– Cart Schema on page 108
– Catalog Schema on page 111
– Order Schema on page 113
– Custom Event Schema on page 115
– Consent Schema on page 118
– Behavior Schema on page 119
• Profile
– Contact Point Email Schema on page 121
– Contact Point Phone Schema on page 122
– Contact Point Address Schema on page 124
– Party Identification Schema on page 125
– Identity Schema on page 126
Translating SDK Events to Mobile Connector Schemas
Understanding how the events from the Engagement Mobile SDK are converted into data that can be ingested into Data Cloud can be
useful for troubleshooting instrumentation code and for extending your schema to capture extra data not covered by the Recommended
Schema.
The Data Cloud event beacon requires fields to be present on all events.
Source Event Property Target Schema Developer Field Type Description
Name
<Automatically Assigned> eventId text Required. Typically the primary
key for the engagement events.
106
Connect Data Schema Mappings
Source Event Property Target Schema Developer Field Type Description
Name
<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:
• Engagement
• Profile
The Data Cloud Module for the Engagement Mobile SDK automatically sets these fields on events sent to Data Cloud.
Automatic Population of the Data Cloud 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 on page 84.
Source Event Property Target Schema Developer Field Type Description
Name
<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.
107
Connect Data Schema Mappings
Schema Field Naming Rules
In order for events to be properly ingested, the data format used with a Data Cloud event beacon is a flattened JSON structure that
imposes certain limitations on how fields are named. The Data Cloud 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.
"giftWrapOptions": {
"paperColor": "green"
}
• 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".
Engagement
Descriptions for how the Data Cloud Module for Engagement Mobile SDK events map to each engagement event definition from the
recommended mobile schema.
Cart Schema
Map an Engagement Mobile SDK cart event to the cart schema.
Catalog Schema
Map an Engagement Mobile SDK catalog event to the catalog schema.
Order Schema
An order interaction is a commerce action that captures actions performed by a user to manage new, in progress, or completed
orders.
Custom Event Schema
Use the event data models provided by the Engagement Mobile SDK for cart event, catalog event, and order event to use the unified
data model across Salesforce. You can create and capture a custom event.
Consent Schema
Consent Management is used to either grant or revoke consent in the Engagement Mobile SDK. When a customer opts in to tracking,
the mobile application sends a consentLog event indicating the choice along with other events that got collected. When a
customer opts out, a consentLog event is sent containing their choice and no other events are sent to Data Cloud.
Behavior Schema
Behavior events are sent to Data Cloud as a customer navigates the application where the Data Cloud Module for the Engagement
Mobile SDK is running. Behavior events can include screen view, and application launch.
Cart Schema
Map an Engagement Mobile SDK cart event to the cart schema.
108
Connect Data Schema Mappings
Source Event Target Schema Field Type Description Customer 360 Data
Property Developer Name Model Object /
Attribute
<Automatically eventId text Required. Typically the Engagement /
Assigned> primary key for the Engagement Id
engagement events.
<Automatically dateTime datetime Required. Used for data Engagement /
Assigned> partitioning for Engagement Date Time
engagement events.
ISO8601 supported
format.
<Automatically eventType = "cart" text Required. The -
Assigned> developerName of an
event defined in the Web
Connector schema.
<Automatically sessionId text Required. The session -
Assigned> identifier.
<Automatically deviceId text Required. Typically the Shopping Cart
Assigned> primary key for profile Engagement / Individual
events.
<Automatically category = text Required. Possible values -
Assigned> "Engagement" are:
• Engagement
• Profile
<Automatically interactionName = "Add text Required. An event’s Shopping Cart
Assigned> To Cart" | "Remove From descriptive name. Engagement / Shopping
Cart" | "Replace Cart" Cart Event Type
<Automatically channel = "mobile" text The SDK event channel. Engagement /
Assigned> For Engagement Mobile Engagement Channel
SDK, the value is mobile. Type
<Automatically Assigned longitude number The longitudinal Device Longitude
when Location Tracking coordinate, in decimal
on page 84 is allowed> degrees, reported by the
device at the time the
event was captured.
<Automatically Assigned latitude number The latitudinal Device Latitude
when Location Tracking coordinate, in decimal
on page 84 is allowed> degrees, reported by the
device at the time the
event was captured.
109
Connect Data Schema Mappings
Each Line Item Attribute on page 102 contained in the Cart Event on page 87 is mapped to a child event where cartEventId is set
to the parent cart event’s eventId.
Source Event Target Schema Field Type Description Customer 360 Data
Property Developer Name Model Object /
Attribute
<Automatically eventId text Required. Typically the -
Assigned> primary key for the
engagement events.
<Automatically dateTime datetime Required. Used for data -
Assigned> partitioning for
engagement events.
ISO8601 supported
format.
<Automatically eventType = "cartItem" text Required. The -
Assigned> developerName of an
event defined in the Web
Connector schema.
<Automatically sessionId text Required. The session -
Assigned> identifier.
<Automatically deviceId text Required. Typically the -
Assigned> primary key for profile
events.
<Automatically category = text Required. Possible values -
Assigned> "Engagement" are:
• Engagement
• Profile
<Automatically cartEventId text Required. The eventId of Shopping Cart Product
Assigned> the cart event containing Engagement / Shopping
the line item. Cart Engagement
lineItem.catalogObjectType catalogObjectType text Required. A type name of Shopping Cart Product
the catalog object Engagement / Product
referenced in the line Category
item.
lineItem.catalogObjectId catalogObjectId text Required. A unique Shopping Cart Product
identifier representing Engagement / Product
the catalog object
referenced in the line
item.
lineItem.quantity quantity number The number of catalog Shopping Cart Product
objects in the line item. Engagement / Product
Quantity
110
Connect Data Schema Mappings
Source Event Target Schema Field Type Description Customer 360 Data
Property Developer Name Model Object /
Attribute
lineItem.price price number The price of the catalog Shopping Cart Product
object referenced in the Engagement / Product
line item. Price
lineItem.currency currency text The currency for the price Shopping Cart Product
field. Engagement / Currency
lineItem.attributes.customField0 attributeCustomField0 any A user-supplied value. -
lineItem.attributes.customFieldN attributeCustomFieldN any A user-supplied value. -
Note: Properties added to lineItem.attributes aren’t automatically defined in the recommended schema. They’re
shown to demonstrate how the source properties are mapped to the target schema. You must manually add the properties to
the schema.
Catalog Schema
Map an Engagement Mobile SDK catalog event to the catalog schema.
Source Event Target Schema Field Type Description CIM Object /
Property Developer Name Attribute
<Automatically eventId text Required. Typically the Product Browse
Assigned> primary key for the Engagement / Product
engagement events. Browse Engagement Id
<Automatically dateTime datetime Required. Used for data Product Browse
Assigned> partitioning for Engagement / Created
engagement events. Date, Last Modified Date,
ISO8601 supported Engagement Date Time
format.
<Automatically eventType = "catalog" text Required. The -
Assigned> developerName of an
event defined in the Web
Connector schema.
<Automatically sessionId text Required. An identifier for -
Assigned> a session.
<Automatically deviceId text Required. Typically the Product Browse
Assigned> primary key for profile Engagement / Individual
events.
<Automatically category = text Required. Possible values -
Assigned> "Engagement" are:
• Engagement
• Profile
111
Connect Data Schema Mappings
Source Event Target Schema Field Type Description CIM Object /
Property Developer Name Attribute
<Automatically interactionName: "View text Required. A descriptive Engagement /
Assigned> Catalog Object" | name for the event. Engagement Channel
"Comment Catalog Action
Object" | "View Catalog
Object Detail" | "Favorite
Catalog Object" | "Share
Catalog Object" | "Review
Catalog Object" | "Quick
View Catalog Object"
<Automatically channel = "mobile" text The SDK event channel. Engagement /
Assigned> For Engagement Mobile Engagement Channel
SDK the value is mobile. Type
catalogObject.type type text Required. A type name -
representing the catalog
object
catalogObject.id id text Required. A unique Product Browse
identifier representing Engagement / Product
the catalog object.
catalogObject.attributes.customField0 attributeCustomField0 any A user-supplied value. -
catalogObject.attributes.customFieldN attributeCustomFieldN any A user-supplied value. -
catalogObject.relatedCatalogObjects.Example relatedCatalogObjectExample0 any The first value in a list of -
related catalog object
identifiers.
- relatedCatalogObjectExampleN any The n-th value in a list of -
related catalog object
identifiers.
<Automatically Assigned longitude number The longitudinal Engagement / Device
if Location Tracking is coordinate in decimal Longitude
allowed> degrees reported by the
device at the time the
event was captured.
<Automatically Assigned latitude number The latitudinal coordinate Engagement / Device
if Location Tracking is in decimal degrees Latitude
allowed> reported by the device at
the time the event was
captured.
Note: Properties added to catalogObject.attributes and catalogObject.relatedCatalogObjects
aren’t automatically defined in the recommended schema. They’re shown to demonstrate how the source properties are mapped
to the target schema. Manually add the properties to the schema.
112
Connect Data Schema Mappings
Order Schema
An order interaction is a commerce action that captures actions performed by a user to manage new, in progress, or completed orders.
Source Event Target Schema Field Type Description Customer 360 Data
Property Developer Name Model Object /
Attribute
<Automatically eventId text Required. Typically the Engagement /
Assigned> primary key for the Engagement Id
engagement events.
<Automatically dateTime datetime Required. Used for data Engagement /
Assigned> partitioning for Engagement Date Time
engagement events.
ISO8601 supported
format.
<Automatically eventType = "order" text Required. The -
Assigned> developerName of an
event defined in the Web
Connector schema.
<Automatically sessionId text Required. The identifier of -
Assigned> the session.
<Automatically deviceId text Required. Typically the Product Order
Assigned> primary key for profile Engagement / Individual
events.
<Automatically category = text Required. Possible values -
Assigned> "Engagement" are:
• Engagement
• Profile
<Automatically interactionName = text Required. A descriptive Product Order
Assigned> "Cancel | Deliver | name for the event. Engagement / Product
Exchange | Preorder | Order Event Type
Purchase | Return | Ship"
<Automatically channel = "mobile" text The SDK event channel. Engagement /
Assigned> For Engagement Mobile Engagement Channel
SDK the value is mobile. Type
<Automatically Assigned longitude number The longitudinal Engagement / Device
if Location Tracking is coordinate in decimal Longitude
allowed> degrees reported by the
device at the time the
event was captured.
<Automatically Assigned latitude number The latitudinal coordinate Engagement / Device
if Location Tracking is in decimal degrees Latitude
allowed> reported by the device at
113
Connect Data Schema Mappings
Source Event Target Schema Field Type Description Customer 360 Data
Property Developer Name Model Object /
Attribute
the time the event was
captured.
order.id orderId text A unique identifier Engagement / Sales
representing the order. Order Product
Engagement Action /
Order Product Number
order.totalValue orderTotalValue number The total value of the Product Order
order. Engagement / Sales
Order Product
Engagement Action / Net
Order Amount
order.currency orderCurrency text The currency of the total Product Order
value for the order. Engagement / Currency
order.attributes Refer to Schema Field number A dictionary of -
Naming Rules user-supplied values.
Each Line Item Attribute on page 102 contained in the Order Event on page 94 gets mapped to a child event where order EventId
is set to the eventId of the parent order event:
Source Event Target Schema Data Type Description Customer 360 Data
Property Developer Name Model Object /
Attribute
<Automatically eventId text Required. Typically the -
Assigned> primary key for the
engagement events.
<Automatically dateTime datetime Required. Used for data -
Assigned> partitioning for
engagement events.
ISO8601 supported
format.
<Automatically eventType = "orderItem" text Required. The -
Assigned> developerName of an
event defined in the Web
Connector schema.
<Automatically sessionId text Required. An identifier for -
Assigned> a session.
<Automatically deviceId text Required. Typically the -
Assigned> primary key for profile
events.
114
Connect Data Schema Mappings
Source Event Target Schema Data Type Description Customer 360 Data
Property Developer Name Model Object /
Attribute
<Automatically category = text Required. Possible values -
Assigned> "Engagement" are:
• Engagement
• Profile
<Automatically orderEventId text Required. The eventId Product Order
Assigned> of the order event Engagement
containing this Line Item.
lineItem.catalogObjectType catalogObjectType text Required. A type name of -
the catalog object
referenced in the line
item.
lineItem.catalogObjectId catalogObjectId text Required. A unique -
identifier representing
the catalog object
referenced in the line
item.
lineItem.quantity quantity number The number of catalog Product Order
objects in the line item. Engagement / Currency
lineItem.price price number The price of the catalog Product Order
object referenced in the Engagement / Currency
line item.
lineItem.currency currency text The currency for the price Product Order
field. Engagement / Currency
lineItem.attributes.customField0 attributeCustomField0 any A user-supplied value. -
lineItem.attributes.customFieldN attributeCustomFieldN any A user-supplied value. -
Note: Properties added to lineItem.attributes aren’t automatically defined in the recommended schema. They’re
shown to demonstrate how the source properties are mapped to the target schema. Manually add the properties to the schema.
Custom Event Schema
Use the event data models provided by the Engagement Mobile SDK for cart event, catalog event, and order event to use the unified
data model across Salesforce. You can create and capture a custom event.
Define the custom event in the Mobile Connector schema:
115
Connect Data Schema Mappings
Source Event Target Schema Field Type Description CIM Object /
Property Developer Name Attribute
<Automatically eventId text Required. Typically the -
Assigned> primary key for the
engagement events.
<Automatically dateTime datetime Required. Used for data -
Assigned> partitioning for
engagement events.
ISO8601 supported
format.
name eventType = <what the text Required. The name -
user defined in name defined in property
property> suffixed with eventType.
Example: The name
Custom Event is
transformed to:
"eventType": "Custom
Event".
<Automatically sessionId text Required. The identifier of -
Assigned> the session.
<Automatically deviceId text Required. Typically the -
Assigned> primary key for profile
events.
<Automatically category = text Required. Possible values -
Assigned> "Engagement" are:
• Engagement
• Profile
<Automatically channel = "mobile" text The SDK event channel. -
Assigned> For Engagement Mobile
SDK the value is mobile.
<user defined attributes <attributes as defined by <user defined> Custom Event -
array> user>
Note: Attributes
array can contain
nested arrays.
<Automatically Assigned longitude number The longitudinal Device Longitude
when Location Tracking coordinate in decimal
on page 84 is allowed> degrees reported by the
device at the time the
event was captured.
116
Connect Data Schema Mappings
Source Event Target Schema Field Type Description CIM Object /
Property Developer Name Attribute
<Automatically Assigned latitude number The latitudinal coordinate Device Latitude
when Location Tracking in decimal degrees
on page 84 is allowed> reported by the device at
the time the event was
captured.
If eventType isn’t provided but name is then eventType defaults to the value of name. For example, the schema could look like:
{
"masterLabel": "CustomEvent",
"developerName": "Custom Event",
"category": "Engagement",
"externalDataTranFields": [
{
"masterLabel": "category",
"developerName": "category",
"dataType": "Text",
"isDataRequired": true
},
{
"masterLabel": "channel",
"developerName": "channel",
"dataType": "Text",
"isDataRequired": false
},
{
"masterLabel": "dateTime",
"developerName": "dateTime",
"dataType": "DateTime",
"isDataRequired": true
},
{
"masterLabel": "deviceId",
"developerName": "deviceId",
"dataType": "Text",
"isDataRequired": true,
"primaryIndexOrder": 1
},
{
"masterLabel": "eventId",
"developerName": "eventId",
"dataType": "Text",
"isDataRequired": true
},
{
"masterLabel": "eventType",
"developerName": "eventType",
"dataType": "Text",
"isDataRequired": true
},
117
Connect Data Schema Mappings
{
"masterLabel": "latitude",
"developerName": "latitude",
"dataType": "Number",
"isDataRequired": false
},
{
"masterLabel": "longitude",
"developerName": "longitude",
"dataType": "Number",
"isDataRequired": false
},
{
"masterLabel": "sessionId",
"developerName": "sessionId",
"dataType": "Text",
"isDataRequired": true
},
{
"masterLabel": "giftMessage",
"developerName": "giftMessage",
"dataType": "Text",
"isDataRequired": false
},
{
"masterLabel": "giftWrap",
"developerName": "giftWrap",
"dataType": "Text",
"isDataRequired": false
},
{
"masterLabel": "giftWrapOptionsPaperColor",
"developerName": "giftOptionsPaperColor",
"dataType": "Text",
"isDataRequired": false
},
{
"masterLabel": "giftWrapOptionsRibbon",
"developerName": "giftOptionsRibbon",
"dataType": "bool",
"isDataRequired": false
}
]
}
Consent Schema
Consent Management is used to either grant or revoke consent in the Engagement Mobile SDK. When a customer opts in to tracking,
the mobile application sends a consentLog event indicating the choice along with other events that got collected. When a customer
opts out, a consentLog event is sent containing their choice and no other events are sent to Data Cloud.
118
Connect Data Schema Mappings
Source Event Target Schema Field Type Description CIM Object /
Property Developer Name Attribute
<Automatically eventId text Required. Typically the Privacy Consent Log
Assigned> primary key for the /Privacy Consent Log Id
engagement events.
<Automatically dateTime datetime Required. Used for data Privacy Consent Log
Assigned> partitioning for /Privacy Consent Activity
engagement events. Date Time
ISO8601 supported
format.
<Automatically eventType = text Required. The -
Assigned> "consentLog" developerName of an
event defined in the Web
Connector schema.
<Automatically sessionId text Required. The identifier of -
Assigned> the session.
<Automatically deviceId text Required. Typically the -
Assigned> primary key for profile
events.
<Automatically category = text Required. Possible values Privacy Consent Log
Assigned> "Engagement" are: /Privacy Consent Log
• Engagement Category
• Profile
consent.status status text Required. Possible values Privacy Consent Log
are: /Privacy Consent Status
• Opt In
• Opt Out
consent.provider provider text A named identifier -
indicating the consent
management system
providing the consent to
the SDK
consent.purpose purpose text What the user is Privacy Consent Log
consenting to. For /Consent Action
example: Tracking
Behavior Schema
Behavior events are sent to Data Cloud as a customer navigates the application where the Data Cloud Module for the Engagement
Mobile SDK is running. Behavior events can include screen view, and application launch.
119
Connect Data Schema Mappings
Source Event Target Schema Field Type Description CIM Object /
Property Developer Name Attribute
<Automatically eventId text Required. Typically the -
Assigned> primary key for the
engagement events.
<Automatically dateTime datetime Required. Used for data -
Assigned> partitioning for
engagement events.
ISO8601 supported
format.
<Automatically eventType = "appEvents" text Required. The -
Assigned> developerName of an
event defined in the Web
Connector schema.
<Automatically sessionId text Required. The identifier of -
Assigned> the session.
<Automatically deviceId text Required. Typically the -
Assigned> primary key for profile
events.
<Automatically category = text Required. Possible values -
Assigned> "Engagement" are:
• Engagement
• Profile
<Automatically channel = "mobile" text The SDK event channel. -
Assigned> For Engagement Mobile
SDK the value is mobile.
appName appName text The name of the software -
application.
appVersion appVersion text The version of the -
software application.
behaviorType behaviorType text The type of behavior -
event captured. Possible
values are:
• ScreenView
• AppBackgrounded
• AppUpdate
• AppFirstLaunch
• AppLaunch
previousAppVersion previousAppVersion text The previous version of -
the software application.
120
Connect Data Schema Mappings
Source Event Target Schema Field Type Description CIM Object /
Property Developer Name Attribute
screenName screenName text The screen name. -
<Automatically Assigned longitude number The longitudinal Engagement / Device
if Location Tracking is coordinate in decimal Longitude
allowed> degrees reported by the
device at the time the
event was captured.
<Automatically Assigned latitude number The latitudinal coordinate Engagement / Device
if Location Tracking is in decimal degrees Latitude
allowed> reported by the device at
the time the event was
captured.
Profile
Descriptions for how the Data Cloud Module for the Engagement Mobile SDK profile changes map to each profile event definition in
the recommended mobile schema within
Contact Point Email Schema
Use the contact point email schema to capture profile data to map to individual data streams.
Contact Point Phone Schema
Use the contact point phone schema to capture profile data to map to individual data streams.
Contact Point Address Schema
Use the contact point address schema to capture profile data to map to individual data streams. An address contains a mix of required
and optional fields. In order to create the contact point and map it to the individual, all required fields must be provided.
Party Identification Schema
Use the party identification schema to capture profile data to map to individual data streams.
Identity Schema
Capturing profile data is achieved through the mobile SDK’s identity component. The component sets and tracks various profile
attributes and emit identity events, which the Data Cloud Module listens for. These identity events can contain an aggregate for
several contact point profile data streams.
Contact Point Email Schema
Use the contact point email schema to capture profile data to map to individual data streams.
Source Event Target Schema Field Type Description CIM Object /
Property Developer Name Attribute
<Automatically eventId text Required. Typically the -
Assigned> primary key for the
engagement events.
121
Connect Data Schema Mappings
Source Event Target Schema Field Type Description CIM Object /
Property Developer Name Attribute
<Automatically dateTime datetime Required. Used for data -
Assigned> partitioning for
engagement events.
ISO8601 supported
format.
<Automatically eventType = text Required. The -
Assigned> "contactPointEmail" developerName of an
event defined in the Web
Connector schema.
<Automatically sessionId text Required. The session -
Assigned> identifier.
<Automatically deviceId text Required. Typically the -
Assigned> primary key for profile
events.
<Automatically category = "Profile" text Required. Possible values -
Assigned> are:
• Engagement
• Profile
<Automatically channel = "mobile" text The SDK event channel. -
Assigned> For Engagement Mobile
SDK, the value is mobile.
email email text Required. The user’s email Contact Point Email
address.
<Automatically Assigned longitude number The latitudinal Engagement / Device
when Location Tracking coordinate, in decimal Longitude
on page 84 is allowed> degrees, reported by the
device at the time the
event was captured.
<Automatically Assigned latitude number The latitudinal Engagement / Device
when Location Tracking coordinate, in decimal Latitude
on page 84 is allowed> degrees, reported by the
device at the time the
event was captured.
Contact Point Phone Schema
Use the contact point phone schema to capture profile data to map to individual data streams.
122
Connect Data Schema Mappings
Source Event Target Schema Field Type Description CIM Object /
Property Developer Name Attribute
<Automatically eventId text Required. Typically the -
Assigned> primary key for the
engagement events.
<Automatically dateTime datetime Required. Used for data -
Assigned> partitioning for
engagement events.
ISO8601 supported
format.
<Automatically eventType = text Required. The -
Assigned> "contactPointPhone" developerName of an
event defined in the Web
Connector schema.
<Automatically sessionId text Required. The identifier of -
Assigned> the session.
<Automatically deviceId text Required. Typically the -
Assigned> primary key for profile
events.
<Automatically category = "Profile" text Required. Possible values -
Assigned> are:
• Engagement
• Profile
<Automatically channel = "mobile" text The SDK event channel. -
Assigned> For Engagement Mobile
SDK the value is mobile.
phoneNumber phoneNumber text Required. The phone Contact Point Phone
number for the customer.
<Automatically Assigned longitude number The longitudinal Engagement / Device
when Location Tracking coordinate in decimal Longitude
on page 84 is allowed> degrees reported by the
device at the time the
event was captured.
<Automatically Assigned latitude number The latitudinal coordinate Engagement / Device
when Location Tracking in decimal degrees Latitude
on page 84 is allowed> reported by the device at
the time the event was
captured.
123
Connect Data Schema Mappings
Contact Point Address Schema
Use the contact point address schema to capture profile data to map to individual data streams. An address contains a mix of required
and optional fields. In order to create the contact point and map it to the individual, all required fields must be provided.
Source Event Target Schema Field Type Description CIM Object /
Property Developer Name Attribute
<Automatically eventId text Required. Typically the -
Assigned> primary key for the
engagement events.
<Automatically dateTime datetime Required. Used for data -
Assigned> partitioning for
engagement events.
ISO8601 supported
format.
<Automatically eventType = text Required. The -
Assigned> "contactPointAddress" developerName of an
event defined in the Web
Connector schema.
<Automatically sessionId text Required. The identifier of -
Assigned> the session.
<Automatically deviceId text Required. Typically the -
Assigned> primary key for profile
events.
<Automatically category = "Profile" text Required. Possible values -
Assigned> are:
• Engagement
• Profile
<Automatically channel = "mobile" text The SDK event channel. -
Assigned> For Engagement Mobile
SDK the value is mobile.
addressLine1 addressLine1 text Required. The first line -
detail for the address.
addressLine2 addressLine2 text The second line detail for -
the address.
addressLine3 addressLine3 text The third line detail for -
the address.
addressLine4 addressLine4 text The fourth line detail for -
the address.
city city text Required. The city detail Contact Point Address /
for the address. City
124
Connect Data Schema Mappings
Source Event Target Schema Field Type Description CIM Object /
Property Developer Name Attribute
postalCode postalCode text Required. The postal code Contact Point Address
or ZIP code for the /PostalCode
address.
stateProvince stateProvince text Required. The state or Contact Point Address
province detail for the /StateProvince
address.
country country text Required. The country -
detail for the address.
<Automatically Assigned longitude number The longitudinal Engagement / Device
if Location Tracking is coordinate in decimal Longitude
allowed> degrees reported by the
device at the time the
event was captured.
<Automatically Assigned latitude number The latitudinal coordinate Engagement / Device
if Location Tracking is in decimal degrees Latitude
allowed> reported by the device at
the time the event was
captured.
Party Identification Schema
Use the party identification schema to capture profile data to map to individual data streams.
Source Event Target Schema Field Type Description CIM Object /
Property Developer Name Attribute
<Automatically eventId text Required. Typically the -
Assigned> primary key for the
engagement events.
<Automatically dateTime datetime Required. Used for data -
Assigned> partitioning for
engagement events.
ISO8601 supported
format.
<Automatically eventType = text Required. The -
Assigned> "partyIdentification" developerName of an
event defined in the Web
Connector schema.
<Automatically sessionId text Required. The identifier of -
Assigned> the session.
125
Connect Data Schema Mappings
Source Event Target Schema Field Type Description CIM Object /
Property Developer Name Attribute
<Automatically deviceId text Required. Typically the Party Identification /Party
Assigned> primary key for profile Identification Id
events.
<Automatically category = "Profile" text Required. Possible values -
Assigned> are:
• Engagement
• Profile
<Automatically channel = "mobile" text The SDK event channel. -
Assigned> For Engagement Mobile
SDK the value is mobile.
IDName iDName text Required. The party Party Identification
identification name. /Identification Name
IDType iDType text Required. The party Party Identification /Party
identification type. Identification Type
userId userId text Required. The user Party Identification
identifier in the party. /Identification Number
<Automatically Assigned longitude number The longitudinal Engagement / Device
if Location Tracking is coordinate in decimal Longitude
allowed> degrees reported by the
device at the time the
event was captured.
<Automatically Assigned latitude number The latitudinal coordinate Engagement / Device
if Location Tracking is in decimal degrees Latitude
allowed> reported by the device at
the time the event was
captured.
Identity Schema
Capturing profile data is achieved through the mobile SDK’s identity component. The component sets and tracks various profile attributes
and emit identity events, which the Data Cloud Module listens for. These identity events can contain an aggregate for several contact
point profile data streams.
Source Event Target Schema Field Type Description CIM Object /
Property Developer Name Attribute
<Automatically eventId text Required. Typically the -
Assigned> primary key for the
engagement events.
126
Connect Data Schema Mappings
Source Event Target Schema Field Type Description CIM Object /
Property Developer Name Attribute
<Automatically dateTime datetime Required. Used for data Individual / Last Modified
Assigned> partitioning for Date
engagement events.
ISO8601 supported
format.
<Automatically eventType = "identity" text Required. The -
Assigned> developerName of an
event defined in the Web
Connector schema.
<Automatically sessionId text Required. The identifier of -
Assigned> the session.
<Automatically deviceId text Required. Typically the Individual / Individual Id
Assigned> primary key for profile
events.
<Automatically category = "Profile" text Required. Possible values -
Assigned> are:
• Engagement
• Profile
<Automatically channel = "mobile" text The SDK event channel. -
Assigned> For Engagement Mobile
SDK the value is mobile.
<Automatically isAnonymous text Required. Indicates if this Individual
Assigned> profile event identifies as
an anonymous user or a
known user. Possible
values are:
• 0 (false)
• 1 (true)
firstName firstName text The first name of the user. Individual / First Name
lastName lastName text The last name of the user. Individual / Last Name
email email text The email address for the Contact Point Email /
user. Email Address
phoneNumber phoneNumber text The phone number for Contact Point Phone /
the customer. Formatted E164 Phone
Number
addressLine1 addressLine1 text The first line detail for the Contact Point Address /
address. Address Line 1
127
Connect Data Schema Mappings
Source Event Target Schema Field Type Description CIM Object /
Property Developer Name Attribute
addressLine2 addressLine2 text The second line detail for Contact Point Address /
the address. Address Line 2
addressLine3 addressLine3 text The third line detail for Contact Point Address /
the address. Address Line 3
addressLine4 addressLine4 text The fourth line detail for Contact Point Address /
the address. Address Line 4
city city text The city detail for the Contact Point Address /
address. City Name
postalCode postalCode text The postal code or ZIP Contact Point Address
code for the address.
stateProvince stateProvince text The state or province Contact Point Address /
detail for the address. State Province
country country text The country detail for the Contact Point Address /
address. Country
advertiserId advertiserId text The unique identifier Contact Point App /
provided by Android and Advertiser Id
iOS platforms that
advertisers can use to
uniquely identify
customers.
deviceType deviceType text Type of device the SDK is -
running on.
osName osName text The name of the device's Contact Point App /
operating system. operating system Name
osVersion osVersion text The version of the Contact Point App /
device's operating operating system Version
system.
registrationId registrationId text The application ID of the Contact Point App
software.
softwareApplicationName softwareApplicationName text The name of the software Contact Point App /
application. Software Application
Name
softwareApplicationVersion softwareApplicationVersion text The version of the Contact Point App /
software application. Version Number
<Automatically Assigned longitude number The longitudinal -
when Location Tracking coordinate in decimal
on page 84 is allowed> degrees reported by the
128
Connect Data Connect MuleSoft with Data Cloud
Source Event Target Schema Field Type Description CIM Object /
Property Developer Name Attribute
device at the time the
event was captured.
<Automatically Assigned latitude number The latitudinal coordinate -
when Location Tracking in decimal degrees
on page 84 is allowed> reported by the device at
the time the event was
captured.
Connect MuleSoft with Data Cloud
Use the power of MuleSoft and its ecosystem of data connectors to bring data into Data Cloud. The CDP MuleSoft Connector helps you
integrate your Data Cloud instance with external systems. Via the Ingestion API, you can enrich existing Data Cloud records by automating
data ingestion from third parties.
1. Set up Ingest Data into Data Cloud on page 131 Bulk Ingestion or Streaming Ingestion.
2. Configure your MuleSoft Connector.
129
CHAPTER 3 Ingest Data
In this chapter ... Load data records into your Data Cloud programmatically using the Ingestion API or configure an S3
connector with retrieval schedule in order to pull records from S3.
• Ingest Data into Data
Cloud
• Create an Amazon
S3 Data Stream
• Rotation of S3
Credentials with
Metadata API
130
Ingest Data Ingest Data into Data Cloud
Ingest Data into Data Cloud
The Ingestion API provides a RESTful interface that supports both streaming and bulk interaction patterns for loading data into Data
Cloud. You can use a single Ingestion API connector for performing both bulk and streaming uploads.
When do you use Bulk and Streaming Ingestion?
Consider the data source and the problem you’re trying to solve when choosing the ingestion mode.
Use bulk ingestion when moving large amounts of data on a daily, weekly, or monthly schedule. A few example scenarios are:
• Moving large amounts of data on a daily, weekly, or monthly schedule.
• Legacy systems where you can only export data in off-peak hours.
• A new Data Cloud org that you want to backfill with 30, 60, 90, or X days of data.
Use streaming ingestion for small micro-batches of records being updated in near-real time, such as:
• Source system built on modern streaming architectures.
• Change data capture events.
• Consuming data from webhooks.
Here's an example use case to understand it better.
Example: Imagine you’re an integrator working for Northern Trail Outfitters (NTO). You need to extract the runner profiles and
activity logs from NTO’s Track My Run mobile app and load them into Data Cloud. The marketer you’re working with has indicated
that he needs the last 90 days of historical data and wants all new and updated data on a go-forward basis.
You query the last 90 days from your data warehouse as requested and you chunk up the data into 150 MB CSV files. You then
load the data into Data Cloud via the bulk ingestion, understanding that the bulk ingestion is an appropriate solution for one-time
operations. Now that the initial dataset is loaded, you decide it’s best to synchronize future changes with an upsert operation via
streaming ingestion. These updates can be forwarded to Data Cloud in micro-batches as soon as the data becomes available.
Get Started with Ingestion API
Before using Ingestion API in Data Cloud, complete the prerequisites, set up authentication, and know the limits that apply to bulk
ingestion and streaming ingestion.
Streaming Ingestion
The Data Cloud Ingestion API uses a fire-and-forget pattern to synchronize micro-batches of updates between the source system
and Data Cloud in near-real time. Data is processed asynchronously approximately every 3 minutes.
Bulk Ingestion
With the Data Cloud Ingestion API, you can upsert or delete large data sets. Prepare a CSV file for the data you want to upload, create
a job, upload job data, and let Salesforce take care of the rest.
SEE ALSO:
Connect Data
Get Started with Ingestion API
Before using Ingestion API in Data Cloud, complete the prerequisites, set up authentication, and know the limits that apply to bulk
ingestion and streaming ingestion.
131
Ingest Data Get Started with Ingestion API
Prerequisites
• Setup an Ingestion API connector to define the endpoints and payload to ingest data.
• Create an Ingestion API data stream to configure ingestion jobs and expose the API for external consumption.
• Contact your Data Cloud Admin to get endpoint details configured in Ingestion API Developer Info.
Authentication
Set up a connected app to authenticate and request access to Data Cloud Ingestion API. The connected app enables standard OAuth
protocols for authentication and authorization. Follow the instructions in Salesforce Help Create a Connected App, and configure the
app as needed. In your connected app, make sure Enable OAuth Settings and necessary OAuth scopes are selected. The possible
scopes are:
• Access and manage your Data Cloud Ingestion API data (cdp_ingest_api).
• Access and manage your data (api).
• Perform requests on your behalf at any time (refresh_token, offline_access).
Important: Your orgs must be provisioned with Data Cloud licenses and the users must be assigned to appropriate roles for
having full access to objects in the Data Cloud. Refer to User Roles and Permission Sets in Data Cloud before setting up the Connected
App.
Acquire a Salesforce Access Token
Send a request for acquiring the Salesforce access token. Here’s how a sample request is going to look like.
POST https://login.salesforce.com/services/oauth2/token
Content-Type : x-www-form-urlencoded
grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer
&
a
se
r
t
io
n
=
ey
J
0
eX
A
i
Oi
J
K
V1
Q
i
LC
J
h
bG
c
i
Oi
J
S
Uz
I
1
Ni
J
9
.e
y
J
pc
3
M
iO
i
I
zT
V
Z
HO
U
F
Pc
D
R
rY
n
J
pW
k
9
JZ
m
g
0e
W
Z
PQ
V
l
QU
j
F
pY
z
J
qb
1
J
DQ
k
h
wZ
F
Z
ta
X
B
XU
0
5
sb
X
N
wT
2
V
ib
1
V
tc
W
d
Md
H
J
Ic
D
l
RV
F
R
QM
G
p
Wc
3
g
0S
H
l
zU
W
4
xL
k
1
Sa
z
F
yI
i
w
ic
3
V
iI
j
o
ic
3
V
ka
G
V
lc
k
B
vc
m
d
tY
W
l
uM
i
5
jb
2
0
iL
C
J
hd
W
Q
iO
i
J
od
H
R
wO
i
8
vc
3
V
rd
W
1
hc
i
1
sd
G
0
ua
W
5
0Z
X
J
uY
W
w
uc
2
F
sZ
X
N
mb
3
J
jZ
S
5
jb
2
0
iL
C
J
le
H
A
iO
j
E
2M
D
Q
2M
z
c
4M
T
k
yN
T
d
9.
W
k
Ec
m
a
Gj
_
j
hJ
p
y
Fq
X
w
EU
t
w
-b
k
e
XY
u
x
kq
c
2
c3
l
k
wb
G
j
g3
G
D
o7
s
S
tI
T
h
t_
O
_
dS
N
a
nS
0
x
k2
q
9
AR
A
6
Uo
m
-
ua
i
y
Nw
_
GG
K
5
L3
j
B
Qj
K
-
yt
r
G
um
u
J
As
u
jf
S
m
Ld
Y
S
tx
P
V
nj
U
2
zy
u
P
SW
M
Q
Jm
e
D
eg
x
D
gm
e
h
t3
U
Q
yl
u
j
0q
4
l
X3
r
a
yx
0
O
l-
v
Z
fT
u
z
r4
Y
l
xm
d
O
KT
N
r
PJ
C
Q
8h
2
6
uM
S
P
Fr
Q
mq
c
sr
S
g
1D
R
g
m3
k
M
h1
5
V
KM
3
y
Zy
N
A
g4
3
E
Pw
1
B
fn
c
P
WI
x
O
ms
G
t
2J
x
Uc
l
B
ER
3
e
nT
L
M
2c
J
K
r9
f
D
x1
6
S
se
s
j
2U
K
q
XG
b
w
N6
8
g
CF
5
r
Zx
D
6
yG
N
5
B0
V
e
ZI
Z
V
Jr
Y
5
cT
t
E
xq
B
p
3L
j
8
UO
c
q
Uj
6
e
sy
C
Q
Note: Refer to OAuth 2.0 JWT Bearer Flow for Server-to-Server Integration for creating a JWT assertion.
Response Format
This example shows a response from Salesforce.
{
"access_token":
"00Dxx0000006JFr!AQEAQL7SvQ1t..2yYtyM0jfXtMNriivdMpTYE3mThqATnm5YqPIX.xnzUC45zd0HEIU3tc9GdHLqWOFVprsgszWdYMPRUnOy",
"scope": "cdp_ingest_api",
"instance_url": "http://orgmain2.localhost.internal.salesforce.com:6109",
"id":
"http://dcorg-ltm.internal.salesforce.com:6109/id/00Dxx0000006JFrEAM/005xx000001X9hBAAS",
"token_type": "Bearer"
}
Exchanging Salesforce Access Token for Data Cloud Access Token
Now that you've acquired the Salesforce access token, use it to get the Data Cloud access token to invoke the Ingestion API.
This example shows a request for Data Cloud access token.
POST https://a360.cdp.cdp001.dev1-uswest2.aws.sfdc.cl/services/a360/token
Content-Type : x-www-form-urlencoded
132
Ingest Data Get Started with Ingestion API
grant_type=urn:salesforce:grant-type:external:cdp
&subject_token=00Dxx0000006JFr!AQEAQL7SvQ1t..2yYtyM0jfXtMNriivdMpTYE3mThqATnm5YqPIX.xnzUC45zd0HEIU3tc9GdHLqWOFVprsgszWdYMPRUnOy
&subject_token_type=urn:ietf:params:oauth:token-type:access_token
This example shows a sample response.
{
"access_token":
"
e
y
J
ra
W
Q
iO
i
J
D
T1
J
F
Lj
A
w
R
Hh
4
M
DA
w
M
D
Aw
N
k
pG
c
i
4
xN
j
A
zM
j
M
5
Nz
I
2
Nj
I
5
I
iw
i
d
Hl
w
I
j
oi
S
l
dU
I
i
w
iY
W
x
nI
j
o
i
Ul
M
y
NT
Y
i
f
Q.
e
y
Jz
d
W
I
iO
i
J
od
H
R
w
Oi
8
v
c3
V
r
d
W1
h
c
i1
s
d
G
0u
a
W
50
Z
X
J
uY
W
w
uc
2
F
s
ZX
N
m
b3
J
j
Z
S5
j
b
20
6
N
j
Ew
O
S
9p
Z
C
8
wM
E
R
4e
D
A
w
MD
A
w
MD
Z
K
R
nJ
F
Q
U0
v
M
D
A1
e
H
gw
M
D
A
wM
D
F
YO
W
h
C
QU
F
T
Ii
w
i
Y
XV
k
I
jo
i
Y
T
M2
M
C
Is
I
n
N
jc
C
I
6I
m
N
k
cH
B
y
b2
Z
p
b
GU
g
Y
2R
w
c
X
Vl
c
n
ki
L
C
J
uY
m
Y
iO
j
E
2
MD
Q
1
NT
E
3
N
zY
s
I
nN
m
b
2
lk
I
j
oi
M
D
B
Ee
H
g
wM
D
A
w
MD
A
2
Sk
Z
y
I
iw
i
a
XN
z
I
j
oi
a
H
R0
c
D
o
vL
3
N
1a
3
V
t
YX
I
t
bH
R
t
L
ml
u
d
GV
y
b
m
Fs
L
n
Nh
b
G
V
zZ
m
9
yY
2
U
u
Y2
9
t
Oj
Y
x
M
Dk
v
I
iw
i
c
2
Z1
a
W
Qi
O
i
I
wM
D
V
4e
D
A
w
MD
A
w
MV
g
5
a
EI
i
L
CJ
l
e
H
Ai
O
j
E2
M
D
Q
1N
T
k
wM
j
g
s
Im
l
h
dC
I
6
M
TY
w
N
DU
1
M
T
gz
N
i
wi
a
n
R
pI
j
o
iY
j
k
1
OD
A
1
ZD
U
t
M
2M
z
Y
S0M
D
N
k
LW
J
i
Nj
g
t
N
jB
k
N
TJ
l
N
m
M4
O
T
Bj
I
i
w
ic
2
Z
hc
H
B
p
ZC
I
6
Ij
NV
k
c
5
QU
9
w
NG
t
i
c
ml
a
T
0l
m
a
D
R5
Z
k
9B
W
V
B
SM
W
l
jM
m
p
v
Uk
N
C
SH
B
k
V
m1
p
c
Fd
Tm
x
t
c
3B
P
Z
WJ
v
V
W
1x
Z
0
x0
c
k
h
wO
V
F
UV
F
A
w
al
Z
z
eD
R
I
e
XN
R
b
jE
u
T
V
Jr
M
X
Ii
f
Q
.
GA
W
q
iP
p
V
J
oD
i
g
-a
d
G
t
D4
d
5
cO
7
L
7
Ja
I
n
2m
O
Y
H
9G
y
D7
o
O
7
Ay
r
s
nv
_
k
0
5Q
R
P
p-
B
1
g
Sd
4
U
8l
q
E
_
cu
C
0
MT
E
9
L
6l
z
J
A"
,
"instance_url": "https://a360.cdp.cdp001.dev1-uswest2.aws.sfdc.cl",
"token_type": "Bearer",
"issued_token_type": "urn:ietf:params:oauth:token-type:jwt",
"expires_in": 7191
}
Bulk Ingest API Limits
Item Description
API usage limits After each request, your app must check the response code. The HTTP 429 Too
Many Requests status code indicates the app must reduce its request frequency.
Bulk Job Retention Time Any open bulk jobs with the status of Open or Upload Complete that are older than 7
days, are deleted from the ingestion queue.
Maximum Number of Files per Job You can upload one file at a time per bulk job. A job can have a maximum of 100 files.
Maximum Payload size CSV files uploaded via Bulk API have a maximum size of 150 MB.
Number of Requests or Jobs Allowed per Hour 20
Number of Concurrent Requests or Jobs 5
Allowed at One Time
Streaming Ingest API Limits
Item Description
API usage limits After each request, your app must check the response code. The
HTTP 429 Too Many Requests status code indicates
the app must reduce its request frequency.
Expected Latency Data is processed asynchronously approximately every 3 minutes.
Maximum Payload Size Per Request JSON data uploaded via Streaming API have a maximum body size
of 200 KB per request
Maximum Number of Records that can be Deleted You can delete a maximum of 200 records via Streaming API.
Total Number of Requests per Second Across All Ingestion API 250 requests
Object Endpoints
133
Ingest Data Get Started with Ingestion API
Status Codes and Error Responses
HTTP Response Code Description
200 OK Request succeeded.
201 Created Indicates that the resource was successfully created.
202 Accepted The request was accepted and the data will be processed
asynchronously.
204 No Content Job was successfully deleted.
400 Bad Request Server can’t process the request due to client error. Possible causes
are a malformed request syntax or invalid request body.
401 Unauthorized Authentication failed because the JWT is invalid or expired. Refresh
the token.
404 Not Found Client error: the requested resource doesn’t exist.
409 Conflict Client error: unable to update the job state given its status.
429 Conflict The user has sent too many requests in a given amount of time.
Implement a back-off policy to reduce the number of requests.
500 Internal Server Error Internal server error. Retry the request.
Data Upload Limits
• For streaming: Small payloads (up to 200 KB per single request)
• For bulk: Large CSVs up to 150 MB
Note: For guidance on overall limitations view Data Cloud Limits and Guidelines.
Streaming Ingestion Walkthrough
Use this walkthrough to understand the steps for loading records using streaming ingestion.
Bulk Ingestion Walkthrough
This walkthrough guides you through the steps for loading records using bulk ingestion.
Streaming Ingestion Walkthrough
Use this walkthrough to understand the steps for loading records using streaming ingestion.
Before you can start, make sure you’ve completed the prerequisites required to set up your Ingestion API:
• Set up an Ingestion API Connector to define the endpoints and object payload to ingest data.
• Download the object endpoints from the configured Ingestion API connector. The object endpoints and the Ingestion API connector
name are used as parameters in the API calls.
• Create an Ingestion API Data Stream to configure ingestion jobs and expose the API for external consumption.
134
Ingest Data Get Started with Ingestion API
1. Create a collection of JSON objects that matches the schema of the source objects you defined in your Ingestion API data stream.
Wrap the collection in a data envelope and save it as orders.json. The payload must be less than 200 KB.
{
"data": [{
"id": 1,
"contact_name": "Joe Smith",
"created_date": "2021-07-22T08:57:08.118Z",
"tax_exempt": false,
"ship_address": "9818 Main",
"total": 77506,
"tax_rate": 84,
"modified_date": "2021-07-05T09:31:44.457Z"
},
{
"id": 2,
"contact_name": "Tina Smith",
"created_date": "2021-07-08T22:57:02.008Z",
"tax_exempt": false,
"ship_address": "245 Main",
"total": 16986,
"tax_rate": 61,
"modified_date": "2021-07-03T06:20:52.886Z"
}
]
}
2. Request a Data Cloud access token. For more information, refer to Authentication. The access_token property in the token
exchange response contains the bearer token to use for the authorization header. The instance_url is the Data Cloud instance
where the Ingestion API is hosted.
3. Use the Synchronous Record Validation method and validate if your ingestion request is configured correctly. Requests that fail
validation aren’t processed into the data lake. If the request fails validation, the API returns a report indicating which records are
problematic and why. Fix the request based on the validation feedback and resubmit until you received a status code in the 200 s
from the API.
curl --location --request POST
'https://{instance_url}/api/v1/ingest/sources/ecomm/Order/actions/test' \
--header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: application/json' \
--data @orders.json
4. After you’re confident that the integration is properly configured, upload your JSON data via the Ingestion API. You must receive a
202 Accepted response indicating your data has been accepted for processing.
curl --location --request POST 'https://{instance_url}/api/v1/ingest/sources/ecomm/Order/'
\ --header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: application/json' \
--data @orders.json
Bulk Ingestion Walkthrough
This walkthrough guides you through the steps for loading records using bulk ingestion.
135
Ingest Data Get Started with Ingestion API
Before you can start, make sure you’ve completed the prerequisites required to set up your Ingestion API:
• Set up an Ingestion API connector to define the endpoints and payload to ingest data.
• Download the object endpoints from the configured Ingestion API connector. The object endpoints and the Ingestion API connector
name are used as parameters in the API calls.
• Create an Ingestion API Data Stream to configure ingestion jobs and expose the API for external consumption.
1. Create a CSV file that has a header row matching the fields in the data stream you created. Each file must not exceed 150 MB. Here's
some sample data of an orders.csv file used in this walkthrough.
id,contact_name,created_date,tax_exempt,ship_address,total,tax_rate,modified_date
f19cae7e-5cdb-41ce-92ba-539afea04f9d,Jadyn Kozey,2021-07-22T08:57:08.118Z,false,9818
Walter Course Apt. 811,77506,84,2021-07-05T09:31:44.457Z
48c8b6a6-8179-4a15-ba19-ec5c8206ce28,Kristina
Jakubowski,2021-07-08T22:57:02.008Z,false,245 Schowalter Port Suite
245,16986,61,2021-07-03T06:20:52.886Z
2. Request a Data Cloud access token. For more information, refer to Authentication. The access_token property in the token
exchange response contains the bearer token to use for the authorization header. The instance_url is the Data Cloud instance
where the Ingestion API is hosted.
3. To upload the data, first create a job. In this example, we’re upserting orders data from an ecomm Ingestion API connector. If
you’re deleting records, use the delete operation instead. You must get a JSON response that includes the job id, with an Open
job state. You’ll need the job id in the next steps.
Request
curl --location --request POST 'https://{instance_url}/api/v1/ingest/jobs' \
--header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"object":"Orders",
"sourceName":"ecomm_api",
"operation":"upsert"
}'
Response
{
"object": "Orders",
"id": "913a8b00-7a9e-4331-aaf6-a019ae5021ab",
"operation": "upsert",
"sourceName": "ecomm_api",
"createdById": "005R0000000zqc8IAA",
"createdDate": "2021-08-12T17:06:42.921387Z",
"systemModstamp": "2021-08-12T17:06:42.921387Z",
"state": "Open",
"contentType": "CSV",
"apiVersion": "v1",
"contentUrl": "/api/v1/ingest/jobs/913a8b00-7a9e-4331-aaf6-a019ae5021ab/batches"
}
4. After creating a job, you're ready to upload your data. You upload the record data using the CSV file you created earlier. You can
submit up to 100 CSV files as part of a job.
136
Ingest Data Get Started with Ingestion API
Request
curl --location --request PUT
'https://{instance_url}/api/v1/ingest/jobs/913a8b00-7a9e-4331-aaf6-a019ae5021ab/batches
' \
--header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: text/csv' \
--data-binary '@orders.csv'
Response
201 Created
5. Once you're done submitting data, close the job to indicate that the job is ready for processing.
Request
curl -v --location --request PATCH
'https://{instance_url}/api/v1/ingest/jobs/913a8b00-7a9e-4331-aaf6-a019ae5021ab' \
--header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"state" : "UploadComplete"
}'
Response
{
"object": "Orders",
"id": "913a8b00-7a9e-4331-aaf6-a019ae5021ab",
"operation": "upsert",
"sourceName": "ecomm_api",
"createdById": "005R0000000zqc8IAA",
"createdDate": "2021-08-12T17:06:42.921387Z",
"systemModstamp": "2021-08-12T17:36:42.921387Z",
"state": "UploadComplete",
"contentType": "CSV",
"apiVersion": "v1",
"contentUrl": "/api/v1/ingest/jobs/913a8b00-7a9e-4331-aaf6-a019ae5021ab/batches"
}
6. Check the job status and results. To get basic status information on a job, such as the overall job state or the number of records
processed, use a Get Job Info request. The job state changes from UploadComplete to either JobComplete or Failed
after the files have been loaded into the data lake.
Request
curl -v --location --request GET
'https://{instance_url}/api/v1/ingest/jobs/913a8b00-7a9e-4331-aaf6-a019ae5021ab' \
--header 'Authorization: Bearer {access_token}' \
Response
{
"object": "Orders",
"id": "913a8b00-7a9e-4331-aaf6-a019ae5021ab",
"operation": "upsert",
137
Ingest Data Streaming Ingestion
"sourceName": "GreasyConnector",
"createdById": "005R0000000zqc8IAA",
"createdDate": "2021-08-12T17:06:42.921387Z",
"systemModstamp": "2021-08-12T18:06:42.921387Z",
"state": "JobComplete",
"contentType": "CSV",
"apiVersion": "v1",
"contentUrl": "/api/v1/ingest/jobs/913a8b00-7a9e-4331-aaf6-a019ae5021ab/batches",
"retries": 0,
"totalProcessingTime": 0
}
Streaming Ingestion
The Data Cloud Ingestion API uses a fire-and-forget pattern to synchronize micro-batches of updates between the source system and
Data Cloud in near-real time. Data is processed asynchronously approximately every 3 minutes.
Insert Records
Load new objects and update existing objects into your Data Cloud data lake table.
Delete Records
Delete records from the data lake table.
Synchronous Record Validation
Quickly validate your payloads synchronously in development mode before you commit records to the lake.
SEE ALSO:
Query Data using Query API V1
Query Data using Query API V1
Data Cloud Reference Guide: Get Started with Ingestion API
Insert Records
Load new objects and update existing objects into your Data Cloud data lake table.
URI
/api/v1/ingest/sources/{name}/{object-name}
Available since release
Data Cloud v1.0, Salesforce v51.0
Formats
JSON
HTTP methods
POST
Authentication
Authorization: Bearer access_token
138
Ingest Data Streaming Ingestion
Request body
Note: All fields defined in the schema must be present in the request payload. This condition holds regardless of whether
the Value Required is set to true or not. If there’s no data available for a certain field on a record, send in a blank value.
curl --location --request POST
'https://{instance_url}/api/v1/ingest/sources/ntotest/exercises_734a9fa2' \
--header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"data": [
{"maid":1,"first_name":"Rachel","last_name":"Rodriquez","email":"[email protected]","gender":"Female","city":"New
York City","state":"NY","created":"2020-04-27T02:48:33Z"}
]
}
'
Request parameters
Parameter Description
Content-Type application/json
name Name of the Ingest API data connector.
object-name Name of the object configured in Ingest API data connector for payload.
Response body
{
"accepted": true
}
Returns a status code of 202 (Accepted), which indicates that the request is accepted and gets processed asynchronously.
Note: For more information on status codes, refer to Status Codes and Error Responses section in Get Started with Ingestion
API.
Delete Records
Delete records from the data lake table.
Note: You can delete up to 200 records using the delete operation. To delete more than 200 records in a request, use bulk
ingestion operations. For more information, see Delete operation in an Upload Job.
URI
/api/v1/ingest/sources/{name}/{object-name}
Available since release
Data Cloud v1.0, Salesforce v51.0
Formats
JSON
HTTP methods
DELETE
139
Ingest Data Streaming Ingestion
Authentication
Authorization: Bearer access_token
Request body
curl --location --request DELETE
'https://{instance_url}/api/v1/ingest/sources/{name}/{object-name}?ids=001xx000003DGb2AAG,003xx000004TmiQAAS'
\
--header 'Authorization: Bearer {access_token}'
Request parameters
Parameter Description
name Name of the Ingest API data connector.
object-name Name of the object configured in Ingest API data connector for payload.
ids The primary keys of the object. ids can be supplied via query parameters or through
the request body.
{
"ids": [
"001xx000003DGb2AAG"
]
}
Response body
{
"accepted": true
}
Returns a status code of 202 (Accepted), which indicates that the request is accepted and it gets processed asynchronously.
Synchronous Record Validation
Quickly validate your payloads synchronously in development mode before you commit records to the lake.
This method provides synchronous validation of object payloads in order to give immediate feedback about the API integration. The
feature is intended to be used during the development phase only. For requests that fail validation, the API response provides the
necessary details to fix the request payload. For requests that pass validation, payloads aren’t persisted downstream.
URI
/api/v1/ingest/sources/{name}/{object-name}/actions/test
Available since release
Data Cloud v1.0, Salesforce v51.0
Formats
JSON
HTTP methods
POST
140
Ingest Data Streaming Ingestion
Authentication
Authorization: Bearer access_token
Request body
Note: All fields defined in the schema must be present in the request payload. This condition holds regardless of whether
the Value Required is set to true or not. If there’s no data available for a certain field on a record, send in a blank value.
curl --location --request POST
'https://{instance_url}/api/v1/ingest/sources/ntotest/exercises/actions/test' \
--header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"data": [
{"id": "f19cae7e-5cdb-41ce-92ba-539afea04f9d","contact_name": "Joe Smith","created_date":
"2021-07-22T08:57:08.118Z","tax_exempt": false,"ship_address": "9818 Main","total":
77506,"tax_rate": 84,"modified_date": "2021-07-05T09:31:44.457Z"},{"id":
"48c8b6a6-8179-4a15-ba19-ec5c8206ce28","contact_name": "Tina
Smith","created_date":"2021-07-08T22:57:02.008Z","tax_exempt": false,"ship_address":
"245 Main","total": 16986,"tax_rate": 61,"modified_date": "2021-07-03T06:20:52.886Z"}
]
}
'
Request parameters
Parameter Description
Content-Type application/json
name Name of the Ingest API data connector.
object-name Name of the object configured in Ingest API data connector for payload.
Response body
{
"timestamp": "2021-08-20T16:34:26.047666Z",
"error": "Bad Request",
"message": "Bad Request: JSON is properly formatted but has a mismatch with
Schema.",
"path": "uri=/api/v1/ingest/sources/ecomm/Orders/actions/test",
"tenantId": "{tenantId}",
"internalErrorCode": "COMMON_ERROR_GENERIC",
"details": {
"validationReport": [{
"record": "{\"contact_name\":\"Joe
Smith\",\"total\":77506,\"tax_exempt\":false,\"id\":\"f19cae7e-5cdb-41ce-92ba-539afea04f9d\",\"created_date\":\"2021-07-22T08:57:08.118Z\",\"ship_address\":\"9818
Main\",\"modified_date\":\"2021-07-05T09:31:44.457Z\",\"tax_rate\":84}",
"causingExceptions": ["#/id: expected type: Number, found: String"]
}, {
"record": "{\"contact_name\":\"Tina
Smith\",\"total\":16986,\"tax_exempt\":false,\"id\":\"48c8b6a6-8179-4a15-ba19-ec5c8206ce28\",\"created_date\":\"2021-07-08T22:57:02.008Z\",\"ship_address\":\"245
141
Ingest Data Bulk Ingestion
Main\",\"modified_date\":\"2021-07-03T06:20:52.886Z\",\"tax_rate\":61}",
"causingExceptions": ["#/id: expected type: Number, found: String"]
}]
}
}
If the request body fails validation, examine the validationReport in the response body to figure out which records failed and what
the reasons were for the failure.
Bulk Ingestion
With the Data Cloud Ingestion API, you can upsert or delete large data sets. Prepare a CSV file for the data you want to upload, create a
job, upload job data, and let Salesforce take care of the rest.
Bulk Jobs and Operations
The Ingestion API upserts or deletes data in Data Cloud using jobs. A bulk job typically goes through following stages:
• Create a job to specify the object type of the data being processed and the operation that’s performed on the data. The operations
supported are upserting bulk data or deleting bulk data.
• After the job is created upload data in CSV format to the job.
• To signal the data is ready to be processed, close the job. You can choose to abort the job if necessary.
• Monitor the progress of the job and act on any failed records.
• Delete a job.
Prepare CSV Files
Lists the field names for the object that you're processing in the first row in the CSV file. Each subsequent row corresponds to a record
in your Data Cloud data lake. All the records in a CSV file must be for the same object. You specify this object when you first create the
job.
• Include all required fields when you create a record.
• Each field-name header in the file must be the same as the Datasource Object's field names. Results only include columns that are
a match.
• Updating records works as a full replace. Patch semantics aren’t supported.
• Files must be in UTF-8 format. Upload data must not exceed 150 MB.
• CSV files are expected to be formatted according to RFC 4180, Common Format, and MIME Type for CSV Files.
• Only supports comma field delimiters.
• Empty field values are set to null.
Example
id,contact_name,created_date,tax_exempt,ship_address,total,tax_rate,modified_date
f19cae7e-5cdb-41ce-92ba-539afea04f9d,Jadyn Kozey,2021-07-22T08:57:08.118Z,false,9818 Walter
Course Apt. 811,77506,84,2021-07-05T09:31:44.457Z
48c8b6a6-8179-4a15-ba19-ec5c8206ce28,Kristina Jakubowski,2021-07-08T22:57:02.008Z,false,245
Schowalter Port Suite 245,16986,61,2021-07-03T06:20:52.886Z
142
Ingest Data Bulk Ingestion
56e005af-cc6c-4f9c-b628-ae6cbbc909cc,Aletha Wilkinson,2021-07-21T04:01:29.838Z,true,7494
Hudson Ports Apt. 123,23907,99,2021-07-18T23:21:43.240Z
Valid Date Format in Records
The Ingestion API supports ISO 8601 UTC with Zulu format.
• Use the yyyy-MM-dd format to specify date values. For example, in 2021-07-05
– yyyy is the four-digit year
– MM is the two-digit month
– dd is the two-digit day
• Use the yyyy-MM-ddTHH:mm:ss.SSSZ format to specify dateTime fields. For example, 2021-07-05T09:31:44.457Z
– yyyy is the four-digit year
– MM is the two-digit month
– dd is the two-digit day
– 'T' is a separator indicating that time-of-day follows
– HH is the two-digit hour
– mm is the two-digit minute
– ss is the two-digit seconds
– SSS is the optional three-digit milliseconds (000=999)
– 'Z' is the reference UTC timezone
Create a Job
Creates a job that represents the bulk operation for loading data into the Data Cloud org.
Upload Job Data
Uploads CSV data for the job to process. A job can consist of up to 100 data files. After all of the data has been uploaded, close the
job to indicate the data is ready to be processed.
Close or Abort a Job
Close a job by updating the job state to UploadComplete. When you close a job, the uploaded data is enqueued for processing.
To abort a job, update the job state to Aborted. If you abort a job, the job doesn’t get queued or processed. Any data uploaded
as part of the aborted job is deleted.
Delete a Job
To delete, a job must have a state of UploadComplete, JobComplete, Aborted, or Failed. When you delete a job, the
stored job data is also deleted and its metadata is removed.
Get Job Info
Retrieves detailed information about the specified job.
Get All Jobs
Retrieves all jobs in Data Cloud.
SEE ALSO:
Data Cloud Reference Guide: Get Started with Ingestion API
143
Ingest Data Bulk Ingestion
Create a Job
Creates a job that represents the bulk operation for loading data into the Data Cloud org.
Creating a data stream in Data Cloud is a prerequisite for creating a job. When the job is created it’s ready to accept data for processing
via Upload Job Data request.
URI
/api/v1/ingest/jobs
Available since release
Data Cloud v1.0, Salesforce v51.0
Formats
JSON
HTTP methods
POST
Authentication
Authorization: Bearer access_token
Request body
Note: All fields defined in the schema must be present in the request payload. This condition holds regardless of whether
the Value Required is set to true or not. If there’s no data available for a certain field on a record, send in a blank value.
{
"object":"my_object",
"sourceName":"my_api_connector",
"operation":"upsert"
}
Request parameters
Parameter Description
object The object type for the data being processed. Use only a single object type per job.
operation The processing operation for the job. Valid values are upsert and delete.
sourceName The name of the connector that represents the source of the object.
Response body
The JSON response body returns a property called id that corresponds to the job id. The state is set to open, which signals that
the job has been created and data can be added to the job. Retain the job id for subsequent steps.
HTTP/1.1 201 Created
{
"id": "4d5a4477-e27f-4bc1-a219-31e79407eade",
"operation": "upsert",
"object": "my_object",
"sourceName": "my_api_connector",
"createdById": "005R0000000sJ1hIAE",
"createdDate": "2021-04-05T13:35:31.000Z",
"systemModstamp": "2021-04-05T13:35:31.000Z",
"state": "Open",
144
Ingest Data Bulk Ingestion
"contentType": "CSV",
"apiVersion": v1,
"contentUrl": "api/v1/ingest/jobs/4d5a4477-e27f-4bc1-a219-31e79407eade/batches"
}
Upload Job Data
Uploads CSV data for the job to process. A job can consist of up to 100 data files. After all of the data has been uploaded, close the job
to indicate the data is ready to be processed.
URI
/api/v1/ingest/jobs/{id}/batches
Available since release
Data Cloud v1.0, Salesforce v51.0
Formats
CSV
HTTP methods
PUT
Authentication
Authorization: Bearer access_token
Request body
Include the CSV file with record data.
curl --location --request PUT 'https://{instance_url}/api/v1/ingest/jobs/{id}/batches'
\
--header 'Content-Type: text/csv' \
--header 'Authorization: Bearer {access_token}' \
--data-binary @type_name-1.csv
HTTP/1.1 202 Accepted
Request parameters
Parameter Description
id The job id returned in the response body from the Create a Job request.
Response body
Returns a status code of 202 (Accepted), which indicates that the job data was successfully uploaded in Data Cloud.
CSV File Layouts for Each Operation
For Upserts: Create a CSV file that has a header row matching the fields in the data stream you defined.
For Deletes: Create a CSV file without any headers, meaning the first row corresponds to raw data, with up to 2 columns. In the first
column, provide the primary key value corresponding to each record that must be deleted. A second column is only necessary for profile
type data or other category type where a record version column was set for the data stream. In such a case, the second column must
contain datetime values greater than the original record, so that the system understands that the deletion request supersedes the original
upsert request.
145
Ingest Data Bulk Ingestion
Example: Profile or Other Category
"f3f7b60d-d8c3-423b-8ee2-4b4d79cfb449","2023-10-26T02:51:28.939Z"
"375907b0-d381-435a-9995-82c6ae995348","2023-10-26T02:51:28.939Z"
"77d07844-eacb-4c81-a5c5-76e35e10e447","2023-10-26T02:51:28.939Z"
"05be4dc0-acc0-4721-93e6-ffa933db6458","2023-10-26T02:51:28.939Z"
"39cd5169-c12c-458f-8e08-dd51c6b06d4e","2023-10-26T02:51:28.939Z"
Example: Engagement Category
"0cbd70f6-3abb-45b0-af78-0535c3849049"
"1b9c134b-7525-4554-bac4-ca660f647458"
"402a1fa1-00fa-40ee-afeb-7a6f9241d518"
"37813397-0427-4f24-b473-10bf22bd0f6e"
"9d20dcd5-a073-42e0-bf85-c30a7d36d1de"
"c1a0014b-6d90-4e16-ada6-aace2d797d2b"
"ede4ef8e-acb6-4b08-90ca-93f318fddef7"
"b5167c8a-bf4f-452d-884f-a8e85e7b59f8"
"4eb81189-86be-4336-8773-207a9f8827ef"
Close or Abort a Job
Close a job by updating the job state to UploadComplete. When you close a job, the uploaded data is enqueued for processing.
To abort a job, update the job state to Aborted. If you abort a job, the job doesn’t get queued or processed. Any data uploaded as
part of the aborted job is deleted.
Any open bulk jobs older than seven days, with state as Open or UploadComplete are deleted from the queue. After a job is closed
or aborted, you can’t add more job data.
URI
/api/v1/ingest/jobs/{id}
Available since release
Data Cloud v1.0, Salesforce v51.0
Formats
JSON
HTTP methods
PATCH
Authentication
Authorization: Bearer access_token
Note: All fields defined in the schema must be present in the request payload. This condition holds regardless of whether the
Value Required in the Ingestion API Connector is set to true or not. If there is no data available for a certain field on a record,
send in a blank value.
Request body
{
"state" : "UploadComplete"
}
146
Ingest Data Bulk Ingestion
Request parameters
Parameter Description
id The job id returned in the response body from the Create Job request.
state The state to update the job to. Use UploadComplete to close a job, or Aborted
to abort a job.
Response body
{
"id": "7505e000001NLkPAAW",
"operation": "upsert",
"object": "Contact",
"createdById": "0055e000003PfMYAA0",
"createdDate": "2021-06-10T13:25:40.000Z",
"systemModstamp": "2021-06-10T13:25:40.000Z",
"state": "UploadComplete",
"contentType": "CSV",
"apiVersion": "v1"
}
Example
curl --location --request PATCH 'https://{instance_url}/api/v1/ingest/jobs/{id}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <access_token>' \
--data-raw '{
"state":"UploadComplete"
}'
< HTTP/1.1 200 OK
< Content-Type: application/json;charset=UTF-8
< Transfer-Encoding: chunked
<
{"id":"7505e000001NLkPAAW","operation":"upsert","object":"Contact","createdById":"0055e000003PfMYAA0","createdDate":"2021-06-10T13:25:40.000Z","systemModstamp":"2021-06-10T13:25:40.000Z","state":"UploadComplete","contentType":"CSV","apiVersion":1}
Delete a Job
To delete, a job must have a state of UploadComplete, JobComplete, Aborted, or Failed. When you delete a job, the
stored job data is also deleted and its metadata is removed.
URI
/api/v1/ingest/jobs/{id}
Available since release
Data Cloud v1.0, Salesforce v51.0
Formats
JSON
147
Ingest Data Bulk Ingestion
HTTP methods
DELETE
Authentication
Authorization: Bearer access_token
Request body
None required.
Request parameters
Parameter Description
id The job id that is returned in the response body from the Create a Job request.
Response body
Returns a status code of 204 (No Content), which indicates that the job was successfully deleted.
Example
curl --location --request DELETE '
https://{instance_url}/api/v1/ingest/jobs/{id}' \
--header 'Authorization: Bearer {access_token'
HTTP/1.1 204 No Content
Usage Notes
When a job is deleted, job data stored by Salesforce is also deleted and job metadata information is removed. You can no longer discover
the job in Get Job Info or Get All Jobs.
Get Job Info
Retrieves detailed information about the specified job.
URI
/api/v1/ingest/jobs/{id}
Available since release
Data Cloud v1.0, Salesforce v51.0
Formats
JSON
HTTP methods
GET
Authentication
Authorization: Bearer access_token
Request body
curl --location --request GET
'https://{instance_url}/api/v1/ingest/jobs/4d5a4477-e27f-4bc1-a219-31e79407eade'
148
Ingest Data Bulk Ingestion
\
--header 'Authorization: Bearer {access_token}'
Request parameters
Parameter Description
id The job id returned in the response body from the Create Job request.
Response body
HTTP/1.1 200 OK
{
"id": "4d5a4477-e27f-4bc1-a219-31e79407eade",
"operation": "upsert",
"object": "runners__c",
"createdById": "005R0000000sJ1hIAE",
"createdDate": "2021-04-08T14:29:53.000Z",
"systemModstamp": "2021-04-08T14:29:53.000Z",
"state": "Open",
"contentType": "CSV",
"apiVersion": 1,
"contentUrl": "api/v1/ingest/jobs/4d5a4477-e27f-4bc1-a219-31e79407eade/batches",
"retries": 0,
"totalProcessingTime": 0
}
Get All Jobs
Retrieves all jobs in Data Cloud.
URI
/api/v1/ingest/jobs
Available since release
Data Cloud v1.0, Salesforce v51.0
Formats
JSON
HTTP methods
GET
Authentication
Authorization: Bearer access_token
Request body
curl --location --request GET 'https://{instance_url}/api/v1/ingest/jobs/' \
--header 'Authorization: Bearer {access_token}'
149
Ingest Data Create an Amazon S3 Data Stream
Request parameters
Parameter Description
limit The number of records to return. Defaults to 20. Maximum up to 100 records per
request.
offset Number of rows to skip before returning.
orderBy The field used to order job definition results. The default order is by systemModstamp.
states Get jobs in specific states. Valid states are Open, UploadComplete, Failed, Aborted, and
JobComplete. The parameter’s value can be a comma-delimited list.
Response body
HTTP/1.1 200 OK
{
"data": [{
"id": "4d5a4477-e27f-4bc1-a219-31e79407eade",
"operation": "upsert",
"object": "MyCdpObject",
"createdById": "005R0000000sJ1hIAE",
"createdDate": "2021-04-08T14:29:53.000Z",
"systemModstamp": "2021-04-08T14:29:53.000Z",
"states": "Open",
"contentType": "CSV",
"apiVersion": "v1",
"contentUrl": "api/v1/ingest/jobs/4d5a4477-e27f-4bc1-a219-31e79407eade/batches"
}, {
"id": "9d5a4477-e27f-4bc1-a219-31e79407eade",
...
}]
}
Create an Amazon S3 Data Stream
Create a data stream to programmatically stream data from an Amazon S3 data source. With the data stream you can ingest data into
your Data Cloud data lake.
Get familiar with Using Metadata API, and then complete these steps to create your data stream.
1. Define metadata in your local client application.
This diagram describes how each object relates to other objects.
150
Ingest Data Create an Amazon S3 Data Stream
2. Create a zip file with package.xml. For more information, see Deploying and Retrieving Metadata with the Zip File.
3. Use the deploy() call to move your metadata package from your local file system to Data Cloud.
151
Ingest Data Post Data from an Amazon S3 Data Source
4. Note the data stream definition ID so that you can use it in your POST request.
After you create the POST request or include the credentials in the Data Connector S3 XML metadata, update the Amazon S3
credentials of the data stream in Data Cloud.
5. Create a POST request for the User Interface API to create the data stream. When a new data stream is created, a data lake object
gets created to store the data ingested from the data stream.
Post Data from an Amazon S3 Data Source
Use the POST method to stream data from an Amazon S3 data source.
SEE ALSO:
Salesforce Help: Create a Cloud Storage Data Stream
DataStreamDefinition
DataSource
MktDataTranObject
ExternalDataConnector
ObjectSourceTargetMap
DataConnectorS3
Get Started with User Interface API
Post Data from an Amazon S3 Data Source
Use the POST method to stream data from an Amazon S3 data source.
Syntax
HTTP method
POST
Availability
Version 51.0 and later.
Formats
REST
URI
/services/data/<vZZ.0>/ui-api/records
Note: Substitute ZZ with the version of the API.
Example
URI
Post /services/data/v51.0/ui-api/records
152
Ingest Data Post Data from an Amazon S3 Data Source
Request Body
{
"apiName": "DataStream",
"fields": {
"Name": "{DATA STREAM NAME}",
"DataStreamDefinitionId" : "{DATA STREAM DEFINITION ID}",
"RefreshFrequency": "Hourly",
"RefreshMode" : "Upsert"
}
}
Request parameters
Parameter Description
apiName Name of the entity that you’re creating.
Name The name of the data stream.
DataStreamDefinitionId The id of the data stream definition that must be associated with the data stream. This
id must be available when you create the setup entities via metadata api CRUD or
deploy.
RefreshFrequency None, Hourly, Weekly. You must provide the day of the week via:
RefreshDayOfWeek
Monthly. You must provide the day of the month via:
RefreshDayOfMonth
RefreshMode Upsert and Full_Refresh are supported.
Response
{
"apiName": "DataStream",
"childRelationships": {},
"eTag": "9e9cb5c9a3e9db2e75918fa9b5b20815",
"fields": {
"CreatedBy": {
"displayValue": "Admin User",
"value": {
"apiName": "User",
"childRelationships": {},
"eTag": "8941f8da5501cf307f51e59c936e434b",
"fields": {
"Id": {
"displayValue": null,
"value": "005R0000000d9SfIAI"
},
153
Ingest Data Post Data from an Amazon S3 Data Source
"Name": {
"displayValue": null,
"value": "Admin User"
}
},
"id": "005R0000000d9SfIAI",
"lastModifiedById": "005R0000000d9SfIAI",
"lastModifiedDate": "2021-03-24T19:03:56.000Z",
"recordTypeId": null,
"recordTypeInfo": null,
"systemModstamp": "2021-03-31T22:47:39.000Z",
"weakEtag": 1617230859000
}
},
"CreatedById": {
"displayValue": null,
"value": "005R0000000d9SfIAI"
},
"CreatedDate": {
"displayValue": "4/2/2021, 2:50 PM",
"value": "2021-04-02T21:50:23.000Z"
},
"DataStreamStatus": {
"displayValue": "Processing",
"value": "PROCESSING"
},
"ImportRunStatus": {
"displayValue": "None",
"value": "NONE"
},
"IsRefreshDeliveryHourAutomatic": {
"displayValue": null,
"value": false
},
"LastNumberOfRowsAddedCount": {
"displayValue": null,
"value": null
},
"LastRefreshDate": {
"displayValue": null,
"value": null
},
"Name": {
"displayValue": null,
"value": "s3-ui-api"
},
"RefreshDayOfMonth": {
"displayValue": null,
"value": null
},
"RefreshDayOfWeek": {
"displayValue": null,
"value": null
},
154
Ingest Data Rotation of S3 Credentials with Metadata API
"RefreshFrequency": {
"displayValue": "Hourly",
"value": "HOURLY"
},
"RefreshHours": {
"displayValue": null,
"value": null
},
"RefreshMode": {
"displayValue": "Upsert",
"value": "UPSERT"
},
"TotalNumberOfRowsAdded": {
"displayValue": null,
"value": null
},
"TotalRowsProcessed": {
"displayValue": null,
"value": null
}
},
"id": "1dsR000000002zzIAA",
"lastModifiedById": "005R0000000d9SfIAI",
"lastModifiedDate": "2021-04-02T21:50:23.000Z",
"recordTypeId": "012000000000000AAA",
"recordTypeInfo": null,
"systemModstamp": "2021-04-02T21:50:23.000Z",
"weakEtag": 1617400223000
}
Rotation of S3 Credentials with Metadata API
Use the Metadata API to rotate the S3 credentials and enable access to AWS. To update the S3 credentials you must retrieve the metadata
of S3 connectors, modify the S3 credentials, and deploy the metadata.
Familiarize Yourself with Salesforce CLI
You can retrieve or deploy S3 connector metadata by using Salesforce CLI. We recommend that you get familiar with using either of the
options to ensure a smooth update of S3 credentials.
Define the Metadata of the S3 Connector
You can use an unpackage.xml file to define the metadata to retrieve. In this case, include the DataConnectorS3 metadata type.
Include all the S3 connectors that you want to update the credentials for. This sample unpackage.xml file illustrates how to work
with S3 connector metadata. A best practice is to name the unpackage.xml file with a low-level qualifier of .xml such as
DataConnectorS3.xml.
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
155
Ingest Data Rotation of S3 Credentials with Metadata API
<members>Contact_Point_Addr</members>
<name>DataConnectorS3</name>
</types>
<types>
<members>Contact_Point_Phone</members>
<name>DataConnectorS3</name>
</types>
<types>
<members>Contact_Point_Email</members>
<name>DataConnectorS3</name>
</types>
<version>54.0</version>
</Package>
Note: Save the file to a directory that Salesforce CLI can access.
Retrieve the Metadata of S3 Data Connector
Refer to Retrieve S3 Connector Metadata with Salesforce CLI and retrieve the metadata for the S3 data connector.
Update the S3 Access Key and Secret Key
1. Extract the contents of the metadata file.
mkdir <location to unzip>
cd <location to unzip>
unzip <filename.zip to unzip> (the default filename will be unpackaged.xml)
Here’s how the extracted folder structure looks like.
2. Edit the files referenced in the s3DataConnectors directory. Update the attributes s3AccessKey and s3SecretKey.
Here's a sample of the contents of the files for S3 connectors metadata.
<?xml version="1.0" encoding="UTF-8"?>
<DataConnectorS3 xmlns="http://soap.sforce.com/2006/04/metadata">
<delimiter>,</delimiter>
156
Ingest Data Rotation of S3 Credentials with Metadata API
<fileNameWildcard>ContactPointEmail_*.csv</fileNameWildcard>
<importFromDirectory>DTX_2020_01/ContactPointEmail/</importFromDirectory>
<masterLabel>Contact_Contact_Point_Email_DTX_01</masterLabel>
<s3AccessKey>*</s3AccessKey>
<s3BucketName>asd-aws-s3-bucket-01</s3BucketName>
<s3SecretKey>*</s3SecretKey>
</DataConnectorS3>
Create the S3 Connectors Package for Deployment
After changes are made to all S3 Connectors files, create a zipped package. Make sure that the package.xml file is at the top-most
level of the package. Navigate down to the unpackaged directory and run this command.
cd <location of unzipped files>
zip -r -X s3Connectors.zip *
Here’s the output of the command.
adding: package.xml (deflated 60%)
adding: s3DataConnectors/ (stored 0%)
adding: s3DataConnectors/Contact_Contact_Point_Addr_DTX_01.s3DataConnector (deflated
43%)
adding: s3DataConnectors/Contact_Contact_Point_Phone_DTX_01.s3DataConnector (deflated
43%)
adding: s3DataConnectors/Contact_Contact_Point_Email_DTX_01.s3DataConnector (deflated
43%)
Deploy DataConnectorS3 Metadata
Refer to Deploy S3 Connector Metadata with Salesforce CLI to deploy the metadata for the S3 data connector.
Verify the Metadata Deployment
To verify if the metadata is deployed, refresh an impacted data stream where the S3 access key and secret key are modified. Click Refresh
Now on at least one of the data streams to validate the change. A successful refresh indicates a successful update of S3 credentials.
157
Ingest Data Retrieve S3 Connector Metadata with Salesforce CLI
Retrieve S3 Connector Metadata with Salesforce CLI
You can retrieve the metadata of an S3 Connector by using Salesforce CLI.
Deploy S3 Connector Metadata with Salesforce CLI
Use Salesforce CLI to deploy the metadata package.
Retrieve S3 Connector Metadata with Salesforce CLI
You can retrieve the metadata of an S3 Connector by using Salesforce CLI.
Complete the prerequisite of Defining the Metadata of S3 Connector
1. Authorize your org so Salesforce CLI can access it by logging into the org. This command redirects you to the default browser.
sf org login web --instance-url https://MyDomainName.my.salesforce.com --alias <Alias>
--set-default
CLI login is a one-time task. The login details are saved so that a username or alias can get used for future logins.
158
Ingest Data Deploy S3 Connector Metadata with Salesforce CLI
2. Retrieve the S3 connector metadata by using this command. The file referenced in the command must be the name of the
unpackage.xml created in Defining the Metadata of S3 Connector step.
sf project retrieve start --manifest=<Filename>.xml --target-metadata-dir <Result
Directory> --target-org <Default User from Login>
Retrieving v59.0 metadata from <org> using the v59.0 SOAP API
Preparing retrieve request... Succeeded
Wrote retrieve zip file to /Users/adray/Downloads/unpackaged.zip.
The file retrieved has the name unpackage.zip. Rename the file recognizably to use in later steps.
Proceed to Update the S3 access key and secret key attributes on page 155.
Deploy S3 Connector Metadata with Salesforce CLI
Use Salesforce CLI to deploy the metadata package.
Complete the prerequisite of Creating the S3 Connectors Package for Deployment
1. Use this command to deploy the S3 connector package.
Note: When deploying to a production instance of Salesforce the testing level must be declared by adding --test-level. In
most cases, the test level is RunLocalTests. This option runs the fewest tests.
sf project deploy start --verbose --single-package --target-org <Username from Login>
--wait 1 --metadata-dir s3Connectors.zip
Deploying <version specified in manifest> metadata to <org> using the v59.0 SOAP API.
Deploy ID: 0Af8D00000r5EhGSAU
Status: Succeeded | ████████████████████████████████████████ | 3/3 Components (Errors:0)
| 0/0 Tests (Errors:0)
Deployed Source
=================================================================================================================================
| State Name Type Path
| ─────── ───────────────────────────────── ──────────────
───────────────────────────────────────────────────────────────────
| package.xml
| Created Contact_Contact_Point_Addr_DTX_01 DataConnectorS3
s3DataConnectors/Contact_Contact_Point_Addr_DTX_01.s3DataConnector
| Created Contact_Contact_Point_Email_DTX_01 DataConnectorS3
s3DataConnectors/Contact_Contact_Point_Email_DTX_01.s3DataConnector
| Created Contact_Contact_Point_Phone_DTX_01 DataConnectorS3
s3DataConnectors/Contact_Contact_Point_Phone_DTX_01.s3DataConnector
Proceed to Verify the Metadata Deployment on page 155.
159
CHAPTER 4 Model Data in Data Cloud
In this chapter ... Learn about the key terms and concepts related to data ingestion and modeling in Data Cloud. Find
reference material on standard data model objects (DMOs), including fields, descriptions, and relationships,
• Standard Data Model along with mappings associated with starter data bundles.
Objects (DMOs)
• Starter Data Bundles
Customer 360 Data Model
Customer 360 Data Model is the standard data model used by Data Cloud to aid in data modeling and
extensibility across platforms.
Data Model Objects (DMOs) and Data Lake Objects
(DLOs)
DMOs are groupings of data created from data streams, insights, and other sources. DMOs can be standard
or custom, based on business need. They’re physical and virtual views of a data lake objects (DLOs). DLOs
are storage containers within the data lake for the data ingested into all data streams within Data Cloud.
Starter Data Bundles
A starter data bundle is a Salesforce-defined data stream definition that includes mapping to Data Cloud
DMOs. After a data stream is deployed, the starter data bundle automatically maps source objects from
the source to a DMO in Data Cloud. You can add or customize the data mappings to meet your business
needs.
Related Content
Salesforce Developer: Standard Objects
Salesforce Help: Data Model Concepts
Salesforce Architects: Data Model Diagrams for Data Cloud
Trailhead: Customer 360 Data Model for Data Cloud
Salesforce Help: Data Model Subject Areas
Salesforce Help: Data Types and Date Formats
160
Model Data in Data Cloud Standard Data Model Objects (DMOs)
Standard Data Model Objects (DMOs)
Data model objects (DMOs) are groupings of data created from data streams, insights, and other sources. Find reference information
about the standard DMOs found in Data Cloud.
Account DMO
The Account DMO is a Data Cloud data model object for how a party wants to interact with your company. Provided in both the
Sales and Service Data Kits.
Account Contact DMO
The Account Contact DMO is a Data Cloud data model object for an individual who has a role specific to an account. Provided in
both the Sales and Service Data Kits.
Affiliation DMO
The Affiliation DMO is a Data Cloud data model object for affiliation or how to map data Marketing Cloud Engagement business unit
use cases.
Agent Service Presence DMO
The Agent Service Presence DMO is a Data Cloud data model object (DMO) for a presence user’s real-time presence status.
Agent Work DMO
The Agent Work DMO is a Data Cloud data model object (DMO) for a work assignment that has been routed to an agent.
Agent Work Skill DMO
The Agent Work Skill DMO is a Data Cloud data model object (DMO) for a for a skill used to route a work assignment to an agent.
Authorization Form DMO
The Authorization Form DMO is a Data Cloud data model object (DMO) for the set of terms and conditions, such as privacy policy,
contract, or consent forms.
Authorization Form Consent DMO
The Authorization Form Consent DMO is a Data Cloud data model object (DMO). This DMO captures the where, when, and how a
party gives consent for a form, a set of terms and conditions, or a privacy policy.
Authorization Form Data Use DMO
The Authorization Form Data Use data model object (DMO) is a Data Cloud DMO for the data uses consented to in an authorization
form.
Authorization Form Text DMO
The Authorization Form Text DMO is a Data Cloud data model object (DMO) for an authorization form’s text and language settings.
Benefit Action DMO
The Benefit Action DMO is a Data Cloud data model object (DMO) for actions triggered when a program benefit is assigned to a
loyalty program member.
Benefit Type DMO
The Benefit Type DMO is a Data Cloud data model object (DMO) for the types of benefits of a loyalty program, such as healthcare,
financial, and loyalty.
Brand DMO
The Brand DMO is a Data Cloud data model object (DMO) for the product’s brand, for example, Northern Trail Outfitters.
Card Account DMO
Represents a financial tool offered by a bank as a type of loan, with a line of revolving credit that you can access via your card and
your card's account. Provided in the Financial Services Cloud Data Kit. This DMO is available in API version 58 and later.
161
Model Data in Data Cloud Standard Data Model Objects (DMOs)
Case DMO
The Case DMO is a Data Cloud data model object (DMO) for support cases based on recorded issues, for example, a laptop connectivity
problem. Provided in both the Sales and Service Data Kits.
Case Update DMO
The Case Update DMO is a Data Cloud data model object (DMO) for a for historical information about changes made to the associated
case.
Communication Subscription DMO
The Communication Subscription DMO is a Data Cloud data model object (DMO) for a customer’s subscription preferences for a
specific communication.
Communication Subscription Channel Type DMO
The Communication Subscription Channel Type DMO is a Data Cloud data model object (DMO) for the engagement channel through
which a customer is reached for a communication subscription.
Communication Subscription Consent DMO
The Communication Subscription Consent DMO is a Data Cloud data model object (DMO) for the engagement or communication
channel preferences of a customer.
Communication Subscription Timing DMO
The Communication Subscription Timing DMO is a Data Cloud data model object (DMO) for a customer's timing preferences for
receiving a communication subscription.
Consent Action DMO
The Consent Action DMO is a Data Cloud data model object (DMO) for what a user consents to be done with their data, for example,
data collection or web activity tracking.
Consent Status DMO
The Consent Status DMO is a Data Cloud data model object (DMO) for the status of consent, for example opted in or out of data
collection.
Contact Point Address DMO
The Contact Point Address data model object (DMO) is a Data CloudDMO based on the mailing address of a party. Provided in both
the Sales and Service Data Kits.
Contact Point App DMO
The Contact Point App DMO is a Data Cloud data model object for the software application of a party on a specific device.
Contact Point Consent DMO
The Contact Point Consent DMO is a Data Cloud data model object (DMO) for recording information about consent for a specific
contact point. This data includes when, how, for how long, and whether the party has double opted-in.
Contact Point Email DMO
The Contact Point Email DMO is a Data Cloud data model object for the email address of a party. Provided in both the Sales and
Service Data Kits.
Contact Point Phone DMO
The Contact Point Phone data model object (DMO) is a Data Cloud DMO for the phone number of a party. Provided in both the Sales
and Service Data Kits.
Contact Point Social DMO
The Contact Point Social DMO is a Data Cloud data model object (DMO) for the social media handle for a party, for example
@trustednews on Twitter.
162
Model Data in Data Cloud Standard Data Model Objects (DMOs)
Conversation Entry Transcript Excerpt DMO
The Conversation Entry Transcript Excerpt DMO is a Data Cloud data model object for a portion of a Conversation Entry that includes
a portion of a transcript.
Conversation Reason DMO
The Conversation Reason DMO is a Data Clouddata model object for the reason a conversation started. It contains aggregated metrics
for excerpts. Example values include cancel order, update order, and check on order status.
Conversation Reason Category DMO
The Conversation Reason Category DMO is a Data Cloud data model object for a grouping of conversation reasons that have the
same overall topic. It contains aggregated metrics for the associated conversation reasons. Example values include Order Management,
Payments, and Account Management.
Conversation Reason Report Definition DMO
The Conversation Reason Report Definition DMO is a Data Cloud data model object for a conversation mining report that contains
an overview of the conversational data shape and groups of conversation reasons and excerpts.
Conversation Reason Report Segment Def DMO
The Conversation Reason Report Segment Def DMO is a Data Cloud data model object for a segment definition of a conversation
reason report.
Data Use Legal Basis DMO
The Data Use Legal Basis DMO is a Data Cloud data model object (DMO) for the legal reason for contacting a customer, such as
billing or contract.
Data Use Purpose DMO
The Data Use Purpose DMO is a Data Cloud data model object (DMO) for the purpose of contacting a prospect or customer, such
as for billing, marketing, or surveys.
Deposit Account DMO
Represents a subtype of a financial account. Provided in the Financial Services Cloud Data Kit. This DMO is available in API version
58 and later.
Data Use Purpose Consent Action DMO
The Data Use Purpose Consent Action DMO is a Data Cloud data model object (DMO) for individual consent preferences for consent
actions.
Device DMO
The Device data model object (DMO) is a Data Cloud DMO for a specific electronic unit that you want to track signals from, for
example, a refrigerator, watch, or car.
Device Application Engagement DMO
The Device Application Engagement DMO is a Data Cloud data model object (DMO) for data about device engagement, for example
mobile app usage.
Device Application Template DMO
The Device Application Template DMO is a Data Cloud data model object (DMO) for a reusable standard format for applications to
exchange information between devices.
Email Engagement DMO
The Email Engagement DMO is a Data Cloud data model object (DMO) for data captured from various data sources about engagement
in the Email channel.
Email Message DMO
The Email Message DMO is a Data Cloud data model object (DMO) for an email message, usually text, but possibly HTML, including
attachments sent or received over the network.
163
Model Data in Data Cloud Standard Data Model Objects (DMOs)
Email Publication DMO
The Email Publication DMO is a Data Cloud data model object (DMO) that contains information about a publication such as a
campaign or an orchestration used in the Email channel
Email Template DMO
The Email Template DMO is a Data Cloud data model object (DMO) for the standard form of an email message that can be personalized
and customized based on a campaign.
Engagement Channel Type DMO
The Engagement Channel Type DMO is a Data Cloud data model object (DMO) for which channels are supported by individual
preferences. For example, individuals can set consent preferences for SMS but not for a phone call.
Engagement Channel Type Consent DMO
The Engagement Channel Type Consent DMO is a Data Cloud data model object (DMO) for an individual’s consent preferences
specific to a type of communication, such as email.
Engagement Topic DMO
The Engagement Topic DMO is a Data Cloud data model object (DMO) that is used to refer to multiple topics such as multiple
campaigns or promotions.
Financial Account Balance DMO
Represents types of balances associated to a financial account. Provided in the Financial Services Cloud Data Kit. This DMO is available
in API version 58 and later.
Financial Account DMO
Represents a financial account held at a financial institution such as a bank. Provided in the Financial Services Cloud Data Kit. This
DMO is available in API version 58 and later.
Financial Account Fee DMO
Represents fees associated with a financial account. Provided in the Financial Services Cloud Data Kit. This DMO is available in API
version 58 and later.
Financial Account Interest Rate DMO
Represents the interest rate associated with a financial account. Provided in the Financial Services Cloud Data Kit. This DMO is available
in API version 58 and later.
Financial Account Limit DMO
Represents the limits associated with a financial account. Provided in the Financial Services Cloud Data Kit. This DMO is available in
API version 58 and later.
Financial Account Party DMO
Represents the role of an organization account or person account related to a financial account. Provided in the Financial Services
Cloud Data Kit. This DMO is available in API version 58 and later.
Financial Account Transaction DMO
Represents transactions related to a financial account. There can be various types of transactions such as credit, debit, and so forth.
Provided in the Financial Services Cloud Data Kit. This DMO is available in API version 58 and later.
Financial Customer DMO
Represents an extension of an account to capture financial services attributes. Provided in the Financial Services Cloud Data Kit. This
DMO is available in API version 58 and later.
Financial Goal DMO
Represents the money to achieve a financial goal such as education or home purchase. Provided in the Financial Services Cloud Data
Kit. This DMO is available in API version 58 and later.
164
Model Data in Data Cloud Standard Data Model Objects (DMOs)
Financial Goal Party DMO
Represents an association between a financial goal and the related party. Provided in the Financial Services Cloud Data Kit. This DMO
is available in API version 58 and later.
Financial Holding DMO
Represents the financial holdings associated with either an account or a financial account. Provided in the Financial Services Cloud
Data Kit. This DMO is available in API version 58 and later.
Financial Security DMO
Represents a financial holding such as securities, bonds, mutual funds, and so forth in relation to either an account or a financial
account (investment account). Provided in the Financial Services Cloud Data Kit. This DMO is available in API version 58 and later.
Flow DMO
The Flow DMO is a Data Cloud data model object (DMO) for details about a flow.
Flow Element DMO
The Flow Element DMO is a Data Cloud data model object (DMO) for details about a single element within a flow version.
Flow Element Run DMO
The Flow Element Run DMO is a Data Cloud data model object (DMO) for the status of a single element executed within a flow run.
Flow Run DMO
The Flow Run DMO is a Data Cloud data model object (DMO) for details about a single execution of a flow.
Flow Version DMO
The Flow Version DMO is a Data Cloud data model object (DMO) for details about a version of a flow.
Goods Product DMO
The Goods Product DMO is a Data Cloud data model object (DMO) for a specific product, for example a carton of milk or a set of
towels
Individual
The Individual DMO is a Data Cloud data model object for contacts, customers, or other people interested in your company's products
or services.
Insurance Policy DMO
Represents an insurance policy. Provided in the Financial Services Cloud Data Kit. This DMO is available in API version 58 and later.
Interest Tag Definition DMO
Represents products, services, features in which a party has expressed interest. Provided in the Financial Services Cloud Data Kit. This
DMO is available in API version 58 and later.
Investment Account DMO
Represents a subtype of a financial account. Provided in the Financial Services Cloud Data Kit. This DMO is available in API version
58 and later.
Knowledge Article Engagement DMO
Stores the user engagement details related to a Knowledge Article. It’s a logical subtype of EngagementAction. Provided by the
Knowledge Engagement Ingestion API. This DMO is available in API version 58 and later.
Lead DMO
The Lead data model object (DMO) is a Data Cloud DMO for a person or company that shows interest in a company’s products or
services.
Loan Account DMO
Represents a subtype of financial account. Provided in the Financial Services Cloud Data Kit. This DMO is available in API version 58
and later.
165
Model Data in Data Cloud Standard Data Model Objects (DMOs)
Loyalty Benefit DMO
The Loyalty Benefit DMO is a Data Cloud data model object (DMO) for a perk or betterment that is available to the members of a
Loyalty Program. Examples include waived airline baggage fees, complimentary hotel stays, or a rental car upgrade.
Loyalty Benefit Type DMO
The Loyalty Benefit Type DMO is a Data Cloud data model object (DMO) for the type of loyalty benefit, such as rewards or gift cards.
Loyalty Journal Subtype DMO
The Loyalty Journal Subtype DMO is a Data Cloud data model object (DMO) for a subtype of a loyalty journal type, such as a watched
video or product review.
Loyalty Journal Type DMO
The Loyalty Journal Type DMO is a Data Cloud data model object (DMO) for the type of loyalty journal.
Loyalty Ledger DMO
The Loyalty Ledger DMO is a Data Cloud data model object (DMO) to record the points credited or debited for a member across
transactions.
Loyalty Member Currency DMO
The Loyalty Member Currency DMO is a Data Cloud data model object (DMO) representing the value a loyalty member selects to
receive, for example, as airline miles or as points.
Loyalty Member Tier Data Model Object
The Loyalty Member Tier DMO is a Data Cloud data model object (DMO) for the benefit tier within the program that a member is
assigned.
Loyalty Partner Product DMO
The Loyalty Partner Product DMO is a Data Cloud data model object (DMO) for a product offered by a loyalty program partner, such
as a coupon from another company.
Loyalty Program DMO
The Loyalty Program DMO is a Data Cloud data model object (DMO) for a strategy designed to encourage customers to continue
to be loyal to the business associated with the program.
Loyalty Program Currency DMO
The Loyalty Program Currency DMO is a Data Cloud data model object (DMO) representing the value or currency that the loyalty
program offers to customers.
Loyalty Program Member Data Model Object
The Loyalty Program Member DMO is a Data Cloud data model object (DMO) for a person who has joined a loyalty program.
Loyalty Program Member Promotion DMO
The Loyalty Program Member Promotion DMO is a Data Cloud data model object (DMO) that represents details about a promotion
available to a loyalty program member. For example, if a program allows double points on outdoor purchases.
Loyalty Program Partner DMO
The Loyalty Program Partner DMO is a Data Cloud data model object (DMO) for companies with loyalty program offerings.
Loyalty Tier DMO
The Loyalty Tier DMO is a Data Cloud data model object (DMO) for a level of a loyalty program where member benefits increase at
higher levels of the hierarchy.
Loyalty Tier Benefit DMO
The Loyalty Tier Benefit DMO is a Data Cloud data model object (DMO) for a benefit that is available in a specific loyalty member tier.
166
Model Data in Data Cloud Standard Data Model Objects (DMOs)
Loyalty Tier Group DMO
The Loyalty Tier Group DMO is a Data Cloud data model object (DMO) for loyalty programs that have multiple tiers of benefits. Tiers
can be organized based on objectives, for example, lifetime, marketing, or regular.
Loyalty Transaction Journal DMO
The Loyalty Transaction Journal DMO is a Data Cloud data model object (DMO) for a collection of transactions related to a loyalty
program. Loyalty Transaction Journals are related to a voucher, but could relate to other payment method types.
Market Journey Activity DMO
The Market Journey Activity data model object (DMO) is a Data Cloud DMO for a step or activity within a journey in Journey Builder.
Master Product DMO
The Master Product DMO is a Data Cloud data model object (DMO) for data about a company’s products.
Market Segment DMO
The Market Segment DMO is a Data Cloud data model object (DMO) for a group of people who share one or more common
characteristics, grouped for marketing purposes.
Member Benefit DMO
The Member Benefit DMO is a Data Cloud data model object (DMO) for a benefit available within the loyalty program that a member
is qualified for and has elected to receive.
Message Engagement DMO
The Message Engagement DMO is a Data Cloud data model object (DMO) for a user’s engagement with a marketing message.
Operating Hours DMO
The Operating Hours DMO is a Data Cloud data model object (DMO) for when a business or business function is available for use.
Opportunity DMO
The Opportunity DMO is a Data Cloud data model object (DMO) for deals or sales that are in progress and not yet completed.
Opportunity Product DMO
The Opportunity Product DMO is a Data Cloud data model object (DMO) for connecting an opportunity to the product that it
represents, allowing for a many-to-many relationship.
Order Delivery Method DMO
The Order Delivery Method data model object (DMO) is a Data Cloud DMO for the order and delivery methods for products or service
fulfillment.
Party Consent DMO
The Privacy Consent DMO is a Data Cloud data model object (DMO) for an individual’s consent preferences.
Party DMO
Represents information about who you are dealing with. Provided in the Financial Services Cloud Data Kit. This DMO is available in
API version 58 and later.
Party Financial Asset DMO
Represents a financial asset associated with an individual or an organization. For example, cash in hand, owned property, and so
forth. Provided in the Financial Services Cloud Data Kit. This DMO is available in API version 58 and later.
Party Financial Liability DMO
Represents a financial liability associated with an individual or an organization. For example a mortgage or loan. Provided in the
Financial Services Cloud Data Kit. This DMO is available in API version 58 and later.
Party Identification DMO
The Party Identification DMO is a Data Cloud data model object for the ways to identify a party, such as a driver’s license or a birth
certificate.
167
Model Data in Data Cloud Standard Data Model Objects (DMOs)
Party Interest Tag DMO
Represents an association between a party and interest tag. Provided in the Financial Services Cloud Data Kit. This DMO is available
in API version 58 and later.
Payment Method DMO
Represents the way a customer pays for a transaction.
Person Life Event DMO
Represents a major life event for an individual. Provided in the Financial Services Cloud Data Kit. This DMO is available in API version
58 and later.
Privacy Consent Log DMO
The Privacy Consent Log DMO is a Data Cloud data model object (DMO) for information about a user’s requested consent and privacy
information.
Product Browse Engagement DMO
Product Browse Engagement DMO is a Data Cloud data model object (DMO) for data captured from a user action, such as searching
for products or viewing a list of products.
Product Catalog DMO
The Product Catalog DMO is a Data Cloud data model object (DMO) for a company’s inventory or merchandising catalog.
Product Catalog Category DMO
The Product Catalog Category DMO is a Data Cloud data model object (DMO) for the category of the product catalog, such as shoes,
trucks, or housewares.
Product Category DMO
The Product Category data model object (DMO) is a Data Cloud DMO for the types of products a company has or offers, such as
shoes or types of services.
Product Category Product DMO
The Product Category Product data model object (DMO) is a Data Cloud DMO used to identify how products are assigned to categories.
For example, Northern Trail Outfitters can use this DMO to identify how a specific running shoe is assigned to a shoe and running
categories.
Product Order Engagement DMO
The Product Order Engagement DMO is a Data Cloud data model object (DMO) for a user’s online shopping order data.
Promotion DMO
The Promotion DMO is a Data Cloud data model object (DMO) for loyalty promotion details such as the type of promotion.
Record Alert DMO
Represents record alerts for an account. Provided in the Financial Services Cloud Data Kit. This DMO is available in API version 58 and
later.
Promotion Loyalty Partner Product DMO
The Promotion Loyalty Partner Product DMO is a Data Cloud data model object (DMO) for the promotion of a product that a partner
is co-marketing to loyalty program members.
Sales Order DMO
The Sales Order DMO is a Data Cloud data model object (DMO) that provides information around current and pending sales orders.
Sales Order Product DMO
The Sales Order Product DMO is a Data Cloud data model object (DMO) for the component of a sales order that identifies a product
or service to be sold to the customer.
168
Model Data in Data Cloud Standard Data Model Objects (DMOs)
Sales Store DMO
The Sales Store DMO is a Data Cloud data model object (DMO) that provides information regarding a retail establishment selling
items to the public.
Service Presence Status DMO
The Service Presence Status DMO is a Data Cloud data model object (DMO) for a presence status that can be assigned to a service
channel. For example, Available for Leads, Out for Lunch, or Busy.
Shopping Cart Engagement DMO
The Shopping Cart Engagement DMO is a Data Cloud Data Platform data model object (DMO) for data captured from user actions,
such as adding and removing items from a shopping cart.
Shopping Cart Event Type DMO
The Shopping Cart Event Type DMO is a Data Cloud data model object (DMO) for when a customer interacts with a commerce site’s
shopping cart.
Shopping Cart Product Engagement DMO
The Shopping Cart Product Engagement DMO is a Data Cloud data model object (DMO) for data captured from user actions, such
as adding and removing items from a shopping cart.
Skill DMO
The Skill DMO is a Data Cloud data model object (DMO) for proficiency, competence, or expertise that an employee possesses, which
is useful to the mission of an organization.
SMS Publication DMO
The SMS Publication DMO is a Data Cloud data model object (DMO) for the process that sends out a set of SMS messages to multiple
recipients.
SMS Template DMO
The SMS Template DMO is a Data Cloud data model object (DMO) for a reusable, standard format for text (SMS) messages.
Software Application DMO
The Software Application DMO is a Data Cloud data model object (DMO) for defining programs created for the end user, such as an
app for Northern Trail Outfitters loyalty members.
Survey DMO
The Survey DMO is a Data Cloud data model object (DMO) for a survey.
Survey Invitation DMO
The Survey Invitation DMO is a Data Cloud data model object (DMO) for the invitation sent to a participant to complete the survey.
Survey Question DMO
The Survey Question DMO is a Data Cloud data model object (DMO) for a question in a survey under a section.
Survey Question Response DMO
The Survey Question Response DMO is a Data Cloud data model object (DMO) for participants who answer specific questions.
Survey Question Section DMO
The Survey Question Section DMO is a Data Cloud data model object (DMO) for a section, such as the title section or a question
section, in a survey.
Survey Response DMO
The Survey Response DMO is a Data Cloud data model object (DMO) for an answer to a survey question.
Survey Subject DMO
The Survey Subject DMO is a Data Cloud data model object (DMO) for a relationship between a survey and another object, such as
an account or a case.
169
Model Data in Data Cloud Account DMO
Survey Version DMO
The Survey Version DMO is a Data Cloud data model object (DMO) for a version of the survey.
User DMO
The User DMO is a Data Cloud data model object (DMO) for an account, a person or a machine, that can log in to use the deployed
software system.
User Group DMO
The User Group DMO is a Data Cloud data model object (DMO) for a set of system users with common characteristics. User Groups
are often created to simplify the granting of system privileges and granting access to resources.
Voucher DMO
The Voucher DMO is a Data Cloud data model object (DMO) for a loyalty program’s voucher.
Voucher Definition DMO
The Voucher Definition DMO is a Data Cloud data model object (DMO) for details about a voucher definition associated with a loyalty
program.
Web Search Engagement DMO
The Web Search Engagement DMO is a Data Cloud data model object (DMO) for web search engagement data.
Website Engagement DMO
The Website Engagement DMO is a Data Cloud data model object (DMO) for any data associated with website engagement, such
as views or clicks.
Account DMO
The Account DMO is a Data Cloud data model object for how a party wants to interact with your company. Provided in both the Sales
and Service Data Kits.
Object API Name
ssot__Account__dlm
Category
Profile
Primary Subject Area
Party
Primary Key
Account ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field Data Bundle
Account Account ID Many To One (N:1) Individual Individual ID Sales
170
Model Data in Data Cloud Account DMO
Object Field Cardinality Related Object Related Field Data Bundle
Account Bill Contact Address Many To One (N:1) Contact Point Contact Point Service
Address Address ID
Account Parent Account Many To One (N:1) Account Account ID Service
Account Contact Account ID Many To One (N:1) Account Account ID Service
Case Account Many To One (N:1) Account Account ID Service
Contact Point Party Many To One (N:1) Account Account ID Sales, Service
Address
Contact Point App Party Many To One (N:1) Account Account ID Sales
Contact Point Email Party Many To One (N:1) Account Account ID Sales, Service
Contact Point Phone Party Many To One (N:1) Account Account ID Service
Financial Account Account ID Many To One (N:1) Account Account ID Financial Services
Party Cloud
Financial Customer Account ID Many To One (N:1) Account Account ID Financial Services
Cloud
Financial Holding Account ID Many To One (N:1) Account Account ID Financial Services
Cloud
Loyalty Program Account Many To One (N:1) Account Account ID Sales
Member
Loyalty Program Partner Account Many To One (N:1) Account Account ID Sales
Partner
Payment Method Account ID Many To One (N:1) Account Account ID Financial Services
Cloud
Record Alert Account ID Many To One (N:1) Account Account ID Financial Services
Cloud
Voucher Definition Partner Account Many To One (N:1) Account Account ID Sales
All Fields
Field Name Field API Name Description Data Data
Type Bundle
Account Business Type ssot___AccountBusinessType__c The business type of the account. text Service
Account Description ssot___Description__c A text description of the contact Sales,
account. Service
Account ID ssot__Id__c A unique ID used as the primary key for text Sales,
the account DMO. Service
171
Model Data in Data Cloud Account DMO
Field Name Field API Name Description Data Data
Type Bundle
Account Name ssot__Name__c The name of the contact account. text Sales,
Service
Account Number ssot__number__c The number assigned to the contact text Sales,
account. Service
Account Ownership Type ssot__AccountOwnershipType__c The ownership type of the account. text Service
Account Rating Type ssot__AccountRatingType__c The rating type of the account. text Service
Account Source ssot__AccountSource__c The source of the account. text Service
Account Type ssot__AccountTypeId__c The reference ID for the type of contact text Sales,
account, for example, a loyalty account Service
or business credit account.
Account Service ssot__AccountServiceEntitlements__c text Sales,
Entitlements Service
Account Website URL ssot__AccountWebsiteURL__c The website URL for the account. Service
Annual Revenue Amount ssot__AnnualRevenueAmount__c The annual revenue amount for the number Service
account.
Assign Territory Flag ssot__AssignTerritoryFlag__c An indicator if an account needs an text Sales,
assigned territory. Service
Auto Pay Enabled Flag ssot__AutoPayEnabledFlag__c An indicator if auto pay is enabled for text Sales,
this contact. Service
Auto Payment Amount ssot__AutoPaymentAmount__c The amount to be automatically paid number Sales,
next time. Service
Auto Payment Amount ssot__AutoPaymentAmountCurrency__c The currency of the auto payment text Sales,
Currency amount. Service
Auto Payment Method sot__AutoPaymentMethodId__c A reference ID for the payment method text Sales,
for auto pay, for example a credit card Service
or bank account.
Balance Amount ssot__BalanceAmount__c The number in an account balance, for number Sales,
example, 100 points, 3 miles, or 6 visits. Service
Balance Amount ssot__BalanceAmountCurrency__c The balance amount’s currency. text Sales,
Currency Service
Balance Amount Limit ssot__BalanceAmountLimit__c The max balance allowed, for example text Sales,
a credit limit. Service
Balance Amount Limit ssot__BalanceAmountLimitCurrency__c The balance amount limit’s currency. text Sales,
Currency Service
172
Model Data in Data Cloud Account DMO
Field Name Field API Name Description Data Data
Type Bundle
Balance Unit Of Measure ssot__BalanceUnitOfMeasureId__c A reference ID for the unit of measure text Sales,
for balance, for example money, points, Service
or miles.
Balance Unit Of Measure ssot__BalanceUnitOfMeasureCurrencyId__c A reference ID for the currency type text Sales,
Currency used if balance unit of measure is Service
money.
Bill Contact Address ssot__BillContactAddressId__c A reference ID for the contact point text Sales,
billing address. Service
Bill Delivery Method ssot__BillDeliveryMethodId__c A reference ID for the preference to text Sales,
send the bill via electronic or physical Service
mail delivery.
Bill Frequency ssot__BillFrequency__c The frequency for billing the account. text Service
Contact Point Address ssot__ContactPointAddressId__c A reference ID for the contact point text Service
address.
Contact Point App ssot__ContactPointAppId__c A reference ID for the contact point app. text Service
Contact Point Email ssot__ContactPointEmailId__c A reference ID for the contact point text Service
email.
Contact Point Location ssot__ContactPointLocationId__c A reference ID for the contact point text Service
location.
Contact Point Phone ssot__ContactPointPhoneId__c A reference ID for the contact point text Service
phone.
Contact Point Social ssot__ContactPointSocialId__c A reference ID for the contact point text Service
social.
Created Date ssot__CreatedDate__c The date the record was created. dateTime Sales,
Service
Data Source ssot__DataSourceId__c A reference ID for the logical name of text Sales,
the object where this record came from, Service
whether that is a name of a cloud
storage file or another connector’s
external object.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of text Sales,
the object where this record came from, Service
whether that is a name of a cloud
storage file or another connector’s
external object.
Default Freight Terms ssot__DefaultFreightTermsId__c A reference ID to the standard freight text Sales,
terms for this contact for example, Free Service
On Board Shipping Point (FOB).
173
Model Data in Data Cloud Account DMO
Field Name Field API Name Description Data Data
Type Bundle
Default Price Book ssot__DefaultPriceBookId__c A reference ID to the standard price text Sales,
book for this contact. Service
Effective Date ssot__EffectiveDate__c The effective date of the record. dateTime Service
Employee Count ssot__EmployeeCount__c The count of employees. number Service
End Date ssot__EndDate__c The end date of the record. dateTime Service
External Record ID ssot__ExternalRecordId__c A reference ID for an external data text Sales,
source system. Service
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which text Sales,
the external record ID was assigned. Service
Fax Phone ssot__FaxPhoneId__c A reference ID to the fax number for the text Sales,
account. Service
General Ledger Account ssot_GeneralLedgerAccountId__c A reference ID for a contact’s financial text Sales,
account where credit and debits are Service
posted.
Hold Status Reason ssot__HoldStatusReasonId__c A reference ID for the reason why the text Sales,
account is on hold. Service
Individual ssot__IndividualId__c A reference ID for the individual Service
associated with the account.
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text Sales,
other internal organization that owns Service
the business account.
Is Active ssot__IsActive__c An indicator if the account is active. text Service
Is Customer ssot__IsCustomer__c An indicator if the account is a customer text Service
account.
Is Internal ssot__IsInternal__c An indicator if the account is an internal text Service
account.
Is Partner ssot__IsPartner__c An indicator if the account is a partner text Service
account.
Is Seller ssot__IsSeller__c An indicator if the account is a seller text Service
account.
Is Supplier ssot__IsSupplier__c An indicator if the account is a supplier text Service
account.
Last Activity Date ssot__LastActivityDate__c The date of the most recent account dateTime Sales,
activity. Service
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the dateTime Sales,
record. Service
174
Model Data in Data Cloud Account DMO
Field Name Field API Name Description Data Data
Type Bundle
Next Interaction Date ssot__NextInteractionDate__c The date when the account should be dateTime Service
contacted again.
Next Review Date ssot__NextReviewDate__c The date when the account should be dateTime Service
reviewed again.
Ninety Day Balance ssot__NinetyDayBalanceAmount__c The account balance 90 days ago. number Sales,
Amount Service
Ninety Day Balance ssot__NinetyDayBalanceAmountCurrency__c The 90-day account balance currency. text Sales,
Amount Currency Service
Operating Hours ssot__OperatingHoursId__c A reference ID to the operating hours text Sales,
associated with the account. Service
Order Delivery Method ssot__OrderDeliveryMethodId__c A reference ID to the standard method text Sales,
for delivery such as overnight or Service
in-person pickup.
Organization ssot__OrganizationId__c A reference ID to the account text Service
organization.
Parent Account ssot__ParentAccountId__c A reference ID to the parent contact text Sales,
account. Service
Party ssot__PartyId__c A reference ID to the parent party, for text Sales,
example, an individual, business, or Service
affiliation group.
Tip: This ID is the same as the
one used in the individual
object.
Party Object ssot__PartyObjectId__c A reference ID to the associated party text Service
object.
Party Role ssot__PartyRoleId__c A reference ID to the associated party text Sales,
role, for example, a customer, supplier, Service
or competitor.
Party Web Address ssot__PartyWebAddressId__c A reference ID to the associated party text Service
web address.
Payment Term ssot__PaymentTerm__c The payment term for the account. text Service
Primary Industry ssot__PrimaryIndustry__c The primary industry for the account. text Service
Primary Sales Contact ssot__PrimarySalesContactPointId__c A reference ID for the best way to text Sales,
Point communicate with the contact Service
regarding sales.
175
Model Data in Data Cloud Account DMO
Field Name Field API Name Description Data Data
Type Bundle
Primary Sales Rep ssot__PrimarySalesRepId__c A reference ID for the sales owner of the text Sales,
account. Service
Review Frequency ssot__ReviewFrequency__c The frequency for reviewing the text Service
account.
Sales Phone ssot__SalesPhoneId__c A reference ID for the phone number text Sales,
for this account. Service
Shipping Address ssot__ShippingAddressId__c A reference ID for the shipping billing text Sales,
address. Service
Shipping Contact ssot__ShippingContactId__c A reference ID for the shipping contact. text Sales,
Service
Shipping Email ssot__ShippingEmailId__c A reference ID for the email used for text Sales,
shipping inquiries. Service
Shipping Phone ssot__ShippingPhoneId__c A reference ID for the phone for text Sales,
shipping inquiries. Service
Sixty Day Balance ssot__SixtyDayBalanceAmount__c The account balance 60 days ago. number Sales,
Amount Service
Sixty Day Balance ssot__SixtyDayBalanceAmountCurrency__c The 60-day account balance currency. text Sales,
Amount Currency Service
SLA Expiration Date ssot__SLAExpirationDate__c The date when a Service Level dateTime Sales,
Agreement (SLA) expires. Service
SLA Type ssot__SLATypeId__c A reference ID for the contact’s Service text Sales,
Level Agreement (SLA) type. Service
Source System Identifier ssot__SourceSystemIdentifier__c The identifier for the source system. text Service
Source System Modified ssot__SourceSystemModifiedDateTime__c The date and time for when the source dateTime Service
Date system was modified.
Thirty Day Balance ssot__ThirtyDayBalanceAmount__c The account balance 30 days ago. number Sales,
Amount Service
Thirty Day Balance ssot__ThirtyDayBalanceAmountCurrency__c The 30-day account balance currency. text Sales,
Amount Currency Service
Use As Billing Account ssot__UseAsBillingAccount__c An indicator if the account is used for text Sales,
billing purposes. Service
Use As Sales Account ssot__UseAsSalesAccount__c An indicator if the account is used for text Sales,
sales. Service
Use As Service Account ssot__UseAsServiceAccount__c An indicator if the account is used for text Sales,
service. Service
176
Model Data in Data Cloud Account Contact DMO
Field Name Field API Name Description Data Data
Type Bundle
Use As Shipping Account ssot__UseAsShippingAccount__c An indicator if the account is used for text
shipping purposes.
Website ssot__WebsiteAddr__c The website address for the account. text Service
Account Contact DMO
The Account Contact DMO is a Data Cloud data model object for an individual who has a role specific to an account. Provided in both
the Sales and Service Data Kits.
Object API Name
ssot__AccountContact__dlm
Category
Profile
Primary Subject Area
Party
Primary Key
Account Contact ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field Data Bundle
Account Contact Account Many To One (N:1) Account Account ID Sales, Service
Account Contact Business Phone Many To One (N:1) Contact Point Phone Contact Point Phone Service
Id
Account Contact Individual Many To One (N:1) Individual Individual ID Sales, Service
Account Contact Contact Email Many To One (N:1) Contact Point Email Contact Point Email Sales, Service
ID
Account Contact Mailing Address Many To One (N:1) Contact Point Contact Point Service
Address Address Id
Case Account Contact Many To One (N:1) Account Contact Contact Point Service
Address ID
177
Model Data in Data Cloud Account Contact DMO
Object Field Cardinality Related Object Related Field Data Bundle
Financial Account Account Contact ID Many To One (N:1) Account Contact ID Financial Services
Party Cloud
Survey Invitation Participant Many To One (N:1) Account Contact Account Contact ID Service
Survey Response Submitter Many To One (N:1) Account Contact Account Contact ID Service
Survey Subject Survey Subject Many To One (N:1) Account Contact Account Contact ID Service
All Fields
Field Name Field API Name Description Data Data
Type Bundle
Account ssot__AccountId__c A reference ID to the account where text Sales,
this contact is included or linked. Service
Account Contact ID ssot__Id__c A unique ID used as the primary key text Sales,
for the account contact DMO. Service
Account Contact Roles ssot__AccountContactRoles__c The business role of the contact at the text Sales,
account. Service
Assistant Name ssot__AssistantName__c The name of the contact’s assistant. text Sales,
Service
Assistant Phone ssot__AssistantPhone__c The phone number of the assistant. text Sales,
Service
Business Phone ssot__BusinessPhoneId__c A reference ID to the phone number text Sales,
for the contact. Service
Contact Email ssot__ContactEmailId__c A reference ID to the email address text Sales,
for the contact. Service
Contact Note ssot__ContactNote__c A description of the contact. text Sales,
Service
Created Date ssot__CreatedDate__c The date the record was created. dateTime Sales,
Service
Data Source ssot__DataSourceId__c A reference ID for the logical name for text Sales,
a system that is the source of records Service
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of text Sales,
the object where this record came Service
from, whether that is a name of a
cloud storage file or another
connector’s external object.
Deceased ssot__DeceasedDateTime__c text Service
178
Model Data in Data Cloud Account Contact DMO
Field Name Field API Name Description Data Data
Type Bundle
Department Name ssot__DepartmentName__c The department the contact works in. text Sales,
Service
External Record ID ssot__ExternalRecordId__c A reference ID for an external data text Sales,
source system. Service
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which text Sales,
the external record ID was assigned. Service
Fax Phone ssot__FaxPhoneId__c A reference ID for the fax number for text Sales,
the contact. Service
First Name ssot__FirstName__c The first name of the contact. text Service
Gender ssot__Gender__c The gender of the contact. text Service
Home Phone ssot__HomePhoneId__c A reference ID for the home phone text Sales,
number for the contact. Service
Indirect Relation ssot__IndirectRelationAccountContactId__c A reference ID to a contact with an text Sales,
Account Contact indirect relationship to the account Service
contact.
Individual ssot__IndividualId__c A reference ID for the person that is text Sales,
the contact for the account. Service
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text Sales,
other internal organization that owns Service
the business account.
Last Activity Date ssot__LastActivityDate__c The date of the most recent account dateTime Sales,
activity. Service
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified dateTime Sales,
the record. Service
Last Name ssot__LastName__c The last name of the contact. text Service
Mailing Address ssot__MailingAddressId__c A reference ID to the mailing address. text Sales,
Service
Marital Status ssot__MaritalStatus__c The marital status of the contact. text Service
Middle Name ssot__MiddleName__c The middle name of the contact. text Service
Mobile Phone ssot__MobilePhoneId__c A reference ID to the contact’s mobile text Sales,
phone number. Service
Other Contact Address ssot__OtherContactAddressId__c A reference ID to another contact text Sales,
address. Service
Person Name ssot__PersonName__c The person name of the contact. text Service
179
Model Data in Data Cloud Affiliation DMO
Field Name Field API Name Description Data Data
Type Bundle
Reports To Account ssot__ReportsToAccountContactId__c A reference ID to the contact’s text Sales,
Contact manager. Service
Sequence In Multiple ssot__SequenceMultipleBirthNumber__c number Service
Birth
Title ssot__Title__c The contact’s title for example, vice text Sales,
president or specialist. Service
Affiliation DMO
The Affiliation DMO is a Data Cloud data model object for affiliation or how to map data Marketing Cloud Engagement business unit
use cases.
Object API Name
ssot__Affiliation__dlm
Category
Other
Primary Subject Area
Party
Primary Key
Affiliation ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Affiliation Party Many To One (N:1) Individual Individual ID
All Fields
Field Name Field API Name Description Data
Type
Affiliated To ssot__AffiliatedTo__c Provides info about the business unit like brand or region. text
180
Model Data in Data Cloud Agent Service Presence DMO
Field Name Field API Name Description Data
Type
Tip: Default mapping is to a Marketing Cloud
Engagement MID. This field ensures activations
are sent to the right business unit.
Affiliation ID ssot__Id__c A unique ID used as the primary key for the affiliation text
DMO.
Affiliation Type ssot__AffiliationType__c The type or category of the affiliation such as product text
category.
Data Source ssot__DataSourceId__c A reference ID for the logical name for a system that is text
the source of records identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the object where text
this record came from, whether that is a name of a cloud
storage file or another connector’s external object.
External Record ID ssot__ExternalRecordId__c A reference ID for an external data source system. text
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the external record text
ID was assigned.
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or other internal text
organization that owns the business account.
Party ssot__PartyId__c A reference ID to the parent party, for example, an text
individual, business, or affiliation group.
Tip: This ID is the same as the one used in the
individual object.
Agent Service Presence DMO
The Agent Service Presence DMO is a Data Cloud data model object (DMO) for a presence user’s real-time presence status.
Object API Name
ssot__AgentServicePresence__dlm
Category
Other
Primary Subject Area
User Service Presence
181
Model Data in Data Cloud Agent Service Presence DMO
Primary Key
Case ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Agent Service Presence Service Presence Status Many To One: N:1 Service Presence Status Agent Work Status Id
Agent Service Presence User Many To One: N:1 User User ID
All Fields
Field Name Field API Name Description Data
Type
Agent Service Presence Id ssot__Id__c A unique ID used as the primary key for text
the agent service presence DMO.
At Capacity Duration ssot__AtCapacityDuration__c The duration a service agent was at number
capacity.
Average Capacity ssot__AverageCapacity__c The average capacity for a service agent. number
Away ssot__IsAway__c An indicator if a service agent is away. text
Configured Capacity ssot__ConfiguredCapacity__c The configured capacity for a service number
agent.
Current State ssot__IsCurrentState__c An indicator of the current state of a text
service agent.
Data Source ssot__DateSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DateSourceObjectId___c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
Description ssot__Description__c The description for the service agent text
presence.
Idle Duration ssot__IdleDuration__c The duration a service agent was idle. number
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
agent service presence.
Name ssot__Name__c The name of a service agent. text
182
Model Data in Data Cloud Agent Work DMO
Field Name Field API Name Description Data
Type
Service Presence Status Id ssot__ServicePresenceStatusId__c A reference ID to the status of the agent text
service presence.
Status Duration ssot__StatusDuration__c The duration a service agent status lasted. number
Status End Date ssot__StatusEndDate__c The date a service agent status ended. dateTime
Status Start Date ssot__StatusStartDate__c The date a service agent status started. dateTime
User ID ssot__UserId__c A reference Id to the agent service text
presence user.
Agent Work DMO
The Agent Work DMO is a Data Cloud data model object (DMO) for a work assignment that has been routed to an agent.
Object API Name
ssot__AgentWork__dlm
Category
Engagement
Primary Subject Area
Agent Work
Primary Key
Case ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Agent Work Related To Many To One: N:1 Case Case ID
Agent Work User Group Many To One: N:1 User Group User Group ID
Agent Work User Many To One: N:1 User User ID
Agent Work Skill Agent Work Many To One: N:1 Agent Work Agent Work ID
183
Model Data in Data Cloud Agent Work DMO
All Fields
Field Name Field API Name Description Data
Type
Accept Date ssot__AcceptDate__c The date the agent work was accepted. dateTime
Active Time ssot__ActiveTimeSeconds__c The time an agent is active on work in number
seconds.
After Conversation Work ssot__AftConvWorkTimeActual__c The actual time an agent works after a number
Actual Time conversation.
After Conversation Work ssot__AftConvWorkExtensionCount__c The count an agent works extended time. number
Extension Count
Agent Work Id ssot__Id__c A unique ID used as the primary key for text
the agent work DMO.
Agent Work Routing Type ssot__AgentWorkRoutingType__c The routing type for agent work. text
Agent Work Routing Type ssot__AgentWorkStatus__c The status of the agent work. text
Bot ssot__BotId___c A reference ID to the agent work bot. text
Close Date ssot__CloseDateTime__c The date the agent work was closed. dateTime
Data Source ssot__DateSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DateSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
Description ssot__Description__c The description of the agent work. text
Handle Time ssot__HandleTimeSeconds__c The time to handle agent work in number
seconds.
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
agent service presence.
Name ssot__Name__c The name of the agent work. text
Preferred User ssot__PreferredUserId__c A reference ID to the preferred user for text
the agent work.
Related To ssot__RelatedToId__c A reference ID to the related item for the text
agent work.
Request DateTime ssot__RequestDateTime__c The date the agent work was requested. dateTime
Speed To Answer ssot__SpeedToAnswerSeconds__c The time to answer the agent work in number
seconds.
184
Model Data in Data Cloud Agent Work Skill DMO
Field Name Field API Name Description Data
Type
User ssot__UserId__c A reference Id to the agent work user. text
User Group ssot__UserGroupId__c A reference Id to the agent work user text
group.
Agent Work Skill DMO
The Agent Work Skill DMO is a Data Cloud data model object (DMO) for a for a skill used to route a work assignment to an agent.
Object API Name
ssot__AgentWorkSkill__dlm
Category
Other
Primary Subject Area
Agent Work Skill
Primary Key
Case ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Agent Work Skill Agent Work Many To One: N:1 Agent Work Agent Work ID
Agent Work Skill Skill Many To One: N:1 Skill Skill ID
All Fields
Field Name Field API Name Description Data
Type
Additional Skill ssot__AdditionalSkill__c An indicator if the agent work skill is an text
additional skill.
Agent Work ssot__AgentWorkId__c A reference ID to the agent work for the text
agent work skill.
185
Model Data in Data Cloud Authorization Form DMO
Field Name Field API Name Description Data
Type
Agent Work Skill Id ssot__Id__c A unique ID used as the primary key for text
the agent work DMO.
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
Description ssot__Description__c The description of the agent work skill. text
Dropped ssot__IsDropped__c An indicator if the agent work skill has text
been dropped.
Internal Organization ssot__InternalOrganizationId___c A reference ID to the business unit or text
other internal organization that owns the
agent service presence.
Name ssot__Name__c The name of the agent work skill. text
Skill ssot__SkillId__c A reference ID to the skill for the agent text
work skill.
Skill Level ssot__SkillLevel__c The level of the skill. number
Skill Priority ssot__SkillPriority__c The priority of the skill. number
Authorization Form DMO
The Authorization Form DMO is a Data Cloud data model object (DMO) for the set of terms and conditions, such as privacy policy,
contract, or consent forms.
Object API Name
ssot__AuthorizationForm__dlm
Category
Other
Primary Subject Area
Privacy
186
Model Data in Data Cloud Authorization Form DMO
Primary Key
Authorization Form Id (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Authorization Form Data Authorization Form ID Many To One: N:1 Authorization Form Authorization Form ID
Use
All Fields
Field Name Field API Name Description Data
Type
Authorization Form ID ssot__Id__c A unique ID used as primary key for the text
Authorization Form DMO.
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
Details URL ssot__DetailsURL__c A URL link with details about terms and text
conditions.
Effective From Date ssot__EffectiveFromDate__c The date when consent form is in effect. dateTime
Effective To Date ssot__EffectiveToDate__c The date when consent form is no longer dateTime
in effect.
External Record ID ssot__ExternalRecordId__c A reference ID for an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
data record.
Revision Number ssot__RevisionNumber__c A free text field to store a revision number text
for consent form, for example "rev1.21".
Summary Text ssot__SummaryText__c A summary of consent form content. text
187
Model Data in Data Cloud Authorization Form Consent DMO
Authorization Form Consent DMO
The Authorization Form Consent DMO is a Data Cloud data model object (DMO). This DMO captures the where, when, and how a party
gives consent for a form, a set of terms and conditions, or a privacy policy.
Object API Name
ssot__AuthorizationFormConsent__dlm
Category
Other
Primary Subject Area
Privacy
Primary Key
Authorization Form Consent ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Authorization Form Party Many To One: N:1 Individual Individual ID
Consent
Authorization Form Authorization Form Text Many To One: N:1 Authorization Form Text Authorization Form Text
Consent ID
Authorization Form Consent Status Many To One: N:1 Consent Status Consent Status ID
Consent
Authorization Form Engagement Channel Many To One: N:1 Engagement Channel Engagement Channel
Consent Type Type Type ID
All Fields
Field Name Field API Name Description Data
Type
Authorization Form Text ssot__AuthorizationFormTextId__c A reference ID to an authorization form’s text
text and language settings.
AuthorizationFormConsent ssot__Id__c A unique ID used as the primary key for text
ID the Authorization Form Consent DMO.
188
Model Data in Data Cloud Authorization Form Consent DMO
Field Name Field API Name Description Data
Type
Consent Captured Date ssot__ConsentCapturedDateTime__c The date and time consent was captured. dateTime
Time
Consent Captured Source ssot__ConsentCapturedSourceName__c The location consent was captured. text
Consent Status ssot__ConsentStatusId__c A reference ID to the status of consent, text
for example opted in or out of data
collection.
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by an external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
Effective From Date ssot__EffectiveFromDate__c The date when a consent form is in effect. dateTime
Effective To Date ssot__EffectiveToDate__c The date when a consent form is no dateTime
longer in effect.
Engagement Channel Type ssot__EngagementChannelTypeId__c A reference ID to the channels supported text
by individual preferences.
Entity ssot__EntityId__c A reference ID to the entity related to the text
authorization consent form.
External Record ID ssot__ExternalRecordId__c A reference ID to an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
business account.
Name ssot__Name__c The name of the authorization consent text
form.
Party ssot__PartyId__c A reference ID to the parent party, for text
example, an individual, business, or
affiliation group.
Party Role ssot__PartyRoleId__c A reference ID to an associated party role, text
for example, a customer, supplier, or
competitor.
189
Model Data in Data Cloud Authorization Form Data Use DMO
Authorization Form Data Use DMO
The Authorization Form Data Use data model object (DMO) is a Data Cloud DMO for the data uses consented to in an authorization
form.
Object API Name
ssot__AuthorizationFormDataUse__dlm
Category
Other
Primary Subject Area
Privacy
Primary Key
Authorization Form Data Use ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Authorization Form Data Data Use Purpose ID Many To One: N:1 Data Use Purpose Data Use Purpose ID
Use
Authorization Form Data Authorization Form ID Many To One: N:1 Authorization Form Authorization Form ID
Use
All Fields
Field Name Field API Name Description Data
Type
Authorization Form Data ssot__Id__c A unique ID used as the primary key for text
Use ID the Authorization Form Data Use DMO.
Authorization Form ID ssot__AuthorizationFormId__c A reference ID to a set of terms and text
conditions, such as privacy policy,
contract, and consent form. This field
name includes version numbers and
associated references to external
documents.
Data Source ssot__DataSourceId__c A reference ID for a system’s logical name text
that is the source of records identified by
an external record ID.
190
Model Data in Data Cloud Authorization Form Text DMO
Field Name Field API Name Description Data
Type
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record originated. For
example, the name of a cloud storage file
or another connector’s external object.
Data Use Purpose ID ssot__DataUsePurposeId__c A reference ID for the reason for text
contacting a prospect or customer, for
example, billing, marketing, or surveys.
External Record Id ssot__ExternalRecordId__c A reference ID for an external data source text
system.
External Source Id ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
data record.
Authorization Form Text DMO
The Authorization Form Text DMO is a Data Cloud data model object (DMO) for an authorization form’s text and language settings.
Object API Name
ssot__AuthorizationFormText__dlm
Category
Other
Primary Subject Area
Privacy
Primary Key
Authorization Form Text ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Authorization Form Authorization Form Text Authorization Form Text Authorization Form Text
Consent ID
Authorization Form Text Authorization Form Authorization Form Authorization Form
191
Model Data in Data Cloud Benefit Action DMO
All Fields
Field Name Field API Name Description Data
Type
Authorization Form ssot__AuthorizationFormId__c A reference ID to set of terms and text
conditions (such as privacy policy,
contract, and consent form), including
version numbers and associated
references to external documents.
Authorization Form Text ssot__Id__c A unique ID used as primary key for the text
Authorization Form Text DMO.
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
External Record ID ssot__ExternalRecordId__c A reference ID for an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
data record.
Locale ssot__LocaleId__c A reference ID to range of longitudes text
where common standard time is used.
Version Number ssot__VersionNumber__c An edition or variant of the authorization text
form text.
Benefit Action DMO
The Benefit Action DMO is a Data Cloud data model object (DMO) for actions triggered when a program benefit is assigned to a loyalty
program member.
Object API Name
ssot__BenefitAction__dlm
Category
Other
192
Model Data in Data Cloud Benefit Action DMO
Primary Subject Area
Loyalty
Primary Key
Benefit Action ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Loyalty Benefit Benefit Action Many To One: N:1 Benefit Action Benefit Action ID
All Fields
Field Name Field API Name Description Data
Type
Benefit Action ID ssot__Id__c A unique ID used as primary key for the text
Benefit Action DMO.
Benefit Action Process Type ssot__BenefitActionProcessTypeId__c A reference ID to the benefit action text
process type, such as loyalty or rebates.
Created Date ssot__CreatedDate__c The date the record was created. dateTime
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
Description ssot__Description__c A description of the benefit action. text
External Record ID ssot__ExternalRecordId__c A reference ID for an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
data record.
Is Benefit Expiration ssot__IsBenefitExpirationAllowed__c An indicator if the benefits expire. text
Allowed
193
Model Data in Data Cloud Benefit Type DMO
Field Name Field API Name Description Data
Type
Is Benefit Update Allowed ssot__IsBenefitUpdateAllowed__c An indicator if updates can be made to text
benefits.
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the dateTime
record.
Benefit Type DMO
The Benefit Type DMO is a Data Cloud data model object (DMO) for the types of benefits of a loyalty program, such as healthcare, financial,
and loyalty.
Object API Name
ssot__BenefitType__dlm
Category
Other
Primary Subject Area
Loyalty
Primary Key
Benefit Type ID (ssot__Id__c)
Relationships
There are no relationships related to this DMO.
All Fields
Field Name Field API Name Description Data
Type
Benefit Type ID ssot__Id__c A unique ID used as primary key for the text
Benefit Type DMO.
Created Date ssot__CreatedDate__c The date the record was created. dateTime
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
194
Model Data in Data Cloud Brand DMO
Field Name Field API Name Description Data
Type
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external
object.
External Record ID ssot__ExternalRecordId__c A reference ID for an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which text
the external record ID was assigned.
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
data record.
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the dateTime
record.
Name ssot__Name__c The name of the benefit type. text
Brand DMO
The Brand DMO is a Data Cloud data model object (DMO) for the product’s brand, for example, Northern Trail Outfitters.
Object API Name
ssot__Brand__dlm
Category
Other
Primary Subject Area
Product
Primary Key
Brand ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Goods Product Brand Many To One: N:1 Brand Brand ID
195
Model Data in Data Cloud Card Account DMO
Object Field Cardinality Related Object Related Field
Bundle Product Brand Many To One: N:1 Brand Brand ID
Master Product Brand Many To One: N:1 Brand Brand ID
Loyalty Transaction Brand Many To One: N:1 Brand Brand ID
Journal
All Fields
Field Name Field API Name Description Data
Type
Brand Grade ssot__BrandGradeId__c A reference ID to the brand’s grade, for text
example, premium or regular.
Brand ID ssot__Id__c A unique ID used as primary key for the text
Brand DMO.
Created Date ssot__CreatedDate__c The date the record was created. dateTime
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
External Record ID ssot__ExternalRecordId__c A reference ID to an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
business account.
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the dateTime
record.
Name ssot__Name__c The brand name of a product, for example text
Northern Trail Outfitters.
Parent Brand ssot__ParentBrandId__c A reference ID to the parent brand. text
Card Account DMO
Represents a financial tool offered by a bank as a type of loan, with a line of revolving credit that you can access via your card and your
card's account. Provided in the Financial Services Cloud Data Kit. This DMO is available in API version 58 and later.
196
Model Data in Data Cloud Card Account DMO
API Name
ssot__CardAccount__dlm
Category
Profile
Primary Subject Area
Financial Account
Primary Key
Card Account ID (ssot__Id__c)
Relationships
DMO Label DMO Field Label Cardinality Related DMO Related DMO Data Bundle or
Label Field Label Origin
Card Account Financial Account ID Many To One (N:1) Financial Account ID Financial Services
Cloud
Financial Account Card Account ID Many To One (N:1) Card Account ID Financial Services
Cloud
Fields
Label API Name Description Data Data
Type Bundle
or Origin
Description ssot__Description__c The credit card account description. Text Financial
Services
Cloud
Financial Account ssot__FinancialAccount__c The associated financial account. Text Financial
Services
Cloud
Card Account ID ssot__Id__c The primary key. Text Financial
Services
Cloud
Name ssot__Name__c The credit card account. name. Text Financial
Services
Cloud
197
Model Data in Data Cloud Case DMO
Case DMO
The Case DMO is a Data Cloud data model object (DMO) for support cases based on recorded issues, for example, a laptop connectivity
problem. Provided in both the Sales and Service Data Kits.
Object API Name
ssot__Case__dlm
Category
Engagement
Primary Subject Area
Case
Primary Key
Case ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field Data Bundle
Agent Work Related To Many To One: N:1 Case Case Id Service
Case Account Contact Many To One: N:1 Account Contact Account Contact ID Sales, Service
Case Account Many To One: N:1 Account Account ID Sales, Service
Case Assigned User Many To One: N:1 User User ID Service
Case Case ID Many To One: N:1 Device Application Case Sales
Engagement
Case Case ID Many To One: N:1 Email Engagement Case Sales
Case Case ID Many To One: N:1 Message Case Sales
Engagement
Case Case ID Many To One: N:1 Product Browse Case Sales
Engagement
Case Case ID Many To One: N:1 Shopping Cart Case Sales
Engagement
Case Case ID Many To One: N:1 Web Search Case Sales
Engagement
Case Case ID Many To One: N:1 Website Case Sales
Engagement
198
Model Data in Data Cloud Case DMO
Object Field Cardinality Related Object Related Field Data Bundle
Case Case Support Work Many To One: N:1 Operating Hours Operating Hours Id Sales, Service
Hours
Case Parent Case Many To One: N:1 Case Case ID Service
Case Update Case Many To One: N:1 Case Case ID Service
Email Message Case Many To One: N:1 Case Case ID Service
All Fields
Field Name Field API Name Description Data Data
Type Bundle
Account ssot__AccountId__c A reference ID to the account where text Sales,
this contact is included or linked. Service
Account Contact ssot__AccountContactId__c The reference ID for the account text Sales,
contact of the case. Service
Assigned User ssot__AssignedUserId__c A reference ID to the assigned text Sales,
customer support rep. Service
Assigned User Object ssot__AssignedUserObject__c The assigned user object for the case. text Service
Case Category ssot__CaseCategoryId__c A reference ID to the category of the text Sales,
case. Service
Case Closure Reason ssot__CaseClosureReasonId__c A reference ID to the reason the case text Sales,
was closed. Service
Case Comments ssot__CaseComments__c The comments for the case. text Service
Case Comments ssot__CaseComments__c text Sales,
Relationship Service
Case Creation Channel ssot__CaseCreationChannelId__c A reference ID to the channel where text Sales,
the case was created. Service
Case ID ssot__Id__c A unique ID used as the primary key text Sales,
for the account contact DMO. Service
Case Number ssot__CaseNumber__c A number assigned to the case. text Sales,
Service
Case Priority ssot__CasePriorityId__c A reference ID to the priority of the text Sales,
case, for example, high, medium, or Service
low.
Case Status ssot__CaseStatusId__c A reference ID to the status of the text Sales,
case, for example, new, in progress, Service
or closed.
199
Model Data in Data Cloud Case DMO
Field Name Field API Name Description Data Data
Type Bundle
Case Support Work ssot__CaseSupportWorkHoursId__c A reference ID to the working hours text Sales,
Hours of support. Service
Case Type ssot__CaseTypeId__c A reference ID to the type of case, for text Sales,
example, a question or a problem. Service
Closed ssot__IsClosed__c An indicator if the case is closed. text Service
Closed Date Time ssot__CloseddateTime__c The date and time that the case was dateTime Sales,
closed. Service
Closed When Created ssot__IsClosedOnCreate__c An indicator if the case was closed text Service
when created.
Created Date ssot__CreatedDate__c The date the record was created. dateTime Sales,
Service
Date Source ssot__DataSourceId__c A reference ID for the logical name for text Sales,
a system that is the source of records Service
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of text Sales,
the object where this record came Service
from, whether that is a name of a
cloud storage file or another
connector’s external object.
Description ssot__Description__c The case description. text Service
Email Messages ssot__EmailMessages__c The email messages for a case. text Sales,
Service
Escalated ssot__IsEscalated__c An indicator if the case is escalated. text Service
Escalation Date ssot__EscalationDate__c The date the case was escalated. dateTime Service
External Record ID ssot__ExternalRecordId__c A reference ID for an external data text Sales,
source system. Service
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which text Sales,
the external record ID was assigned. Service
Individual ssot__IndividualId__c A reference ID for the individual text Service
associated with the case.
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text Sales,
other internal organization that owns Service
the business account.
Is Web Portal Visible ssot__IsWebPortalVisible__c An indicator if the web portal is visible. text Service
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified dateTime Sales,
the record. Service
200
Model Data in Data Cloud Case Update DMO
Field Name Field API Name Description Data Data
Type Bundle
Name ssot__Name__c The name of the case. text Service
Origin ssot__Origin__c The origin of the case. text Service
Parent Case ssot__ParentCaseId__c A reference ID to an associated parent text Sales,
case. Service
Service Entitlement ssot__ServiceEntitlementId__c A reference ID to the customer’s text Sales,
support level, for example, phone or Service
chat support only.
Subject ssot__Subject__c A short description of the case. text Service
Case Update DMO
The Case Update DMO is a Data Cloud data model object (DMO) for a for historical information about changes made to the associated
case.
Object API Name
ssot__CaseUpdate__dlm
Category
Other
Primary Subject Area
CaseHistory2
Primary Key
Case ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Case Update Case Many To One: N:1 Case Case ID
Case Update Last Modified By Many To One: N:1 User User ID
Case Update Related Owner Many To One: N:1 User User ID
201
Model Data in Data Cloud Communication Subscription DMO
All Fields
Field Name Field API Name Description Data
Type
Case Id ssot__CaseId__c A reference ID to the associated case. text
Case Update Id ssot__Id__c A unique ID used as the primary key for text
the case update DMO.
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
Description ssot__Description__c The case update description. text
Internal Organization ssot__InternalOrganizationId___c A reference ID to the business unit or text
other internal organization that owns the
case.
Last Modified By ssot__LastModifiedById__c A reference ID to the user that made the text
last update.
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the dateTime
record.
Name ssot__Name__c The name of the case update. text
Previous Update Date ssot__PreviousUpdateDateTime__c The date and time the case was dateTime
previously updated.
Related Owner ssot__RelatedOwnerId__c A reference ID to the related user for the text
update.
Related Owner Object ssot__RelatedOwnerObject__c The related owner object for the case text
update.
Status ssot__Status__c The status of the case update. text
Communication Subscription DMO
The Communication Subscription DMO is a Data Cloud data model object (DMO) for a customer’s subscription preferences for a specific
communication.
Object API Name
ssot__CommunicationSubscription__dlm
202
Model Data in Data Cloud Communication Subscription DMO
Category
Other
Primary Subject Area
Privacy
Primary Key
Communication Subscription ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Communication Data Use Purpose ID Many To One: N:1 Data Use Purpose Data Use Purpose ID
Subscription
Communication Communication Many To One: N:1 Communication Communication
Subscription Channel Subscription ID Subscription Subscription ID
Type
All Fields
Field Name Field API Name Description Data
Type
Communication ssot__Id__c A unique ID used as primary key for the text
Subscription ID Communication Subscription DMO.
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
Data Use Purpose ID ssot__DataUsePurposeId__c A reference ID to reason for contacting a text
prospect or customer, for example billing,
marketing, or surveys.
External Record ID ssot__ExternalRecordId__c A reference ID to an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
203
Model Data in Data Cloud Communication Subscription Channel Type DMO
Field Name Field API Name Description Data
Type
Internal Organization ssot__InternalOrganizationId__c A reference ID to business unit or other text
internal organization that owns the
business account.
Name ssot__Name__c The name of the communication text
subscription.
Communication Subscription Channel Type DMO
The Communication Subscription Channel Type DMO is a Data Cloud data model object (DMO) for the engagement channel through
which a customer is reached for a communication subscription.
Object API Name
ssot__CommunicationSubscriptionChannelType__dlm
Category
Other
Primary Subject Area
Privacy
Primary Key
Communication Subscription Channel Type ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Communication Communication Many To One: N:1 Communication Communication
Subscription Channel Subscription ID Subscription Subscription ID
Type
All Fields
Field Name Field API Name Description Data
Type
Communication ssot__Id__c A unique ID used as primary key for the text
Subscription Channel Type Communication Subscription Channel
ID Type DMO.
204
Model Data in Data Cloud Communication Subscription Consent DMO
Field Name Field API Name Description Data
Type
Communication ssot__CommunicationSubscriptionId__c A reference ID to customer’s subscription text
Subscription ID preferences for a specific communication.
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
Engagement Channel Type ssot__EngagementChannelTypeId__c A reference ID to channel type by which text
message can be delivered, for example
email, phone call, SMS message, or TV
advertisement.
External Record ID ssot__ExternalRecordId__c A reference ID for an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
data record.
Communication Subscription Consent DMO
The Communication Subscription Consent DMO is a Data Cloud data model object (DMO) for the engagement or communication
channel preferences of a customer.
Object API Name
ssot__CommunicationSubscriptionConsent__dlm
Category
Other
Primary Subject Area
Privacy
Primary Key
Communication Subscription Consent ID (ssot__Id__c)
205
Model Data in Data Cloud Communication Subscription Consent DMO
Relationships
Object Field Cardinality Related Object Related Field
Communication Communication Many To One: N:1 Communication Communication
Subscription Timing Subscription Consent Subscription Consent Subscription Consent ID
Communication Consent Status Many To One: N:1 Consent Status Consent Status ID
Subscription Consent
Communication Party Many To One: N:1 Individual Individual ID
Subscription Consent
All Fields
Field Name Field API Name Description Data
Type
Communication ssot__CommunicationSubscriptionId__c A reference ID to customer’s subscription text
Subscription preferences for a specific communication.
Communication ssot__Id__c A unique ID used as primary key for the text
Subscription Consent ID Communication Subscription Consent
DMO.
Consent Captured Date ssot__ConsentCaptureddateTime__c The date and time consent was captured. dateTime
Time
Consent Captured Source ssot__ConsentCapturedSourceName__c The source where consent was captured. text
Consent Status ssot__ConsentStatusId__c A reference ID to a user’s consent status. text
Contact Point ssot__ContactPointId__c A reference ID to contact point for party, text
for example phone number or email
address.
Contact Point Consent ssot__ContactPointConsentId__c A reference ID to contact point where text
customer gives their consent.
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
Effective From Date ssot__EffectiveFromDate__c The date when consent form is in effect. dateTime
Effective To Date ssot__EffectiveToDate__c The date when consent form is no longer dateTime
in effect.
206
Model Data in Data Cloud Communication Subscription Timing DMO
Field Name Field API Name Description Data
Type
Engagement Channel Type ssot__EngagementChannelTypeId__c A reference ID to engagement channel text
type.
Engagement Channel Type ssot__EngagementChannelTypeConsentId__c A reference ID to engagement channel text
Consent consent type.
External Record ID ssot__ExternalRecordId__c A reference ID to an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
business account.
Name ssot__Name__c The name of the communication text
subscription.
Party ssot__PartyId__c A reference ID to the parent party, for text
example, an individual, business, or
affiliation group.
Tip: This ID is the same as the one
used in the individual object.
Party Role ssot__PartyRoleId__c A reference ID to associated party role, for text
example, a customer, supplier, or
competitor.
Communication Subscription Timing DMO
The Communication Subscription Timing DMO is a Data Cloud data model object (DMO) for a customer's timing preferences for receiving
a communication subscription.
Object API Name
ssot__CommunicationSubscriptionTiming__dlm
Category
Other
Primary Subject Area
Privacy
207
Model Data in Data Cloud Communication Subscription Timing DMO
Primary Key
Communication Subscription Timing ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Communication Communication Many To One: N:1 Communication Communication
Subscription Timing Subscription Consent Subscription Consent Subscription Consent ID
All Fields
Field Name Field API Name Description Data
Type
Communication ssot__CommunicationSubscriptionConsentId__c A reference ID to preferences for one text
Subscription Consent engagement channel on one
communication subscription (channel)
created by a care coordinator or patient.
Communication ssot__Id__c A unique ID used as primary key for the text
Subscription Timing ID Communication Subscription Timing
DMO.
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
External Record ID ssot__ExternalRecordId__c A reference ID to an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID to system that External text
Record ID was assigned.
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
business account.
Offset ssot__Offset__c When a communication subscription text
occurs based on the unit of measure, for
example, if UOM is "day of week" and
offset is "1", communication subscriptions
occur on Mondays.
208
Model Data in Data Cloud Consent Action DMO
Field Name Field API Name Description Data
Type
Preferred Time End ssot__PreferredEndTime__c The user’s preferred end time to stop dateTime
sending communications.
Preferred Time Start ssot__PreferredStartTime__c The user’s preferred start time for sending dateTime
communications.
Preferred Time Zone ssot__PreferredTimeZoneId__c A reference ID to range of longitudes text
where common standard time is used.
Time UOM ssot__TimeUOM__c A reference ID to unit of measure (time) text
used in communication subscription, for
example hours or days.
Consent Action DMO
The Consent Action DMO is a Data Cloud data model object (DMO) for what a user consents to be done with their data, for example,
data collection or web activity tracking.
Object API Name
ssot__ConsentAction__dlm
Category
Other
Primary Subject Area
Privacy
Primary Key
Consent Action ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Privacy Consent Log Consent Action Many To One: N:1 Consent Action Consent Action ID
209
Model Data in Data Cloud Consent Status DMO
All Fields
Field Name Field API Name Description Data
Type
Consent Action ID ssot__Id__c A unique ID used as primary key for the text
Consent Action DMO.
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
External Record ID ssot__ExternalRecordId__c A reference ID to an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID to system that External text
Record Id was assigned.
Internal Organization ssot__InternalOrganizationId__c A reference ID for the system in which the text
external record ID was assigned.
Name ssot__Name__c The consent action name. text
Consent Status DMO
The Consent Status DMO is a Data Cloud data model object (DMO) for the status of consent, for example opted in or out of data collection.
Object API Name
ssot__ConsentStatus__dlm
Category
Other
Primary Subject Area
Privacy
Primary Key
Consent Status ID (ssot__Id__c)
210
Model Data in Data Cloud Contact Point Address DMO
Relationships
Object Field Cardinality Related Object Related Field
Authorization Form Consent Status Many To One: N:1 Consent Status Consent Status ID
Consent
Communication Consent Status Many To One: N:1 Consent Status Consent Status ID
Subscription Consent
All Fields
Field Name Field API Name Description Data
Type
Consent Status ID ssot__Id__c A unique ID used as primary key for the text
Consent Status DMO.
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
External Record ID ssot__ExternalRecordId__c A reference ID for an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
business account.
Name ssot__Name__c The consent status name. text
Contact Point Address DMO
The Contact Point Address data model object (DMO) is a Data CloudDMO based on the mailing address of a party. Provided in both the
Sales and Service Data Kits.
Object API Name
ssot__ContactPointAddress__dlm
211
Model Data in Data Cloud Contact Point Address DMO
Category
Other
Primary Subject Area
Party
Primary Key
Contact Point Address ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field Data Bundle
Account Bill Contact Address Many To One (N:1) Contact Point Contact Point Service
Address Address ID
Account Contact Mailing Address Many To One (N:1) Contact Point Contact Point Service
Address Address ID
Contact Point Party Many To One (N:1) Individual Individual ID Sales, Service
Address
Contact Point Party Many To One (N:1) Account Individual ID Sales
Address
Contact Point Party Many To One (N:1) Account Account ID Service
Address
Contact Point Contact Point Many To One (1:1) Unified Link Contact Point Sales
All Fields
Field Name Field API Name Description Data Data
Type Bundle
Active From Date ssot__ActiveFromDate__c The date from which the contact’s address is dateTime Sales,
active. Service
Active To Date ssot__ActiveToDate__c The date the contact’s address becomes dateTime Sales,
inactive. Service
Address ssot__AddressLineId__c A reference ID for the contact’s address. text Sales,
Service
Address Line 1 ssot__AddressLine1__c The first line of the address, including the text Sales,
street name and number. Service
Address Line 2 ssot__AddressLine2__c The second line of an address, for example, text Sales,
a suite number. Service
212
Model Data in Data Cloud Contact Point Address DMO
Field Name Field API Name Description Data Data
Type Bundle
Address Line 3 ssot__AddressLine3__c The third line of an address. text Sales,
Service
Address Line 4 ssot__AddressLine4__c The fourth line of an address. text Sales,
Service
Best Time To Contact End ssot__BestTimeToContactEndTime__c A contact’s preferred date and time to stop dateTime Sales,
Time receiving communication. Service
Best Time To Contact Start ssot__BestTimeToContactStartTime__c A contact’s preferred date and time to start dateTime Sales,
Time receiving communication. Service
Best Time to Contact ssot__BestTimeToContactTimezoneId__ A reference ID to the contact’s preferred time text Sales,
Timezone zone. Service
City ssot__CityId__c The reference ID of a city, town, or village. text Sales,
Service
City Name ssot__CityName__c The name of a city, town, or village. text
Contact Point Address ID ssot__Id__c A unique ID used as the primary key for the text Sales,
contact point address DMO. Service
Contact Point Type ssot__ContactPointTypeId__c A reference ID to the contact type. text Sales,
Service
Country ssot__CountryId__c The reference ID of the country where the text Sales,
address is located. Service
Country Name ssot__CountryName__c The country where the address is located. text Sales,
Service
Country Region ssot__CountryRegionId__c A reference ID for the country or region text Sales,
where the address is located. Service
Created Date ssot__CreatedDate__c The record’s creation date. dateTime Sales,
Service
Data Source ssot__DataSourceId__c A reference ID for the logical name of a text Sales,
system that is the source of records identified Service
by an external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text Sales,
object where this record came from, for Service
example, a name of a cloud storage file or
another connector’s external object.
External Record ID ssot__ExternalRecordId__c A reference ID for an external data source text Sales,
system. Service
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text Sales,
external record ID was assigned. Service
213
Model Data in Data Cloud Contact Point Address DMO
Field Name Field API Name Description Data Data
Type Bundle
For Business Use ssot__ForBusinessUse__c Whether the address is for business use. text Sales,
Service
For Personal Use ssot__ForPersonalUse__c Whether the address is for personal use. text Sales,
Service
Geo Accuracy ssot__GeoAccuracy__c Additional information about an address’ number Sales,
latitude and longitude. Service
Geocode Accuracy Type ssot__GeocodeAccuracyType__c The geographic code accuracy type for the number Service
contact point.
Geo Latitude ssot__GeoLatitude__c The address’ geographical latitude. number Sales,
Service
Geo Longitude ssot__GeoLongitude__c The address’ geographical longitude. number Sales,
Service
Internal Organization ssot__InternalOrganizationId__c A reference ID for the business unit or other text Sales,
internal organization that owns the business Service
account.
Is Active ssot__IsActive__c Whether the address is active. text Sales,
Service
Is Undeliverable ssot__IsUndeliverable__c Whether the address is undeliverable. text Sales,
Service
Is Used For Billing ssot__IsUsedForBilling__c Whether the address is the contact’s billing text Sales,
address. Service
Is Used For Mailing ssot__IsUsedForMailing__c Whether the contact point address can be text Service
used for mailing.
Is Used For Shipping ssot__IsUsedForShipping__c Whether the address is the contact’s shipping text Sales,
address. Service
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the dateTime Sales,
record. Service
Party ssot__PartyId__c A reference ID to the parent party, for text Sales,
example, an individual, business, or affiliation Service
group. This ID is the same as the one used in
the individual object.
Party Role ssot__PartyRoleId__c A reference ID to the associated party role, text Sales,
for example, a customer, supplier, or Service
competitor.
Physical Location ssot__PhysicalLocationId__c A reference ID to the physical location of the text Sales,
address. Service
214
Model Data in Data Cloud Contact Point App DMO
Field Name Field API Name Description Data Data
Type Bundle
Postal Code ssot__PostalCodeId__c The reference ID for the postal code. text Sales,
Service
Postal Code text ssot__PostalCodetext__c The contact’s postal code. text Sales,
Service
Preference Rank ssot__PreferenceRankNumber__c The preference rank number for the contact number Service
point address.
Primary Contact Phone ssot__ContactPhoneId__c A reference ID for the primary phone number text Sales,
for this address. Service
Primary Flag ssot__PrimaryFlag__c Indicates whether the address is the primary text Sales,
address of the individual or account. Service
Profile First Created Date ssot__ProfileFirstCreatedDate___c The date the profile was created. dateTime Sales,
Service
Profile Last Updated Date ssot__ProfileLastUpdatedDate__c The date the profile was last updated. dateTime Sales,
Service
Profile Occurrence Count ssot__ProfileOccurrenceCount__c The number of occurrences of the profile for number Sales,
the contact point address. Service
State Province ssot__StateProvinceId__c The reference ID for the state or province text Sales,
where the address is located. Service
State Province Name ssot__StateProvinceName__c The state or province where the address is text Sales,
located. Service
Timezone Code ssot__TimezoneCode__c A single-character code indicating the time text Sales,
zone’s relationship to Greenwich Mean Time Service
(GMT).
Usage Type ssot__UsageType__c The usage type for the contact point address. text Service
Contact Point App DMO
The Contact Point App DMO is a Data Cloud data model object for the software application of a party on a specific device.
Object API Name
ssot__ContactPointApp__dlm
Category
Other
215
Model Data in Data Cloud Contact Point App DMO
Primary Subject Area
Party
Primary Key
Contact Point App ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Contact Point App Party Many To One (N:1) Individual Individual ID
Contact Point App Device Many To One (N:1) Device Device ID
Contact Point App Contact Point App ID One To One (1:1) Contact Point App Contact Point App ID
Identity Link
Contact Point App Party Many To One (N:1) Account Account ID
All Fields
Field Name Field API Name Description Data
Type
Active From Date ssot__ActiveFromDate__c The date the app is active. dateTime
Active To Date ssot__ActiveToDate__c The date the app is inactive. dateTime
Application Login ID ssot__ApplicationLoginId__c The unique ID used to log in to the application. text
Asset Type ID ssot__AssetTypeId__c A reference ID to the type of asset on which the text
application is present.
Badge Count ssot__BadgeCount__c text
Best Time To Contact End ssot__BestTimeToContactEndTime__c A contact’s preferred date and time to stop dateTime
Time receiving communications.
Best Time To Contact Start ssot__BestTimeToContactStartTime__c A contact’s preferred date and time to start dateTime
Time receiving communication.
Best Time to Contact ssot__BestTimeToContactTimezoneId__c A reference ID to the contact’s preferred time text
Timezone zone.
Contact Point App ID ssot__Id__c A unique ID used as the primary key for the text
contact point app DMO.
Contact Point Type ssot__ContactPointTypeId__c A reference ID to the type of contact. text
216
Model Data in Data Cloud Contact Point App DMO
Field Name Field API Name Description Data
Type
Cookie ID ssot__CookieIdtext__c An identifier that is specific to a cookie text
generated in a web browser for a particular
application.
Created Date ssot__CreatedDate__c The date when the record was created. dateTime
Data Source ssot__DataSourceId__c A reference ID for the logical name for a system text
that is the source of records identified by
external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the object text
where this record came from, whether that is a
name of a cloud storage file or another
connector’s external object.
Device ssot__DeviceId__c A unique ID of a device. text
Device End Point ssot__DeviceEndPointId__c The ID for the device’s end point. text
External Record ID ssot__ExternalRecordId__c A reference ID for an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
For Business Use ssot__ForBusinessUse__c An indicator if the app is used for business use. text
For Personal Use ssot__ForPersonalUse__c An indicator if the app is used for personal use. text
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or other text
internal organization that owns the business
account.
Is Active ssot__IsActive__c An indicator if the app is active. text
Is Undeliverable ssot__IsUndeliverable__c An indicator if the app is undeliverable. text
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the record. dateTime
Party ssot__PartyId__c A reference ID to the parent party, for example, text
an individual, business, or affiliation group.
Tip: This ID is the same as the one used
in the individual object.
Party Role ssot__PartyRoleId__c A reference ID to the associated party role, for text
example, a customer, supplier, or competitor.
Primary Flag ssot__PrimaryFlag__c An indicator if the phone number is the primary text
phone number of the individual or account.
Profile First Created Date ssot__ProfileFirstCreatedDate___c The date the profile was created. dateTime
Profile Last Updated Date ssot__ProfileLastUpdatedDate__c The date the profile was last updated. dateTime
217
Model Data in Data Cloud Contact Point Consent DMO
Field Name Field API Name Description Data
Type
Profile Occurrence Count ssot__ProfileOccurrenceCount__c number
Software Application ssot__SoftwareApplicationId__c The reference ID to the application the contact text
point represents.
Timezone Code ssot__TimezoneCode__c A single-character code indicating the time text
zone's relationship to Greenwich Mean Time
(GMT).
Contact Point Consent DMO
The Contact Point Consent DMO is a Data Cloud data model object (DMO) for recording information about consent for a specific contact
point. This data includes when, how, for how long, and whether the party has double opted-in.
Object API Name
ssot__ContactPointConsent__dlm
Category
Other
Primary Subject Area
Privacy
Primary Key
Contact Point Consent ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Contact Point Consent Contact Point Many To One: N:1 Contact Point Email Contact Point Email ID
Contact Point Consent Contact Point Many To One: N:1 Contact Point Phone Contact Point Phone ID
Contact Point Consent Contact Point Many To One: N:1 Contact Point Address Contact Point Address ID
Contact Point Consent Contact Point Many To One: N:1 Contact Point Social Contact Point Social ID
Contact Point Consent Contact Point Many To One: N:1 Contact Point App Contact Point App ID
Contact Point Consent Contact Point Many To One: N:1 Contact Point OTT Service Contact Point OTT Service
ID
Contact Point Consent Party Many To One: N:1 Individual Individual ID
218
Model Data in Data Cloud Contact Point Consent DMO
Object Field Cardinality Related Object Related Field
Contact Point Consent Data Use Purpose Many To One: N:1 Data Use Purpose Data Use Purpose ID
Contact Point Consent Consent Status Many To One: N:1 Consent Status Consent Status ID
All Fields
Field Name Field API Name Description Data
Type
Consent Captured Date ssot__ConsentCaptureddateTime__c The date and time consent was captured. dateTime
Time
Consent Captured Source ssot__ConsentCapturedSourceName__c The location where consent was text
captured.
Consent Status ssot__ConsentStatusId__c A reference ID to consent status. text
Contact Point ssot__ContactPointId__c A reference ID to a contact point. text
Contact Point Consent ID ssot__Id__c A unique ID that is used as the primary text
key for the Consent Point Consent DMO.
Data Source ssot__DataSourceId__c A reference ID to a logical name for a text
system that is the source of records
identified by an external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where the record originated, for
example a cloud storage file or another
connector’s external object.
Data Use Purpose ssot__DataUsePurposeId__c A reference ID to how the data is being text
used.
Double Consent Capture ssot__DoubleConsentCapturedateTime__c The data and time a contact consents to dateTime
Date Time receive communication using a
double-opt in process.
Effective From Date ssot__EffectiveFromDate__c The date when the consent form is in dateTime
effect.
Effective To Date ssot__EffectiveToDate__c The date when the consent form is no dateTime
longer in effect.
External Record ID ssot__ExternalRecordId__c A reference ID to an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
219
Model Data in Data Cloud Contact Point Email DMO
Field Name Field API Name Description Data
Type
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
business account.
Name ssot__Name__c The name of the contact who provided text
consent.
Party ssot__PartyId__c A reference ID to the parent party, for text
example, an individual, business, or
affiliation group.
Party Role ssot__PartyRoleId__c A reference ID to an associated party role, text
for example, a customer, supplier, or
competitor.
Contact Point Email DMO
The Contact Point Email DMO is a Data Cloud data model object for the email address of a party. Provided in both the Sales and Service
Data Kits.
Object API Name
ssot__ContactPointEmail__dlm
Category
Other
Primary Subject Area
Contact
Primary Key
Contact Point Email ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field Data Bundle
Account Contact Contact Email Many To One (N:1) Contact Point Email Contact Point Email Sales, Service
ID
Contact Point Email Party Many To One (N:1) Individual Individual ID Sales, Service
Contact Point Email Contact Point Email One To One (1:1) Contact Point Email Contact Point Email Sales
ID Identity Link ID
220
Model Data in Data Cloud Contact Point Email DMO
Object Field Cardinality Related Object Related Field Data Bundle
Contact Point Email Party Many To One (N:1) Account Account ID Sales, Service
All Fields
Field Name Field API Name Description Data Type Data
Bundle
Active From Date ssot__ActiveFromDate__c The date the email address is dateTime Sales,
active. Service
Active To Date ssot__ActiveToDate__c The date the email address is dateTime Sales,
inactive. Service
Best Time To Contact End ssot__BestTimeToContactEndTime__c A contact’s preferred date and time dateTime Sales,
Time to stop receiving emails. Service
Best Time To Contact ssot__BestTimeToContactStartTime__c A contact’s preferred date and time dateTime Sales,
Start Time to start receiving emails. Service
Best Time to Contact ssot__BestTimeToContactTimezone__c The preferred timezone for the text Service
Timezone contact.
Best Time to Contact ssot__BestTimeToContactTimezoneId__c A reference ID for the contact’s text Sales,
Timezone preferred time zone. Service
Contact Point Email Id ssot__Id__c A unique ID used as the primary text Sales,
key for the contact point email Service
DMO.
Contact Point Type ssot__ContactPointTypeId__c A reference ID for the type of text Sales,
email, for example business or Service
personal.
Created Date ssot__CreatedDate__c The date when the record was dateTime Sales,
created. Service
Data Source ssot__DataSourceId__c A reference ID for the logical name text Sales,
for a system that is the source of Service
records identified by external
record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name text Sales,
of the object where this record Service
came from, whether that is a name
of a cloud storage file or another
connector’s external object.
Email Address ssot__EmailAddress__c The contact’s full email address. text Sales,
Service
221
Model Data in Data Cloud Contact Point Email DMO
Field Name Field API Name Description Data Type Data
Bundle
Email Domain ssot__EmailDomain__c The domain of an email address, text Sales,
for example salesforce.com or Service
gmail.com.
Email Latest Bounce Date ssot__EmailLatestBouncedateTime__c The date of the most recent email dateTime Sales,
Time bounce. Service
Email Latest Bounce ssot__EmailLatestBounceReasontext__c The reason the email bounced, for text Sales,
Reason text example the mailbox was full. Service
Email Mail Box ssot__EmailMailBox__c The specific unique mailbox found text Sales,
before the domain, for example Service
janedoe@.
External Record ID ssot__ExternalRecordId__c A reference ID for an external data text Sales,
source system. Service
External Source ID ssot__ExternalSourceId__c A reference ID for the system in text Sales,
which the external record ID was Service
assigned.
For Business Use ssot__ForBusinessUse__c An indicator if the email address is text Sales,
used for business use. Service
For Personal Use ssot__ForPersonalUse__c An indicator if the email address is text Sales,
used for personal use. Service
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit text Sales,
or other internal organization that Service
owns the business account.
Is Active ssot__IsActive__c An indicator if the email address is text Sales,
active. Service
Is Undeliverable ssot__IsUndeliverable__c An indicator if the email address is text Sales,
undeliverable. Service
Is Verified ssot__IsVerified__c Indicates whether the email Text Financial
address is verified. Services
Cloud
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified dateTime Sales,
the record. Service
Party ssot__PartyId__c A reference ID to the parent party, text Sales,
for example, an individual, Service
business, or affiliation group.
Tip: This ID is the same as
the one used in the
individual object.
222
Model Data in Data Cloud Contact Point Phone DMO
Field Name Field API Name Description Data Type Data
Bundle
Party Role ssot__PartyRoleId__c A reference ID to the associated text Sales,
party role, for example, a customer, Service
supplier, or competitor.
Preference Rank ssot__PreferenceRankNumber__c The preference rank number for number Service
the contact point email.
Primary Flag ssot__PrimaryFlag__c An indicator if the email address is text Sales,
the primary email address of the Service
individual or account.
Profile First Created Date ssot__ProfileFirstCreatedDate___c The date the profile was created. dateTime Sales,
Service
Profile Last Updated Date ssot__ProfileLastUpdatedDate__c The date the profile was last dateTime Sales,
updated. Service
Profile Occurrence Count ssot__ProfileOccurrenceCount__c number Sales,
Service
Timezone Code ssot__TimezoneCode__c A single-character code indicating text Sales,
the time zone's relationship to Service
Greenwich Mean Time (GMT).
Usage Type ssot__UsageType__c The usage type for the contact text Service
point email.
Verified ssot__IsVerified__c An indicator if this contact point text Service
email is verified.
Contact Point Phone DMO
The Contact Point Phone data model object (DMO) is a Data Cloud DMO for the phone number of a party. Provided in both the Sales
and Service Data Kits.
Object API Name
ssot__ContactPointPhone__dlm
Category
Other
Primary Subject Area
Party
223
Model Data in Data Cloud Contact Point Phone DMO
Primary Key
Contact Point Phone ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field Data Bundle
Account Sales Phone Many To One (N:1) Contact Point Phone Contact Point Phone Service
ID
Account Contact Business Phone Many To One (N:1) Contact Point Phone Contact Point Phone Service
ID
Contact Point Phone Party Many To One (N:1) Individual Individual ID Sales, Service
Contact Point Phone Contact Point Phone One To One (1:1) Contact Point Phone Contact Point Phone Sales
ID Identity Link ID
Contact Point Phone Party Many To One (N:1) Account Account ID Sales, Service
Contact Point Phone Device ID Many To One (N:1) Device Device ID Financial Services
Cloud
All Fields
Field Name Field API Name Description Data
Type
Active From Date ssot__ActiveFromDate__c The date the phone number is active. dateTime Sales,
Service
Active To Date ssot__ActiveToDate__c The date the phone number is dateTime Sales,
inactive. Service
Area Code ssot__AreaCode__c A phone number’s area code. text Sales,
Service
Best Time To Contact End ssot__BestTimeToContactEndTime__c A contact’s preferred date and time dateTime Sales,
Time to stop receiving calls. Service
Best Time To Contact Start ssot__BestTimeToContactStartTime__c A contact’s preferred date and time dateTime Sales,
Time to start receiving calls. Service
Best Time to Contact ssot__BestTimeToContactTimezone__c The preferred timezone for the text Service
Timezone contact
Best Time to Contact ssot__BestTimeToContactTimezoneId__c A reference ID for the contact’s text Sales,
Timezone preferred time zone. Service
City Name ssot__CityName__c The city related to the phone text Sales,
number. Service
224
Model Data in Data Cloud Contact Point Phone DMO
Field Name Field API Name Description Data
Type
Contact Point Phone ID ssot__Id__c A unique ID used as the primary key text Sales,
for the contact point phone DMO. Service
Contact Point Type ssot__ContactPointTypeId__c A reference ID for the type of phone text Sales,
number, for example business or Service
personal.
Country ssot__CountryId__c A reference ID for the country related text Sales,
to the phone number. Service
Country Name ssot__CountryName__c The country related to the phone text Sales,
number. Service
Created Date ssot__CreatedDate__c The record’s creation date. dateTime Sales,
Service
Data Source ssot__DataSourceId__c A reference ID for the system’s logical text Sales,
name that is the source of records Service
identified by an external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name text Sales,
of the object where this record Service
originated, whether that is a name of
a cloud storage file or another
connector’s external object.
Device ssot__DeviceId__c A unique ID of the device where the text Sales,
phone number is associated. Service
Extension number ssot__Extensionnumber__c An associated phone extension. text Sales,
Service
External Record ID ssot__ExternalRecordId__c A reference ID for an external data text Sales,
source system. Service
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which text Sales,
the external record ID was assigned. Service
For Business Use ssot__ForBusinessUse__c An indicator if the phone number is text Sales,
used for business use. Service
For Personal Use ssot__ForPersonalUse__c An indicator if the phone number is text Sales,
used for personal use. Service
Formatted E164 Phone ssot__FormattedE164Phonenumber__c The number that is formatted text Sales,
number according to e164 formatting, for Service
example, +165012345678.
Formatted International ssot__FormattedInternationalPhonenumber__c The number that is formatted text Sales,
Phone number according to international formatting, Service
for example, +16 501-234-5678.
225
Model Data in Data Cloud Contact Point Phone DMO
Field Name Field API Name Description Data
Type
Formatted National Phone ssot__FormattedNationalPhonenumber__c The number that is formatted text Sales,
number according to 3123 formatting, for Service
example, 501 234 5678.
Internal Organization ssot__InternalOrganizationId__c A reference ID for the business unit text Sales,
or other internal organization that Service
owns the business account.
Is Active ssot__IsActive__c Whether the phone number is active. text Sales,
Service
Is Fax Capable ssot__IsFaxCapable__c Whether the phone number can text Sales,
receive a fax. Service
Is SMS Capable ssot__IsSMSCapable__c Whether the phone number can send text Sales,
and receive SMS messages. Service
Is Undeliverable ssot__IsUndeliverable__c Whether the phone number isn’t text Sales,
working. Service
Is Verified ssott_IsVerified__c Indicates whether the phone number Text Financial
is verified. Services
Cloud
Is Voice Capable ssot__IsVoiceCapable__c Whether the phone number is voice text Sales,
over internet protocol (VOIP) capable. Service
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified dateTime Sales,
the record. Service
Party ssot__PartyId__c A reference ID for the parent party, text Sales,
for example, an individual, business, Service
or affiliation group. This ID is the same
as the one used in the individual
object.
Party Role ssot__PartyRoleId__c A reference ID for the associated party text Sales,
role, for example, a customer, Service
supplier, or competitor.
Phone Country Code ssot__PhoneCountryCode__c The phone number’s country code, text Sales,
for example, +1. Service
Preference Rank ssot__PreferenceRankNumber__c The preference rank number for the number Service
contact point phone.
Postal Code text ssot__PostalCodetext__c The contact’s postal code. text Sales,
Service
Primary Flag ssot__PrimaryFlag__c Whether a phone number is the text Sales,
primary number of the individual or Service
account.
226
Model Data in Data Cloud Contact Point Social DMO
Field Name Field API Name Description Data
Type
Primary Phone Type ssot__PrimaryPhoneTypeId__c The type of phone number, for text Sales,
example home, business, or fax. Service
Profile First Created Date ssot__ProfileFirstCreatedDate___c The profile’s creation date. dateTime Sales,
Service
Profile Last Updated Date ssot__ProfileLastUpdatedDate__c The date the profile was last updated. dateTime Sales,
Service
Profile Occurrence Count ssot__ProfileOccurrenceCount__c The number of occurrences of the number Sales,
profile for the contact point address. Service
Short Code ssot__ShortCode__c A number assigned to SMS and MMS text Sales,
messages. Service
State Province text ssot__StateProvincetext__c The contact’s state or province. text Sales,
Service
Phone number ssot__Telephonenumber__c The contact’s phone number. text Sales,
Service
Timezone Code ssot__TimezoneCode__c A single-character code indicating text Sales,
the time zone’s relationship to Service
Greenwich Mean Time (GMT).
Usage Type ssot__UsageType__c The usage type for the contact point text Service
email.
Contact Point Social DMO
The Contact Point Social DMO is a Data Cloud data model object (DMO) for the social media handle for a party, for example @trustednews
on Twitter.
Object API Name
ssot__ContactPointSocial__dlm
Category
Other
Primary Subject Area
Party
Primary Key
Contact Point Social ID (ssot__Id__c)
227
Model Data in Data Cloud Contact Point Social DMO
Relationships
Object Field Cardinality Related Object Related Field
Contact Point Social Party Many To One: N:1 Account Account ID
Contact Point Social Contact Point Social ID Many To One: N:1 Unified Link Contact Contact Point Social ID
Point Social
Contact Point Social Party Many To One: N:1 Individual Individual ID
Device Application Contact Point Many To One: N:1 Contact Point Social Contact Point Social ID
Engagement
Website Engagement Contact Point Many To One: N:1 Contact Point Social Contact Point Social ID
Web Search Engagement Contact Point Many To One: N:1 Contact Point Social Contact Point Social ID
Account Primary Sales Contact Many To One: N:1 Contact Point Social Contact Point Social ID
Point
Contact Point Consent Contact Point Many To One: N:1 Contact Point Social Contact Point Social ID
Email Engagement Contact Point Many To One: N:1 Contact Point Social Contact Point Social ID
Message Engagement Contact Point Many To One: N:1 Contact Point Social Contact Point Social ID
Product Browse Contact Point Many To One: N:1 Contact Point Social Contact Point Social ID
Engagement
Product Order Contact Point Many To One: N:1 Contact Point Social Contact Point Social ID
Engagement
Shopping Cart Contact Point Many To One: N:1 Contact Point Social Contact Point Social ID
Engagement
Privacy Consent Log Contact Point Many To One: N:1 Contact Point Social Contact Point Social ID
All Fields
Field Name Field API Name Description Data
Type
Active From Date ssot__ActiveFromDate__c The date the social account is active. dateTime
Active To Date ssot__ActiveToDate__c The date the social account is inactive. dateTime
Best Time To Contact End ssot__BestTimeToContactEndTime__c A contact’s preferred date and time to dateTime
Time stop receiving communications.
Best Time To Contact Start ssot__BestTimeToContactStartTime__c A contact’s preferred date and time to dateTime
Time start receiving communication.
Best Time to Contact ssot__BestTimeToContactTimezoneId__c A reference ID to the contact’s preferred text
Timezone time zone.
228
Model Data in Data Cloud Contact Point Social DMO
Field Name Field API Name Description Data
Type
Contact Point Social ID ssot__Id__c A unique ID used as primary key for the text
Contact Point Social DMO.
Contact Point Type ssot__ContactPointTypeId__c A reference ID to the type of contact. text
Created Date ssot__CreatedDate__c The date when the record was created. dateTime
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
External Record ID ssot__ExternalRecordId__c A reference ID to an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Followers Count ssot__FollowersCount__c The total number of followers that social number
media persona possesses.
For Business Use ssot__ForBusinessUse__c An indicator if the social account is used text
for business use.
For Personal Use ssot__ForPersonalUse__c An indicator if the social account is used text
for personal use.
Internal Organization ssot__InternalOrganizationId__c A reference ID to business unit or other text
internal organization that owns the
business account.
Is Active ssot__IsActive__c An indicator if the account is active. text
Is Undeliverable ssot__IsUndeliverable__c An indicator if the account is text
undeliverable.
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the dateTime
record.
Party ssot__PartyId__c A reference ID to the parent party, for text
example, an individual, business, or
affiliation group.
Tip: This ID is the same as the one
used in the individual object.
229
Model Data in Data Cloud Conversation Entry Transcript Excerpt DMO
Field Name Field API Name Description Data
Type
Party Role ssot__PartyRoleId__c A reference ID to the associated party role, text
for example, a customer, supplier, or
competitor.
Primary Flag ssot__PrimaryFlag__c An indicator if phone number is primary text
phone number of the individual or
account.
Profile First Created Date ssot__ProfileFirstCreatedDate__c The date the social profile was created. dateTime
Profile Last Updated Date ssot__ProfileLastUpdatedDate__c The date the social profile was last dateTime
updated.
Profile Occurrence Count ssot__ProfileOccurrenceCount__c number
Profile Picture URL ssot__ProfilePictureURL__c The URL link to profile photo of social text
media account.
Social Fan Status ssot__SocialFanStatusId__c A reference ID to status of social media text
persona, for example and influencer or
fan.
Social Handle ID ssot__SocialHandleId__c A reference ID to a social media handle. text
Social Handle Name ssot__SocialHandleName__c The name of the social media persona. text
Social Network Provider ssot__SocialNetworkProviderId__c A reference ID to source of social media text
persona, for example Facebook or
LinkedIn.
Timezone Code ssot__TimezoneCode__c A single-character code indicating the text
time zone's relationship to Greenwich
Mean Time (GMT).
Conversation Entry Transcript Excerpt DMO
The Conversation Entry Transcript Excerpt DMO is a Data Cloud data model object for a portion of a Conversation Entry that includes a
portion of a transcript.
Object API Name
ssot__ConversationEntryTranscriptExcerpt__dlm
Category
Other
230
Model Data in Data Cloud Conversation Entry Transcript Excerpt DMO
Primary Subject Area
Primary Key
Conversation Entry Transcript Excerpt Id (ssot__Id__c)
Relationships
None.
All Fields
Field Name Field API Name Description Data
Type
Conversation Entry Id ssot__ConversationEntryId__c A reference ID to the conversation entry text
that is the source of the conversation reason
excerpt. An excerpt with a messaging
session will also have the conversation
entry.
Conversation Entry ssot__id__c A unique ID used as the primary key for the text
Transcript Excerpt Id conversation entry transcript excerpt DMO.
Conversation Intent Status ssot__ConversationIntentStatus__c The status of the conversation intent for text
transcript excerpt.
Conversation Reason ssot__ConversationReasonId__c A reference ID to the conversation reason text
for the transcript excerpt.
Data Source ssot__DateSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by the external record ID.
Data Source Object ssot__DateSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
Duration in Seconds ssot__DurationInSeconds__c The duration of the conversation entry number
transcript excerpt in seconds.
Email Message ssot__EmailMessageId__c A reference ID to the email message that is text
the source of the conversation reason
excerpt.
Engagement Channel Type ssot__EngagementChannelType__c The engagement channel type for the text
conversation entry transcript excerpt.
Excerpt Sequence Number ssot__ExcerptSequenceNumber__c The sequence number for the conversation text
entry transcript excerpt.
231
Model Data in Data Cloud Conversation Reason DMO
Field Name Field API Name Description Data
Type
Excerpt Text Index ssot__ExcerptTextIndexText__c The index text for the conversation entry text
transcript excerpt.
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or other text
internal organization that owns the
conversation entry transcript excerpt.
Language ssot__Language__c The language of the conversation entry text
transcript excerpt.
Live Chat Transcript ssot__ExternalRecordId__c A reference ID to the live chat transcript that text
is the source of the conversation reason
excerpt.
Messaging Session ssot__MessagingSessionId__c A reference ID to the messaging session text
that is the source of the conversation reason
excerpt.
Moved ssot__IsMoved__c An indicator if the conversation entry text
transcript excerpt has moved.
Turn Count ssot__TurnCount__c The turn count for the transcript excerpt. number
Conversation Reason DMO
The Conversation Reason DMO is a Data Clouddata model object for the reason a conversation started. It contains aggregated metrics
for excerpts. Example values include cancel order, update order, and check on order status.
Object API Name
ssot__ConversationReason__dlm
Category
Other.
Primary Subject Area
Primary Key
Conversation Reason ID (ssot__Id__c)
Relationships
None.
232
Model Data in Data Cloud Conversation Reason Category DMO
All Fields
Field Name Field API Name Description Data
Type
Average Duration In ssot__AverageDurationInSeconds__c The average duration of the conversation number
Seconds is in seconds.
Average Number of Turns ssot__AverageNumOfTurnsNumber__c The average number of turns for the number
conversation.
Conversation Reason ssot__ConversationReasonCategoryId__c A reference ID to the conversation reason text
Category category.
Conversation Reason ID ssot__Id__c A unique ID used as the primary key for text
the conversation reason DMO.
Conversation Reason ssot__ConversationReasonStatusCode__c A reference ID to the conversation reason text
status code.
Data Source ssot__DateSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by the external record ID.
Data Source Object ssot__DateSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
Einstein Score ssot__EinsteinScoreNumber__c The Einstein score for the conversation. number
Frequency Percent ssot__FrequencyPercent__c The frequency percent for the number
conversation.
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
conversation reason.
Summary Text ssot__SummaryText__c A summary text for the conversation text
reason.
Total Conversation Count ssot__TotalConversationCount__c The total number of conversations. number
Conversation Reason Category DMO
The Conversation Reason Category DMO is a Data Cloud data model object for a grouping of conversation reasons that have the same
overall topic. It contains aggregated metrics for the associated conversation reasons. Example values include Order Management,
Payments, and Account Management.
Object API Name
ssot__ConversationReasonCategory__dlm
233
Model Data in Data Cloud Conversation Reason Category DMO
Category
Other
Primary Subject Area
Primary Key
Conversation Reason Category (ssot__Id__c)
Relationships
None.
All Fields
Field Name Field API Name Description Data
Type
Average Duration Seconds ssot__AverageDurationSecondsNumber__c The average duration for the conversation number
category in seconds.
Average Number of ssot__AverageNumOfTurnsConversationNumber__c The average number of turns in the number
Conversation Turns conversation category/
Conversation Reason ssot__Id__c A unique ID used as the primary key for text
Category ID the conversation reason category DMO.
Conversation Reason ssot__ConvReasonReportDefinitionID__c A reference ID to the conversation reason text
Report Definition report definition.
Data Source ssot__DateSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by the external record ID.
Data Source Object ssot__DateSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
Einstein Score ssot__EinsteinScoreNumber__c The Einstein score for the conversation number
reason category.
Frequency Percent ssot__FrequencyPercent__c The frequency percent for the number
conversation reason category.
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
conversation reason category.
Name ssot__Name__c The name of the conversation reason text
category.
234
Model Data in Data Cloud Conversation Reason Report Definition DMO
Field Name Field API Name Description Data
Type
Reason Count ssot__ReasonCount__c The count of conversation reasons in the number
category.
Total Conversation Count ssot__TotalConnversationCount__c The count of conversations in the number
category.
Training Date ssot__TrainingDate__c The date when the category report dateTime
training last occurred.
Conversation Reason Report Definition DMO
The Conversation Reason Report Definition DMO is a Data Cloud data model object for a conversation mining report that contains an
overview of the conversational data shape and groups of conversation reasons and excerpts.
Object API Name
ssot__ConversationReasonReportDefinition__dlm
Category
Other
Primary Subject Area
Primary Key
Conversation Reason Report Definition Id (ssot__Id__c)
Relationships
None.
All Fields
Field Name Field API Name Description Data
Type
Conversation Reason ssot__ConversationReasonRptStatus__c The conversation reason status code for text
Status Code the report
Conversation Reason ssot__Id__c A unique ID used as the primary key for text
Report Definition ID the conversation reason category DMO
Created Date ssot__CreatedDate__c The date the record was created dateTime
235
Model Data in Data Cloud Conversation Reason Report Segment Def DMO
Field Name Field API Name Description Data
Type
Data Source ssot__DateSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by the external record ID
Data Source Object ssot__DateSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object
EndDate ssot__EndDateTime__c The date and time the report ended dateTime
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
conversation reason report definition
Name ssot__Name__c The name of the conversation reason text
report definition
Pipeline Run Identifier ssot__PipelinerunId__c A reference ID to the ML pipeline run text
identifier.
Recurring Event Frequency ssot__RecurringEventFrequencyUOM__c The interval that the event reoccurs. text
UOM Values include Secondly, Minutely, Hourly,
Daily, Weekly, Monthly, Yearly, and No
Refresh.
StartDate ssot__StartDateTime__c The date and time the report started. dateTime
Conversation Reason Report Segment Def DMO
The Conversation Reason Report Segment Def DMO is a Data Cloud data model object for a segment definition of a conversation reason
report.
Object API Name
ssot__ConvReasonReportSegmentDef__dlm
Category
Other
Primary Subject Area
Primary Key
Conv Reason Report Segment Def ID (ssot__Id__c)
236
Model Data in Data Cloud Data Use Legal Basis DMO
Relationships
None.
All Fields
Field Name Field API Name Description Data
Type
Conversation Reason ssot__ConvReasonReportDefinitionID__c A reference ID to the report definition the text
Report Definition segment belongs to.
Conversation Reason ssot__ConvRsnRptSegmentTypeID__c A reference ID to the segment type. text
Report Segment Type
Conv Reason Report ssot__Id__c A unique ID used as the primary key for text
Segment Def ID the conversation reason report segment
definition DMO.
Created Date ssot__CreatedDate__c The date the record was created. dateTime
Data Source ssot__DateSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by the external record ID.
Data Source Object ssot__DateSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
conversation reason report segment
definition.
Name ssot__Name__c The name of the conversation reason text
report segment definition.
SegmentObject ssot__SegmentObjectName__c The name of the segment object for the text
conversation reason report segment
definition.
Target Object ssot__TargetObjectName__c The name of the target object for the text
conversation reason report segment
definition.
Data Use Legal Basis DMO
The Data Use Legal Basis DMO is a Data Cloud data model object (DMO) for the legal reason for contacting a customer, such as billing
or contract.
237
Model Data in Data Cloud Data Use Legal Basis DMO
Object API Name
ssot__DataUseLegalBasis__dlm
Category
Other
Primary Subject Area
Privacy
Primary Key
Data Use Legal Basis ID (ssot__Id__c)
Relationships
There are no relationships related to this DMO.
All Fields
Field Name Field API Name Description Data
Type
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
Data Use Legal Basis ID ssot__Id__c A unique ID used as primary key for the text
Data Use Legal Basis DMO.
Data Use Legal Basis Name ssot__Name__c The name of data uses legal basis. text
Description ssot__Description__c The description of data uses legal basis. text
External Record ID ssot__ExternalRecordId__c A reference ID to an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
business account.
Source ssot__Source__c The source of the data consent request. text
238
Model Data in Data Cloud Data Use Purpose DMO
Data Use Purpose DMO
The Data Use Purpose DMO is a Data Cloud data model object (DMO) for the purpose of contacting a prospect or customer, such as for
billing, marketing, or surveys.
Object API Name
ssot__DataUsePurpose__dlm
Category
Other
Primary Subject Area
Privacy
Primary Key
Data Use Purpose ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Communication Data Use Purpose ID Many To One: N:1 Data Use Purpose Data Use Purpose ID
Subscription
Data Use Purpose Data Use Purpose ID Many To One: N:1 Data Use Purpose Data Use Purpose ID
Consent Action
All Fields
Field Name Field API Name Description Data
Type
Can Data Subject Opt Out ssot__CanDataSubjectOptOut__c An indicator whether a user can opt out text
of data use for a specific purpose.
Data Source ssot__DataSourceId__c A reference ID to logical name for system text
that is source of records identified by
external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID to logical name of object text
where record originated, for example a
cloud storage file or another connector’s
external object.
239
Model Data in Data Cloud Deposit Account DMO
Field Name Field API Name Description Data
Type
Data Use Purpose ID ssot__Id__c A unique ID used as primary key for the text
Data Use Purpose DMO.
Data Use Purpose Name ssot__Name__c The purpose name, for example text
third-party data sharing, marketing,
billing, or shipping.
Description ssot__Description__c The description of the purpose of the data text
use.
Entity ssot__EntityId__c A reference ID to class of data specific to text
data use purpose, for example product.
Entity Instance ID ssot__EntityInstanceId__c A reference ID to instance of an entity. text
External Record ID ssot__ExternalRecordId__c A reference ID to an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
business account.
Legal Basis ID ssot__LegalBasisId__c A reference ID to legal basis of data use. text
Maintain Per Contact ssot__CanMaintainPerContactChannel__c An indicator whether data use purpose text
Channel Flag can be maintained per contact channel.
Maintain Per Contact Point ssot__CanMaintainPerContactPoint__c An indicator whether data use purpose text
Flag can be maintained per contact point.
Maintain Per Party Flag ssot__CanMaintainPerParty__c An indicator whether data use purpose text
can be maintained per party.
Deposit Account DMO
Represents a subtype of a financial account. Provided in the Financial Services Cloud Data Kit. This DMO is available in API version 58
and later.
API Name
ssot__DepositAccount__dlm
Category
Profile
240
Model Data in Data Cloud Deposit Account DMO
Primary Subject Area
Financial Account
Primary Key Label
Deposit Account ID (ssot_Id_c).
Relationships
DMO Label DMO Field Label Cardinality Related DMO Related DMO Data Bundle or
Label Field Label Origin
Deposit Account Financial Account ID Many To One (N:1) Financial Account ID Financial Services
Cloud
Financial Account Deposit Account ID Many To One (N:1) Deposit Account ID Financial Services
Cloud
Fields
Label API Name Description Data Data
Type Bundle
or
Origin
Description ssot__Description__c The deposit account description. Text Financial
Services
Cloud
Financial Account ID ssot__FinancialAccountID__c The associated financial account. Text Financial
Services
Cloud
Deposit Account ID ssot__Id__c The primary key. Text Financial
Services
Cloud
Name ssot__Name__c The deposit account name. Text Financial
Services
Cloud
Is Tax Free Saving ssot__isTaxFreeSavingAccount__c Indicates whether the account is tax Text Financial
Account free. Services
Cloud
241
Model Data in Data Cloud Data Use Purpose Consent Action DMO
Data Use Purpose Consent Action DMO
The Data Use Purpose Consent Action DMO is a Data Cloud data model object (DMO) for individual consent preferences for consent
actions.
Object API Name
ssot__DataUsePurposeConsentAction__dlm
Category
Privacy
Primary Subject Area
Privacy
Primary Key
Data Use Purpose Consent Action ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Data Use Purpose Data Use Purpose ID Many To One: N:1 Data Use Purpose Data Use Purpose ID
Consent Action
All Fields
Field Name Field API Name Description Data
Type
Consent Action ssot__ConsentActionId__c A reference ID to user permission text
regarding how their personal data is
shared, for example data collection (of
events), tracking (of web and email
activity), and sharing data with third
parties.
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
242
Model Data in Data Cloud Device DMO
Field Name Field API Name Description Data
Type
Data Use Purpose Category ssot__Id__c A unique ID used as primary key for the text
ID Data Use Purpose Consent Action DMO.
Data Use Purpose ID ssot__DataUsePurposeId__c A reference ID to reason for contacting a text
prospect or customer, for example billing,
marketing, or surveys.
External Record ID ssot__ExternalRecordId__c A reference ID to an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
business account.
Device DMO
The Device data model object (DMO) is a Data Cloud DMO for a specific electronic unit that you want to track signals from, for example,
a refrigerator, watch, or car.
Object API Name
ssot__Device__dlm
Category
Other
Primary Subject Area
Engagement
Primary Key
Device Id (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Contact Point App Device Many To One (N:1) Device Device ID
243
Model Data in Data Cloud Device DMO
All Fields
Field Name Field API Name Description Data
Type
Advertiser Id ssot__AdvertiserId__c A reference ID for the advertiser that owns text
the device or that is the source of the
device record.
Created Date ssot__CreatedDate__c The record’s creation date. dateTime
Data Source ssot__DataSourceId__c A reference ID for the system’s logical text
name that is the source of records
identified by an external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for an object’s logical name text
where this record originated, whether
that is a name of a cloud storage file or
another connector’s external object.
Device Id ssot__Id__c A unique ID used as the primary key for text
the device DMO.
Device Number ssot__DeviceNumber__c A number assigned to the device. text
Device System Token ssot__DeviceSystemTokentext__c A token assigned to the device that text
uniquely identifies the device from the
perspective of the operating system.
Device Type ssot__DeviceTypeId__c The reference ID for the type of device. text
DeviceEndPoints ssot__DeviceEndPoints__c The device’s end points. text
relationship
DeviceUserSessions ssot__DeviceUserSessions__c The device’s user sessions. text
relationship
External Record Id ssot__ExternalRecordId__c A reference ID for an external data source text
system.
External Source Id ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
GCM Sender Id ssot__GCMSenderId__c A reference ID assigned to the device in text
Google Cloud Messaging (GCM).
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
data record.
Language ssot__LanguageId__c The device’s operating language. text
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the dateTime
record.
Manufacturer Name ssot__ManufacturerName__c The device’s manufacturer name. text
244
Model Data in Data Cloud Device Application Engagement DMO
Field Name Field API Name Description Data
Type
Model Name ssot__ModelName__c The device’s model name. text
Name ssot__Name__c The name of the device. text
OS Name ssot__OSName__c The device’s operating system name. text
OS Version ssot__OSVersionNumber__c The operating system version number for text
the device’s OS.
Device Application Engagement DMO
The Device Application Engagement DMO is a Data Cloud data model object (DMO) for data about device engagement, for example
mobile app usage.
Object API Name
ssot__DeviceApplicationEngagement__dlm
Category
Engagement
Primary Subject Area
Engagement
Primary Key
Device Application Engagement Id
(ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Device Application Contact Point Many To One (N:1) Contact Point App Contact Point App ID
Engagement
Device Application Engagement Asset Many To One (N:1) Device Application Device Application
Engagement Template Template ID
Device Application Contact Point Many To One (N:1) Contact Point Address Contact Point Address ID
Engagement
Device Application Contact Point Many To One (N:1) Contact Point Email Contact Point Email ID
Engagement
245
Model Data in Data Cloud Device Application Engagement DMO
Object Field Cardinality Related Object Related Field
Device Application Contact Point Many To One (N:1) Contact Point Phone Contact Point Phone ID
Engagement
Device Application Engagement Asset Many To One (N:1) Email Template Email Template ID
Engagement
Device Application Engagement Asset Many To One (N:1) SMS Template SMS Template ID
Engagement
Device Application Individual Many To One (N:1) Individual Individual ID
Engagement
Device Application Market Journey Activity Many To One (N:1) Market Journey Activity Market Journey Activity
Engagement ID
Engagement Topic Engagement Many To One (N:1) Device Application Device Application
Engagement Engagement ID
All Fields
Field Name Field API Name Description Data
Type
Account Contact ssot__AccountContactId__c A reference ID for the account contact. text
Action Cadence Step ssot__ActionCadenceStepId__c A reference ID for the action cadence step. text
Case ssot__CaseId__c A reference ID for any recorded issue, such text
as a laptop connectivity problem
Contact Point ssot__ContactPointId__c A reference ID for the accounts’ contact text
point, for example, an address or social
network handle.
Created Date ssot__CreatedDate__c The date the record was created. dateTime
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
Device ssot__DeviceId__c A reference ID for a specific device on text
which the engagement was recorded.
Device App Event Type ssot__DeviceAppEventTypeId__c A reference ID for the Device App Event text
Type DMO.
246
Model Data in Data Cloud Device Application Engagement DMO
Field Name Field API Name Description Data
Type
Device Application ssot__Id__c A unique ID used as the primary key for text
Engagement ID the device application engagement DMO.
Device Country ssot__DeviceCountryId__c The reference ID of the country where the text
device is located.
Device IP Address ssot__DeviceIPAddress__c The IP address of the device. text
Device Latitude ssot__DeviceLatitude__c The geo latitude of the device when the number
engagement was recorded.
Device Locale ssot__DeviceLocaleId__c A reference ID for the user locale text
configured on the device.
Device Longitude ssot__DeviceLongitude__c The geo longitude of the device when the number
engagement was recorded.
Device Postal Code ssot__DevicePostalCode__c The postal code associated with the text
device.
Device Type Device_Type__c The type of device. text
Engagement Asset ssot__EngagementAssetId__c A reference ID for the type of engagement text
asset.
Engagement Channel ssot__EngagementChannelId__c A reference ID for the engagement text
channel.
Engagement Channel ssot__EngagementChannelActionId__c A reference ID for the engagement action. text
Action
Engagement Channel Type ssot__EngagementChannelTypeId__c A reference ID for the engagement text
channel type.
Engagement Date Time ssot__EngagementDateTm__c The date and time of engagement. dateTime
Engagement Event ssot__EngagementEventDirectionId__c A reference ID for the engagement event text
Direction direction, for example, inbound or
outbound.
Engagement Notes ssot__EngagementNotesTxt__c The details about what transpired during text
the engagement.
Engagement Number ssot__EngagementNbr__c A user-facing ID for an engagement. text
Engagement Publication ssot__EngagementPublicationId__c A reference ID for a background process text
that generates volumes of emails, SMS,
or other engagement types.
Engagement Type ssot__EngagementTypeId__c A reference ID for one of the defined text
varieties of engagement, for example, an
email or a phone engagement.
247
Model Data in Data Cloud Device Application Engagement DMO
Field Name Field API Name Description Data
Type
Engagement Vehicle ssot__EngagementVehicleId__c A reference ID for the vehicle through text
which the engagement was recorded.
External Record ID ssot__ExternalRecordId__c A reference ID for an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Geofence Name ssot__GeofenceName__c The geofence name where the device was text
when the engagement was recorded.
Individual ssot__IndividualId__c A reference ID for the person that is the text
contact for the account.
Internal Engagement Actor ssot__ssot__InternalEngagementActorId__c A reference ID for an internal engagement text
actor that groups the different types of
individuals who are targets of marketing
engagements.
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
data record.
Is Test Send ssot__IsTestSend__c An indicator if the engagement record text
was generated as part of testing.
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the dateTime
record.
Lead ssot__ssot__LeadlId__c A reference ID for a person or company text
that showed interest in the company's
products.
Link URL ssot__LinkURL__c The URL that was used to access a text
software application or web page.
Market Audience ssot__MarketAudienceId__c A reference ID to a market audience or text
the people you want to reach with
marketing communication.
Market Journey Activity ssot__MarketJourneyActivityId__c A reference ID for a step or activity that a text
customer configures in the Salesforce
Journey Builder tool.
Market Segment ssot__MarketSegmentId__c A reference ID for a group of people who text
share one or more common
characteristics, grouped for marketing
purposes who are associated with this
engagement.
248
Model Data in Data Cloud Device Application Engagement DMO
Field Name Field API Name Description Data
Type
Marketing Email List ssot__MarketingEmailListId__c A reference ID for a set of email addresses text
that is used for marketing
communications.
Name ssot__Name__c The name of the engagement. text
Referrer ssot__Referrer__c A container that stores contextual data text
about the user's usage of the site or the
application that referred them to the
software application that generated the
engagement. For example, a campaign
or search advertisement.
Referrer URL ssot__ReferrerURL__c The URL of the application that the user text
was using before being directed to the
Software Application that generated this
Engagement.
Sales Order ssot__SalesOrderId__c A reference ID for the internal document text
generated by the seller.
Screen Name ssot__ScreenName__c The name of the screen. text
SDK Version Number ssot__SdkVersionNbr__c The Software Development Kit (SDK) text
version number of the software powering
the device.
Sent Date Time ssot__SentDateTm__c The date and time when the publication dateTime
or communication was sent.
Session ssot__SessionId__c A reference ID for the session used to text
group related events together.
Shopping Cart ssot__ShoppingCartId__c A reference ID for the shopping cart for text
data captured from user actions such as
adding and removing items from a
shopping cart.
Software Application ssot__SoftwareApplicationId__c A reference ID for the software application text
that generated the engagement, or that
is on the device where the engagement
was generated.
Target Engagement Actor ssot__TargetEngagementActorId__c A reference ID for how groups of text
individuals are targeted for marketing
engagements, for example, leads.
Task ssot__TaskId__c A reference ID that represents a business text
activity such as making a phone call or
other to-do items.
249
Model Data in Data Cloud Device Application Template DMO
Field Name Field API Name Description Data
Type
Time In App Seconds ssot__TimeInAppSecondsCt__c The time spent in the application, number
Count measured in seconds.
Web Cookie ssot__WebCookieId__c A reference ID for a small piece of data text
sent from a website and stored on the
user's computer by the user's web
browser while the user is browsing.
Workflow ssot__WorkflowId__c A reference ID for a sequence of steps or text
processes in a software application
through which a piece of work passes
from initiation to completion.
Device Application Template DMO
The Device Application Template DMO is a Data Cloud data model object (DMO) for a reusable standard format for applications to
exchange information between devices.
Object API Name
ssot__DeviceApplicationTemplate__dlm
Category
Other
Primary Subject Area
Engagement
Primary Key
Device Application Template ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Device Application Engagement Asset Many To One (N:1) Device Application Device Application
Engagement Template Template ID
Email Engagement Engagement Asset Many To One (N:1) Device Application Device Application
Template Template ID
Message Engagement Engagement Asset Many To One (N:1) Device Application Device Application
Template Template ID
250
Model Data in Data Cloud Device Application Template DMO
All Fields
Field Name Field API Name Description Data
Type
Created Date ssot__CreatedDate__c The date the record was created. dateTime
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
Device Application ssot__Id__c A unique ID used as primary key for text
Template ID Device Application Template DMO.
Device ssot__DeviceApplicationTemplateBodyTxt__c The text representation of device text
ApplicationTemplate Body application message.
Engagement Asset ssot__EngagementAssetNbr__c A user-facing number to identify the text
Number engagement asset.
Engagement Asset Type ssot__EngagementAssetTypeId__c A reference ID to type of engagement text
asset, for example an email or phone
template.
Engagement Message ssot__EngagementMessageTypeId__c A reference ID to type of engagement text
Type message, for example outbound, location
entry, or beacon.
External Record ID ssot__ExternalRecordId__c A reference ID for an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Internal Organization ssot__InternalOrganizationId__c A reference ID to business unit or other text
internal organization that owns business
account.
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the dateTime
record.
Message Format Type ssot__MessageFormatTypeId__c A reference ID to type of asset or template text
format, for example a landing page or
application alert.
Parent Engagement Asset ssot__ParentEngagementAssetId__c A reference ID for primary engagement text
asset. This relationship enables
engagement asset hierarchies.
251
Model Data in Data Cloud Email Engagement DMO
Email Engagement DMO
The Email Engagement DMO is a Data Cloud data model object (DMO) for data captured from various data sources about engagement
in the Email channel.
Object API Name
ssot__EmailEngagement__dlm
Category
Engagement
Primary Subject Area
Engagement
Primary Key
Email Engagement Id (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Email Engagement Engagement Asset ManyToOne (N:1) Device Application Device Application
Template Template Id
Email Engagement Engagement Asset ManyToOne (N:1) SMS Template SMS Template Id
Email Engagement Market Journey Activity ManyToOne (N:1) Market Journey Activity Market Journey Activity
Id
Email Engagement Engagement Publication ManyToOne (N:1) Email Publication Email Publication Id
Email Engagement Engagement Asset ManyToOne (N:1) Email Template Email Template Id
Email Engagement Individual ManyToOne (N:1) Individual Individual Id
Engagement Topic Engagement ManyToOne (N:1) Email Engagement Email Engagement Id
All Fields
Field Name Field API Name Description Data
Type
Account Contact ssot__AccountContactId__c A reference ID to account contact. text
Action Cadence Step ssot__ActionCadenceStepId__c A reference ID to action cadence step. text
252
Model Data in Data Cloud Email Engagement DMO
Field Name Field API Name Description Data
Type
Case ssot__CaseId__c A reference ID to a recorded issue, for text
example laptop connectivity.
City Name ssot__CityName__c The city of recipient derived from IP text
address at time of engagement event.
Contact Point ssot__ContactPointId__c A reference ID to accounts’ contact point, text
for example physical address, email
address, or phone number.
Country ssot__CountryId__c A reference ID to country of recipient text
derived from IP address at time of
engagement event.
Created Date ssot__CreatedDate__c The date the record was created. datetime
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
Device Country ssot__DeviceCountryId__c A reference ID to the country where text
device is located.
Device IP Address ssot__DeviceIPAddress__c The IP address of device. text
Device Latitude ssot__DeviceLatitude__c The Geo latitude of the device when number
engagement was recorded.
Device Locale ssot__DeviceLocaleId__c A reference ID to user locale configured text
on device.
Device Longitude ssot__DeviceLongitude__c The Geo longitude of the device when number
engagement was recorded.
Device Postal Code ssot__DevicePostalCode__c The postal code associated with device. text
Email Domain Name ssot__EmailDomainName__c The subset of email address that text
represents domain after @ sign.
Email Engagement Id ssot__Id__c A unique ID used as primary key for the text
Email Engagement DMO.
Email From Address ssot__EmailFromAddr__c The email address of sender profile text
associated with email at time of send.
Email From Name ssot__EmailFromName__c The sender profile name associated with text
email at time of send.
253
Model Data in Data Cloud Email Engagement DMO
Field Name Field API Name Description Data
Type
Email Name ssot__EmailName__c The email message name associated at text
time of send.
Engagement Asset ssot__EngagementAssetId__c A reference ID to the engagement asset. text
Engagement Channel ssot__EngagementChannelId__c A reference ID to the engagement text
channel.
Engagement Channel ssot__EngagementChannelActionId__c A reference ID to the engagement text
Action channel action.
Engagement Channel Type ssot__EngagementChannelTypeId__c A reference ID to the type of engagement text
channel.
Engagement Date Time ssot__EngagementDateTm__c The date and time of engagement. datetime
Engagement records result from activities
occurring later than the send, so
Engagement Date Time must be later
than Send Date Time.
Engagement Event ssot__EngagementEventDirectionId__c The engagement event direction where text
Direction values are Inbound or Outbound.
Engagement Notes ssot__EngagementNotesTxt__c The details about what transpired during text
engagement.
Engagement Number ssot__EngagementNbr__c A user-facing ID that isn’t automatically text
set using auto-number.
Engagement Publication ssot__EngagementPublicationId__c A reference ID to background process that text
generates volumes of email messages,
SMS messages, or other Engagement
Vehicle types. Publications can be specific
to Engagement Channel Actions.
Engagement Type ssot__EngagementTypeId__c A reference ID to the type of engagement, text
for example email or phone.
Engagement Vehicle ssot__EngagementVehicleId__c A reference ID for the engagement text
vehicle.
External Record ID ssot__ExternalRecordId__c A reference ID for an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Individual ssot__IndividualId__c A reference ID to contact for account. text
Internal Engagement Actor ssot__InternalEngagementActorId__c A reference ID to engagement actor that text
groups the different types of individuals
targeted for marketing engagements, for
example leads and account contacts.
254
Model Data in Data Cloud Email Engagement DMO
Field Name Field API Name Description Data
Type
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
business account.
Is Test Send ssot__IsTestSend__c A flag to indicate if an engagement record text
was generated as part of testing.
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the datetime
record.
Lead ssot__LeadlId__c A reference ID to person or company that text
showed interest in products.
Link URL ssot__LinkURL__c The link where software application or text
web page accessed, generated the
engagement.
Market Audience ssot__MarketAudienceId__c A reference ID to the intended audience text
that engagement was designed to reach.
Market Journey Activity ssot__MarketJourneyActivityId__c A reference ID to step or activity that text
customer configures in Salesforce Journey
Builder tool for marketing associated with
engagement.
Market Segment ssot__MarketSegmentId__c A reference ID to group of people who text
share one or more common
characteristics, and are grouped for
marketing associated with engagement.
Marketing Email List ssot__MarketingEmailListId__c A reference ID to the marketing email list text
used for the engagement.
Name ssot__Name__c The name of the engagement. text
Referrer ssot__Referrer__c The name of a generic marketing method text
that generated user engagement, for
example a campaign or search
advertisement. For example, a campaign
or search advertisement.
Referrer URL ssot__ReferrerURL__c The URL of application that directed user text
to the software application that
generated engagement.
Sales Order ssot__SalesOrderId__c An internal document generated by seller text
indicating that customer is ready to
purchase products and services.
Send Classification ssot__SendClassificationId__c A reference ID to how consent is checked, text
for example Transactional such as placing
an order implies opt-in for an order
255
Model Data in Data Cloud Email Message DMO
Field Name Field API Name Description Data
Type
confirmation email or a commercial
promotional email requiring opt-in
Sent Date Time ssot__SentDateTm__c The date and time of send. datetime
Session ssot__SessionId__c A reference ID to session used to group text
related events together.
Shopping Cart ssot__ShoppingCartId__c A reference ID to the shopping cart for text
data captured from user actions, for
example adding or removing items from
shopping cart.
State Province ssot__StateProvinceId__c A reference ID to the state of recipient text
derived from IP address at time of
engagement event.
State Province Code ssot__StateProvinceTxt__c A reference ID to the state/province code text
of recipient derived from IP address at
time of engagement event.
Subject Line Text ssot__SubjectLineTxt__c The associated email subject line at the text
time of send.
Target Engagement Actor ssot__TargetEngagementActorId__c A reference ID to engagement actor that text
groups different types of individuals
targeted for marketing associated with
engagement, for example leads and
account contacts.
Task ssot__TaskId__c A reference ID to business activity, for text
example making a phone call. In the user
interface, tasks and event records are
collectively referred to as activities.
Web Cookie ssot__WebCookieId__c A reference ID to a small piece of data text
sent from website and stored on user's
computer by user's web browser while
user is browsing.
Workflow ssot__WorkflowId__c A reference ID to a sequence of steps or text
processes in software application where
a piece of work passes from initiation to
completion.
Email Message DMO
The Email Message DMO is a Data Cloud data model object (DMO) for an email message, usually text, but possibly HTML, including
attachments sent or received over the network.
256
Model Data in Data Cloud Email Message DMO
Object API Name
ssot__EmailMessage__dlm
Category
Engagement
Primary Subject Area
Primary Key
Email Message ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Email Message Case ID Many To One: N:1 Case Case ID
Email Message Created By Many To One: N:1 User User ID
Email Message Last Modified By Many To One: N:1 User User ID
All Fields
Field Name Field API Name Description Data
Type
Case Id ssot__CaseId__c A reference ID to the associated case. text
Channel Engagement ssot__ChannelEngagementNumber__c The channel engagement number for the text
Number email messagel.
Country Region ssot__CountryRegion__c The country or region for the email text
message.
Created By ssot__CreatedById__c A reference ID to the user who created text
the record.
Created Date ssot__CreatedDate__c The date the record was created. dateTime
Created Date Time ssot__CreatedDateTime___c The time the record was created. dateTime
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
257
Model Data in Data Cloud Email Message DMO
Field Name Field API Name Description Data
Type
whether that is a name of a cloud storage
file or another connector’s external object.
Email Header ssot__EmailHeaderText__c The header text for the email message. text
Email Message ssot__EmailMessageText__c The message text for the email message. text
Email Message Id ssot__Id__c A unique ID used as the primary key for text
the email message DMO.
Email Status ssot__EmailStatus__c The status of the email message. text
Email Subject ssot__EmailSubjectText__c The subject text for the email message. text
Email Thread ssot__EmailThreadId__c A reference ID to the email thread the text
message is associated with.
Engagement Channel Type ssot__EngagementChannelType__c The engagement channel type for the text
email message.
External BCC Email Address ssot__ExternalBCCEmailAddressListText__c The external BCC email address list for the text
List email message.
First Open Date ssot__FirstOpenDate__c The date the message was first opened. dateTime
From Address ssot__FromAddress__c The from address of the email message. text
From Name ssot__FromName__c The from name of the email message. text
HasRelatedDocument ssot__HasRelatedDocument__c An indicator if the email message has a text
related document.
HTML Body ssot__HTMLBodyText__c The HTML body text for the email text
message.
Internal BCC Email Address ssot__InternalBCCEmailAddressListText__c The internal BCC email address list for the text
List email message.
Internal CC Email Address ssot__InternalCCEmailAddressListText__c The internal CC email address list for the text
List email message.
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
email message.
Is Bounced ssot__IsBounced__c An indicator if the email message has text
bounced.
Is Incoming ssot__IsIncoming__c An indicator if the email message is an text
incoming message.
Is Opened ssot__IsOpened__c An indicator if the email message has text
been opened.
258
Model Data in Data Cloud Email Publication DMO
Field Name Field API Name Description Data
Type
Is Private Draft ssot__IsPrivateDraft__c An indicator if the email message is a text
private draft.
Is Tracked ssot__IsTracked__c An indicator if the email message is text
tracked.
Last Modified By ssot__LastModifiedById__c A reference ID to the user that made the text
last update.
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the dateTime
record.
Lastest Open Date ssot__LastestOpenDate__c The date the message was opened last. dateTime
Market Journey Activity ssot__MarketJourneyActivity__c The market journey activity for the email text
message.
Message Date ssot__MessageDate__c The date the email message was sent. dateTime
Message Purpose ssot__MessagePurpose__c The purpose for the email message. text
Name ssot__Name__c The name of the case. text
Related To ssot__RelatedToId__c A reference ID to the related item for the text
email message.
Related To Object ssot__RelatedToObject__c The related object for the message. text
Reply To Address ssot__ReplyToAddress__c The reply to address for the email text
message.
Reply To Email Message ssot__ReplyToEmailMessageId__c A reference ID to the reply to message for text
the email message.
Software Application ssot__SoftwareApplication__c The software application for the email text
message.
Subject ssot__Subject__c The subject for the email message. text
To Email Address List ssot__ToEmailAddressListText__c The to email address list for the email text
message.
Email Publication DMO
The Email Publication DMO is a Data Cloud data model object (DMO) that contains information about a publication such as a campaign
or an orchestration used in the Email channel
Object API Name
ssot__EmailPublication__dlm
259
Model Data in Data Cloud Email Publication DMO
Category
Engagement
Primary Subject Area
Engagement
Primary Key
Email Publication Id (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Object Field Cardinality Related Object Related Field
Email Engagement Engagement Publication ManyToOne Email Publication Email Publication Id
All Fields
Field Name Field API Name Description Data Type
Body Text ssot__BodyTxt__c The text representation of an text
Email message.
Click Through Percent ssot__ClickThroughPct__c The percentage of emails sent number
which contained a tracked URL
that was clicked by the recipient.
Click To Open Percent ssot__ClickToOpenPct__c The quantity of emails where the number
tracked URL was clicked,
compared with the quantity that
were opened, expressed as a
percentage.
Created Date ssot__CreatedDate__c The date and time record was datetime
created.
Data Source ssot__DataSourceId__c A reference ID for the logical text
name for a system that is the
source of records identified by
External Record Id.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical text
name of the object where the
record came from, whether that
is the name of a cloud storage
260
Model Data in Data Cloud Email Publication DMO
Field Name Field API Name Description Data Type
file or another connector’s
external object.
Delivery Percent ssot__DeliveryPct__c The percentage of emails sent number
based on this template that
were successfully delivered.
Description ssot__Description__c Detailed description of an text
in-person appointment.
Duration Seconds Quantity ssot__DurationSecondsQty__c number
Email Publication Id ssot__Id__c A unique ID used as the primary text
key for Email Publication Id.
Engagement Asset ssot__EnagementAssetId__c A reference ID to the text
engagement asset.
Engagement Asset content ssot__EnagementAssetContentId__c A reference ID to the text
engagement asset content.
Engagement Channel Type ssot__EngagementChannelTypeId__c A reference ID to the type of text
engagement channel.
Engagement Publication ssot__EngagementPublicationNbr__c The engagement publication text
Number number.
Engagement Publication Status ssot__EngagementPublicationStatusId__c The engagement publication text
status.
Engagement Publication Type ssot__EnagementPublicationTypeId__c The engagement publication text
type.
Engagement Topic Group ssot__EngagementTopicGroupId__c A reference ID for the master list text
of topics that Engagements can
be about.
Error Message Text ssot__ErrorMessageTxt__c The text of the error message text
External Record Id ssot__ExternalRecordId__c A reference ID to an external text
data source system.
External Source Id ssot__ExternalSourceId__c A reference ID for the system in text
which the External Record ID
was assigned.
Failed Record Count ssot__FailedRecordCt__c number
From Address ssot__FromAddr__c Email address from which the text
emails are sent
From Name ssot__FromName__c The name of the person the text
email is from.
261
Model Data in Data Cloud Email Publication DMO
Field Name Field API Name Description Data Type
Has Attachment ssot__HasAttachment__c True if an attachment is included text
in this email.
HTML Body ssot__HTMLBodyTxt__c The HTML rendering of the email text
body.
Internal Organization ssot__InternalOrganizationId__c A reference ID to a business unit text
or other internal organization
that owns the business account.
Is Tracked ssot__IsTracked__c text
Last Modified Date ssot__LastModifiedDate__c Date and time when the user datetime
last modified the record.
Name ssot__Name__c The name of the Email text
publication.
Open Percent ssot__OpenPct__c The number of emails opened number
compared to the number of
emails sent, expressed as a
percentage.
Opt Out Percent ssot__OptOutPct__c The quantity of emails that number
resulted in unsubscription,
compared to the total number
sent, expressed as a percentage.
Parent Engagement Publication ssot__ParentEngagementPublicationId__c A reference ID for another text
publication. This relationship
enables engagement
publication hierarchies.
Publication Attempts Number ssot__PublicationAttemptsNbr__c number
Publication Status Date ssot__PublicationStatusDt__c datetime
Reply to Address ssot__ReplyToAddr__c The reply-to address set on the text
generated emails.
Scheduled Date ssot__ScheduledDt__c The scheduled date and time to datetime
send the email to recipients.
Send Classification ssot__SendClassificationId__c A reference ID that determines text
how consent is checked. Enum
values: Transactional (for
example, placing an order
implies opt-in for an order
confirmation email), Commercial
(promotional email requiring
opt-in)
262
Model Data in Data Cloud Email Template DMO
Field Name Field API Name Description Data Type
Send Mechanism Name ssot__SendMechanismName__c The mechanism used to send text
this email.
Successful Record Count ssot__SuccessfulRecordCt__c number
Total Delivered Quantity ssot__TotalDeliveredQty__c The number of times emails number
based on this template have
been successfully delivered.
Total Hard Bounce Quantity ssot__TotalHardBounceQty__c The number of times emails number
based on this template have
hard bounced due to invalid
email addresses.
Total Opens Quantity ssot__TotalOpensQty__c The number of times emails number
based on this template have
been opened.
Total Publication Items Count ssot__TotalPublicationItemsCt__c number
Total Sent Quantity ssot__TotalSentQty__c The number of emails sent. number
Total Soft Bounce Quantity ssot__TotalSoftBounceQty__c The number of times emails number
based on this template have soft
bounced (returned by server).
Total Spam Complaints Quantity ssot__TotalSpamComplaintsQty__c The number of emails that were number
reported as spam.
Total Tracked Link Clicks ssot__TotalTrackedLinkClicksQty__c The number of tracked URLs in number
Quantity emails that were opened.
Unique Click Through Percent ssot__UniqueClickThroughPct__c The percentage of emails sent number
which contained a tracked URL
that was clicked by unique
recipients.
Unique Opens Quantity ssot__UniqueOpensQty__c The number of emails that were number
opened by unique recipients.
Unique Opt Outs Quantity ssot__UniqueOptOutsQty__c The total number of emails that number
resulted in recipients
unsubscribing.
Unique Tracked Link Clicks ssot__UniqueTrackedLinkClicksQty__c The number of tracked URLs in number
Quantity emails that were opened by
unique recipients.
Email Template DMO
The Email Template DMO is a Data Cloud data model object (DMO) for the standard form of an email message that can be personalized
and customized based on a campaign.
263
Model Data in Data Cloud Email Template DMO
Object API Name
ssot__EmailTemplate__dlm
Category
Other
Primary Subject Area
Engagement
Primary Key
Email Template ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Device Application Engagement Asset ManyToOne Email Template Email Template ID
Engagement
Email Engagement Engagement Asset ManyToOne Email Template Email Template ID
Message Engagement Engagement Asset ManyToOne Email Template Email Template ID
All Fields
Field Name Field API Name Description Data
Type
API Version ssot__APIVersionName__c The variant number of email API used text
with template.
Body ssot__BodyTxt__c The content of an email. text
Created Date ssot__CreatedDate__c The date record was created. dateTime
Data Source ssot__DataSourceId__c A reference ID for logical name for system text
that is source of records identified by
External Record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
Delivery Percent ssot__DeliveryPct__c The percentage of emails based on number
template that were successfully delivered.
264
Model Data in Data Cloud Email Template DMO
Field Name Field API Name Description Data
Type
Email Template Body Text ssot__EmailTemplateBodyTxt__c Text representation of email. text
Email Template ID ssot__Id__c A unique ID used as primary key for Email text
Template DMO.
Email Template Style ssot__EmailTemplateStyleId__c A reference ID for enumeration values of text
Email Template Style: None, FreeForm,
FormalLettter, PromotionRight,
PromotionLeft, Newsletter, and Products.
Email Template Type ssot__EmailTemplateTypeId__c A reference ID for enumeration values of text
email template type, such as text or
HTML.
Engagement Asset ssot__EngagementAssetNbr__c A number assigned to an engagement text
Number asset.
Engagement Asset Type ssot__EngagementAssetTypeId__c A reference ID for the description of an text
engagement asset type, such as an email
or phone.
Engagement Message ssot__EngagementMessageTypeId__c A reference ID for the description of an text
Type Engagement Message Type. Examples
include: Outbound, Location Entry,
Location Entry, Beacon.
External Record ID ssot__ExternalRecordId__c A reference ID for an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Internal Organization ssot__InternalOrganizationId__c A reference ID for the business unit or text
other internal organization that owns the
business account.
Last Modified Date ssot__LastModifiedDate__c The date when user last modified record. dateTime
Message Format Type ssot__MessageFormatTypeId__c A reference ID for description of the text
format of the asset/template. Examples
include Landing Page, Application Alert.
Name ssot__Name__c The engagement’s name. text
Namespace Prefix Text ssot__NamespacePrefixTxt__c A value that defines a unique set of email text
templates.
Parent Engagement Asset ssot__ParentEngagementAssetId__c A reference ID to the parent record’s text
engagement asset.
Send Classification ssot__SendClassificationId__c A reference ID for the method of how user text
consents to email engagement, for
example transactional or commercial.
265
Model Data in Data Cloud Engagement Channel Type DMO
Field Name Field API Name Description Data
Type
Subject ssot__SubjectTxt__c The main topic of email. text
Times Used Quantity ssot__TimesUsedQty__c The number of times emails based on text
template has been used to create
published emails.
Total Delivered Quantity ssot__TotalDeliveredQty__c The number of times emails based on number
template that were successfully delivered.
Total Hard Bounced ssot__TotalHardBouncedQty__c The number of times emails based on number
Quantity template have hard bounced (invalid
email address).
Total Opens Quantity ssot__TotalOpensQty__c The number of times emails based on number
template have been opened.
Total Sent Quantity ssot__TotalSentQty__c The number of times published emails number
based on template have been sent.
Total Soft Bounced ssot__TotalSoftBouncedQty__c The number of times emails based on number
Quantity template have soft bounced (returned by
server).
User Interface Type ssot__UITypeTxt__c The description of type of user interface text
(UI) presented in received email message.
Engagement Channel Type DMO
The Engagement Channel Type DMO is a Data Cloud data model object (DMO) for which channels are supported by individual preferences.
For example, individuals can set consent preferences for SMS but not for a phone call.
Object API Name
ssot__EngagementChannelType__dlm
Category
Engagement
Primary Subject Area
Engagement
Primary Key
Engagement Channel Type ID (ssot__Id__c)
266
Model Data in Data Cloud Engagement Channel Type DMO
Relationships
Object Field Cardinality Related Object Related Field
Authorization Form Engagement Channel Many To One: N:1 Engagement Channel Engagement Channel
Consent Type Type Type ID
Communication Engagement Channel Many To One: N:1 Engagement Channel Engagement Channel
Subscription Channel Type Type Type ID
Type
Device Application Engagement Channel Many To One: N:1 Engagement Channel Engagement Channel
Engagement Type Type Type ID
Email Engagement Engagement Channel Many To One: N:1 Engagement Channel Engagement Channel
Type Type Type ID
Message Engagement Engagement Channel Many To One: N:1 Engagement Channel Engagement Channel
Type Type Type ID
Privacy Consent Log Engagement Channel Many To One: N:1 Engagement Channel Engagement Channel
Type Type Type ID
Product Browse Engagement Channel Many To One: N:1 Engagement Channel Engagement Channel
Engagement Type Type Type ID
Product Order Engagement Channel Many To One: N:1 Engagement Channel Engagement Channel
Engagement Type Type Type ID
Shopping Cart Engagement Channel Many To One: N:1 Engagement Channel Engagement Channel
Engagement Type Type Type ID
Website Engagement Engagement Channel Many To One: N:1 Engagement Channel Engagement Channel
Type Type Type ID
Web Search Engagement Engagement Channel Many To One: N:1 Engagement Channel Engagement Channel
Type Type Type ID
Opportunity Engagement Engagement Channel Many To One: N:1 Engagement Channel Engagement Channel
Type Type Type ID
Email Publication Engagement Channel Many To One: N:1 Engagement Channel Engagement Channel
Type Type Type ID
SMS Publication Engagement Channel Many To One: N:1 Engagement Channel Engagement Channel
Type Type Type ID
All Fields
Field Name Field API Name Description Data
Type
Can Capture Consent ssot__CanCaptureConsent__c An indicator whether the engagement text
channel provides a way for viewer or
267
Model Data in Data Cloud Engagement Channel Type Consent DMO
Field Name Field API Name Description Data
Type
consumer of communication to agree to
it. For example, consumers can be asked
to authorize SMS messages, but they can't
be asked to authorize the viewing of
billboards.
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
Engagement Channel Type ssot__Id__c A unique ID used as primary key for the text
ID Engagement Channel Type DMO.
External Record ID ssot__ExternalRecordId__c A reference ID to an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Internal Organization ssot__InternalOrganizationId__c A reference ID to business unit or other text
internal organization that owns the
business account.
Is Direct Activation Channel ssot__IsDirectActivationChannel__c An indicator whether an activation text
channel is available for use in Salesforce
applications.
Name ssot__Name__c The name of engagement channel type, text
for example SMS, email, or phone.
Engagement Channel Type Consent DMO
The Engagement Channel Type Consent DMO is a Data Cloud data model object (DMO) for an individual’s consent preferences specific
to a type of communication, such as email.
Object API Name
ssot__EngagementChannelTypeConsent__dlm
Category
Engagement
268
Model Data in Data Cloud Engagement Channel Type Consent DMO
Primary Subject Area
Privacy
Primary Key
Engagement Channel Type Consent ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Engagement Channel Party Many To One: N:1 Individual Individual ID
Type Consent
Engagement Channel Consent Status Many To One: N:1 Consent Status Consent Status ID
Type Consent
All Fields
Field Name Field API Name Description Data
Type
Consent Captured Date ssot__ConsentCaptureddateTime__c The date and time when consent was dateTime
Time captured.
Consent Captured Source ssot__ConsentCapturedSourceName__c The location where consent was captured text
for an individual.
Consent Status ssot__ConsentStatusId__c A reference ID for an individual’s consent text
status, for example, opted out of data
collection.
Data Source ssot__DataSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
Data Use Purpose ssot__DataUsePurposeId__c A reference ID to reason for contacting text
prospect or customer, for example billing,
marketing, or surveys.
Effective From Date ssot__EffectiveFromDate__c The date when consent form is in effect. dateTime
Effective To Date ssot__EffectiveToDate__c The date when a consent form is no dateTime
longer in effect.
269
Model Data in Data Cloud Engagement Topic DMO
Field Name Field API Name Description Data
Type
Engagement Channel Type ssot__EngagementChannelTypeId__c A reference ID to method of message text
delivery, for example and email or TV
commercial.
Engagement Channel Type ssot__Id__c A unique ID used as primary key for the text
Consent ID Engagement Channel Type Consent
DMO.
External Record ID ssot__ExternalRecordId__c A reference ID to an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
business account.
Name ssot__Name__c The name of the engagement channel text
type.
Party ssot__PartyId__c A reference ID to the parent party, for text
example, an individual, business, or
affiliation group.
Party Role ssot__PartyRoleId__c A reference ID to associated party role, for text
example, a customer, supplier, or
competitor.
Engagement Topic DMO
The Engagement Topic DMO is a Data Cloud data model object (DMO) that is used to refer to multiple topics such as multiple campaigns
or promotions.
Object API Name
ssot__EngagementTopic__dlm
Category
Engagement
Primary Subject Area
Engagement
270
Model Data in Data Cloud Engagement Topic DMO
Primary Key
Engagement Topic Id
(ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Engagement Topic Engagement ManyToOne (N:1) Email Engagement Email Engagement ID
Engagement Topic Engagement ManyToOne (N:1) Device Application Device Application
Engagement Engagement ID
Engagement Topic Engagement ManyToOne (N:1) Message Engagement Message Engagement ID
Engagement Topic Campaign ManyToOne {N:1) Campaign ID
All Fields
Field Name Field API Name Description Data
Type
Campaign ssot__CampaignId__c A reference ID for a campaign. A text
campaign is an outbound marketing
project that you want to plan, manage,
and track. It can be a direct mail program,
seminar, print advertisement, email, or
other type of marketing initiative.
Created Date ssot__CreatedDate__c The date record was created. dateTime
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by External Record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
Engagement ssot__EngagementId__c A reference ID for the engagement text
record, which is described by the
Engagement Topic. For example, an
Engagement record that describes an
email opened event could have a sales
campaign as a topic.
Engagement Topic Group ssot__EngagementTopicGroupId__c A reference ID for the main list of topics text
that engagements can be about.
271
Model Data in Data Cloud Financial Account Balance DMO
Field Name Field API Name Description Data
Type
Engagement Topic Id ssot__Id__c A unique ID used as primary key for the text
Email Template DMO.
External Record Id ssot__ExternalRecordId__c A reference ID for an external data source text
system.
External Source Id ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Internal Organization ssot__InternalOrganizationId__c A reference ID for the business unit or text
other internal organization that owns the
business account.
Last Modified Date ssot__LastModifiedDate__c The date when user last modified record. dateTime
Opportunity ssot__OpportunityId__c A reference ID for a deal or sale that is in text
progress, not yet completed.
Promotion ssot__PromotionId__c A reference ID for any type of marketing text
communication used to inform or
persuade target audiences of the relative
merits of a product, service, brand, or
issue.
Financial Account Balance DMO
Represents types of balances associated to a financial account. Provided in the Financial Services Cloud Data Kit. This DMO is available
in API version 58 and later.
API Name
ssot__FinancialAccountBalance__dlm
Category
Profile
Primary Subject Area
Financial Account
Primary Key Label
Financial Account Balance ID (ssot_Id_c).
272
Model Data in Data Cloud Financial Account Balance DMO
Relationships
DMO Label DMO Field Label Cardinality Related DMO Related DMO Data Bundle or
Label Field Label Origin
Financial Account Financial Account ID Many To One (N:1) Financial Account ID Financial Services
Balance Cloud
Fields
Label API Name Description Data Data
Type Bundle
or
Origin
Amount ssot__Amount__c The balance current value. Number Financial
Services
Cloud
Currency ssot__Currency__c The associated currency. Text Financial
Services
Cloud
Description ssot__Description__c The financial account balance Text Financial
description. Services
Cloud
End Date ssot__EndDate__c The balance end date. Date Financial
Time Services
Cloud
Financial Account Id ssot__FinancialAccountId__c The associated financial account. Text Financial
Services
Cloud
Financial Balance Type ssot__FinancialBalanceType__c The financial balance type. Text Financial
Services
Cloud
Financial Account ssot__Id__c The primary key. Text Financial
Balance ID Services
Cloud
Name ssot__Name__c The financial account balance name. Text Financial
Services
Cloud
Start Date ssot__StartDate__c The balance start date. Date Financial
Time Services
Cloud
273
Model Data in Data Cloud Financial Account DMO
Financial Account DMO
Represents a financial account held at a financial institution such as a bank. Provided in the Financial Services Cloud Data Kit. This DMO
is available in API version 58 and later.
API Name
ssot__FiancialAccount__dlm
Category
Profile
Primary Subject Area
Financial Account
Primary Key Label
Financial Account ID (ssot_Id_c).
Relationships
DMO Label DMO Field Label Cardinality Related DMO Related DMO Data Bundle or
Label Field Label Origin
Financial Account Address Many To One (N:1) Address ID Financial Services
Cloud
Financial Account Card Account ID Many To One (N:1) Card Account ID Financial Services
Cloud
Financial Account Deposit Account ID Many To One (N:1) Deposit Account ID Financial Services
Cloud
Financial Account Insurance Policy ID Many To One (N:1) Insurance Policy ID Financial Services
Cloud
Financial Account Investment Account Many To One (N:1) Investment Account ID Financial Services
ID Cloud
Financial Account Loan Account ID Many To One (N:1) Loan Account ID Financial Services
Cloud
Card Account Financial Account ID Many To One (N:1) Financial Account ID Financial Services
Cloud
Communication Financial Account ID Many To One (N:1) Financial Account ID Financial Services
Subscription Cloud
Consent
Deposit Account Financial Account ID Many To One (N:1) Financial Account ID
274
Model Data in Data Cloud Financial Account DMO
DMO Label DMO Field Label Cardinality Related DMO Related DMO Data Bundle or
Label Field Label Origin
Financial Account Financial Account ID Many To One (N:1) Financial Account ID Financial Services
Balance Cloud
Financial Account Financial Account ID Many To One (N:1) Financial Account ID Financial Services
Fee Cloud
Financial Account Financial Account ID Many To One (N:1) Financial Account ID Financial Services
Interest Rate Cloud
Financial Account Financial Account ID Many To One (N:1) Financial Account ID Financial Services
Limit Cloud
Financial Account Financial Account ID Many To One (N:1) Financial Account ID Financial Services
Party Cloud
Financial Account Financial Account ID Many To One (N:1) Financial Account ID Financial Services
Transaction Cloud
Financial Holding Financial Account ID Many To One (N:1) Financial Account ID Financial Services
Cloud
Insurance Policy Financial Account ID Many To One (N:1) Financial Account ID Financial Services
Cloud
Investment Account Financial Account ID Many To One (N:1) Financial Account ID Financial Services
Cloud
Loan Account Financial Account ID Many To One (N:1) Financial Account ID Financial Services
Cloud
Payment Method Financial Account ID Many To One (N:1) Financial Account ID Financial Services
Cloud
Record Alert Financial Account ID Many To One (N:1) Financial Account Financial Services
Cloud
Fields
Label API Name Description Data Data
Type Bundle
or
Origin
Application Date ssot__ApplicationDate__c The financial account application Date Financial
submission date. Time Services
Cloud
Close Date ssot__CloseDate__c The financial account close date. Date Financial
Time Services
Cloud
275
Model Data in Data Cloud Financial Account DMO
Label API Name Description Data Data
Type Bundle
or
Origin
Credit Card Account ID ssot__CreditCardAccountId__c The associated credit card account. Text Financial
Services
Cloud
Current Account ID ssot__CurrentAccountId__c The associated current amount. Text Financial
Services
Cloud
Description ssot__Description__c The financial account description. Text Financial
Services
Cloud
Financial Account ID ssot__Id__c The primary key. Text Financial
Services
Cloud
Insurance Policy Id ssot__InsurancePolicyId__c The associated insurance policy. Text Financial
Services
Cloud
Investment Account Id ssot__InvestmentAccountId__c The associated investment account . Text Financial
Services
Cloud
Lien Holder Name ssot__LienHolderName__c Name of lien holder on the financial Text Financial
account. Services
Cloud
Loan Account Id ssot__LoanAccountId__c The associated loan account. Text Financial
Services
Cloud
Name ssot__Name__c The financial account name. Text Financial
Services
Cloud
Open Date ssot__OpenDate__c The financial account open date. Date Financial
Time Services
Cloud
Routing Number Text ssot__RoutingNumberText__c The bank routing number. Text Financial
Services
Cloud
Savings Account Id ssot__SavingsAccountId__c The associated savings account. Text Financial
Services
Cloud
276
Model Data in Data Cloud Financial Account Fee DMO
Label API Name Description Data Data
Type Bundle
or
Origin
Trust Owner Name ssot__TrustOwnerName__c Name of the trust where the account Text Financial
is managed by a trust. Services
Cloud
Is Held Away ssot__isHeldAway__c Indicates whether this financial Text Financial
account is held by another Services
organization. Cloud
Is Managed ssot__isManaged__c Indicates whether the financial Text Financial
account is managed. Services
Cloud
Financial Account Fee DMO
Represents fees associated with a financial account. Provided in the Financial Services Cloud Data Kit. This DMO is available in API version
58 and later.
API Name
ssot__FinancialAccountFee__dlm
Category
Profile
Primary Subject Area
Financial Account
Primary Key Label
Financial Account Fee ID (ssot_Id_c).
Relationships
DMO Label DMO Field Label Cardinality Related DMO Related DMO Data Bundle or
Label Field Label Origin
Financial Account Financial Account ID Many To One (N:1) Financial Account ID Financial Services
Fee Cloud
277
Model Data in Data Cloud Financial Account Interest Rate DMO
Fields
Label API Name Description Data Data
Type Bundle
or
Origin
Amount ssot__Amount__c The financial account fee amount. Number Financial
Services
Cloud
Currency ssot__Currency__c The financial account fee currency. Text Financial
Services
Cloud
Description ssot__Description__c The financial account fee description. Text Financial
Services
Cloud
End Date ssot__EndDate__c The end date of the limit. Date Financial
Time Services
Cloud
Financial Account Id ssot__FinancialAccountId__c The associated financial account. Text Financial
Services
Cloud
Financial Fee Type ssot__FinancialFeeType__c The financial account fee type. Text Financial
Services
Cloud
Financial Account Fee ID ssot__Id__c The primary key. Text Financial
Services
Cloud
Name ssot__Name__c The financial account fee name. Text Financial
Services
Cloud
Start Date ssot__StartDate__c The start date of the financial account Date Financial
fee. Time Services
Cloud
Financial Account Interest Rate DMO
Represents the interest rate associated with a financial account. Provided in the Financial Services Cloud Data Kit. This DMO is available
in API version 58 and later.
API Name
ssot__FinancialAccountInterestRate__dlm
278
Model Data in Data Cloud Financial Account Interest Rate DMO
Category
Profile
Primary Subject Area
Financial Account
Primary Key Label
Financial Account Interest Rate (ssot_Id_c).
Relationships
DMO Label DMO Field Label Cardinality Related DMO Related DMO Data Bundle or
Label Field Label Origin
Financial Account Financial Account ID Many To One (N:1) Financial Account ID Financial Services
Interest Rate Cloud
Fields
Label API Name Description Data Data
Type Bundle
or
Origin
Description ssot__Description__c The financial account description. Text Financial
Services
Cloud
End Date ssot__EndDate__c The end date of the interest rate limit. Date Financial
Time Services
Cloud
Financial Account ID ssot__FinancialAccountId__c The associated financial account. Text Financial
Services
Cloud
Financial Interest Rate ID ssot__Id__c The primary key. Text Financial
Services
Cloud
Interest Rate Percent ssot__InterestRatePercent__c The interest rate percentage. Number Financial
Services
Cloud
Interest Rate Type ssot__InterestRateType__c The interest rate type. Text Financial
Services
Cloud
279
Model Data in Data Cloud Financial Account Limit DMO
Label API Name Description Data Data
Type Bundle
or
Origin
Name ssot__Name__c The interest rate name. Text Financial
Services
Cloud
Start Date ssot__StartDate__c The start date of the limit. Date Financial
Time Services
Cloud
Financial Account Limit DMO
Represents the limits associated with a financial account. Provided in the Financial Services Cloud Data Kit. This DMO is available in API
version 58 and later.
API Name
ssot__FinancialAccountLimit__dlm
Category
Profile
Primary Subject Area
Financial Account
Primary Key Label
Financial Account Limit ID (ssot_Id_c).
Relationships
DMO Label DMO Field Label Cardinality Related DMO Related DMO Data Bundle or
Label Field Label Origin
Financial Account Financial Account ID Many To One (N:1) Financial Account ID Financial Services
Limit Cloud
280
Model Data in Data Cloud Financial Account Party DMO
Fields
Label API Name Description Data Data
Type Bundle
or
Origin
Amount ssot__Amount__c The currency value of the limit Number Financial
amount. Services
Cloud
Currency ssot__Currency__c The associated currency. Text Financial
Services
Cloud
Description ssot__Description__c The financial account limit. Text Financial
Services
Cloud
End Date ssot__EndDate__c The limit end date. Date Financial
Time Services
Cloud
Financial Account Id ssot__FinancialAccountId__c The associated financial account. Text Financial
Services
Cloud
Financial Limit Type ssot__FinancialLimitType__c The financial limit type. Text Financial
Services
Cloud
Financial Account Limit ssot__Id__c The primary key. Text Financial
ID Services
Cloud
Name ssot__Name__c The financial account limit name. Text Financial
Services
Cloud
Start Date ssot__StartDate__c The limit start date. Date Financial
Time Services
Cloud
Financial Account Party DMO
Represents the role of an organization account or person account related to a financial account. Provided in the Financial Services Cloud
Data Kit. This DMO is available in API version 58 and later.
API Name
ssot__FinancialAccountParty__dlm
281
Model Data in Data Cloud Financial Account Party DMO
Category
Profile
Primary Subject Area
Financial Account
Primary Key Label
Financial Account Party ID (ssot_Id_c).
Relationships
DMO Label DMO Field Label Cardinality Related DMO Related DMO Data Bundle or
Label Field Label Origin
Financial Account Account Contact ID Many To One (N:1) Account Contact ID Financial Services
Party Cloud
Financial Account Account ID Many To One (N:1) Account ID Financial Services
Party Cloud
Financial Account Financial Account ID Many To One (N:1) Financial Account ID Financial Services
Party Cloud
Fields
Label API Name Description Data Data
Type Bundle
or
Origin
Account Contact Id ssot__AccountContactId__c The associated contact. Text Financial
Services
Cloud
Account ID ssot__AccountId__c The associated account. Text Financial
Services
Cloud
Description ssot__Description__c The financial account party Text Financial
description. Services
Cloud
Financial Account ID ssot__FinancialAccountId__c The associated financial account. Text Financial
Services
Cloud
282
Model Data in Data Cloud Financial Account Transaction DMO
Label API Name Description Data Data
Type Bundle
or
Origin
Financial Account Role ssot__FinancialAccountRole__c The financial party role. Text Financial
Services
Cloud
Financial Account Party ssot__Id__c The primary key. Text Financial
ID Services
Cloud
Name ssot__Name__c The financial account party name. Text Financial
Services
Cloud
Is Active ssot__IsActive__c Indicates if the association is active. Text Financial
Services
Cloud
Is Primary Owner ssot__IsPrimaryOwner__c Indicates whether the party is the Text Financial
primary owner of the associated Services
financial account. Cloud
Financial Account Transaction DMO
Represents transactions related to a financial account. There can be various types of transactions such as credit, debit, and so forth.
Provided in the Financial Services Cloud Data Kit. This DMO is available in API version 58 and later.
API Name
ssot__FinancialAccountTransaction__dlm
Category
Profile
Primary Subject Area
Financial Account
Primary Key Label
Financial Account Transaction ID (ssot_Id_c).
283
Model Data in Data Cloud Financial Account Transaction DMO
Relationships
DMO Label DMO Field Label Cardinality Related DMO Related DMO Data Bundle or
Label Field Label Origin
Financial Account Financial Account ID Many To One (N:1) Financial Account ID Financial Services
Transaction Cloud
Fields
Label API Name Description Data Data
Type Bundle
or
Origin
Acquiring Bank Name ssot__AcquiringBankName__c The acquiring bank name. Text Financial
Services
Cloud
Authorization Record ssot__AuthorizationRecordText__c The transaction authorization code (if Text Financial
Text credit or debit). Services
Cloud
Card Scheme Name ssot__CardSchemeName__c The card name. Text Financial
Services
Cloud
Cash Flow Type ssot__CashFlowType__c The direction of the transaction from Text Financial
the perspective of the account holder: Services
inflow or outflow. Cloud
Currency ssot__Currency__c The associated currency. Text Financial
Services
Cloud
Description ssot__Description__c The financial account transaction Text Financial
description. Services
Cloud
Financial Account ID ssot__FinancialAccountID__c The associated financial account. Text Financial
Services
Cloud
FinancialAccountTransactionType__c ssot__FinancialAccountTransactionType__c The transaction type. Text Financial
Services
Cloud
ForexConversionChargeAmount__c ssot__ForexConversionChargeAmount__c The amount of charge within the Number Financial
transaction relating to Forex Services
conversion. Cloud
284
Model Data in Data Cloud Financial Account Transaction DMO
Label API Name Description Data Data
Type Bundle
or
Origin
Financial Transaction ID ssot__Id__c The primary key. Text Financial
Services
Cloud
Issuing Bank Name ssot__IssuingBankName__c The credit or debit card issuing bank Text Financial
name. Services
Cloud
Merchant Category Code ssot__MerchantCategoryCode__c The merchant identifier. Text Financial
Services
Cloud
Merchant Name ssot__MerchantName__c The merchant accepting payment of Text Financial
debit or credit card. Services
Cloud
Name ssot__Name__c The financial account transaction Text Financial
name. Services
Cloud
Running Balance ssot__RunningBalanceAmount__c The running balance of the Number Financial
Amount transaction. Services
Cloud
Secret Key Identifier ssot__SecretKeyIdentifier__c The secret identifier if the transaction Text Financial
is from open banking. Services
Cloud
Source System Identifier ssot__SourceSystemIdentifier__c The external data source record ID. Text Financial
Services
Cloud
Source Transaction ssot__SourceTransactionIdentifier__c The external data source unique Text Financial
Identifier identifier. Services
Cloud
Source Transaction Type ssot__SourceTransactionTypeCode__c The external data source transaction Text Financial
Code type. Services
Cloud
Target Account Identifier ssot__TargetAccountIdentifier__c The payment target account unique Text Financial
identifier. Services
Cloud
Transaction Amount ssot__TransactionAmount__c The transaction amount. Number Financial
Services
Cloud
285
Model Data in Data Cloud Financial Customer DMO
Label API Name Description Data Data
Type Bundle
or
Origin
Transaction Date ssot__TransactionDate__c The transaction date. Date Financial
Time Services
Cloud
Transaction Location ssot__TransactionLocationName__c The transaction location name. Text Financial
Name Services
Cloud
Transaction Posted Date ssot__TransactionPostedDate__c The transaction posted date. Date Financial
Time Services
Cloud
Financial Customer DMO
Represents an extension of an account to capture financial services attributes. Provided in the Financial Services Cloud Data Kit. This
DMO is available in API version 58 and later.
API Name
ssot__FinancialCustomer__dlm
Category
Profile
Primary Subject Area
Financial Account
Primary Key Label
Financial Customer ID (ssot_Id_c).
Relationships
DMO Label DMO Field Label Cardinality Related DMO Related DMO Data Bundle or
Label Field Label Origin
Financial Customer Account ID Many To One (N:1) Account ID Financial Services
Cloud
286
Model Data in Data Cloud Financial Goal DMO
Fields
Label API Name Description Data Data
Type Bundle
or
Origin
Account ID ssot__AccountId__c The associated account. Text Financial
Services
Cloud
Customer Category ssot__CustomerCategory__c The rating of individual's business with Text Financial
your firm. Services
Cloud
Customer Service Level ssot__CustomerServiceLevel__c The service level assigned to the Text Financial
financial customer. Services
Cloud
Description ssot__Description__c The financial customer description. Text Financial
Services
Cloud
Financial Customer ID ssot__Id__c The primary key. Text Financial
Services
Cloud
Investment Experience ssot__InvestmentExperienceLevel__c The financial customer investment Text Financial
Level experience level. Services
Cloud
Name ssot__Name__c The financial customer name. Text Financial
Services
Cloud
Policy Count ssot__PolicyCount__c The total number of active policies Number Financial
that the policy holder’s primary Services
household owns. Cloud
Financial Goal DMO
Represents the money to achieve a financial goal such as education or home purchase. Provided in the Financial Services Cloud Data
Kit. This DMO is available in API version 58 and later.
API Name
ssot__FinancialGoal__dlm
Category
Profile
287
Model Data in Data Cloud Financial Goal DMO
Primary Subject Area
Financial Account
Primary Key Label
Financial Goal ID (ssot_Id_c).
Relationships
DMO Label DMO Field Label Cardinality Related DMO Related DMO Data Bundle or
Label Field Label Origin
Financial Goal Financial Plan ID Many To One (N:1) Financial Plan ID Financial Services
Cloud
Financial Goal Party Financial Goal ID Many To One (N:1) Financial Goal ID Financial Services
Cloud
Fields
Label API Name Description Data Data
Type Bundle
or
Origin
Actual Value Amount ssot__ActualValueAmount__c The actual value of the financial goal. Numb er Financial
Services
Cloud
Completion Date ssot__CompletionDate__c The financial goal completion date. Date Financial
Time Services
Cloud
Currency ssot__Currency__c The currency associated with the Text Financial
value. Services
Cloud
Description ssot__Description__c The financial goal description. Text Financial
Services
Cloud
Financial Goal Status ssot__FinancialGoalStatus__c The financial goal status. Text Financial
Services
Cloud
Financial Goal ID ssot__FinancialGoalTd__c The primary key. Text Financial
Services
Cloud
288
Model Data in Data Cloud Financial Goal Party DMO
Label API Name Description Data Data
Type Bundle
or
Origin
Financial Goal Priority ssot__FinancialGoalPriority__c The priority of the financial goal. Text Financial
Services
Cloud
Financial Goal Type ssot__FinancialGoalType__c The financial goal type. Text Financial
Services
Cloud
Financial Plan ID ssot__FinancialPlanId__c The associated financial plan. Text Financial
Services
Cloud
Initial Value Amount ssot__InitialValueAmount__c The initial value of the financial goal. Number Financial
Services
Cloud
Key Qualifier Financial ssot__KeyQualifierFinancialGoalId__c
Goal Id
Name ssot__Name__c The financial goal name. Text Financial
Services
Cloud
Start Date ssot__StartDate__c The start date of the financial goal. Date Financial
Time Services
Cloud
Target Date ssot__TargetDate__c The financial goal target date. Date Financial
Time Services
Cloud
Target Value Amount ssot__TargetValueAmount__c The financial goal target value. Number Financial
Services
Cloud
Financial Goal Party DMO
Represents an association between a financial goal and the related party. Provided in the Financial Services Cloud Data Kit. This DMO is
available in API version 58 and later.
API Name
ssot__FinancialGoalParty__dlm
Category
Profile
289
Model Data in Data Cloud Financial Holding DMO
Primary Subject Area
Financial Account
Primary Key Label
Financial Goal Party ID (ssot_Id_c).
Relationships
DMO Label DMO Field Label Cardinality Related DMO Related DMO Data Bundle or
Label Field Label Origin
Financial Goal Party Financial Goal ID Many To One (N:1) Financial Goal ID Financial Services
Cloud
Financial Goal Party Party ID Many To One (N:1) Party ID Financial Services
Cloud
Fields
Label API Name Description Data Data
Type Bundle
or
Origin
Financial Goal Party ID ssot__Id__c The primary key. Text Financial
Services
Cloud
Name ssot__Name__c The financial goal party name. Text Financial
Services
Cloud
Financial Goal Id ssot__FinancialGoalId__c The associated financial goal. Text Financial
Services
Cloud
Party ID ssot__PartyId__c The associated party. Text Financial
Services
Cloud
Financial Holding DMO
Represents the financial holdings associated with either an account or a financial account. Provided in the Financial Services Cloud Data
Kit. This DMO is available in API version 58 and later.
290
Model Data in Data Cloud Financial Holding DMO
API Name
ssot__FinancialHolding__dlm
Category
Profile
Primary Subject Area
Financial Account
Primary Key Label
Financial Holding ID (ssot_Id_c).
Relationships
DMO Label DMO Field Label Cardinality Related DMO Related DMO Data Bundle or
Label Field Label Origin
Financial Holding Account ID Many To One (N:1) Account ID Financial Services
Cloud
Financial Holding Financial Account ID Many To One (N:1) Financial Account ID Financial Services
Cloud
Financial Holding Financial Security ID Many To One (N:1) Financial Security ID Financial Services
Cloud
Fields
Label API Name Description Data Data
Type Bundle
or
Origin
Account ID ssot__AccountId__c The associated account. Text Financial
Services
Cloud
Change Percent ssot__ChangePercent__c The percentage change in price. Number Financial
Services
Cloud
Currency ssot__Currency__c The currency associated with the Text Financial
price. Services
Cloud
291
Model Data in Data Cloud Financial Holding DMO
Label API Name Description Data Data
Type Bundle
or
Origin
Description ssot__Description__c The financial holding description. Text Financial
Services
Cloud
Equity Category ssot__EquityCategory__c The financial holding category. Text Financial
Services
Cloud
Financial Account Id ssot__FinancialAccountId__c The associated financial account. Text Financial
Services
Cloud
Financial Holding Class ssot__FinancialHoldingClass__c The financial holding class. Text Financial
Services
Cloud
Financial Holding Sub ssot__FinancialHoldingSubClass__c The financial holding sub class. Text Financial
Class Services
Cloud
Financial Security ID ssot__FinancialSecurityId__c The associated security. Text Financial
Services
Cloud
Gain Loss Amount ssot__GainLossAmount__c The gain or loss amount. Number Financial
Services
Cloud
Holding Count ssot__HoldingCount__c The number of holdings purchased. Number Financial
Services
Cloud
Financial Holding ID ssot__Id__c The primary key. Text Financial
Services
Cloud
Market Value Amount ssot__MarketValueAmount__c The holding market value. Number Financial
Services
Cloud
Name ssot__Name__c The financial holding name. Text Financial
Services
Cloud
Purchase Price Amount ssot__PurchasePriceAmount__c The holding purchase price. Number Financial
Services
Cloud
292
Model Data in Data Cloud Financial Security DMO
Label API Name Description Data Data
Type Bundle
or
Origin
Source System Identifier ssot__SourceSystemIdentifier__c The ID that uniquely identifies the Text Financial
holding in an external data source. Services
Cloud
Financial Security DMO
Represents a financial holding such as securities, bonds, mutual funds, and so forth in relation to either an account or a financial account
(investment account). Provided in the Financial Services Cloud Data Kit. This DMO is available in API version 58 and later.
API Name
ssot__FinancialSecurity__dlm
Category
Profile
Primary Subject Area
Financial Account
Primary Key Label
Financial Security (ssot_Id_c).
Relationships
DMO Label DMO Field Label Cardinality Related DMO Related DMO Data Bundle or
Label Field Label Origin
Financial Holding Financial Security Many To One (N:1) Financial Security ID Financial Services
Cloud
293
Model Data in Data Cloud Flow DMO
Fields
Label API Name Description Data Data
Type Bundle
or
Origin
Currency ssot__Currency__c The currency associated with the Text Financial
price. Services
Cloud
Description ssot__Description__c The financial security description. Text Financial
Services
Cloud
Financial Exchange ssot__FinancialExchange__c The financial exchange description. Text Financial
Services
Cloud
Financial Security ID ssot__Id__c The primary key. Text Financial
Services
Cloud
Name ssot__Name__c The financial security name. Text Financial
Services
Cloud
Price Amount ssot__PriceAmount__c The current price of the security. Number Financial
Services
Cloud
Security Identifer ssot__SecurityIdentifier__c The security identifier. Text Financial
Services
Cloud
Flow DMO
The Flow DMO is a Data Cloud data model object (DMO) for details about a flow.
Object API Name
ssot__Flow__dlm
Category
Other
Primary Subject Area
Engagement
294
Model Data in Data Cloud Flow Element DMO
Primary Key
Flow ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Flow Associated Record Many to One (N:1) Campaign Campaign ID
Flow Version Flow Many to One (N:1) Flow Flow ID
All Fields
Field Name Field API Name Description Data
Type
Associated Record ssot__Flow.AssociatedRecordId__c A reference ID to the record associated text
with the flow.
Description ssot__Description__c The description of the flow. text
Flow ID ssot__Id__c A unique ID used as primary key for the text
Flow DMO.
Name ssot__Name__c The name of the flow. text
Flow Element DMO
The Flow Element DMO is a Data Cloud data model object (DMO) for details about a single element within a flow version.
Object API Name
ssot__FlowElement__dlm
Category
Other
Primary Subject Area
Engagement
Primary Key
Flow Element ID (ssot__Id__c)
295
Model Data in Data Cloud Flow Element Run DMO
Relationships
Object Field Cardinality Related Object Related Field
Bulk Email Message Flow Element Many to One (N:1) Flow Element Flow Element ID
Flow Element Flow Version Many to One (N:1) Flow Version Flow Version ID
Flow Element Run Flow Element Many to One (N:1) Flow Element Flow Element ID
All Fields
Field Name Field API Name Description Data
Type
Flow Element ID ssot__Id__c A unique ID used as primary key for the text
Flow Element DMO.
Flow Version ssot__FlowVersionId__c A reference ID to the associated flow text
version of the flow element.
Name ssot__Name__c The name of the flow element. text
Flow Element Run DMO
The Flow Element Run DMO is a Data Cloud data model object (DMO) for the status of a single element executed within a flow run.
Object API Name
ssot__FlowElementRun__dlm
Category
Engagement
Primary Subject Area
Engagement
Primary Key
Flow Element Run ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Email Engagement Flow Element Run Many to One (N:1) Flow Element Run Flow Element Run ID
296
Model Data in Data Cloud Flow Element Run DMO
Object Field Cardinality Related Object Related Field
Flow Element Run Flow Element Many to One (N:1) Flow Element Flow Element ID
Flow Element Run Flow Run Many to One (N:1) Flow Run Flow Run ID
All Fields
Field Name Field API Name Description Data
Type
Completed DateTime ssot__CompletedDateTime__c The date and time when the flow dateTime
completes or encounters an error. After
this field has a value, no further
processing can take place through the
Flow Element Run DMO.
Error Description ssot__ErrorDescriptionText__c The description of the Error Reason. text
This field is available in API version 59.0
and later.
Error Reason ssot__ErrorReason__c The error type if the flow run encountered text
an error. Valid values are:
• DeactivatedUser—The user
that activated the flow is no longer
active, so the flow can’t execute.
• InternalError— There was a
system error that prevented the flow
from executing.
This field is available in API version 59.0
and later.
Flow Element ssot__FlowElementId__c A reference ID to the associated flow text
element.
Flow Element Run ID ssot__Id__c A unique ID used as primary key for the text
Flow Element Run DMO.
Flow Element Run Status ssot__FlowElementRunStatus__c The status of the flow element run. text
Flow Run ssot__FlowRunId__c A reference ID to the associated flow run text
of the flow element run.
Scheduled DateTime ssot__ScheduledDateTime__c The date and time when the flow element dateTime
run was scheduled for execution. Actual
execution time can be later due to
queuing, retries, or other issues.
297
Model Data in Data Cloud Flow Run DMO
Flow Run DMO
The Flow Run DMO is a Data Cloud data model object (DMO) for details about a single execution of a flow.
Object API Name
ssot__FlowRun__dlm
Category
Engagement
Primary Subject Area
Engagement
Primary Key
Flow Run ID(ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Flow Element Run Flow Run Many to One (N:1) Flow Run Flow Run ID
Flow Run Flow Version Many to One (N:1) Flow Version Flow Version ID
Flow Run Primary Record ID Many to One (N:1) Individual Individual ID
All Fields
Field Name Field API Name Description Data
Type
Completed DateTime ssot__CompletedDateTime__c The date and time when the flow run dateTime
completed or encountered an error. After
this field has a value, no further
processing can take place through the
Flow Run DMO.
Error Description ssot__ErrorDescriptionText__c The description of the Error Reason text
This field is available in API version 59.0
and later.
298
Model Data in Data Cloud Flow Run DMO
Field Name Field API Name Description Data
Type
Error Reason ssot__ErrorReason__c The error type if the flow run encountered text
an error. Valid values are:
• MessagingApiEntitlementReached—A
metered usage limit value was
exceeded.
• IndividualContactPointNotFound—When
attempting to send an email, no
contact point was found, so the email
couldn’t be sent.
• InternalError—There was a
system error that prevented the flow
from executing.
• ServiceError—A request on a
third-party system failed.
This field is available in API version 59.0
and later.
Flow Run ID ssot__Id__c A unique ID used as a primary key for the text
Flow Run DMO.
Flow Run Status ssot__FlowRunStatus__c The status of the flow run. text
Flow Version ssot__FlowVersionId__c A reference ID to the flow version that the text
flow run is executing.
Flow Version Occurrence ssot__FlowVersionOccurrenceId__c The ID of the instance of the scheduled text
segment-triggered flow associated with
the flow run. This field is available in API
version 60.0 and later.
Primary Record ID ssot__PrimaryRecordId__c A reference ID for the record that the flow text
run is executed against.
Primary Record Object ssot__PrimaryRecordObject__c The type of entity referenced by text
Primary Record ID, for example,
Account, Case, or Individual. This field is
available in API version 59.0 and later.
Scheduled DateTime ssot__ScheduledDateTime__c The date and time when the flow run was dateTime
scheduled for execution. Actual execution
time can be slightly later due to queueing,
retries, or other issues.
Stopped Reason ssot__StoppedReason__c The error code if the flow run was text
stopped. Valid values are:
• FLOW_DEACTIVATED—The
marketing user clicked Stop Now in
299
Model Data in Data Cloud Flow Version DMO
Field Name Field API Name Description Data
Type
Flow Builder, which causes all flow
runs to stop.
• INDIVIDUAL_NOT_FOUND—The
unified individual on this flow run no
longer exists.
This field is available in API version 61.0
and later.
Flow Version DMO
The Flow Version DMO is a Data Cloud data model object (DMO) for details about a version of a flow.
Object API Name
ssot__FlowVersion__dlm
Category
Other
Primary Subject Area
Engagement
Primary Key
Flow Version ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Flow Element Flow Version Many to One (N:1) Flow Version Flow Version ID
Flow Run Flow Version Many to One (N:1) Flow Version Flow Version ID
Flow Version Flow Many to One (N:1) Flow Flow ID
300
Model Data in Data Cloud Goods Product DMO
All Fields
Field Name Field API Name Description Data
Type
Flow ssot__FlowId__c A reference ID to the parent flow of the text
flow version.
Flow Version ID ssot__Id__c A unique ID used as a primary key for the text
Flow Version DMO.
Version Number ssot__VersionNumber__c The version number of the flow version.
Goods Product DMO
The Goods Product DMO is a Data Cloud data model object (DMO) for a specific product, for example a carton of milk or a set of towels
Object API Name
ssot__GoodsProduct__dlm
Category
Other
Primary Subject Area
Product
Primary Key
Goods Product ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Goods Product Master Product Many To One (N:1) Goods Product Goods Product ID
Goods Product Master Product Many To One (N:1) Bundle Product Bundle Product ID
Goods Product Master Product Many To One (N:1) Master Product Master Product ID
Product Category Product Product Many To One (N:1) Goods Product Goods Product ID
Sales Order Product Product Many To One (N:1) Goods Product Goods Product ID
Product Browse Product Many To One (N:1) Goods Product Goods Product ID
Engagement
301
Model Data in Data Cloud Goods Product DMO
Object Field Cardinality Related Object Related Field
Shopping Cart Product Many To One (N:1) Goods Product Goods Product ID
Engagement
Software Application Product Many To One (N:1) Goods Product Goods Product ID
Goods Product Brand Many To One (N:1) Brand Brand ID
Bundle Product Master Product Many To One (N:1) Goods Product Goods Product ID
Loyalty Partner Product Product Many To One (N:1) Goods Product Goods Product ID
Loyalty Transaction Product Many To One (N:1) Goods Product Goods Product ID
Journal
Opportunity Product Product Many To One (N:1) Goods Product Goods Product ID
Order Delivery Method Product Many To One (N:1) Goods Product Goods Product ID
Goods Product Primary Product Category Many To One (N:1) Product Category Product Category ID
All Fields
Field Name Field API Name Description Data
Type
Age ssot__AgeId__c A reference ID for the age the product is text
intended for, for example infants or
adults.
Allow Customer Return ssot__AllowCustomerReturn__c An indicator whether product is text
returnable.
Allow Partial Refund ssot__AllowPartialRefund__c An indicator whether a partial refund is text
allowed, for example if a membership is
canceled early.
Brand ssot__BrandId__c A reference ID to brand name. text
Color ssot__ColorId__c A reference ID to the color of the product. text
Created Date ssot__CreatedDate__c The date the record was created. dateTime
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
Depth ssot__Depth__c The depth size of the product. number
302
Model Data in Data Cloud Goods Product DMO
Field Name Field API Name Description Data
Type
Diameter ssot__Diameter__c The diameter of a product. number
Disposal Type ssot__DisposalTypeId__c A reference ID to how product is to be text
disposed, for example recycle or throw
away.
Drained Weight ssot__DrainedWeight__c The weight of the product excluding number
packaging and after being drained.
Environment Requirement ssot__EnvironmentRequirementId__c A reference ID to environmental text
requirements of a product.
External Record ID ssot__ExternalRecordId__c A reference ID for external data source text
record.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
External Source Record ID ssot__ExternalSourceRecordId__c A reference to record ID in external text
system where product originated.
Fabric ssot__FabricId__c A reference ID for the product’s fabric text
type.
Gender ssot__GenderId__c A reference ID for the gender the product text
was designed for.
GL Account Code ssot__GlAccountCode__c A reference ID to how instances of this text
product are accounted for, for example
consumable, livestock, or merchandise.
Goods Product ID ssot__Id__c A unique ID used as primary key for the text
Goods Product DMO.
Gross Weight ssot__GrossWeight__c The weight of the product in its original number
packaging.
Height ssot__Height__c The height of the product. number
Internal Organization ssot__InternalOrganizationId__c A reference ID to business unit or other text
internal organization that owns business
account.
Is Auto Provisionable ssot__IsAutoProvisionable__c An indicator whether product can be auto text
installed.
Is Back Ordered ssot__IsBackOrdered__c An indicator whether a product has been text
back ordered after being out of stock.
Is Coupon Redemption ssot__IsCouponRedemptionAllowed__c An indicator whether coupon can be used text
Allowed to redeem product.
303
Model Data in Data Cloud Goods Product DMO
Field Name Field API Name Description Data
Type
Is Customer Discount ssot__IsCustomerDiscountAllowed__c An indicator whether customer can be text
Allowed offered product at discounted price.
Is Dynamic Bundle ssot__IsDynamicBundle__c An indicator whether content of product text
is bundled at point of use.
Is Food stamp Payment ssot__IsFoodstampPaymentAllowed__c An indicator whether product can be text
Allowed purchased with food stamps.
Is Installable ssot__IsInstallable__c An indicator whether product can be text
installed.
Is Intellectual Property ssot__IsIntellectualPropertyProtected__c An indicator whether intellectual property text
Protected of product is protected.
Is Made To Order ssot__IsMadeToOrder__c An indicator whether the product is text
created after being order, for example a
monogrammed towel or a birthday cake.
Is Manual Price Entry ssot__IsManualPriceEntryRequired__c An indicator whether product price text
Required requires manual entry.
Is Multiple Coupons ssot__IsMultipleCouponsAllowed__c An indicator whether multiple coupons text
Allowed can be applied to same product.
Is Partner Discount Allowed ssot__IsPartnerDiscountAllowed__c An indicator whether seller and supplier text
partners can get a discount on product.
Is Perishable ssot__IsPerishable__c An indicator whether the product is text
perishable.
Is Pre Orderable ssot__IsPreOrderable__c An indicator whether product can be text
preordered.
Is Quality Verification ssot__IsQualityVerificationRequired__c An indicator whether product requires text
Required visual inspection to designate quality.
Is Quantity Entry Required ssot__IsQuantityEntryRequired__c An indicator whether quantity of product text
must be entered during checkout.
Is Rain Check Allowed ssot__IsRainCheckAllowed__c An indicator for when a product isn’t in text
stock, if a customer can sign up to
purchase the product at current price
when new shipment arrives.
Is Returnable ssot__IsReturnable__c An indicator whether product can be text
returned.
Is Sellable ssot__IsSellable__c An indicator whether the product is text
intended to be sold.
Is Sellable Independently ssot__IsSellableIndependently__c An indicator whether a product can be text
sold by itself or only as part of a bundle.
304
Model Data in Data Cloud Goods Product DMO
Field Name Field API Name Description Data
Type
Is Sellable Without Price ssot__IsSellableWithoutPrice__c An indicator whether a product can be text
"sold" without a price, for example
personalized monogram for clothing at
no additional cost.
Is Serialized ssot__IsSerialized__c An indicator whether each individual text
product has a unique serial number.
Is Weight Entry Required ssot__IsWeightEntryRequired__c An indicator whether product weight is text
required.
Is Worker Discount Allowed ssot__IsWorkerDiscountAllowed__c An indicator whether employees and text
contractors can get a discount on
product.
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the dateTime
record.
Lot Identifier ssot__LotIdentifier__c The name or number of the lot that text
manufactured product.
Manufacturer Name ssot__ManufacturerName__c The name of the product’s manufacturer. text
Master Product ssot__MasterProductId__c A reference ID referring to the parent or text
primary product.
Max Holding Day Count ssot__MaxHoldingDayCount__c The amount of time the product can be number
displayed before removal.
Maximum Order Quantity ssot__MaximumOrderQuantityCount__c The maximum quantity of the product number
Count allowed for purchase.
Minimum Advertisement ssot__MinimumAdvertisementAmount__c The lowest price allowed (normally by number
Amount manufacturer) to use in an ad.
Minimum Advertisement ssot__MinimumAdvertisementAmountCurrency__c The currency for the minimum text
Amount Currency advertisement amount.
Minimum Advertisement ssot__MinimumAdvertisementAmountStartDate__c The earliest date the lowest number
Amount Start Date manufacturer's price can be stated in an
ad.
Minimum Order Quantity ssot__MinimumOrderQuantityCount__c The minimum quantity of product number
Count allowed for purchase.
Model Number ssot__ModelNumber__c The identifier that manufacturer uses for text
product, for example SHOE-123-RED-8.
Model Year ssot__ModelYear__c The marketed model year for product. number
MSRP Amount ssot__MSRPAmount__c The manufacturer suggested retail price number
or the default price of a product.
305
Model Data in Data Cloud Goods Product DMO
Field Name Field API Name Description Data
Type
MSRP Amount Currency ssot__MSRPAmountCurrency__c The currency for the suggested retail text
price.
Net Weight ssot__NetWeight__c The weight of the product excluding number
packaging.
Packaged in Country ssot__PackagedInCountry__c The country where the product is text
packaged.
Pattern ssot__PatternId__c A reference ID to the pattern of a product, text
for example striped or checkered.
Price Charge Type ID ssot__PriceChargeTypeId__c A reference ID to how product is priced, text
for example by weight, units, or usage.
Primary Product Category ssot__PrimaryProductCategory__c The category of the product, for example text
shoes or frozen meals.
Primary Sales Channel ssot__PrimarySalesChannelId__c A reference ID to the primary sales text
channel used to sell product.
Produced in Country ssot__ProducedInCountry__c The country where the product is text
produced.
Product Description ssot__Description__c A general description of product. text
Product Long Description ssot__LongDescription__c The long description of product. text
Product May Expand ssot__ProductMayExpand__c An indicator whether the product can text
become bigger under certain
circumstances like heat.
Product Name ssot__Name__c The name of the product. text
Product Security ssot__ProductSecurityRequirementId__c An indicator whether the product requires text
Requirement any special security for handling or selling.
Product SKU ssot__ProductSKU__c The unique Stock Keeping Unit (SKU) text
identifier for product.
Product Status ssot__ProductStatusId__c A reference ID to status of product, for text
example active or inactive.
Quantity Installment Count ssot__QuantityInstallmentCount__c An indicator whether the product requires number
a number of installments.
Quantity Installment Period ssot__QuantityInstallmentPeriodId__c A reference ID to a product's quantity text
schedule, the amount of time covered by
the schedule.
Quantity Schedule Type ssot__QuantityScheduleTypeId__c A reference ID to quantity schedule type, text
if product has one, for example Divide or
Repeat.
306
Model Data in Data Cloud Goods Product DMO
Field Name Field API Name Description Data
Type
Quantity Scheduling ssot__CanUseQuantitySchedule__c An indicator whether product has a text
Enabled quantity schedule.
Required Cleanup Process ssot__RequiredCleanupProcessId__c An indicator whether the product requires text
special cleanup procedures if it’s spilled
or leaked.
Required Deposit Amount ssot__RequiredDepositAmount__c An indicator whether a deposit is required number
to pick up or use the product.
Required Deposit Amount ssot__RequiredDepositAmountCurrency__c The currency of the required deposit. text
Currency
Required Deposit ssot__RequiredDepositPercentage__c The percentage of the deposit that is number
Percentage required to pick up or use the product.
Required Humidity ssot__RequiredHumidityPercentage__c The humidity percentage required for the number
Percentage product.
Required Temperature ssot__RequiredTemperatureHighestNumber__c The highest temperature required for the number
Highest Number product.
Required Temperature ssot__RequiredTemperatureLowestNumber__c The lowest temperature required for the number
Lowest Number product.
Required Temperature ssot__RequiredTemperatureUOMId__c The required temperature’s Unit of text
UOM Measure (UOM).
Requires Individual Unit ssot__RequiresInvididualUnitPricing__c An indicator whether product requires text
Pricing individual price, for example due to
variable weight or size.
Requires Unit Price Label ssot__RequiresUnitPriceLabel__c An indicator whether the unit price label text
must be visible on the product.
Revenue Installment Count ssot__RevenueInstallmentCount__c The number of installments from 1 to 150 number
if a product has a revenue schedule
Revenue Installment Period ssot__RevenueInstallmentPeriodId__c A reference ID to the time covered by a text
revenue schedule, for example weekly or
monthly.
Revenue Schedule Type ssot__RevenueScheduleTypeId__c A reference ID to revenue schedule type. text
Revenue Scheduling ssot__CanUseRevenueSchedule__c An indicator whether product can have text
Enabled a revenue schedule.
Reward Program Points ssot__RewardProgramPointsCount__c The number of points given for the number
Count purchase of product.
Season ssot__SeasonId__c A reference ID to the season the product text
is intended for, for example summer or
winter.
307
Model Data in Data Cloud Individual
Field Name Field API Name Description Data
Type
Service Entitlement ssot__ServiceEntitlementTemplateId__c A reference ID to a service entitlement text
Template template.
Shelf Facing Unit Count ssot__ShelfFacingUnitCount__c The number of units per row of the number
product that can be displayed.
Size UOM ssot__SizeUOMId__c A reference ID for the unit of measure for text
the product’s size.
Standard Warranty Length ssot__StandardWarrantyLengthMonth__c The length of warranty included from the number
Month seller (not manufacturer).
Stock Ledger Valuation ssot__StockLedgerValuationAmount__c The total value of the products in stock. number
Amount
Stock Ledger Valuation ssot__StockLedgerValuationAmountCurrency__c The currency of the total value of the text
Amount Currency products in stock.
Style ssot__StyleId__c A reference ID to the style of the product. text
Tare Weight ssot__TareWeight__c The weight of the product packaging number
without the product content.
Valid For Period Count ssot__ValidForPeriodCount__c The duration of time that product is valid. number
Valid For Period Unit Of ssot__ValidForPeriodUOMId__c A reference ID to measurement of time text
Measure associated with Valid For Period Count,
for example hours, days, or months.
Valid From Date ssot__ValidFromDate__c The initial date that product can be used. dateTime
Valid To Date ssot__ValidToDate__c The final date that product can be used. dateTime
Version Number ssot__VersionNumber__c The product version. text
Weight UOM ssot__WeightUOMId__c A reference ID for the unit of the measure text
used for a product’s weight.
Width ssot__Width__c The width of a product. number
Individual
The Individual DMO is a Data Cloud data model object for contacts, customers, or other people interested in your company's products
or services.
Object API Name
ssot__Individual__dlm
308
Model Data in Data Cloud Individual
Category
Profile
Primary Subject Area
Contact
Primary Key
Individual ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field Data Bundle
Account Account ID Many To One (N:1) Individual Individual ID Sales
Account Contact Individual Many To One (N:1) Individual Individual ID Sales, Service
Consent Contact ID One To One (1:1) Individual Individual ID Sales
Contact Point Party Many To One (N:1) Individual Individual ID Sales, Service
Address
Contact Point App Party Many To One (N:1) Individual Individual ID Sales
Contact Point Email Party Many To One (N:1) Individual Individual ID Sales, Service
Contact Point Phone Party Many To One (N:1) Individual Individual ID Sales, Service
Device Application Individual Many To One (N:1) Individual Individual ID Sales
Engagement
Einstein Email Subscriber Key Many To One (N:1) Individual Individual ID Sales
Engagement Scores
Einstein Push Subscriber Key Many To One (N:1) Individual Individual ID Sales
Engagement Scores
Email Engagement Individual Many To One (N:1) Individual Individual ID Sales
Individual Individual ID One To One (1:1) Individual Identity Individual ID Sales
Link
Individual Account Manager One To One (1:1) Individual Individual ID Sales
Individual Party ID One To One (1:1) Party Party ID Financial Services
Cloud
Loyalty Program Household ID Many To One (N:1) Individual Individual ID Sales
Loyalty Program Party Many To One (N:1) Individual Individual ID Sales
Member
309
Model Data in Data Cloud Individual
Object Field Cardinality Related Object Related Field Data Bundle
Marketing Contact ID Many To One (N:1) Individual Individual ID Sales
Engagement
Party Individual ID Many To One (N:1) Individual Individual ID Financial Services
Cloud
Party Identification Party Many To One (N:1) Individual Individual ID Sales
Person Life Event Individual ID Many To One (N:1) Individual Individual ID Financial Services
Cloud
Product Browse Individual Many To One (N:1) Individual Individual ID Sales
Engagement
Product Order Individual Many To One (N:1) Individual Individual ID Sales
Engagement
Website Individual Many To One (N:1) Individual Individual ID Sales
Engagement
All Fields
Field Name Field API Name Description Data Data
Type Bundle
Birth Date ssot__BirthDate__c A person’s birth date including year, month, and dateTime Sales,
date. Service
Birth Date Day ssot__BirthDateDay__c The day the individual was born. number Service
Birth Date Month ssot__BirthDateMonth__c The month the individual was born. number Service
Birth Date Year ssot__BirthDateYear__c The year the individual was born. number Service
Birth Place ssot__BirthPlace__c The location the person was born. text Sales,
Service
Block Geolocation ssot__HasOptedOutGeoTracking__c An indicator if the individual has opted out of text Service
Tracking geolocation tracking.
Children Count ssot__ChildrenCount__c The number of children the person has. number Sales,
Service
Consumer Credit ssot__ConsumerCreditScore__c The individual’s consumer credit score. number Service
Score
Consumer Credit ssot__ConsumerCreditScoreProviderName__c The provider of the individual’s consumer credit number Service
Score Provider Name score.
Convictions Count ssot__ConvictionsCount__c The number of convictions the individual has. number Service
Created Date ssot__CreatedDate__c The date when the record was created. dateTime Sales,
Service
310
Model Data in Data Cloud Individual
Field Name Field API Name Description Data Data
Type Bundle
Current Employer ssot__CurrentEmployerName__c The name of the person’s current employer. text Sales,
Name Service
Data Source ssot__DataSourceId__c The reference ID for the logical name for a system text Sales,
that is the source of records identified by external Service
record ID.
Data Source Object ssot__DataSourceObjectId__c The reference ID for the logical name of the object text Sales,
where this record came from, whether that is a Service
name of a cloud storage file or another
connector’s external object.
Death Date ssot__DeathDate__c The date the person died. dateTime Sales,
Service
Death Place ssot__DeathPlace__c The location of the person’s death. text Sales,
Service
Dependent Count ssot__DependentCount__c The number of dependents a person claims. number Sales,
Service
Do Extract My Data ssot__DoExtractMyDataUpdateDate__c The update date to extract an individual’s data. dateTime Service
Update Date
Do Forget Me Update ssot__DoForgetMeUpdateDate__c The update date to forget an individual’s data. dateTime Service
Date
Do Not Market Update ssot__DoNotMarketUpdateDate__c The update date to not market an individual’s dateTime Service
Date data.
Do Not Process ssot__HasOptedOutProcessing__c An indicator if the individual has opted out of text Service
processing.
Do Not Process Reason ssot__DoNotProcessReasonId__c A reference ID for the reason the individual has text Service
opted out of processing.
Do Not Process ssot__DoNotProcessUpdateDate__c The update date to not process an individual’s dateTime Service
Update Date data.
Do Not Profile ssot__HasOptedOutProfiling__c An indicator if the individual has opted out of text Service
profiling.
Do Not Profile Update ssot__DoNotProfileUpdateDate__c The update date to not profile an individual’s dateTime Service
Date data.
Do Not Solicit ssot__HasOptedOutSolicit__c An indicator if the individual has opted out of text Service
soliciting.
Do Not Track ssot__HasOptedOutTracking__c An indicator if the individual has opted out of text Service
tracking.
Do Not Track Location ssot__DoNotTrackLocationUpdateDate__c The update date to not track an individual’s dateTime Service
Update Date location.
311
Model Data in Data Cloud Individual
Field Name Field API Name Description Data Data
Type Bundle
Do Not Track Update ssot__DoNotTrackUpdateDate__c The update date to not track an individual’s data. dateTime Service
Date
Employed Since Date ssot__EmployedSinceDate__c The date the person was hired at their current dateTime Sales,
employer. Service
Ethnicity ssot__EthnicityId__c A reference ID for the individual’s ethnicity. text Service
Export Individual’s ssot__SendIndividualData___c An indicator to export the individual’s data. text Service
Data
External Record ID ssot__ExternalRecordId__c The reference ID for an external data source text Sales,
system. Service
External Source ID ssot__ExternalSourceId__c The reference ID for the system in which the text Sales,
external record ID was assigned. Service
First Name ssot__FirstName__c A person’s first name. text Sales,
Service
Forget This Individual ssot__ShouldForget__c An indicator to forget the individual’s data. text
Gender ssot__GenderId__c The reference ID for the person’s gender. text Sales,
Service
Gender Identity ssot__GenderIdentity__c The gender identity of the individual. text Service
Global Party ssot__GlobalPartyId__c A reference ID to the global party, for example, text Sales,
an individual, business, or affiliation group. Service
Has Alcohol Abuse ssot__HasAlcoholAbuseHistory__c An indicator if the individual has a history of text Service
History alcohol abuse.
Has Drug Abuse ssot__HasDrugAbuseHistory__c An indicator if the individual has a history of drug text Service
History abuse.
Highest Education ssot__HighestEducationLevelId__c The reference ID to the person’s highest text Sales,
Level completed education level, for example high Service
school or PhD.
Hospitalizations Last 5 ssot__HospitalizationsLast5YearsCount__c The number of hospitalizations the individual has text Service
Years Count had in the last 5 years.
Individual ID ssot__Id__c A unique ID used as the primary key for the text Sales,
individual DMO. Service
Influencer Rating ssot__InfluencerRating__c The rating given to a person based on their text Sales,
influence, typically in social media. Service
Internal Organization ssot__InternalOrganizationId__c The reference ID to the business unit or other text Sales,
internal organization that owns the business Service
account.
Is Alcohol Consumer ssot__IsAlcoholConsumer__c An indicator if the individual consumes alcohol. text Service
312
Model Data in Data Cloud Individual
Field Name Field API Name Description Data Data
Type Bundle
Is Anonymous ssot__IsAnonymous__c An indicator that the person wishes to remain text Sales,
anonymous. Service
Is Drug Consumer ssot__IsDrugConsumer__c An indicator if the individual consumes drugs. text Service
Is Good Driver ssot__IsGoodDriver__c An indicator if the individual is a good driver. text Service
Is Good Student ssot__IsGoodStudent__c An indicator if the individual is a good student. text Service
Is High Risk Hobby ssot__IsHighRiskHobby__c An indicator if the individual has a high risk text Service
hobby.
Is High Risk ssot__IsHighRiskOccupation__c An indicator if the individual has a high risk text Service
Occupation occupation.
Is Home Owner ssot__IsHomeOwner__c An indicator that the person owns a home. text Sales,
Service
Is Tobacco Consumer ssot__IsTobaccoConsumer__c An indicator if the individual consumes tobacco. text Service
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the record. dateTime Sales,
Service
Last Name ssot__LastName__c The person’s last name. text Sales,
Service
Mailing Name ssot__MailingName__c The person’s full name used for mailing purposes, text Sales,
for example Dr. Jane Doe. Service
Main Dietary Habit ssot__MainDietaryHabitTypeId__c A reference ID to the individual’s main dietary text Service
Type habit type.
Main Disability Type ssot__MainDisabilityTypeId__c A reference ID to the individual’s main disability text Service
type.
Main Life Attitude ssot__MainLifeAttitudeTypeId__c A reference ID to the individual’s main life attitude text Service
Type type.
Main Life Style Type ssot__MainLifeStyleTypeId__c A reference ID to the individual’s main life style text Service
type.
Main Personal Value ssot__MainPersonalValueTypeId__c A reference ID to the individual’s main personal text Service
Type value type.
Main Personality Type ssot__MainPersonalityTypeId__c A reference ID to the individual’s main personality text Service
type.
Major Citation Count ssot__MajorCitationCount__c The number of major citations the individual has. number Service
Marital Status ssot__MaritalStatusId__c A reference ID for a person’s marital status. text Sales,
Service
Middle Name ssot__MiddleName__c A person’s middle name. text Sales
313
Model Data in Data Cloud Individual
Field Name Field API Name Description Data Data
Type Bundle
Military Service ssot__MilitaryServiceId__c A reference ID showing if the person served in text Sales
the military.
Military Status ssot__MilitaryStatusId__c A reference ID for a person’s military status, for text Sales
example retired or active duty.
Minor Citation Count ssot__MinorCitationCount__c The number of minor citations the individual has. number Service
Mothers Maiden Name ssot__MothersMaidenName__c The unmarried last name of a person’s mother. text Sales,
Service
Name Suffix ssot__NameSuffix__c The suffix of a person’s name, for example, Jr. text Sales,
Service
Net Worth ssot__NetWorth__c The net worth of the individual. number Service
No Merge Reason ssot__NoMergeReason__c A reference ID to the reason not to merge the text Service
individual’s data.
Occupation ssot__Occupation__c A description of the person’s job. text Sales,
Service
Occupation Type ssot__OccupationTypeId__c A reference ID for the type of job a person has for text Sales,
example professional or student. Service
Official Name ssot__OfficialName__c A person’s legal name used in communications. text Sales,
Service
OK to Store Pll Data ssot__CanStorePllElsewhere__c An indicator if the individual’s Pll data can be text Service
Elsewhere stored elsewhere.
Ordering Name ssot__OrderingName__c The name used when sorting people in a list, text Sales,
often alphabetical for example, Doe J. Service
Origin Country ssot__OriginCountryId__c A reference ID to the individual’s country of origin. text Service
Over Age ssot__OverAgeNumber__c The over age number of the individual. number Service
Party Type ssot__PartyTypeId__c A reference ID for the type of party, for example, text Sales,
individual or household. Service
Party Additional ssot__PartyAdditionalNames__c The additional names associated with the text Sales,
Names individual. Service
Party Roles ssot__PartyRoles__c The role of an individual for example a customer, text Sales,
supplier, or competitor. Service
Party Web Addresses ssot__PartyWebAddresses__c text Sales,
Service
Person Name ssot__PersonName__c A person’s full name. text Service
Person Education ssot__PersonEducations__c Any associated educations for the individual. text Sales,
Service
314
Model Data in Data Cloud Individual
Field Name Field API Name Description Data Data
Type Bundle
Person Height ssot__PersonHeight__c The height of the individual. number Service
Person Height Unit of ssot__PersonHeightUnitofMeasureId__c A reference ID to the unit of measurement of an text Service
Measure individual’s height.
Person Employment ssot__PersonEmployments__c Any associated employments for the individual. text Sales,
Service
Person Language ssot__PersonLanguages__c Any associated languages for the individual. text Sales,
Service
Person Life Events ssot__PersonLifeEvents__c Any associated life events for the individual. text Sales,
Service
Person Life Stage ssot__PersonLifeStage__c The life stage of the individual. text Service
Person Weight ssot__PersonWeight__c The weight of the individual. number Service
Person Weight Unit of ssot__PersonWeightUnitofMeasureId___c A reference ID to the unit of measurement of an text Service
Measure individual’s weight.
Photo URL ssot__PhotoURL__c A link to an individual’s photo. text Sales,
Service
Preferred Name ssot__PreferredName__c A person’s preferred name. text Sales,
Service
Primary Account ssot__PrimaryAccountId__c A reference ID for person’s account. text Sales,
Service
Primary Citizenship ssot__PrimaryCitizenshipCountryId__c A reference ID to the individual’s primary country text Service
Country of citizenship.
Primary Hobby ssot__PrimaryHobbyId__c A reference ID for a person’s primary hobby. text Sales,
Service
Primary Household ssot__PrimaryHouseholdId__c A reference ID for a person’s household. text Sales,
Service
Primary Language ssot__PrimaryLanguageId__c A reference ID for a person’s first language. text Sales,
Service
Pronoun ssot__Pronoun__c The pronouns for the individual. text Service
Religion ssot__ReligionId__c A reference ID to the individual’s religion. text Service
Residence Capture ssot__ResidenceCaptureMethodId__c A reference ID for how residence information was text Sales,
Method obtained. Service
Residence Country ssot__ResidenceCountryId__c A reference ID for the country where a person text Sales,
resides. Service
Residence Country ssot__ResidenceCountryName__c The primary country where a person resides. text Sales,
Name Service
315
Model Data in Data Cloud Insurance Policy DMO
Field Name Field API Name Description Data Data
Type Bundle
Rewards Balance ssot__Rewards_Balance__c A person’s balance of rewards, for example total text Sales
points.
Salutation ssot__Salutation__c The person’s preferred greeting, for example Ms. text Sales,
or Mx. Service
Second Last Name ssot__SecondLastName__c A person’s second last name. text Sales,
Service
Secondary Citizenship ssot__SecondaryCitizenshipCountryId__c A reference ID to the individual’s secondary text Service
Country country of citizenship.
Surgeries Last 5 Years ssot__SurgeriesLast5YearsCount__c The number of surgeries the individual has had number Service
Count in the last 5 years.
Tax Bracket Range ssot__TaxBracketRange__c The tax bracket range of the individual. text Service
Title ssot__TitleName__c The title of the individual. text Service
Web Site URL ssot__WebSiteURL__c The link to a person’s website. text Sales,
Service
Wedding Anniversary ssot__WeddingAnniversaryDate__c The date of a person’s wedding. dateTime Sales,
Date Service
Yearly Income ssot__YearlyIncome__c The yearly income for the individual. number Service
Yearly Income ssot__YearlyIncomeCurrencyId__c A reference ID to the currency for the individual’s text Service
Currency year income.
Yearly Income Range ssot__YearlyIncomeRangeId__c A reference ID to the range for the individual’s text Service
year income.
Insurance Policy DMO
Represents an insurance policy. Provided in the Financial Services Cloud Data Kit. This DMO is available in API version 58 and later.
API Name
ssot__InsurancePolicy__dlm
Category
Profile
Primary Subject Area
Financial Account
316
Model Data in Data Cloud Interest Tag Definition DMO
Primary Key Label
Insurance Policy ID (ssot_Id_c).
Relationships
DMO Label DMO Field Label Cardinality Related DMO Related DMO Data Bundle or
Label Field Label Origin
Insurance Policy Financial Account ID Many To One (N:1) Party ID Financial Services
Cloud
Financial Account Insurance Policy ID Many To One (N:1) Insurance Policy ID Financial Services
Cloud
Fields
Label API Name Description Data Data
Type Bundle
or
Origin
Currency ssot__Currency__c The associated currency. Text Financial
Services
Cloud
Description ssot__Description__c The description of the insurance Text
policy.
Financial Account ID ssot__FinancialAccountID__c The associated financial account. Text
Insurance Policy ID ssot__Id__c The primary key. Text
Insurance Policy Number ssot__InsurancePolicyNumber__c The insurance policy number. Text
Insured Amount ssot__InsuredAmount__c The insurance policy amount. Number
Name ssot__Name__c The name of the insurance policy. Text
Premium Amount ssot__PremiumAmount__c The amount paid to the insurer for Number
insurance policy coverage.
Renewal Date ssot__RenewalDate__c The due date of the insurance policy Date
renewal. Time
Interest Tag Definition DMO
Represents products, services, features in which a party has expressed interest. Provided in the Financial Services Cloud Data Kit. This
DMO is available in API version 58 and later.
317
Model Data in Data Cloud Interest Tag Definition DMO
API Name
ssot__InterestTagDefinition__dlm
Category
Profile
Primary Subject Area
Add value
Primary Key Label
Interest Tag Definition ID (ssot_Id_c).
Relationships
DMO Label DMO Field Label Cardinality Related DMO Related DMO Data Bundle or
Label Field Label Origin
Party Interest Tag Interest Tag Many To One (N:1) Interest Tag ID Financial Services
Definition ID Definition Cloud
Fields
Label API Name Description Data Data
Type Bundle
or
Origin
Description ssot__Description__c The interest tag definition. description. Text Financial
Services
Cloud
Interest Tag Definition ID ssot__Id__c The primary key. Text Financial
Services
Cloud
Interest Tag Type ssot__InterestTagType__c The interest tag definition type. Text Financial
Services
Cloud
Name ssot__Name__c The interest tag definition name. Text Financial
Services
Cloud
318
Model Data in Data Cloud Investment Account DMO
Investment Account DMO
Represents a subtype of a financial account. Provided in the Financial Services Cloud Data Kit. This DMO is available in API version 58
and later.
API Name
ssot__InvestmentAccount__dlm
Category
Profile
Primary Subject Area
Financial Account
Primary Key Label
Investment Account (ssot_Id_c).
Relationships
DMO Label DMO Field Label Cardinality Related DMO Related DMO Data Bundle or
Label Field Label Origin
Investment Account Financial Account ID Many To One (N:1) Financial Account ID Financial Services
Cloud
Financial Account Investment Account Many To One (N:1) Investment Account ID Financial Services
ID Cloud
Fields
Label API Name Description Data Data
Type Bundle
or
Origin
Annual Yield Percentage ssot__AnnualYieldPercentage__c The annual percentage yield of the Number Financial
investment account. Services
Cloud
Description ssot__Description__c The description of the investment Text Financial
account. Services
Cloud
319
Model Data in Data Cloud Knowledge Article Engagement DMO
Label API Name Description Data Data
Type Bundle
or
Origin
Financial Account ID ssot__FinancialAccountID__c The associated financial account. Text Financial
Services
Cloud
Investment Account ID ssot__Id__c The primary key. Text Financial
Services
Cloud
Investment Objective ssot__InvestmentObjective__c The associated investment objective. Text Financial
Services
Cloud
Investment Time ssot__InvestmentTimeHorizon__c The investment time horizon. Text Financial
Horizon Services
Cloud
Model Portfolio Type ssot__ModelPortfolioType__c The associated model portfolio type. Text Financial
Services
Cloud
Name ssot__Name__c The name of the investment account. Text Financial
Services
Cloud
Knowledge Article Engagement DMO
Stores the user engagement details related to a Knowledge Article. It’s a logical subtype of EngagementAction. Provided by the Knowledge
Engagement Ingestion API. This DMO is available in API version 58 and later.
API Name
ssot__KnowledgeArticleEngagement__dlm
Category
Unassigned
Primary Subject Area
Knowledge Articles
Primary Key Label
Knowledge Article Engagement Id (ssot_Id_c)
320
Model Data in Data Cloud Knowledge Article Engagement DMO
Relationships
DMO Label DMO Field Label Cardinality Related DMO Related DMO Data Bundle or
Label Field Label Origin
Knowledge Article Knowledge Article Many To One (N:1) Knowledge Article Knowledge Article Knowledge
Engagement Version Version Version Id Engagement
Ingestion API
Knowledge Article Source Reference Many To One (N:1) Case Case Id Service
Engagement
Knowledge Article User Many To One (N:1) User Iser Id Service
Engagement
Fields
Label API Name Description Data Data
Type Bundle
or
Origin
Account Contact ssot__AccountContactId__c An individual who has a role specific text Knowledge
to an account. Engagement
Ingestion
API
Article View Context ssot__ArticleViewContextDescription__c The context in which the article was text Knowledge
viewed. Engagement
Ingestion
API
Browser Model ssot__BrowserModel__c The specific version or release of a text Knowledge
web browser where the article was Engagement
viewed, which includes its features, Ingestion
capabilities, and rendering engine. API
Browser Name ssot__BrowserName__c The name of the client browser using text Knowledge
the website where the article was Engagement
viewed. Ingestion
API
Contact Point ssot__ContactPointId__c A specific email address, phone text Knowledge
number, or other contact method that Engagement
was used to communicate with a Ingestion
Party. API
Created Date ssot__CreatedDate__c The date and time when this record dateTime Knowledge
was created. Engagement
Ingestion
API
321
Model Data in Data Cloud Knowledge Article Engagement DMO
Label API Name Description Data Data
Type Bundle
or
Origin
Data Source ssot__DataSourceId__c The system where the data in this text Knowledge
record originated. Engagement
Ingestion
API
Data Source Object ssot__DataSourceObjectId__c An object or table in the Data Source text Knowledge
where the data in this record Engagement
originated. Ingestion
API
Device Country ssot__DeviceCountry__c The country of the computing device's text Knowledge
geographic coordinates at the time of Engagement
the session. Ingestion
API
Device IP Address ssot__DeviceIPAddress__c A unique address that identifies a text Knowledge
device on the internet. Engagement
Ingestion
API
Device Latitude ssot__DeviceLatitude__c The north/south geographic number Knowledge
coordinate of a user's device during a Engagement
session. Ingestion
API
Device Locale ssot__DeviceLocale__c A geographic or political region that text Knowledge
shares language and customs. Users Engagement
of a software app often set their Ingestion
locale. Examples are en-US or API
fr-CH, which are locales for English
US or French Switzerland respectively.
Device Longitude ssot__DeviceLongitude__c The east/west geographic coordinate number Knowledge
of a user's device during a session. Engagement
Ingestion
API
Device Model Name ssot__DeviceModelName__c The model name of the device. text Knowledge
Engagement
Ingestion
API
Device Postal Code ssot__DevicePostalCode__c The postal code of the computing text Knowledge
device's geographic coordinates at Engagement
the time of the session. Ingestion
API
322
Model Data in Data Cloud Knowledge Article Engagement DMO
Label API Name Description Data Data
Type Bundle
or
Origin
Device Type ssot__DeviceType__c The name of the client device type text Knowledge
using the website or marketing link Engagement
as free text. Ingestion
API
Engagement Action ssot__EngagementActionReasonText__c The additional data about the text Knowledge
Reason Engagement Channel Action. Engagement
Ingestion
API
Engagement Channel ssot__EngagementChannelId__c An actor or business that serves as a text Knowledge
provider for an Engagement Channel Engagement
Type. For example AT&T, Telia and Ingestion
T-Mobile are Engagement Channels API
for the phone call Engagement
Channel Type.
Engagement Channel ssot__EngagementChannelAction__c An activity or operation that can be text Knowledge
Action performed for an Engagement Engagement
Channel Type, and for which there’s Ingestion
business interest in recording details. API
For example, for the SMS Engagement
Channel Type, there’s business value
in the Sent, Delivered, and
Read actions
Engagement Channel ssot__EngagementChannelType__c An actor or business that serves as a text Knowledge
Type provider for an Engagement Channel Engagement
Type. For example AT&T, Telia and Ingestion
T-Mobile are Engagement Channels API
for the phone call Engagement
Channel Type.
Engagement Date Time ssot__EngagementDateTm__c The date and time of the dateTime Knowledge
Engagement/Channel Action. For Engagement
certain Engagement Vehicles types, Ingestion
this could be different than the system API
datetime when the record is stored.
Engagement Event ssot__EngagementEventDirection__c Many engagement subtypes involve text Knowledge
Direction messages that are either inbound or Engagement
outbound. This field can be used to Ingestion
define which direction an API
engagement instance is, either
inbound or outbound.
323
Model Data in Data Cloud Knowledge Article Engagement DMO
Label API Name Description Data Data
Type Bundle
or
Origin
External Record Id ssot__ExternalRecordId__c The corresponding record Id from an text Knowledge
external data source system. Engagement
Ingestion
API
External Source Id ssot__ExternalSourceId__c The system in which the text Knowledge
ExternalRecordId was Engagement
assigned. Ingestion
API
Flow Element Run ssot__FlowElementRunId__c The state of a single element within a text Knowledge
business process step execution, for Engagement
example, Joe Smith's Drip Campaign Ingestion
"Send Follow-up Email" element flow API
execution.
Geographic Region ssot__GeographicRegion__c The area where the user was located text Knowledge
when using the software application. Engagement
Ingestion
API
Individual ssot__IndividualId__c A reference ID for the individual text Knowledge
associated with the engagement. Engagement
Ingestion
API
Internal Organization ssot__InternalOrgnizationId__c A reference ID for the business unit or text Knowledge
other internal organization that owns Engagement
the business account. Ingestion
API
IP Address ssot__IPAddress__c The IP address from the client using text Knowledge
the website. Engagement
Ingestion
API
Is Test Send ssot__IsTestSend__c Indicates whether the engagement is text Knowledge
the result of a communication that Engagement
was sent for testing purposes (true) Ingestion
or not (false). The default is API
false.
Knowledge Article ssot__Id__c The primary key. text Knowledge
Engagement Id Engagement
Ingestion
API
324
Model Data in Data Cloud Knowledge Article Engagement DMO
Label API Name Description Data Data
Type Bundle
or
Origin
Knowledge Article User ssot__KnowledgeArticleUserType__c The user type for the article. Example text Knowledge
Type values are A (API User), I (Internal Engagement
User), C (Experience Cloud Customer Ingestion
User), P (Experience Cloud Customer API
User).
Knowledge Article ssot__KnowledgeArticleVersionId__c The reference ID to the associated text Knowledge
Version knowledge article version. Engagement
Ingestion
API
Lead ssot__LeadId__c A person or company that showed text Knowledge
interest in the company's products. Engagement
Ingestion
API
Link Name ssot__LinkName__c The label associated with a link URL text Knowledge
that is embedded in a page, email, or Engagement
message. Ingestion
API
Link URL ssot__LinkURL__c When the software application or web text Knowledge
page that generated the engagement Engagement
was accessed via a link or deep link. Ingestion
this stores the URL that was used API
(unpersonalized).
Name ssot__Name__c The name of an instance of an text Knowledge
engagement, which is an action for Engagement
an email send, SMS or other Ingestion
communication. API
OS Model Name ssot__OSModelName__c The operating system model name of text Knowledge
the client device using the website. Engagement
Ingestion
API
OS Name ssot__OSName__c The operating system name of the text Knowledge
client device using the website. Engagement
Ingestion
API
OS Version Number ssot__OSVersionNumber__c The version of the operating system, text Knowledge
for example "Ventura 13.4.1" is a Engagement
version number of the Mac operating Ingestion
system. API
325
Model Data in Data Cloud Knowledge Article Engagement DMO
Label API Name Description Data Data
Type Bundle
or
Origin
Personalization ssot__PersonalizationId__c The personalization ID uniquely text Knowledge
identifies a personalization request for Engagement
a particular personalization point and Ingestion
individual serviced by the API
personalization pipeline.
Personalization Content ssot__PersonalizationContentId__c The ID for a unique piece of text Knowledge
personalized digital content. Engagement
Ingestion
API
Personalization Request ssot__PersonalizationRequestId__c The request ID to the Personalization text Knowledge
service, which results in one or more Engagement
personalization content records. Ingestion
API
Personalization Service ssot__PerslServiceProviderName__c The name of the service that provided text Knowledge
Provider personalization. Engagement
Ingestion
API
Recipient IP Address ssot__RecipientIPAddress__c The IP address of the device used to text Knowledge
receive the email message. Engagement
Ingestion
API
Recipient Message Id ssot__RecipientMessageId__c The ID for a particular recipient of an text Knowledge
email message, and common for all Engagement
engagement actions related to the Ingestion
recipient's email message or other API
engagement channel type.
Referrer ssot__Referrer__c The contextual data about the user's text Knowledge
usage of the site or application that Engagement
referred them to the software Ingestion
application that generated the API
engagement, for example a campaign
or search advertisement.
Resolved URL ssot__ResolvedURL__c The personalized URL is used when text Knowledge
the software application or web page Engagement
that generated the engagement was Ingestion
accessed via a link or deep link. API
SMS Template ssot__SMSTemplateId__c The standard form of a message that text Knowledge
can be personalized and customized Engagement
with data specific to an individual Ingestion
API
326
Model Data in Data Cloud Knowledge Article Engagement DMO
Label API Name Description Data Data
Type Bundle
or
Origin
recipient, market segment, or other
customization factor.
Source Reference ssot__SourceReferenceId__c The unique ID of the non-knowledge text Knowledge
record, like a case record or chat Engagement
record, where the article was shown. Ingestion
API
Source Reference Object ssot__SourceReferenceObject__c The name of the source reference text Knowledge
object, for example, Case. Engagement
Ingestion
API
Used For Grounding ssot__UsedForGrounding__c Indicates whether the GPT service text Knowledge
produced a reply to an agent that is Engagement
based on a Knowledge Article, and Ingestion
the agent used that reply (true) or API
if the service didn’t produce a reply,
or the reply wasn’t used by the agent
(false).
User Agent ssot__UserAgentText__c A field in HTTP requests, email text Knowledge
envelopes, and other communication Engagement
protocols that is decomposed into Ingestion
data such as browser type, device API
type, and other data.
User ssot__UserId__c The ID for the associated User. text Knowledge
Engagement
Ingestion
API
Web Cookie ssot__WebCookieId__c A small piece of data sent from a text Knowledge
website and stored on the user's Engagement
computer by the user's web browser Ingestion
while the user is browsing. API
Web Session ssot__WebSession__c A group of user interactions with a text Knowledge
website or device app that take place Engagement
within a given time frame. Ingestion
API
Website ssot__Websiteid__c The ID of the related site that is hosted text Knowledge
on the internet. Engagement
Ingestion
API
327
Model Data in Data Cloud Lead DMO
Lead DMO
The Lead data model object (DMO) is a Data Cloud DMO for a person or company that shows interest in a company’s products or services.
Object API Name
ssot__Lead__dlm
Category
Profile
Primary Subject Area
Party
Primary Key
Lead ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Lead Contact Point Email Many to One (N:1) Contact Point Email Contact Point Email ID
Lead Contact Point Phone Many to One (N:1) Contact Point Phone Contact Point Phone ID
Lead Converted to Account Many to One (N:1) Account Account ID
Lead Converted to AccountContact Many to One (N:1) Account Contact Account Contact ID
All Fields
Field Name Field API Name Description Data
Type
Annual Revenue ssot__AnnualRevenue__c The annual revenue for the lead’s company. number
City ssot__City__c The city of the lead’s address. text
Company Name ssot__CompanyName__c The lead’s company name. text
Contact Address ssot__ContactAddressId__c The reference ID of the lead’s address. text
Contact Point Email ssot__ContactPointEmailId__c The reference ID of the lead’s email address. text
Converted Date ssot__ConvertedDate__c The date that the lead was converted. dateTime
Converted To Account ssot__ConvertedToAccountId__c The reference ID that points to the account into text
which the lead has been converted.
328
Model Data in Data Cloud Lead DMO
Field Name Field API Name Description Data
Type
Converted To ssot__ConvertedToAccountContactId__c The reference ID that points to the account text
AccountContact contact into which the lead has been converted.
Converted To Opportunity ssot__ConvertedToOpportunityId__c The reference ID that points to the opportunity text
into which the lead has been converted.
Country ssot__CountryId__c The reference ID of the country where the text
address is located.
Country Name ssot__CountryName__c The free text name of the country where the text
address is located.
Created Date ssot__CreatedDate__c The date the record was created. dateTime
Currency ssot__CurrencyId__c The reference ID for a currency code. text
Data Source ssot__DataSourceId__c The reference ID for the logical name for a text
system that is the source of records identified
by external record ID.
Data Source Object ssot__DataSourceObjectId__c The reference ID for the logical name of the text
object where this record originated, whether
that is a name of a cloud storage file or another
connector’s external object.
Description ssot__Description__c The description of the lead. text
EmailBouncedDate ssot__EmailBouncedDate__c The lead’s email bounced, if applicable. dateTime
EmailBouncedReason ssot__EmailBouncedReason__c The reason the bounce occurred, if applicable. text
External Record ID ssot__ExternalRecordId__c The reference ID for an external data source text
system.
External Source ID ssot__ExternalSourceId__c The reference ID for the system in which the text
external record ID was assigned.
Fax Contact Phone ssot__FaxContactPhoneId__c The reference ID for the lead’s fax number. text
Geo Accuracy ssot__GeoAccuracy__c Additional information about the latitude and number
longitude attributes of an address.
Geo Latitude ssot__GeoLatitude__c The geographical latitude for the address. number
Geo Longitude ssot__GeoLongitude__c The geographical longitude for the address. number
Industry ssot__IndustryId__c The reference ID for the lead’s industry. text
Internal Organization ssot__InternalOrganizationId__c The reference ID for the business unit or other text
internal organization that owns the business
account.
Is Converted ssot__IsConverted__c An indicator if the lead was converted. text
Last Activity Date ssot__LastActivityDate__c The date of the most recent account activity. dateTime
329
Model Data in Data Cloud Loan Account DMO
Field Name Field API Name Description Data
Type
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the record. dateTime
Lead ID ssot__Id__c A unique ID used as the primary key for the lead text
DMO.
Lead Party Role ssot__PartyRoleId__c The reference ID to the associated party role, text
for example, a customer, supplier, or competitor.
Lead Rating ssot__LeadRating__c A lead’s rating, for example, cold or warm. text
Lead Score ssot__LeadScore__c A score or value assigned by Einstein logic. Number
Lead Source ssot__LeadSourceId__c The reference ID to the source of the lead. text
Lead Status ssot__LeadStatusId__c The reference ID to the status of the lead. text
Mobile Contact Phone ssot__MobileContactPhoneId__c The reference ID to the lead’s mobile phone text
number.
Partner Account ssot__PartnerAccountId__c The reference ID to the partner who found the text
lead.
Phone Contact Point ssot__PhoneContactPointId__c The reference ID for the lead’s phone number. text
Photo URL ssot__PhotoURL__c A link to a lead’s photo. text
Postal Code ssot__PostalCodeId__c The reference ID for the postal code. text
State Province ssot__StateProvinceId__c The reference ID for the state or prince where text
the address is located.
State Province Name ssot__StateProvinceName__c The state or province name where the address text
is located.
Street Name ssot__StreetName__c The lead’s address street number and name. text
Website ssot__Website__c The lead’s website. text
Loan Account DMO
Represents a subtype of financial account. Provided in the Financial Services Cloud Data Kit. This DMO is available in API version 58 and
later.
API Name
ssot__LoanAccount__dlm
Category
Profile
330
Model Data in Data Cloud Loan Account DMO
Primary Subject Area
Financial Account
Primary Key Label
Loan Account ID (ssot_Id_c).
Relationships
DMO Label DMO Field Label Cardinality Related DMO Related DMO Data Bundle or
Label Field Label Origin
Loan Account Financial Account ID Many To One (N:1) Financial Account ID Financial Services
Cloud
Financial Account Loan Account ID Many To One (N:1) Loan Account ID Financial Services
Cloud
Fields
Label API Name Description Data Data
Type Bundle
or
Origin
Currency ssot__Currency__c The associated Currency Text Financial
Services
Cloud
Description ssot__Description__c The description of the loan account. Text Financial
Services
Cloud
Expected Close Date ssot__ExpectedCloseDate__c The date when loan is expected to be Date Financial
closed. Time Services
Cloud
Financial Account ID ssot__FinancialAccountID__c The associated financial account. Text Financial
Services
Cloud
Loan Account ID ssot__Id__c The primary key. Text Financial
Services
Cloud
Loan Amount ssot__LoanAmount__c The loan amount. Number Financial
Services
Cloud
331
Model Data in Data Cloud Loyalty Benefit DMO
Label API Name Description Data Data
Type Bundle
or
Origin
Loan End Date ssot__LoanEndDate__c The end date of the loan. Date Financial
Time Services
Cloud
Loan Term Months ssot__LoanTermMonthsNumber__c The loan term in months. Number Financial
Number Services
Cloud
Loan Type ssot__LoanType__c The type of loan. Text Financial
Services
Cloud
Name ssot__Name__c The name of the loan account. Text Financial
Services
Cloud
Property Type ssot__PropertyType__c The property type. Text Financial
Services
Cloud
Repayment Period ssot__RepaymentPeriodMonthsNumber__c The repayment period in months. Number Financial
Months Number Services
Cloud
Loyalty Benefit DMO
The Loyalty Benefit DMO is a Data Cloud data model object (DMO) for a perk or betterment that is available to the members of a Loyalty
Program. Examples include waived airline baggage fees, complimentary hotel stays, or a rental car upgrade.
Object API Name
ssot__LoyaltyBenefit__dlm
Category
Other
Primary Subject Area
Loyalty
Primary Key
Loyalty Benefit ID (ssot__Id__c)
332
Model Data in Data Cloud Loyalty Benefit DMO
Relationships
Object Field Cardinality Related Object Related Field
Loyalty Benefit Loyalty Benefit Type Many To One: N:1 Loyalty Benefit Type Loyalty Benefit Type ID
Loyalty Tier Benefit Loyalty Benefit Many To One: N:1 Loyalty Benefit Loyalty Benefit ID
Member Benefit Loyalty Benefit Many To One: N:1 Loyalty Benefit Loyalty Benefit ID
Voucher Loyalty Benefit Many To One: N:1 Loyalty Benefit Loyalty Benefit ID
All Fields
Field Name Field API Name Description Data
Type
Benefit Action ssot__BenefitActionId__c A reference ID for actions such as creating text
a service entitlement that can be
triggered automatically when a loyalty
program benefit is assigned to a program
member.
Benefit Status ssot__BenefitStatusId__c A reference ID for benefit status values text
such as Active or Inactive.
Created Date ssot__CreatedDate__c The date the record was created. dateTime
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by an external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
Description ssot__Description__c The description of the loyalty program. text
External Record ID ssot__ExternalRecordId__c A reference ID to an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
business account.
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the dateTime
record.
333
Model Data in Data Cloud Loyalty Benefit Type DMO
Field Name Field API Name Description Data
Type
Loyalty Benefit Priority ssot__LoyaltyBenefitPriorityNumber__c Priority rating of the loyalty benefit, for text
Number example, 1 for highest or 2 for second
highest priority.
Loyalty Benefit ID ssot__Id__c A unique ID used as the primary key for text
the Loyalty Benefit DMO.
Loyalty Benefit Type ssot__LoyaltyBenefitTypeId__c A reference ID to the Loyalty Benefit Types text
that are used to group the various
benefits available within a Loyalty
Program. For example, baggage benefits
could be used to group reduced fees,
extra baggage allowances, and weight
limit benefits.
Loyalty Benefit UOM ssot__LoyaltyBenefitUOM__c The type of benefit unit within a Loyalty text
Benefit Type. For example, if the Loyalty
Benefit Type is luggage, then UOM is the
number of additional free bags.
Loyalty Benefit Value ssot__LoyaltyBenefitValueText__c Loyalty Benefit values are used to text
determine how many units of the benefit
type. For instance if Loyalty Benefit UOM
is the number of free bags, then Benefit
Value could be 1, 2 or 3.
Name ssot__Name__c Name of the loyalty benefit. text
Loyalty Benefit Type DMO
The Loyalty Benefit Type DMO is a Data Cloud data model object (DMO) for the type of loyalty benefit, such as rewards or gift cards.
Object API Name
ssot__LoyaltyBenefitType__dlm
Category
Other
Primary Subject Area
Loyalty
Primary Key
Loyalty Benefit Type ID (ssot__Id__c)
334
Model Data in Data Cloud Loyalty Benefit Type DMO
Relationships
Object Field Cardinality Related Object Related Field
Loyalty Benefit Benefit Action Many To One: N:1 Benefit Action Benefit Action ID
Loyalty Benefit Loyalty Benefit Type Many To One: N:1 Loyalty Benefit Type Loyalty Benefit Type ID
Loyalty Tier Benefit Loyalty Benefit Many To One: N:1 Loyalty Benefit Loyalty Benefit ID
Member Benefit Loyalty Benefit Many To One: N:1 Loyalty Benefit Loyalty Benefit ID
Voucher Loyalty Benefit Many To One: N:1 Loyalty Benefit Loyalty Benefit ID
All Fields
Field Name Field API Name Description Data
Type
Created Date ssot__CreatedDate__c The date when the record was created. dateTime
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
External Record Id ssot__ExternalRecordId__c A reference ID to an external data source text
system.
External Source Id ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Internal Organization ssot__InternalOrganizationId__c reference ID to the business unit or other text
internal organization that owns the
business account.
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the dateTime
record.
Loyalty Benefit Category ssot__LoyaltyBenefitCategoryId__c A reference ID to category of loyalty text
benefit.
Loyalty Benefit Type ID ssot__Id__c A unique ID used as primary key for the text
Loyalty Benefit Type DMO.
Loyalty Program ssot__LoyaltyProgramId__c A reference ID to a loyalty program. text
Name ssot__Name__c The name of loyalty benefit type. text
335
Model Data in Data Cloud Loyalty Journal Subtype DMO
Loyalty Journal Subtype DMO
The Loyalty Journal Subtype DMO is a Data Cloud data model object (DMO) for a subtype of a loyalty journal type, such as a watched
video or product review.
Object API Name
ssot__LoyaltyJournalSubtype__dlm
Category
Other
Primary Subject Area
Loyalty
Primary Key
Loyalty Journal Subtype Id (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Loyalty Journal Subtype Loyalty Journal Type ID Many To One: N:1 Loyalty Journal Type Loyalty Journal Type ID
Loyalty Transaction Loyalty Journal Subtype Many To One: N:1 Loyalty Journal Subtype Loyalty Journal Subtype
Journal ID
Voucher Loyalty Journal Subtype Many To One: N:1 Loyalty Journal Subtype Loyalty Journal Subtype
ID
All Fields
Field Name Field API Name Description Data
Type
Created Date ssot__CreatedDate__c The date when the record was created. dateTime
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
336
Model Data in Data Cloud Loyalty Journal Type DMO
Field Name Field API Name Description Data
Type
External Record ID ssot__ExternalRecordId__c A reference ID to an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
business account.
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the dateTime
record.
Loyalty Journal Subtype ID ssot__Id__c A unique ID used as primary key for the text
Loyalty Journal Subtype DMO.
Loyalty Journal Type ID ssot__LoyaltyJournalTypeId__c A reference ID to loyalty program journal text
type, for example accrual, redemption,
and signup.
Name ssot__Name__c Name of loyalty program journal subtype. text
Loyalty Journal Type DMO
The Loyalty Journal Type DMO is a Data Cloud data model object (DMO) for the type of loyalty journal.
Object API Name
ssot__LoyaltyJournalType__dlm
Category
Other
Primary Subject Area
Loyalty
Primary Key
Loyalty Journal Type ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Loyalty Journal Subtype Loyalty Journal Type ID Many To One: N:1 Loyalty Journal Type Loyalty Journal Type ID
337
Model Data in Data Cloud Loyalty Ledger DMO
Object Field Cardinality Related Object Related Field
Loyalty Transaction Loyalty Journal Type Many To One: N:1 Loyalty Journal Type Loyalty Journal Type ID
Journal
All Fields
Field Name Field API Name Description Data
Type
Created Date ssot__CreatedDate__c The date when a record was created. dateTime
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
External Record ID ssot__ExternalRecordId__c A reference ID to an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
business account.
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the dateTime
record.
Loyalty Journal Type ID ssot__Id__c A unique ID used as primary key for the text
Loyalty Journal Type DMO.
Name ssot__Name__c The names of the loyalty transaction text
journal, for example, accrual, redemption,
or signup.
Loyalty Ledger DMO
The Loyalty Ledger DMO is a Data Cloud data model object (DMO) to record the points credited or debited for a member across
transactions.
Object API Name
ssot__LoyaltyLedger__dlm
338
Model Data in Data Cloud Loyalty Ledger DMO
Category
Other
Primary Subject Area
Loyalty
Primary Key
Loyalty Ledger ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Loyalty Ledger Loyalty Program Currency Many To One: N:1 Loyalty Program Currency Loyalty Program Currency
ID
Loyalty Ledger Loyalty Transaction Many To One: N:1 Loyalty Transaction Loyalty Transaction
Journal Journal Journal ID
All Fields
Field Name Field API Name Description Data
Type
Activity Datetime ssot__ActivitydateTime__c The date a loyalty program member dateTime
completes a transaction with the loyalty
program partner.
Created Date ssot__CreatedDate__c The date when the record was created. dateTime
Data Entity ssot__DataEntityId__c A reference ID to the category a business text
or organization is interested in, for
example, a hospital, account, or person.
Data Entity Instance ssot__DataEntityInstanceId__c A reference ID to a particular occurrence text
of one category of things defined by the
Data Entity.
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by an external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
339
Model Data in Data Cloud Loyalty Member Currency DMO
Field Name Field API Name Description Data
Type
External Record ID ssot__ExternalRecordId__c A reference ID to an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Financial TransactionType ssot__FinancialTransactionTypeId__c A reference ID to financial transactions, text
for example Credit or Debit.
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
business account.
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the DateTime
record.
Ledger Processing Status ssot__LedgerProcessingStatusId__c A reference ID to the value of Ledger text
Processing Status, for example, not
processed, successfully processed, or
failed processing.
Loyalty Currency Unit ssot__LoyaltyCurrencyUnitQuantity__c The total number of loyalty currency units, number
Quantity such as points or miles, given for ledger
record.
Loyalty Ledger ID ssot__Id__c A unique ID used as the primary key for text
the Loyalty Ledger DMO.
Loyalty Ledger Notes ssot__LoyaltyLedgerNotestext__c Additional details about loyalty ledger text
entry.
Loyalty Program Currency ssot__LoyaltyProgramCurrencyId__c A reference ID to the medium of text
exchange allowed within a loyalty
program, for example points or miles.
Loyalty Program Currency ssot__LoyaltyProgramCurrencyExpirationDate__c The date when the loyalty program dateTime
Expiration Date currency is set to expire.
Loyalty Program Currency ssot__LoyaltyProgramCurrencyUnitsQuantity__c The quantity of loyalty program currency number
Units Quantity awarded or spent in a transaction.
Loyalty Transaction Journal ssot__LoyaltyTransactionJournalId__c A reference ID to a collection of text
transactions related to loyalty program.
Name ssot__Name__c The name of a loyalty ledger. text
Loyalty Member Currency DMO
The Loyalty Member Currency DMO is a Data Cloud data model object (DMO) representing the value a loyalty member selects to receive,
for example, as airline miles or as points.
340
Model Data in Data Cloud Loyalty Member Currency DMO
Object API Name
ssot__LoyaltyMemberCurrency__dlm
Category
Other
Primary Subject Area
Loyalty
Primary Key
Loyalty Member Currency ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Loyalty Member Currency Loyalty Member Tier Loyalty Member Tier Loyalty Member Tier ID
Loyalty Member Currency Loyalty Program Member Loyalty Program Member Loyalty Program Member
ID
Loyalty Member Currency Currency Type Loyalty Program Currency Loyalty Program Currency
ID
All Fields
Field Name Field API Name Description Data
Type
Created Date ssot__CreatedDate__c The date the record was created. dateTime
Currency Type ssot__CurrencyTypeId__c A reference ID to methods of accruing text
value in loyalty program, for example
miles, points, or a hard currency such as
US dollars.
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
341
Model Data in Data Cloud Loyalty Member Currency DMO
Field Name Field API Name Description Data
Type
Expirable Points ssot__ExpirablePointsNumber__c The number of points that expire if not number
redeemed.
External Record ID ssot__ExternalRecordId__c A reference ID to an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
business account.
Last Accrual Processed ssot__LastAccrualProcessedDate__c The date when point accrual process was dateTime
Date last run.
Last Expiration Process Run ssot__LastExpirationProcessRunDate__c The date when expirable points were last dateTime
Date calculated.
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the dateTime
record.
Last Reset Date ssot__LastResetDate__c The date when points were most recently dateTime
converted to baseline value for point
accrual period.
Loyalty Member Currency ssot__Id__c A unique ID used as primary key for the text
Id Loyalty Member Currency DMO.
Loyalty Member Tier Id ssot__LoyaltyMemberTierId__c A reference ID to which tier loyalty text
member belongs.
Loyalty Program Member ssot__LoyaltyProgramMemberId__c A reference ID to person who joined text
loyalty program.
Name ssot__Name__c The loyalty member currency name. text
Next Reset Date ssot__NextResetDate__c The date when points are changed to a dateTime
baseline value for the accrual period.
Points Balance ssot__PointsBalanceNumber__c The current number of points available number
for redemption.
Points Balance Before Reset ssot__PointsBalanceBeforeResetNumber__c The total number of points before number
account was reset.
Total Points Accrued ssot__TotalPointsAccruedNumber__c The total number of accrued points, number
including expired and redeemed points.
Total Points Expired ssot__TotalPointsExpiredNumber__c The total number of expired points. number
Total Points Redeemed ssot__TotalPointsRedeemedNumber__c The total number of points redeemed. number
342
Model Data in Data Cloud Loyalty Member Tier Data Model Object
Loyalty Member Tier Data Model Object
The Loyalty Member Tier DMO is a Data Cloud data model object (DMO) for the benefit tier within the program that a member is assigned.
Object API Name
ssot__LoyaltyMemberTier__dlm
Category
Other
Primary Subject Area
Loyalty
Primary Key
Loyalty Member Tier ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Loyalty Member Currency Loyalty Member Tier Many To One: N:1 Loyalty Member Tier Loyalty Member Tier ID
Loyalty Member Tier Loyalty Program Member Many To One: N:1 Loyalty Program Member Loyalty Program Member
ID
Loyalty Member Tier Loyalty Tier Many To One: N:1 Loyalty Tier Loyalty Tier ID
All Fields
Field Name Field API Name Description Data
Type
Created Date ssot__CreatedDate__c The date the record was created. dateTime
Data Source ssot__DataSourceId__c A reference ID to logical name for system text
that is source of records identified by
external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID to logical name of object text
where record originated, for example a
cloud storage file or another connector’s
external object.
Effective Date ssot__EffectiveDate__c The date when a member joined the dateTime
loyalty tier.
343
Model Data in Data Cloud Loyalty Partner Product DMO
Field Name Field API Name Description Data
Type
External Record ID ssot__ExternalRecordId__c A reference ID to an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
business account.
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the dateTime
record.
Loyalty Member Tier ssot__LoyaltyMemberTierChangeTypeId__c A reference ID to change type of loyalty text
Change Type member tier.
Loyalty Member Tier ID ssot__Id__c A unique ID used as primary key for the text
Loyalty Member Tier DMO.
Loyalty Program Member ssot__LoyaltyProgramMemberId__c A reference ID to individual who joined text
loyalty program.
Loyalty Tier ssot__LoyaltyTierId__c A reference ID to tier of loyalty program. text
Member benefits increase as member
moves up loyalty program hierarchy.
Name ssot__Name__c The name of loyalty member tier. text
Tier Change Reason ssot__TierChangeReasonText__c An explanation of a loyalty member tier text
change.
Tier Expiration Date ssot__TierExpirationDate__c The date when member's eligibility for text
loyalty member tier expires.
Loyalty Partner Product DMO
The Loyalty Partner Product DMO is a Data Cloud data model object (DMO) for a product offered by a loyalty program partner, such as
a coupon from another company.
Object API Name
ssot__LoyaltyPartnerProduct__dlm
Category
Other
344
Model Data in Data Cloud Loyalty Partner Product DMO
Primary Subject Area
Loyalty
Primary Key
Loyalty Partner Product ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Loyalty Partner Product Product Many To One: N:1 Goods Product Goods Product ID
Loyalty Partner Product Product Many To One: N:1 Bundle Product Bundle Product ID
Loyalty Partner Product Product Many To One: N:1 Master Product Master Product ID
Loyalty Partner Product Loyalty Program Partner Many To One: N:1 Loyalty Program Partner Loyalty Program Partner
ID
All Fields
Field Name Field API Name Description Data
Type
Created Date ssot__CreatedDate__c The date the record was created. dateTime
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
External Record ID ssot__ExternalRecordId__c A reference ID to an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Internal Organization ssot__InternalOrganizationId__c A reference ID to business unit or other text
internal organization that owns business
account.
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified dateTime
record.
345
Model Data in Data Cloud Loyalty Program DMO
Field Name Field API Name Description Data
Type
Loyalty Partner Category ssot__LoyaltyPartnerCategoryId__c A reference ID to category designated for text
loyalty partner, for example, alliance or
bilateral.
Loyalty Partner Status ssot__LoyaltyPartnerStatusId__c A reference ID to status of loyalty partner. text
Loyalty Partner Type ssot__LoyaltyPartnerTypeId__c A reference ID to type of loyalty partner. text
Loyalty Program ssot__LoyaltyProgramId__c A reference ID to marketing strategy text
designed to encourage customers to
shop at or use the services of business
associated with program.
Loyalty Partner Product Id ssot__Id__c A unique ID used as primary key for the text
Loyalty Partner Product DMO.
Partner Account ssot__PartnerAccountId__c A reference ID to account of partner to text
loyalty program.
Partner Industry ssot__PartnerIndustryId__c A reference ID to primary economic text
activity of partner, for example
automotive or retail.
Partnership End Date ssot__PartnershipEndDate__c The date when a loyalty program dateTime
partnership expires.
Partnership Start Date ssot__PartnershipStartDate__c The date when a loyalty program dateTime
partnership begins.
Party ssot__PartyId__c A reference ID to the parent party, for text
example, an individual, business, or
affiliation group.
Loyalty Program DMO
The Loyalty Program DMO is a Data Cloud data model object (DMO) for a strategy designed to encourage customers to continue to be
loyal to the business associated with the program.
Object API Name
ssot__LoyaltyProgram__dlm
Category
Other
Primary Subject Area
Loyalty
346
Model Data in Data Cloud Loyalty Program DMO
Primary Key
Loyalty Program ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Loyalty Benefit Type Loyalty Program Many To One: N:1 Loyalty Program Loyalty Program ID
Loyalty Program Currency Loyalty Program Many To One: N:1 Loyalty Program Loyalty Program ID
Loyalty Program Member Loyalty Program Many To One: N:1 Loyalty Program Loyalty Program ID
Loyalty Program Partner Loyalty Program Many To One: N:1 Loyalty Program Loyalty Program ID
Loyalty Tier Group Loyalty Program Many To One: N:1 Loyalty Program Loyalty Program ID
Loyalty Transaction Loyalty Program Many To One: N:1 Loyalty Program Loyalty Program ID
Journal
Promotion Loyalty Program Many To One: N:1 Loyalty Program Loyalty Program ID
Voucher Definition Loyalty Program Many To One: N:1 Loyalty Program Loyalty Program ID
All Fields
Field Name Field API Name Description Data
Type
Created Date ssot__CreatedDate__c The date the record was created. dateTime
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
End Date ssot__EndDate__c The date when the loyalty program dateTime
expires.
External Record ID ssot__ExternalRecordId__c A reference ID to an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
business account.
347
Model Data in Data Cloud Loyalty Program Currency DMO
Field Name Field API Name Description Data
Type
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the dateTime
record.
Loyalty Program ID ssot__Id__c A unique ID used as primary key for the text
Loyalty Program DMO.
Loyalty Program Partner ssot__LoyaltyProgramPartnerId__c A reference ID to partner of loyalty text
program.
Name ssot__Name__c The loyalty program name. text
Product ssot__ProductId__c A reference ID to the product associated text
with the loyalty program.
Start Date ssot__StartDate__c The date when loyalty program begins. dateTime
Loyalty Program Currency DMO
The Loyalty Program Currency DMO is a Data Cloud data model object (DMO) representing the value or currency that the loyalty program
offers to customers.
Object API Name
ssot__LoyaltyProgramCurrency__dlm
Category
Other
Primary Subject Area
Loyalty
Primary Key
Loyalty Program Currency ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Loyalty Ledger Loyalty Program Currency Many To One (N:1) Loyalty Program Currency Loyalty Program Currency
ID
Loyalty Member Currency Currency Type Many To One (N:1) Loyalty Program Currency Loyalty Program Currency
ID
348
Model Data in Data Cloud Loyalty Program Currency DMO
Object Field Cardinality Related Object Related Field
Loyalty Program Currency Loyalty Program Many To One (N:1) Loyalty Program Household ID
Loyalty Program Currency Loyalty Tier Group Many To One (N:1) Loyalty Tier Group Loyalty Tier Group ID
Promotion Loyalty Program Currency Many To One (N:1) Loyalty Program Currency Loyalty Program Currency
ID
All Fields
Field Name Field API Name Description Data
Type
Created Date ssot__CreatedDate__c The date the record was created. dateTime
Currency Expiration ssot__CurrencyExpirationExtensionModelId__c A reference ID to the program’s currency text
Extension Model model, for example, the rewards don’t
expire or expire on a certain date.
Currency Expiration Model ssot__CurrencyExpirationModelId__c A reference ID to the values of the text
currency expiration model, such as fixed
or activity based.
Currency Type ssot__CurrencyTypeId__c A reference ID to methods of accruing text
value in loyalty program, for example
miles, points, or a hard currency such as
US dollars.
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
Expiration Period ssot__ExpirationPeriodFrequencyNumber__c The frequent currency units expire in number
Frequency relation to the unit of measure (UOM).
Expiration Period ssot__ExpirationPeriodFrequencyTimeUOM__c The time period for how often currency text
Frequency Time UOM such as points or miles expire.
External Record ID ssot__ExternalRecordId__c A reference ID to an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Internal Organization Expiration Period Frequency Time UOM A reference ID to the business unit or text
ssot__InternalOrganizationId__c other internal organization that owns the
business account.
349
Model Data in Data Cloud Loyalty Program Member Data Model Object
Field Name Field API Name Description Data
Type
Is Active ssot__IsActive__c An indicator if the currency is being used. text
Is Primary ssot__IsPrimary__c An indicator if the currency is the primary text
currency for the loyalty program.
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the dateTime
record.
Loyalty Program ssot__LoyaltyProgramId__c A reference ID to the loyalty program. text
Loyalty Program Currency ssot__Id__c A unique ID used as primary key for the text
ID Loyalty Program Currency DMO.
Loyalty Tier Group ssot__LoyaltyTierGroupId__c A reference ID to the tiers available in a text
loyalty program.
Name ssot__Name__c The loyalty member currency name. text
Qualifying Point End Date ssot__QualifyingPointEndDate__c The date when currency stops being dateTime
accrued.
Qualifying Point Start Date ssot__QualifyingPointStartDate__c The date when currency begins to be dateTime
accrued.
Loyalty Program Member Data Model Object
The Loyalty Program Member DMO is a Data Cloud data model object (DMO) for a person who has joined a loyalty program.
Object API Name
ssot__LoyaltyProgramMember__dlm
Category
Other
Primary Subject Area
Loyalty
Primary Key
Loyalty Program Member ID (ssot__Id__c)
350
Model Data in Data Cloud Loyalty Program Member Data Model Object
Relationships
Object Field Cardinality Related Object Related Field
Loyalty Member Currency Loyalty Program Member Many To One: N:1 Loyalty Program Member Loyalty Program Member
ID
Loyalty Member Tier Loyalty Program Member Many To One: N:1 Loyalty Program Member Loyalty Program Member
ID
Loyalty Program Member Loyalty Program Member Many To One: N:1 Individual Individual ID
ID
Loyalty Transaction Loyalty Program Member Many To One: N:1 Loyalty Program Member Loyalty Program Member
Journal ID
Voucher Loyalty Program Member Many To One: N:1 Loyalty Program Member Loyalty Program Member
ID
All Fields
Field Name Field API Name Description Data
Type
Account ssot__AccountId__c A reference ID to account of company text
that employs member.
Account Contact ssot__AccountContactId__c A reference ID to individual who has a text
role specific to account.
Can Receive Partner ssot__CanReceivePartnerPromotions__c An indicator whether a member has text
Promotions opted-in to receive promotions from
partners.
Can Receive Promotions ssot__CanReceivePromotions__c An indicator whether a member has text
opted-in to receive promotions.
Created Date ssot__CreatedDate__c The date when the record was created. dateTime
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
Enrollment Channel ssot__EnrollmentChannelId__c A reference ID to methods that members text
can use to enroll in loyalty programs, for
example via web, email, call center, social
media, or point of sale.
351
Model Data in Data Cloud Loyalty Program Member Data Model Object
Field Name Field API Name Description Data
Type
Enrollment Date ssot__EnrollmentDate__c The date the member was admitted to dateTime
loyalty program.
External Record ID ssot__ExternalRecordId__c A reference ID to an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
business account.
Last Activity Date ssot__LastActivityDate__c The date of the most recent account dateTime
activity.
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the dateTime
record.
Last Renewal Date ssot__LastRenewalDate__c The date when member last extended dateTime
their membership in program.
Loyalty Member Type ssot__LoyaltyMemberTypeId__c A reference ID to types of loyalty text
members.
Loyalty Program ssot__LoyaltyProgramId__c A reference ID to marketing strategy text
designed to encourage customers to
shop at or use the services of business
associated with program.
Loyalty Program Member ssot__Id__c A unique ID used as primary key for the text
ID Loyalty Program Member DMO.
Loyalty Program Member ssot__LoyaltyProgramMemberStatusId__c A reference ID to state of member's status text
Status in loyalty program.
Loyalty Statement Delivery ssot__LoyaltyStatementDeliveryTypeId__c A reference ID to type of delivery method text
Type for loyalty statement, for example postal
mail, email, or text message.
Membership Expiration ssot__MembershipExpirationDate__c The date a membership expires. dateTime
Date
Membership Number ssot__MembershipNumber__c An alphanumeric ID visible to loyalty text
program members.
Name ssot__Name__c The name of loyalty program member. text
Party ssot__PartyId__c A reference ID to person who belongs to text
loyalty program.
Referred by Member ssot__ReferredByMemberId__c A reference ID to person who referred text
member to loyalty program.
352
Model Data in Data Cloud Loyalty Program Member Promotion DMO
Field Name Field API Name Description Data
Type
Referred by Party ssot__ReferredByPartyId__c A reference ID to person who referred text
member to loyalty program.
Related Corporate Program ssot__RelatedCorporateProgramMemberId__c A reference ID to corporate membership text
Member account associated with member.
Statement Last Generated ssot__StatementLastGeneratedDate__c The date the member was last sent dateTime
Date program statement.
Statement Frequency Time ssot__StatementFrequencyTimeUOM__c A reference ID to how often member has text
UOM elected to receive program statements,
for example monthly or yearly.
Loyalty Program Member Promotion DMO
The Loyalty Program Member Promotion DMO is a Data Cloud data model object (DMO) that represents details about a promotion
available to a loyalty program member. For example, if a program allows double points on outdoor purchases.
Object API Name
ssot__LoyaltyProgramMemberPromotion__dlm
Category
Other
Primary Subject Area
Loyalty
Primary Key
Loyalty Program Member Promotion ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Loyalty Program Member Promotion Many To One: N:1 Promotion Promotion ID
Promotion
Loyalty Program Member Loyalty Program Member Many To One: N:1 Loyalty Program Member Loyalty Program Member
Promotion ID
353
Model Data in Data Cloud Loyalty Program Member Promotion DMO
All Fields
Field Name Field API Name Description Data
Type
Created Date ssot__CreatedDate__c The date the record was created. dateTime
Cumulative Usage ssot__CumulativeUsageCompletePercent__c The loyalty program member’s promotion number
Complete Percent usage, expressed as a percentage.
Cumulative Usage ssot__CumulativeUsageCompleted__c The loyalty program member’s promotion number
Completed usage, expressed as a number.
Cumulative Usage Target ssot__CumulativeUsageTargetNumber__c The loyalty program member’s goal for number
the use of the promotion.
Data Source ssot__DataSourceId__c A reference ID to the logical name for a text
system that is the source of records
identified by an external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where the record originated, for
example a cloud storage file or another
connector’s external object.
External Record ID ssot__ExternalRecordId__c A reference ID to an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID to system that External text
Record Id was assigned.
Internal Organization ssot__InternalOrganizationId__c A reference ID to a business unit or other text
internal organization that owns a business
account.
Is Enrollment Active ssot__IsEnrollmentActive__c An indicator that determines if the loyalty text
program member is enrolled in the
promotion. For example, True indicates
that the member is enrolled in the
promotion.
Last Modified Date ssot__LastModifiedDate__c The date when the user last modified the dateTime
record.
Loyalty Program Member ssot__LoyaltyProgramMemberId__c The name of the loyalty program member text
that’s associated with the loyalty badge.
Loyalty Program Member ssot__Id__c A unique ID that is used as the primary text
Promotion Id key for the Loyalty Program Member
Promotion DMO.
Name ssot__Name__c The name of a loyalty program member text
promotion.
354
Model Data in Data Cloud Loyalty Program Partner DMO
Field Name Field API Name Description Data
Type
Promotion ssot__PromotionId__c A reference ID to the promotion text
associated with the loyalty program
member promotion.
Loyalty Program Partner DMO
The Loyalty Program Partner DMO is a Data Cloud data model object (DMO) for companies with loyalty program offerings.
Object API Name
ssot__LoyaltyProgramPartner__dlm
Category
Other
Primary Subject Area
Loyalty
Primary Key
Loyalty Program Partner ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Loyalty Partner Product Loyalty Program Partner Many To One: N:1 Loyalty Program Partner Loyalty Program Partner
ID
Loyalty Transaction Loyalty Program Partner Many To One: N:1 Loyalty Program Partner Loyalty Program Partner
Journal ID
Loyalty Program Partner Partner Account Many To One: N:1 Account Account ID
Loyalty Program Partner Loyalty Program Many To One: N:1 Loyalty Program Loyalty Program ID
Promotion Loyalty Loyalty Partner Product Many To One: N:1 Loyalty Program Partner Loyalty Program Partner
Partner Product ID
355
Model Data in Data Cloud Loyalty Program Partner DMO
All Fields
Field Name Field API Name Description Data
Type
Created Date ssot__CreatedDate__c The date when the record was created. dateTime
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
External Record ID ssot__ExternalRecordId__c A reference ID to an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
business account.
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the dateTime
record.
Loyalty Partner Category ssot__LoyaltyPartnerCategoryId__c A reference ID to category designated for text
loyalty partner, for example, alliance or
bilateral.
Loyalty Partner Status ssot__LoyaltyPartnerStatusId__c A reference ID to status of loyalty partner. text
Loyalty Partner Type ssot__LoyaltyPartnerTypeId__c A reference ID to type of loyalty partner. text
Loyalty Program ssot__LoyaltyProgramId__c A reference ID to marketing strategy text
designed to encourage customers to
shop at or use the services of business
associated with program.
Loyalty Program Partner ID ssot__Id__c A unique ID used as primary key for the text
Loyalty Program Partner DMO.
Partner Account ssot__PartnerAccountId__c A reference ID to account of partner to text
loyalty program.
Partner Industry ssot__PartnerIndustryId__c A reference ID to primary economic text
activity of partner, for example
automotive or retail.
Partnership End Date ssot__PartnershipEndDate__c The date when partnership participation dateTime
in loyalty program ends.
356
Model Data in Data Cloud Loyalty Tier DMO
Field Name Field API Name Description Data
Type
Partnership Start Date ssot__PartnershipStartDate__c The date when partnership participation dateTime
in loyalty program begins.
Party ssot__PartyId__c A reference ID to person or organization text
that is partner in loyalty program.
Loyalty Tier DMO
The Loyalty Tier DMO is a Data Cloud data model object (DMO) for a level of a loyalty program where member benefits increase at higher
levels of the hierarchy.
Object API Name
ssot__LoyaltyTier__dlm
Category
Other
Primary Subject Area
Loyalty
Primary Key
Loyalty Tier ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Loyalty Member Tier Loyalty Tier Loyalty Tier Loyalty Tier ID
Loyalty Tier Loyalty Tier Group Loyalty Tier Group Loyalty Tier Group ID
Loyalty Tier Benefit Loyalty Program Loyalty Tier Loyalty Tier ID
All Fields
Field Name Field API Name Description Data
Type
Created Date ssot__CreatedDate__c The date when the record was created. dateTime
357
Model Data in Data Cloud Loyalty Tier Benefit DMO
Field Name Field API Name Description Data
Type
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
Description ssot__Description__c The description of the loyalty program text
tier.
External Record ID ssot__ExternalRecordId__c A reference ID to an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Internal Organization ssot__InternalOrganizationId__c A reference ID to business unit or other text
internal organization that owns business
account.
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the dateTime
record.
Loyalty Tier Group ssot__LoyaltyTierGroupId__c A reference ID to the loyalty tier group, text
for example silver or gold.
Loyalty Tier ID ssot__Id__c A unique ID used as primary key for the text
Loyalty Tier DMO.
Name ssot__Name__c The name of the loyalty tier. text
Sequence Number ssot__SequenceNumber__c The sequence number of the loyalty tier. number
Loyalty Tier Benefit DMO
The Loyalty Tier Benefit DMO is a Data Cloud data model object (DMO) for a benefit that is available in a specific loyalty member tier.
Object API Name
ssot__LoyaltyTierBenefit__dlm
Category
Other
358
Model Data in Data Cloud Loyalty Tier Benefit DMO
Primary Subject Area
Loyalty
Primary Key
Loyalty Tier Benefit ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Loyalty Tier Benefit Loyalty Benefit Many To One: N:1 Loyalty Benefit Loyalty Benefit ID
Loyalty Tier Benefit Loyalty Tier Many To One: N:1 Loyalty Tier Loyalty Tier ID
All Fields
Field Name Field API Name Description Data
Type
Created Date ssot__CreatedDate__c The date when the record was created. dateTime
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
External Record ID ssot__ExternalRecordId__c A reference ID to an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
business account.
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the dateTime
record.
Loyalty Benefit ssot__LoyaltyBenefitId__c A reference ID to loyalty benefit. text
Loyalty Tier ssot__LoyaltyTierId__c A reference ID to loyalty tier. text
Loyalty Tier Benefit ID ssot__Id__c A unique ID used as primary key for the text
Loyalty Tier Benefit DMO.
Name ssot__Name__c The name of the loyalty tier benefit. text
359
Model Data in Data Cloud Loyalty Tier Group DMO
Loyalty Tier Group DMO
The Loyalty Tier Group DMO is a Data Cloud data model object (DMO) for loyalty programs that have multiple tiers of benefits. Tiers can
be organized based on objectives, for example, lifetime, marketing, or regular.
Object API Name
ssot__LoyaltyTierGroup__dlm
Category
Other
Primary Subject Area
Loyalty
Primary Key
Loyalty Tier Group Id (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Loyalty Program Currency Loyalty Tier Group Many To One: N:1 Loyalty Tier Group Loyalty Tier Group ID
Loyalty Tier Loyalty Tier Group Many To One: N:1 Loyalty Tier Group Loyalty Tier Group ID
Loyalty Tier Group Loyalty Program Many To One: N:1 Loyalty Program Loyalty Program ID
All Fields
Field Name Field API Name Description Data
Type
Created Date ssot__CreatedDate__c The date when the record was created. dateTime
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by an external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
Description ssot__Description__c A description of the loyalty program tier text
group.
360
Model Data in Data Cloud Loyalty Tier Group DMO
Field Name Field API Name Description Data
Type
External Record Id ssot__ExternalRecordId__c A reference ID to an external data source text
system.
External Source Id ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Internal Organization ssot__InternalOrganizationId__c A reference ID to a business unit or other text
internal organization that owns a business
account.
Is Active ssot__IsActive__c An indicator of whether the loyalty tier text
group is active.
Is Extended To End Of ssot__IsExtendedToEndOfMonth__c An indicator that determines if the benefit text
Month expiration date is extended to the last
date of the month.
Is Hidden To Members ssot__IsHiddenToMembers__c An indicator that determines the visibility text
of the Loyalty Tier Group to the members
of the loyalty program.
Is Primary ssot__IsPrimary__c An indicator that determines if the loyalty text
tier group is the primary tier group for the
loyalty program.
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the dateTime
record.
Loyalty Program ssot__LoyaltyProgramId__c A reference ID to a marketing strategy text
designed to encourage customers to
shop at or use the services of business
associated with the program.
Loyalty Tier Group Id ssot__Id__c A unique ID that is used as the primary text
key for the Loyalty Tier Group DMO.
Loyalty Tier Model ssot__LoyaltyTierModelId__c A reference ID to the tier model used for text
processing, either fixed or anniversary.
Name ssot__Name__c The name of the loyalty program tier text
group.
Qualifying Points Reset ssot__QualifyingPointsResetDate__c The date when the qualifying points are dateTime
Date to be reset.
Qualifying Points Reset ssot__QualifyingPointsResetFrequencyNumber__c The unit of measure for the reset period number
Frequency between qualifying points resets. For
example, the number of months between
a reset.
361
Model Data in Data Cloud Loyalty Transaction Journal DMO
Field Name Field API Name Description Data
Type
Qualifying Points Reset ssot__QualifyingPointsResetPeriodUOM__c The measure of time between resets of text
Period UOM qualifying points, for example monthly
or yearly.
Tier Period Time UOM ssot__TierPeriodTimeUOM__c The measure of time between processing text
of tiers, for example monthly or yearly.
Tier Time Period Quantity ssot__TierTimePeriodQuantity__c The number of time units that between number
processing of tiers within the loyalty tier
group.
Loyalty Transaction Journal DMO
The Loyalty Transaction Journal DMO is a Data Cloud data model object (DMO) for a collection of transactions related to a loyalty program.
Loyalty Transaction Journals are related to a voucher, but could relate to other payment method types.
Object API Name
ssot__LoyaltyTransactionJournal__dlm
Category
Other
Primary Subject Area
Loyalty
Primary Key
Loyalty Transaction Journal ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Loyalty Ledger Loyalty Transaction Many To One: N:1 Loyalty Transaction Loyalty Transaction
Journal Journal Journal ID
Loyalty Transaction Engagement Many To One: N:1 Product Browse Product Browse
Journal Engagement Engagement ID
Loyalty Transaction Engagement Many To One: N:1 Product Order Product Order
Journal Engagement Engagement ID
Loyalty Transaction Product Many To One: N:1 Goods Product Goods Product ID
Journal
362
Model Data in Data Cloud Loyalty Transaction Journal DMO
Object Field Cardinality Related Object Related Field
Loyalty Transaction Product Many To One: N:1 Bundle Product Bundle Product ID
Journal
Loyalty Transaction Engagement Many To One: N:1 Shopping Cart Shopping Cart
Journal Engagement Engagement ID
Loyalty Transaction Engagement Many To One: N:1 Message Engagement Message Engagement ID
Journal
Loyalty Transaction Account Contact Many To One: N:1 Account Contact Account Contact ID
Journal
Loyalty Transaction Brand Many To One: N:1 Brand Brand ID
Journal
Loyalty Transaction Engagement Many To One: N:1 Device Application Device Application
Journal Engagement Engagement ID
Loyalty Transaction Engagement Many To One: N:1 Email Engagement Email Engagement ID
Journal
Loyalty Transaction Loyal Journal Subtype Many To One: N:1 Loyal Journal Subtype Loyal Journal Subtype ID
Journal
Loyalty Transaction Loyalty Program Many To One: N:1 Loyalty Program Member Loyalty Program Member
Journal Corporate Member ID
Loyalty Transaction Loyalty Program Member Many To One: N:1 Loyalty Program Member Loyalty Program Member
Journal ID
Loyalty Transaction Loyalty Program Referred Many To One: N:1 Loyalty Program Member Loyalty Program Member
Journal Member ID
Loyalty Transaction Loyalty Program Partner Many To One: N:1 Loyalty Program Partner Loyalty Program Partner
Journal ID
Loyalty Transaction Loyalty Program Many To One: N:1 Loyalty Program Loyalty Program ID
Journal
Loyalty Transaction Engagement Many To One: N:1 Web Search Engagement Web Search Engagement
Journal ID
Loyalty Transaction Engagement Many To One: N:1 Website Engagement Website Engagement ID
Journal
Loyalty Transaction Related Loyalty Many To One: N:1 Loyalty Transaction Loyalty Transaction
Journal Transaction Journal Journal Journal ID
Loyalty Transaction Loyalty Journal Type Many To One: N:1 Loyalty Journal Type Loyalty Journal Type ID
Journal
Loyalty Transaction Payment Method Many To One: N:1 Voucher Voucher ID
Journal
363
Model Data in Data Cloud Loyalty Transaction Journal DMO
Object Field Cardinality Related Object Related Field
Loyalty Transaction Product Many To One: N:1 Master Product Master Product ID
Journal
Loyalty Transaction Sales Order Product Many To One: N:1 Sales Order Product Sales Order Product ID
Journal
Voucher Loyalty Transaction Many To One: N:1 Loyalty Transaction Loyalty Transaction
Journal Journal Journal ID
All Fields
Field Name Field API Name Description Data
Type
Account Contact ssot__AccountContactId__c A reference ID to an individual who has text
a role specific to the account.
Activity Date ssot__ActivityDate__c The date of the transaction. dateTime
Benefit Action Process Type ssot__BenefitActionProcessTypeId__c A reference idea to the process type of text
the benefit.
Booked Fare Class ssot__BookedFareClassId__c A reference ID for the fare class that was text
booked, such as economy or first-class.
Booked Room Type ssot__BookedRoomTypeId__c A reference ID for the type of room text
booked.
Booking Date ssot__BookingDate__c The booking date of the voucher or dateTime
related loyalty reward.
Brand ssot__BrandId__c A reference ID to the brand association text
to the transaction journal.
Created Date ssot__CreatedDate__c The date the record was created. dateTime
Currency ssot__CurrencyId__c A reference ID to the currency related to text
the reward.
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by an external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
Engagement ssot__EngagementId__c A reference ID to the engagement related text
to the transaction.
364
Model Data in Data Cloud Loyalty Transaction Journal DMO
Field Name Field API Name Description Data
Type
Establishment Name ssot__EstablishmentName__c The name of the establishment related text
to the transaction.
External Record ID ssot__ExternalRecordId__c A reference ID to an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Financial Transaction Type ssot__FinancialTransactionTypeId__c A reference ID to the type of the financial text
institution used for the transaction.
Flight Number ssot__FlightNumber__c The flight number related to the text
transaction.
Industry ssot__IndustryId__c A reference ID to the industry, for text
example, financial services or hospitality.
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
business account.
Invoice Date ssot__InvoiceDate__c The date of the invoice. dateTime
Journal Date ssot__JournalDate__c The date of the journal. dateTime
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the dateTime
record.
Location ssot__LocationId__c A reference ID to the location related to text
the transaction.
Loyalty Journal Subtype ssot__LoyaltyJournalSubtypeId__c A reference ID for a subtype of a loyalty text
journal type, for example, a watched
video or product review.
Loyalty Journal Type ssot__LoyaltyJournalTypeId__c A reference ID to the type of loyalty text
journal.
Loyalty Program ssot__LoyaltyProgramId__c A reference ID to a marketing strategy text
designed to encourage customers to
shop at or use the services of business
associated with the program.
Loyalty Program Corporate ssot__LoyaltyProgramCorporateMemberId__c A reference ID to the corporate member text
Member of a loyalty program
Loyalty Program Member ssot__LoyaltyProgramMemberId__c A reference ID to the person who has text
joined a loyalty program
Loyalty Program Partner ssot__LoyaltyProgramPartnerId__c A reference ID to a company who text
provides a loyalty program offering to
members.
365
Model Data in Data Cloud Loyalty Transaction Journal DMO
Field Name Field API Name Description Data
Type
Loyalty Program Referred ssot__LoyaltyProgramReferredMemberId__c A reference ID to a person referred to the text
Member program by a loyalty member.
Loyalty Transaction Journal ssot__Id__c A unique ID used as the primary key for text
Id the Loyalty Transaction Journal DMO.
Loyalty Transaction Journal ssot__LoyaltyTransactionJournalStatus__c The status of the loyalty transaction text
Status journal.
Name ssot__Name__c The name of a loyalty program text
transaction journal.
Payment Method ssot__PaymentMethodId__c A reference ID to the method of payment. text
Payment Method Type ssot__PaymentMethodTypeId__c A reference ID to the type of payment text
method, for example a gift card or cash.
Product ssot__ProductId__c A reference ID to a product intended to text
be sold, for example goods, services,
bundles, or made-to-order products.
Reason ssot__ReasonText__c The reason for the loyalty transaction. text
Related Loyalty Transaction ssot__RelatedLoyaltyTransactionJournalId__c A reference ID to related transaction text
Journal records.
Sales Channel ssot__SalesChannelId__c A reference ID to the sales channel used text
to place order.
Sales Order Product ssot__SalesOrderProductId__c A reference ID to the product purchased text
in a sales order.
Transaction Amount ssot__TransactionAmount__c The amount of the transaction. number
Transaction Quantity ssot__TransactionQuantity__c The number of transactions. number
Transaction Quantity UOM ssot__TransactionQuantityUOM__c The transaction unit of measure, for text
example, credits.
Travel Destination Name ssot__TravelDestinationName__c The name of the travel destination. text
Travel Distance Number ssot__TravelDistanceNumber__c The total distance, for example, 100. number
Travel Distance UOM ssot__TravelDistanceUOM__c The total distance unit of measure, for text
example, miles.
Travel Origin Name ssot__TravelOriginName__c The name or location where the travel text
began.
Traveled Fare Class ssot__TraveledFareClassId__c A reference ID to the type of class, for text
example, first or business class.
366
Model Data in Data Cloud Market Journey Activity DMO
Market Journey Activity DMO
The Market Journey Activity data model object (DMO) is a Data Cloud DMO for a step or activity within a journey in Journey Builder.
Object API Name
ssot__MarketJourneyActivity__dlm
Category
Other
Primary Subject Area
Market Audience
Primary Key
Market Journey Activity ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Device Application Market Journey Activity Many To One: N:1 Market Journey Activity Market Journey Activity
Engagement ID
Email Engagement Market Journey Activity Many To One: N:1 Market Journey Activity Market Journey Activity
ID ID
Message Engagement Market Journey Activity Many To One: N:1 Market Journey Activity Market Journey Activity
ID
Product Browse Market Journey Activity Many To One: N:1 Market Journey Activity Market Journey Activity
Engagement ID
Product Order Market Journey Activity Many To One: N:1 Market Journey Activity Market Journey Activity
Engagement ID ID
Shopping Cart Market Journey Activity Many To One: N:1 Market Journey Activity Market Journey Activity
Engagement ID ID
Web Search Engagement Market Journey Activity Many To One: N:1 Market Journey Activity Market Journey Activity
ID ID
Website Engagement Market Journey Activity Many To One: N:1 Market Journey Activity Market Journey Activity
ID ID
367
Model Data in Data Cloud Master Product DMO
All Fields
Field Name Field API Name Description Data
Type
Created Date ssot__CreatedDate__c The record’s creation date and time. dateTime
Data Source ssot__DataSourceId__c A reference ID to a logical name for a text
system that is the source of records
identified by an external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID to the logical name of the text
object where the record originated, for
example, a cloud storage file or another
connector’s external object.
External Record ID ssot__ExternalRecordId__c A reference ID to an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID to the system where the text
external record ID was assigned.
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
business account.
Last Modified Date ssot__LastModifiedDate__c The date and time when the user last dateTime
modified the record.
Market Journey Activity ID ssot__Id__c A unique ID used as the primary key for text
the Market Journey Activity.
Market Journey Activity ssot__MarketJourneyActivityNbr__c The number of the activity in Journey text
Number Builder.
Market Journey ID MarketJourneyId__c A reference ID for the journey in Journey text
Builder.
Name ssot__Name__c The name of the journey activity. text
Master Product DMO
The Master Product DMO is a Data Cloud data model object (DMO) for data about a company’s products.
Object API Name
ssot__MasterProduct__dlm
Category
Other
368
Model Data in Data Cloud Master Product DMO
Primary Subject Area
Product
Primary Key
Master Product ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Bundle Product Brand Many To One (N:1) Brand Brand ID
Loyalty Transaction Product Many To One (N:1) Bundle Product Bundle Product ID
Journal
Product Category Product Product Many To One (N:1) Bundle Product Bundle Product ID
Sales Order Product Product Many To One (N:1) Bundle Product Bundle Product ID
Sales Order Product Product Many To One (N:1) Master Product Master Product ID
All Fields
Field Name Field API Name Description Data
Type
Allow Customer Return ssot__AllowCustomerReturn__c An indicator whether a product is text
returnable.
Allow Partial Refund ssot__AllowPartialRefund__c An indicator if a partial refund is allowed, text
for example, refunding a membership fee.
Brand ssot__BrandId__c A reference ID to the brand’s name. text
Created Date ssot__CreatedDate__c The date a record was created. dateTime
Data Source ssot__DataSourceId__c A reference ID to a logical name for a text
system that is the source of records
identified by the external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID to the logical name of the text
object where the record originated, for
example a cloud storage file or another
connector’s external object.
Disposal Type ssot__DisposalTypeId__c A reference ID to how the product is to text
be disposed, for example, recycled or
thrown away.
External Record Id ssot__ExternalRecordId__c A reference ID for an external data source text
record.
369
Model Data in Data Cloud Master Product DMO
Field Name Field API Name Description Data
Type
External Source Id ssot__ExternalSourceId__c A reference ID to the system where the text
external record ID was assigned.
External Source Record Id ssot__ExternalSourceRecordId__c A reference to the record ID in the text
external system where the product
originated.
GL Account Code ssot__GlAccountCode__c A code that describes how instances of text
this product are accounted for, for
example, are they consumable, livestock,
or merchandise.
Internal Organization ssot__InternalOrganizationId__c A reference ID to a business unit or other text
internal organization that owns a business
account.
Is Auto Provisionable ssot__IsAutoProvisionable__c An indicator whether a product can be text
auto-installed.
Is Back Ordered ssot__IsBackOrdered__c An indicator if a product is out of stock or text
backordered.
Is Coupon Redemption ssot__IsCouponRedemptionAllowed__c An indicator whether a coupon can be text
Allowed used to redeem a product.
Is Customer Discount ssot__IsCustomerDiscountAllowed__c An indicator whether a customer can be text
Allowed offered a product at a discounted price.
Is Dynamic Bundle ssot__IsDynamicBundle__c An indicator whether a content of a text
product is bundled at the point of use.
Is Foodstamp Payment ssot__IsFoodstampPaymentAllowed__c An indicator whether a product can be text
Allowed purchased with food stamps.
Is Installable ssot__IsInstallable__c An indicator whether a product can be text
installed.
Is Intellectual Property ssot__IsIntellectualPropertyProtected__c An indicator whether the intellectual text
Protected property of a product is protected.
Is Manual Price Entry ssot__IsManualPriceEntryRequired__c An indicator whether a price requires text
Required manual entry.
Is Multiple Coupons ssot__IsMultipleCouponsAllowed__c An indicator whether multiple coupons text
Allowed can be applied to the same product.
Is Partner Discount Allowed ssot__IsPartnerDiscountAllowed__c An indicator whether the seller and text
supplier partners can get a discount on a
product.
Is Pre Orderable ssot__IsPreOrderable__c An indicator whether a product can be text
preordered.
370
Model Data in Data Cloud Master Product DMO
Field Name Field API Name Description Data
Type
Is Quality Verification ssot__IsQualityVerificationRequired__c An indicator whether a product requires text
Required visual inspection to designate quality.
Is Quantity Entry Required ssot__IsQuantityEntryRequired__c An indicator whether the quantity of a text
product must be entered during
checkout.
Is Rain Check Allowed ssot__IsRainCheckAllowed__c If a product isn’t in stock, an indicator if a text
customer can sign up to purchase the
product at the current price when a new
shipment arrives.
Is Returnable ssot__IsReturnable__c An indicator whether a product can be text
returned.
Is Sellable ssot__IsSellable__c An indicator whether a product can be text
sold.
Is Sellable Independently ssot__IsSellableIndependently__c An indicator whether a product can be text
sold individually or as a part of a bundle.
Is Sellable Without Price ssot__IsSellableWithoutPrice__c An indicator whether a product can be text
sold without a price, for example, a free
monogram.
Is Serialized ssot__IsSerialized__c An indicator whether each individual text
product has a unique serial number.
Is Weight Entry Required ssot__IsWeightEntryRequired__c An indicator if a product weight is text
required.
Is Worker Discount Allowed ssot__IsWorkerDiscountAllowed__c An indicator if employees and contractors text
can get a discount on a product.
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the dateTime
record.
Lot Identifier ssot__LotIdentifier__c The name or lot number of the text
manufactured product.
Manufacturer Name ssot__ManufacturerName__c The name of the product manufacturer. text
Master Product ssot__MasterProductId__c A reference ID for the master product. text
Master Product Id ssot__Id__c A unique ID that is used as the primary text
key for the Master Product DMO.
Maximum Order Quantity ssot__MaximumOrderQuantityCount__c The maximum quantity of product number
Count allowed for purchase.
Minimum Advertisement ssot__MinimumAdvertisementAmount__c The lowest price allowed to be used in number
Amount ads (normally established by a
manufacturer).
371
Model Data in Data Cloud Master Product DMO
Field Name Field API Name Description Data
Type
Minimum Advertisement ssot__MinimumAdvertisementAmountCurrency__c The currency for the minimum text
Amount Currency advertisement amount.
Minimum Advertisement ssot__MinimumAdvertisementAmountStartDate__c The earliest date the lowest number
Amount Start Date manufacturer's price can be stated in an
ad.
Minimum Order Quantity ssot__MinimumOrderQuantityCount__c The minimum quantity of product number
Count allowed for purchase.
Model Number ssot__ModelNumber__c The identifier that the manufacturer uses text
for product, for example,
SHOE-123-RED-8.
Model Year ssot__ModelYear__c The product’s model year. number
MSRP Amount ssot__MSRPAmount__c The default price for the product called number
the Manufacturer Suggested Retail Price
(MSRP).
MSRP Amount Currency ssot__MSRPAmountCurrency__c The currency of the MSRP. text
Packaged in Country ssot__PackagedInCountry__c The country where the product is text
packaged.
Price Charge Type Id ssot__PriceChargeTypeId__c A reference ID to how the product is text
priced, for example by weight, units, or
usage.
Primary Product Category ssot__PrimaryProductCategory__c The name of the primary product text
category.
Primary Sales Channel ssot__PrimarySalesChannelId__c A reference ID to the primary channel text
used to sell the product.
Produced in Country ssot__ProducedInCountry__c The country where the product is text
produced.
Product Description ssot__Description__c A general description of the product. text
Product Long Description ssot__LongDescription__c A product’s long description. text
Product Name ssot__Name__c The name of the product. text
Product SKU ssot__ProductSKU__c The unique stock keeping unit (SKU) for text
product, for example,
SHOE-NIKE-MOD1-SZ12-RED.
Product Status ssot__ProductStatusId__c A reference ID to the status of the text
product, for example Active or Inactive.
Quantity Installment Count ssot__QuantityInstallmentCount__c The number of installments, if the product number
has a quantity schedule.
372
Model Data in Data Cloud Master Product DMO
Field Name Field API Name Description Data
Type
Quantity Installment Period ssot__QuantityInstallmentPeriodId__c A reference ID to the product's quantity text
schedule, the amount of time covered by
the schedule.
Quantity Schedule Type ssot__QuantityScheduleTypeId__c A reference ID to the quantity schedule text
type, for example, divide or repeat.
Quantity Scheduling ssot__CanUseQuantitySchedule__c An indicator whether a product has a text
Enabled quantity schedule.
Required Deposit Amount ssot__RequiredDepositAmount__c The deposit required to pick up or use a number
product.
Required Deposit Amount ssot__RequiredDepositAmountCurrency__c The currency of the required deposit text
Currency amount.
Required Deposit ssot__RequiredDepositPercentage__c The percentage of deposit required to number
Percentage pick up or use product.
Requires Individual Unit ssot__RequiresInvididualUnitPricing__c An indicator whether a product requires text
Pricing an individual price, for example, due to
its variable weight or size.
Revenue Installment Count ssot__RevenueInstallmentCount__c The number of installments if a product number
has a revenue schedule.
Revenue Installment Period ssot__RevenueInstallmentPeriodId__c A reference ID to the time period covered text
by a schedule, for example, weekly or
monthly.
Revenue Schedule Type ssot__RevenueScheduleTypeId__c A reference ID to the revenue schedule text
type, for example, divide or repeat.
Revenue Scheduling ssot__CanUseRevenueSchedule__c An indicator whether the product has a text
Enabled revenue schedule.
Reward Program Points ssot__RewardProgramPointsCount__c The number of points given for the number
Count purchase of a product.
Service Entitlement ssot__ServiceEntitlementTemplateId__c A reference ID for the types of customer text
Template support, such as phone support, for which
a customer is eligible to use under the
terms of a contract.
Standard Warranty Length ssot__StandardWarrantyLengthMonth__c The length of warranty included from the number
Month seller (not the manufacturer).
Stock Ledger Valuation ssot__StockLedgerValuationAmount__c The total value of the product in stock. number
Amount
Stock Ledger Valuation ssot__StockLedgerValuationAmountCurrency__c The currency for the stock ledger text
Amount Currency valuation amount.
373
Model Data in Data Cloud Market Segment DMO
Field Name Field API Name Description Data
Type
Valid For Period Count ssot__ValidForPeriodCount__c The numeric duration of time that the number
product is valid, for example, 1, 2, or 3.
Valid For Period Unit Of ssot__ValidForPeriodUOMId__c A reference ID to the measurement of text
Measure time associated with “Valid For Period
Count,” for example, hours or months.
Valid From Date ssot__ValidFromDate__c The initial date that the product can be dateTime
used.
Valid To Date ssot__ValidToDate__c The final date that the product can be dateTime
used.
Version Number ssot__VersionNumber__c The product version, for example, 1.3.5. text
Note: Where possible, we changed noninclusive terms to align with our company value of Equality. We retained noninclusive
terms to document a third-party system, but we encourage the developer community to embrace more inclusive language. We
can update the term when it’s no longer required for technical accuracy.
Market Segment DMO
The Market Segment DMO is a Data Cloud data model object (DMO) for a group of people who share one or more common characteristics,
grouped for marketing purposes.
Object API Name
ssot__MarketSegment__dlm
Category
Other
Primary Subject Area
Market Audience
Primary Key
Market Segment ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Website Engagement Market Segment Many To One: N:1 Market Segment Market Segment ID
374
Model Data in Data Cloud Market Segment DMO
Object Field Cardinality Related Object Related Field
Device Application Market Segment Many To One: N:1 Market Segment Market Segment ID
Engagement
Email Engagement Market Segment Many To One: N:1 Market Segment Market Segment ID
Message Engagement Market Segment Many To One: N:1 Market Segment Market Segment ID
Product Browse Market Segment Many To One: N:1 Market Segment Market Segment ID
Engagement
Product Order Market Segment Many To One: N:1 Market Segment Market Segment ID
Engagement
Shopping Cart Market Segment Many To One: N:1 Market Segment Market Segment ID
Engagement
Web Search Engagement Market Segment Many To One: N:1 Market Segment Market Segment ID
All Fields
Field Name Field API Name Description Data
Type
Created Date ssot__CreatedDate__c The date the record was created. dateTime
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
External Record ID ssot__ExternalRecordId__c A reference ID to an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Internal Organization ssot__InternalOrganizationId__c A reference ID to business unit or other text
internal organization that owns the
business account.
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the dateTime
record.
Market Segment ID ssot__Id__c A unique ID used as primary key for the text
Market Segment DMO.
Name ssot__Name__c The display name of market segment. text
375
Model Data in Data Cloud Member Benefit DMO
Member Benefit DMO
The Member Benefit DMO is a Data Cloud data model object (DMO) for a benefit available within the loyalty program that a member is
qualified for and has elected to receive.
Object API Name
ssot__MemberBenefit__dlm
Category
Other
Primary Subject Area
Loyalty
Primary Key
Member Benefit ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Member Benefit Loyalty Benefit Many To One: N:1 Loyalty Benefit Loyalty Benefit ID
Member Benefit Loyalty Program Member Many To One: N:1 Loyalty Program Member Loyalty Program Member
ID
All Fields
Field Name Field API Name Description Data
Type
Created Date ssot__CreatedDate__c The date the record was created. dateTime
Data Source ssot__DataSourceId__c reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID to logical name of object text
where record originated, for example a
cloud storage file or another connector’s
external object.
End Date ssot__EndDate__c The last date when member can receive dateTime
loyalty program benefits.
376
Model Data in Data Cloud Message Engagement DMO
Field Name Field API Name Description Data
Type
External Record ID ssot__ExternalRecordId__c A reference ID to an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
business account.
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the dateTime
record.
Loyalty Benefit ssot__LoyaltyBenefitId__c A reference ID to perk or betterment text
available to loyalty program members.
Loyalty Program Member ssot__LoyaltyProgramMemberId__c A reference ID to person who has joined text
a loyalty program.
Member Benefit ID ssot__Id__c A unique ID used as primary key for the text
Member Benefit DMO.
Member Benefit Status ssot__MemberBenefitStatusId__c A reference ID to status of member text
benefit for example new or pending.
Name ssot__Name__c The name of the member benefit. text
Start Date ssot__StartDate__c The first date when member can receive dateTime
loyalty program benefits.
Message Engagement DMO
The Message Engagement DMO is a Data Cloud data model object (DMO) for a user’s engagement with a marketing message.
Object API Name
ssot__MessageEngagement__dlm
Category
Engagement
Primary Subject Area
Engagement
Primary Key
Message Engagement ID (ssot__Id__c)
377
Model Data in Data Cloud Message Engagement DMO
Relationships
Object Field Cardinality Related Object Related Field
Engagement Topic Engagement Many To One (N:1) Message Engagement Message Engagement ID
Message Engagement Engagement Asset Many To One (N:1) SMS Template SMS Template ID
Message Engagement Engagement Channel Many To One (N:1) Engagement Channel Engagement Channel
Type Type Type ID
Message Engagement Account Contact Many To One (N:1) Account Contact Account Contact ID
Message Engagement Case Many To One (N:1) Case Case I
Message Engagement Contact Point Many To One (N:1) Contact Point Address Contact Point Address ID
Message Engagement Contact Point Many To One (N:1) Contact Point App Contact Point App ID
Message Engagement Contact Point Many To One (N:1) Contact Point Email Contact Point Email ID
Message Engagement Contact Point Many To One (N:1) Contact Point Phone Contact Point Phone ID
Message Engagement Contact Point Many To One (N:1) Contact Point Social Contact Point Social ID
Message Engagement Engagement Asset Many To One (N:1) Device Application Device Application
Template Template ID
Message Engagement Engagement Publication Many To One (N:1) Email Publication Email Publication ID
Message Engagement Engagement Asset Many To One (N:1) Email Template Email Template ID
Message Engagement Lead Many To One (N:1) Lead Lead ID
Message Engagement Market Journey Activity Many To One (N:1) Market Journey Activity Market Journey Activity
ID
Message Engagement Engagement Asset Many To One (N:1) SMS Template SMS Template ID
Message Engagement Market Segment Many To One (N:1) Market Segment Market Segment ID
Message Engagement Individual Many To One (N:1) Individual Individual ID
All Fields
Field Name Field API Name Description Data
Type
Account Contact ssot__AccountContactId__c A reference ID for the account contact. text
Action Cadence Step ssot__ActionCadenceStepId__c A reference ID for the action cadence text
step.
Case ssot__CaseId__c A reference ID for any recorded issue, text
such as a laptop connectivity problem
378
Model Data in Data Cloud Message Engagement DMO
Field Name Field API Name Description Data
Type
Contact Point ssot__ContactPointId__c A reference ID for the accounts’ contact text
point, for example, an address or social
network handle.
Country ssot__CountryId__c A reference ID to country dialing code for text
SMS phone number.
Created Date ssot__CreatedDate__c The date the record was created. datetime
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
Device Country ssot__DeviceCountryId__c The reference ID of the country where the text
device is located.
Device IP Address ssot__DeviceIPAddress__c The IP address of the device. text
Device Latitude ssot__DeviceLatitude__c The geo latitude of the device when the number
engagement was recorded.
Device Locale ssot__DeviceLocaleId__c A reference ID for the user locale text
configured on the device.
Device Longitude ssot__DeviceLongitude__c The geo longitude of the device when number
the engagement was recorded.
Device Postal Code ssot__DevicePostalCode__c The postal code associated with the text
device.
Engagement Asset ssot__EngagementAssetId__c A reference ID for the type of text
engagement asset.
Engagement Channel ssot__EngagementChannelId__c A reference ID for the engagement text
channel.
Engagement Channel ssot__EngagementChannelActionId__c A reference ID for the engagement action. text
Action
Engagement Channel Type ssot__EngagementChannelTypeId__c A reference ID for the engagement text
channel type.
Engagement Date Time ssot__EngagementDateTm__c The date and time of engagement. datetime
Engagement Event ssot__EngagementEventDirectionId__c A reference ID for the engagement event text
Direction direction, for example, inbound or
outbound.
379
Model Data in Data Cloud Message Engagement DMO
Field Name Field API Name Description Data
Type
Engagement Notes ssot__EngagementNotesTxt__c The details about what transpired during text
the engagement.
Engagement Number ssot__EngagementNbr__c A user-facing ID for an engagement. text
Engagement Publication ssot__EngagementPublicationId__c A reference ID for a background process text
that generates volumes of emails, SMS,
or other engagement types.
Engagement Type ssot__EngagementTypeId__c A reference ID for one of the defined text
varieties of engagement, for example, an
email or a phone engagement.
Engagement Vehicle ssot__EngagementVehicleId__c A reference ID for the vehicle through text
which the engagement was recorded.
External Record ID ssot__ExternalRecordId__c A reference ID to an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Individual ssot__IndividualId__c A reference ID to contact for account. text
Internal Engagement Actor ssot__InternalEngagementActorId__c A reference ID for an internal engagement text
actor that groups the different types of
individuals who are targets of marketing
engagements.
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
data record.
Is Test Send ssot__IsTestSend__c An indicator if the engagement record text
was generated as part of testing.
Is Valid IsValid__c An indicator if the engagement record is number
valid.
Keyword Text ssot__KeywordTxt__c The short code keyword for the message. text
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the datetime
record.
Lead ssot__LeadlId__c A reference ID for a person or company text
that showed interest in the company's
products.
Link URL ssot__LinkURL__c The URL that was used to access a text
software application or web page.
380
Model Data in Data Cloud Message Engagement DMO
Field Name Field API Name Description Data
Type
Market Audience ssot__MarketAudienceId__c A reference ID to a market audience or text
the people you want to reach with
marketing communication.
Market Journey Activity ssot__MarketJourneyActivityId__c A reference ID for a step or activity that a text
customer configures in the Salesforce
Journey Builder tool.
Market Segment ssot__MarketSegmentId__c A reference ID for a group of people who text
share one or more common
characteristics, grouped for marketing
purposes who are associated with this
engagement.
Marketing Email List ssot__MarketingEmailListId__c A reference ID for a set of email addresses text
that is used for marketing
communications.
Message Delivery Short ssot__MessageDeliveryShortCd__c The short code used for the message text
Code delivery.
Message Engagement ID ssot__Id__c A unique ID used as primary key for the text
Message Engagement DMO.
Name ssot__Name__c The name of the engagement. text
Referrer ssot__Referrer__c A container that stores contextual data text
about the user's usage of the site or the
application that referred them to the
software application that generated the
engagement. For example, a campaign
or search advertisement.
Referrer URL ssot__ReferrerURL__c The URL of the application that the user text
was using before being directed to the
Software Application that generated this
Engagement.
Sales Order ssot__SalesOrderId__c A reference ID for the internal document text
generated by the seller.
Send Classification ssot__SendClassificationId__c A reference ID to how consent is checked, text
either transactional or commercial.
Sent Date Time ssot__SentDateTm__c The date and time when the publication dateTime
or communication was sent.
Session ssot__SessionId__c A reference ID for the session used to text
group related events together.
Shopping Cart ssot__ShoppingCartId__c A reference ID for the shopping cart for text
data captured from user actions such as
381
Model Data in Data Cloud Operating Hours DMO
Field Name Field API Name Description Data
Type
adding and removing items from a
shopping cart.
Target Engagement Actor ssot__TargetEngagementActorId__c A reference ID for how groups of text
individuals are targeted for marketing
engagements, for example, leads.
Task ssot__TaskId__c A reference ID that represents a business text
activity such as making a phone call or
other to-do items.
Web Cookie ssot__WebCookieId__c A reference ID for a small piece of data text
sent from a website and stored on the
user's computer by the user's web
browser while the user is browsing.
Workflow ssot__WorkflowId__c A reference ID for a sequence of steps or text
processes in a software application
through which a piece of work passes
from initiation to completion.
Operating Hours DMO
The Operating Hours DMO is a Data Cloud data model object (DMO) for when a business or business function is available for use.
Object API Name
ssot__OperatingHours__dlm
Category
Other
Primary Subject Area
Primary Key
Email Message ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Case Case Support Working Many To One: N:1 Operating Hours Operating Hours ID
Hours
382
Model Data in Data Cloud Operating Hours DMO
All Fields
Field Name Field API Name Description Data
Type
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
Description ssot__Description__c The operating hours description. text
Friday End Time ssot__Friday_EndTime__c The time operating hours end on Friday. text
Friday Start Time ssot__Friday_StartTime__c The time operating hours start on Friday. text
Hours Type ssot__HoursType__c The type for the operating hours. text
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
operating hour.
Is Active ssot__IsActive__c An indicator if the operating hours are text
active.
Is Default ssot__IsDefault__c An indicator if the operating hours are the text
default.
Is Time Slots Used ssot__IsTimeSlotsUsed__c An indicator if the operating hours time text
slots are used.
Monday End Time ssot__Monday_EndTime__c The time operating hours end on text
Monday.
Monday Start Time ssot__Monday_StartTime__c The time operating hours start on text
Monday.
Name ssot__Name__c The name for the operating hours. text
Operating Hours Id ssot__Id__c A unique ID used as the primary key for text
the operating hours DMO.
Saturday End Time ssot__Saturday_EndTime__c The time operating hours end on text
Saturday.
Saturday Start Time ssot__Saturday_StartTime__c The time operating hours start on text
Saturday.
Sunday End Time ssot__Sunday_EndTime__c The time operating hours end on Sunday. text
Sunday Start Time ssot__Sunday_StartTime__c The time operating hours start on Sunday. text
383
Model Data in Data Cloud Opportunity DMO
Field Name Field API Name Description Data
Type
Thursday End Time ssot__Thursday_EndTime__c The time operating hours end on text
Thursday.
Thursday Start Time ssot__Thursday_StartTime__c The time operating hours start on text
Thursday.
Time Zone ssot__TimeZone__c The timezone for the operating hours. text
Tuesday End Time ssot__Tuesday_EndTime__c The time operating hours end on text
Tuesday.
Tuesday Start Time ssot__Tuesday_StartTime__c The time operating hours start on text
Tuesday.
Wednesday End Time ssot__Wednesday_EndTime__c The time operating hours end on text
Wednesday.
Wednesday Start Time ssot__Wednesday_StartTime__c The time operating hours start on dateTime
Wednesday.
Opportunity DMO
The Opportunity DMO is a Data Cloud data model object (DMO) for deals or sales that are in progress and not yet completed.
Object API Name
ssot__Opportunity__dlm
Category
Other
Primary Subject Area
Sales Order
Primary Key
Opportunity ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Engagement Topic Campaign Many To One: N:1 Opportunity Opportunity Id
384
Model Data in Data Cloud Opportunity DMO
Object Field Cardinality Related Object Related Field
Lead Converted To Many To One: N:1 Opportunity Opportunity Id
Opportunity
Opportunity CustomerAccount Many To One: N:1 Account Account Id
Opportunity Partner Account Many To One: N:1 Account Account Id
Opportunity Engagement Channel Many To One: N:1 Engagement Channel Engagement Channel
Type Type Type Id
Opportunity Lead Many To One: N:1 Lead Lead Id
Opportunity Product Opportunity Many To One: N:1 Opportunity Opportunity Id
Sales Order Opportunity Many To One: N:1 Opportunity Opportunity Id
All Fields
Field Name Field API Name Description Data
Type
Close Date ssot__CloseDate__c The date when the opportunity was dateTime
closed.
Contract ssot__ContractId__c A reference ID to contract associated with text
order.
Created Date ssot__CreatedDate__c The date a record was created. dateTime
Currency ssot__CurrencyId__c A reference ID to the currency of the sales text
opportunity.
Customer Account ssot__CustomerAccountId__c A reference ID to business or person that text
is prospective buyer of opportunity's
product or service.
Data Source ssot__DataSourceId__c A reference ID to logical name for system text
that is source of records identified by
External Record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID to logical name of object text
where record originated, for example a
cloud storage file or another connector’s
external object.
Description ssot__Description__c A description of the opportunity. text
Engagement Channel ssot__EngagementChannelId__c A reference ID to the business or text
company that serves as a provider for
engagement channel type.
385
Model Data in Data Cloud Opportunity DMO
Field Name Field API Name Description Data
Type
Engagement Channel Type ssot__EngagementChannelTypeId__c A reference ID to method of message text
delivery, for example email, phone call,
SMS message, or TV commercial.
Expected Revenue Amount ssot__ExpectedRevenueAmount__c The calculated revenue based on amount number
and probability fields.
External Record ID ssot__ExternalRecordId__c A reference ID to an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Internal Organization ssot__InternalOrganizationId__c A reference ID to business unit or other text
internal organization that owns the
business account.
Is Private ssot__IsPrivate__c An indicator if an opportunity can be text
shared with someone outside the
opportunity team.
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the dateTime
record.
Lead ssot__LeadId__c A reference ID to person or company that text
shows interest in company's products.
Lead Source ssot__LeadSourceId__c A reference ID to source where lead was text
obtained.
Name ssot__Name__c The name of the opportunity. text
Next Step ssot__NextStep__c A description of the next task needed to text
close an opportunity.
Opportunity Forecast ssot__OpportunityForecastCategoryId__c A reference ID to a revenue probability text
Category category within the sales cycle.
Opportunity Id ssot__Id__c A unique ID used as primary key for the text
Opportunity DMO.
Opportunity Name ssot__OpportunityName__c The name of the opportunity. text
Opportunity Stage ssot__OpportunityStageId__c A reference ID to phase or step of text
opportunity, for example, new, won, or
closed.
Opportunity Type ssot__OpportunityTypeId__c A reference ID to the type of opportunity, text
for example, new or existing business.
Partner Account ssot__PartnerAccountId__c A reference ID to external business text
supporting or participating in
opportunity.
386
Model Data in Data Cloud Opportunity Product DMO
Field Name Field API Name Description Data
Type
Price Book ssot__PriceBookId__c A reference ID to sets of prices tailored to text
different needs. Using price books, each
product can have many different prices.
Probability ssot__Probability__c The probability of closing an opportunity. number
Total Amount ssot__TotalAmount__c The estimated amount of the total sale. number
Total Product Quantity ssot__TotalProductQuantity__c The total quantity value for all products, number
if the opportunity has products
associated.
Opportunity Product DMO
The Opportunity Product DMO is a Data Cloud data model object (DMO) for connecting an opportunity to the product that it represents,
allowing for a many-to-many relationship.
Object API Name
ssot__OpportunityProduct__dlm
Category
Other
Primary Subject Area
Sales Product
Primary Key
Opportunity Product ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Opportunity Product Product Many To One: N:1 Bundle Product Bundle Product Id
Opportunity Product Product Many To One: N:1 Goods Product Goods Product Id
Opportunity Product Product Many To One: N:1 Master Product Master Product Id
Opportunity Product Product Many To One: N:1 Opportunity Opportunity Id
387
Model Data in Data Cloud Opportunity Product DMO
All Fields
Field Name Field API Name Description Data
Type
Close Date ssot__CloseDate__c The date when a record was closed. dateTime
Created Date ssot__CreatedDate__c The date when a record was created. dateTime
Currency ssot__CurrencyId__c A reference ID to the currency of the sales text
opportunity.
Data Source ssot__DataSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
Description ssot__Description__c The description of an opportunity. text
Discount Percentage ssot__DiscountPercentage__c The discount for a product as a number
percentage.
External Record ID ssot__ExternalRecordId__c A reference ID to an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Internal Organization ssot__InternalOrganizationId__c A reference ID to business unit or other text
internal organization that owns the
business account.
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified a dateTime
record.
List Price Amount ssot__ListPriceAmount__c The price of a product. number
Name ssot__Name__c A short description of the opportunity’s text
product.
Opportunity ssot__OpportunityId__c A reference ID to a deal or sale that is in text
progress and isn’t yet completed.
Opportunity Product ID ssot__Id__c A unique ID used as primary key for the text
Opportunity Product DMO.
Pricebook Entry ssot__PricebookEntryId__c A reference ID to list of products and their text
prices.
Product ssot__ProductId__c A reference ID to what's intended to be text
sold, for example, goods or services.
388
Model Data in Data Cloud Order Delivery Method DMO
Field Name Field API Name Description Data
Type
Product Quantity ssot__ProductQuantity__c The number of product units in an number
opportunity.
Quote Product ssot__QuoteProductId__c A reference ID to item on a quote for text
prospective purchase of goods and
services.
Service Date ssot__ServiceDate__c The planned date when the to-be dateTime
purchased product is in service.
Subtotal Amount ssot__SubtotalAmount__c number
Total Price Amount ssot__TotalPriceAmount__c The sum of all the product amounts for number
the opportunity’s product.
Order Delivery Method DMO
The Order Delivery Method data model object (DMO) is a Data Cloud DMO for the order and delivery methods for products or service
fulfillment.
Important: Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain
terms to avoid any effect on customer implementations.
Object API Name
ssot__OrderDeliveryMethod__dlm
Category
Other
Primary Subject Area
Sales Order
Primary Key
Order Delivery Method ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Account Order Delivery Method Many To One: N:1 Order Delivery Method Order Delivery Method ID
Order Delivery Method Product Many To One: N:1 Goods Product Goods Product ID
389
Model Data in Data Cloud Party Consent DMO
Object Field Cardinality Related Object Related Field
Order Delivery Method Product Many To One: N:1 Bundle Product Bundle Product ID
Order Delivery Method Product Many To One: N:1 Master Product Master Product ID
All Fields
Field Name Field API Name Description Data
Type
Created Date ssot__CreatedDate__c The record’s creation date. dateTime
Data Source ssot__DataSourceId__c A reference ID for a system’s logical name text
for a system that is the source of records
identified by an external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for an object’s logical name text
where this record originated, whether
that is a name of a cloud storage file or
another connector’s external object.
External Record ID ssot__ExternalRecordId__c A reference ID to an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
business account.
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the dateTime
record.
Name ssot__Name__c The name of the sales order delivery text
method, for example, in-store pickup or
overnight delivery.
Order Delivery Method ID ssot__Id__c A unique ID used as the primary key for text
the Order Delivery Method DMO.
Product ssot__ProductId__c A reference ID for sale items, for example text
goods, services, bundles, and
made-to-order products.
Party Consent DMO
The Privacy Consent DMO is a Data Cloud data model object (DMO) for an individual’s consent preferences.
390
Model Data in Data Cloud Party Consent DMO
Object API Name
ssot__PartyConsent__dlm
Category
Other
Primary Subject Area
Privacy
Primary Key
Party Consent ID (ssot__Id__c)
Relationships
There are no relationships related to this DMO.
All Fields
Field Name Field API Name Description Data
Type
Consent Captured Contact ssot__ConsentCapturedContactPointType__c The type of communication that an text
Point Type individual provided their consent
preferences.
Consent Captured Date ssot__ConsentCaptureddateTime__c The date and time when consent was dateTime
Time given.
Consent Captured Source ssot__ConsentCapturedSource__c The type of source where consent was text
retrieved, for example, a website.
Consent Captured Source ssot__ConsentCapturedSourceName__c The specific name of the source where text
consent was retrieved.
Consent Status ssot__ConsentStatusId__c The status of consent. text
Consent Grantors ssot__ConsentGrantors__c The relationship to the individual who text
Relationship granted consent.
Created Date ssot__CreatedDate__c The date when the record was created. dateTime
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
391
Model Data in Data Cloud Party DMO
Field Name Field API Name Description Data
Type
whether that is a name of a cloud storage
file or another connector’s external object.
Effective From Date ssot__EffectiveFromDate__c The date when consent is in effect. dateTime
Effective To Date ssot__EffectiveToDate__c The date when consent is no longer dateTime
effective.
External Record ID ssot__ExternalRecordId__c A reference ID to an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Internal Organization ssot__InternalOrganizationId__c A reference ID to business unit or other text
internal organization that owns the
business account.
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the dateTime
record.
Name ssot__Name__c The short description of privacy consent text
record.
Party ssot__PartyId__c reference ID to the parent party, for text
example, an individual, business, or
affiliation group.
Party Role ssot__PartyRoleId__c A reference ID to associated party role, for text
example, a customer, supplier, or
competitor.
Privacy Consent ID ssot__Id__c A unique ID used as primary key for the text
Privacy Consent DMO.
Privacy Consent Status ssot__PrivacyConsentStatusId__c A reference ID for the status of privacy text
consent, for example opted in or opted
out.
Party DMO
Represents information about who you are dealing with. Provided in the Financial Services Cloud Data Kit. This DMO is available in API
version 58 and later.
API Name
ssot__Party__dlm
392
Model Data in Data Cloud Party DMO
Category
Profile
Primary Subject Area
Add value
Primary Key Label
Party ID (ssot_Id_c).
Relationships
DMO Label DMO Field Label Cardinality Related DMO Related DMO Data Bundle or
Label Field Label Origin
Party Individual ID Many To One (N:1) Individual ID Financial Services
Cloud
Party Organization ID Many To One (N:1) Organization ID ID Financial Services
Cloud
Account Party ID Many To One (N:1) Party ID Financial Services
Cloud
Authorization Form Party ID Many To One (N:1) Party ID Financial Services
Consent Cloud
Communication Party ID Many To One (N:1) Party ID Financial Services
Subscription Cloud
Consent
Contact Point Party ID Many To One (N:1) Party ID Financial Services
Consent Cloud
Contact Point Type Party ID Many To One (N:1) Party ID Financial Services
Consent Cloud
Contact Point Party ID Many To One (N:1) Party ID Financial Services
Cloud
Coupon Customer ID Many To One (N:1) Party ID Financial Services
Cloud
Engagement Party ID Many To One (N:1) Party ID Financial Services
Channel Type Cloud
Consent
Financial Goal Party Party ID Many To One (N:1) Party ID Financial Services
Cloud
393
Model Data in Data Cloud Party DMO
DMO Label DMO Field Label Cardinality Related DMO Related DMO Data Bundle or
Label Field Label Origin
Financial Plan Party ID Many To One (N:1) Party ID Financial Services
Cloud
Individual Party ID Many To One (N:1) Party ID Financial Services
Cloud
Lead Party ID Many To One (N:1) Party ID Financial Services
Cloud
Loyalty Program Party ID Many To One (N:1) Party ID Financial Services
Member Cloud
Organization Party ID Many To One (N:1) Party ID Financial Services
Cloud
Party Consent Party ID Many To One (N:1) Party ID Financial Services
Cloud
Party Expense Payee ID Many To One (N:1) Party ID Financial Services
Cloud
Party Expense Player ID Many To One (N:1) Party ID Financial Services
Cloud
Party Financial Asset Party ID Many To One (N:1) Party ID Financial Services
Cloud
Party Financial Party ID Many To One (N:1) Party ID Financial Services
Liability Cloud
Party Identification Party ID Many To One (N:1) Party ID Financial Services
Cloud
Party Income Party ID Many To One (N:1) Party ID Financial Services
Cloud
Party Interest Tag Party ID Many To One (N:1) Party ID Financial Services
Cloud
Party Role Party ID Many To One (N:1) Party ID Financial Services
Cloud
Party Web Address Party ID Many To One (N:1) Party ID Financial Services
Cloud
Payment Method Party ID Many To One (N:1) Party ID Financial Services
Cloud
Privacy Consent Party ID Many To One (N:1) Party ID Financial Services
Cloud
Shopping Card Party ID Many To One (N:1) Party ID Financial Services
Cloud
394
Model Data in Data Cloud Party Financial Asset DMO
Fields
Label API Name Description Data Data
Type Bundle
or
Origin
Borrower Rating ID ssot__BorrowerRatingId__c The party’s borrowing history. Text Financial
Services
Cloud
Credit Rating ID ssot__CreditRatingId__c The party’s credit rating. Test Financial
Services
Cloud
Credit Score Number ssot__CreditScoreNumber__c The party’s credit score. Number Financial
Services
Cloud
Lifetime Asset Value ssot__LifetimeAssetValueAmount__c The party’s lifetime net asset value to Number Financial
Amount a financial institution. Services
Cloud
Party Financial Asset DMO
Represents a financial asset associated with an individual or an organization. For example, cash in hand, owned property, and so forth.
Provided in the Financial Services Cloud Data Kit. This DMO is available in API version 58 and later.
API Name
ssot__PartyFinancialAsset__dlm
Category
Profile
Primary Subject Area
Financial Account
Primary Key
Party Financial Asset ID (ssot__Id__c)
395
Model Data in Data Cloud Party Financial Asset DMO
Relationships
DMO Label DMO Field Label Cardinality Related DMO Related DMO Data Bundle or
Label Field Label Origin
Party Financial Asset Party ID Many To One (N:1) Party ID Financial Services
Cloud
Fields
Label API Name Description Data Data
Type Bundle
or
Origin
Currency ssot__Curency__c The associated currency. Text Financial
Services
Cloud
Description ssot__Description__c The description of the party financial Text Financial
asset. Services
Cloud
End Date ssot__EndDate__c The effective end date of the market Date Financial
value. Time Services
Cloud
Financial Asset Type ssot__FinancialAssetType__c The type of financial asset. Text Financial
Services
Cloud
Party Financial Asset Id ssot__Id__c The primary key. Text Financial
Services
Cloud
Market Value ssot__MarketValue__c The market value of the asset. Number Financial
Services
Cloud
Name ssot__Name__c The name of the party financial asset. Text Financial
Services
Cloud
Party ID ssot__PartyId__c The party who owns the asset. Text Financial
Services
Cloud
Start Date ssot__StartDate__c The effective start date of the market Date Financial
value. Time Services
Cloud
396
Model Data in Data Cloud Party Financial Liability DMO
Label API Name Description Data Data
Type Bundle
or
Origin
Valuation Date ssot__ValuationDate__c The date on which the market value Date Financial
was captured. Time Services
Cloud
Party Financial Liability DMO
Represents a financial liability associated with an individual or an organization. For example a mortgage or loan. Provided in the Financial
Services Cloud Data Kit. This DMO is available in API version 58 and later.
API Name
ssot__PartyFinancialLiability__dlm
Category
Profile
Primary Subject Area
Financial Account
Primary Key Label
Party Financial Liability ID (ssot_Id_c).
Relationships
DMO Label DMO Field Label Cardinality Related DMO Related DMO Data Bundle or
Label Field Label Origin
Party Financial Party ID Many To One (N:1) Party ID Financial Services
Liability Cloud
397
Model Data in Data Cloud Party Identification DMO
Fields
Label API Name Description Data Data
Type Bundle
or
Origin
Currency ssot__Currency__c The associated currency. Text Financial
Services
Cloud
Description ssot__Description__c The description of the party financial Text Financial
liability. Services
Cloud
End Date ssot__EndDate__c The effective end date of the market Date Financial
value. Time Services
Cloud
Financial Liability Type ssot__FinancialLiabilityType__c The type of the financial liability. Text Financial
Services
Cloud
Party Financial Liability ssot__PartyFinancialLiabilityId__c The primary key. Text Financial
Id Services
Cloud
Market Value ssot__MarketValue__c The market value of the liability. Number Financial
Services
Cloud
Name ssot__Name__c The name of the party financial Text Financial
liability. Services
Cloud
Party ID ssot__PartyId__c The associated party who owns the Text Financial
liability. Services
Cloud
Start Date ssot__StartDate__c The effective start date of the market Date Financial
value. Time Services
Cloud
Valuation Date ssot__ValuationDate__c The date on which the market value Date Financial
was captured. Time Services
Cloud
Party Identification DMO
The Party Identification DMO is a Data Cloud data model object for the ways to identify a party, such as a driver’s license or a birth
certificate.
398
Model Data in Data Cloud Party Identification DMO
Object API Name
ssot__PartyIdentification__dlm
Category
Other
Primary Subject Area
Party
Primary Key
Party Identification (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Party Identification Party Many To One (N:1) Individual Individual ID
Party Identification Party Identification ID One to One (1:1) Party Identification Party Identification ID
Identity Link
All Fields
Field Name Field API Name Description Data
Type
Created Date ssot__CreatedDate__c The date when the record was created. dateTime
Data Source ssot__DataSourceId__c A reference ID for the logical name for a system text
that is the source of records identified by external
record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the object text
where this record came from, whether that is a
name of a cloud storage file or another
connector’s external object.
Expiry Date ssot__ExpiryDate__c The date the identification expires. dateTime
External Record ID ssot__ExternalRecordId__c A reference ID for an external data source system. text
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
399
Model Data in Data Cloud Party Interest Tag DMO
Field Name Field API Name Description Data
Type
Identification Name ssot__Name__c A required field used to specify the name of the text
identification, for example, California State issued
Driver's License or LinkedIn URL.
Identification number ssot__Identificationnumber__c The value of the identification, for example, driver text
license B1234456.
Tip: Also used in identity resolution.
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or other text
internal organization that owns the business
account.
Issued At Location ssot__IssuedAtLocation__c The location where the identification was issued. text
Issued By Authority ssot__IssuedByAuthority__c The authority who issued the identification. text
Issued Date ssot__IssuedDate__c The date the identification was issued. dateTime
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the record. dateTime
Party ssot__PartyId__c A reference ID to the parent party, for example, text
an individual, business, or affiliation group.
Tip: This ID is the same as the one used
in the individual object.
Party Identification ID ssot__Id__c A unique ID used as the primary key for the party text
identification DMO.
Party Identification Type ssot__PartyIdentificationTypeId__c A reference ID to the additional information about text
a party used for greater organization.
Party Role ssot__PartyRoleId__c A reference ID to the associated party role, for text
example, a customer, supplier, or competitor.
Verified By User ssot__VerifiedByUserId__c A reference ID for the user who verified the text
document.
Verified Date ssot__VerifiedDate__c The date identification was verified. dateTime
Party Interest Tag DMO
Represents an association between a party and interest tag. Provided in the Financial Services Cloud Data Kit. This DMO is available in
API version 58 and later.
API Name
ssot__PartyInterestTag__dlm
400
Model Data in Data Cloud Party Interest Tag DMO
Category
Profile
Primary Subject Area
Add value
Primary Key Label
Party Interest Tag (ssot_Id_c).
Relationships
DMO Label DMO Field Label Cardinality Related DMO Related DMO Data Bundle or
Label Field Label Origin
Party Interest Tag Interest Tag Many To One (N:1) Interest Tag ID Financial Services
Definition ID Definition Cloud
Party Interest Tag Party ID Many To One (N:1) Party ID Financial Services
Cloud
Fields
Label API Name Description Data Data
Type Bundle
or
Origin
Description ssot__Description__c The description of the party interest Text Financial
tag. Services
Cloud
Party Interest Tag ID ssot__Id__c The primary key. Text Financial
Services
Cloud
Interest Tag Definition ID ssot__InterestTagDefinitionId__c The related interest tag definition. Text Financial
Services
Cloud
Name ssot__Name__c The name of the party interest tag. Text Financial
Services
Cloud
Party ID ssot__PartyId__c The related party. Text Financial
Services
Cloud
401
Model Data in Data Cloud Payment Method DMO
Payment Method DMO
Represents the way a customer pays for a transaction.
API Name
ssot__PaymentMethod_dlm
Category
Profile
Primary Subject Area
Payment Method
Primary Key Label
Payment Method ID (ssot_Id_c).
Relationships
DMO Label DMO Field Label Cardinality Related DMO Label Related DMO Field
Label
Payment Method Account ID Many To One (N:1) Account ID
Payment Method Alternate Payment ID Many To One (N:1) Alternate Payment ID
Payment Method Bank Transfer Tender ID Many To One (N:1) Bank Transfer Tender ID
Payment Method Cash Tender ID Many To One (N:1) Cash Tender ID
Payment Method Check Tender ID Many To One (N:1) Check Tender ID
Payment Method Credit Tender ID Many To One (N:1) Credit Tender ID
Payment Method Digital Wallet ID Many To One (N:1) Digital Wallet ID
Payment Method Financial Account ID Many To One (N:1) Financial Account ID
Payment Method Party ID Many To One (N:1) Party ID
Payment Method Prepaid Card ID Many To One (N:1) Prepaid Card ID
Payment Method Trade In Tender ID Many To One (N:1) Trade In Tender ID
Payment Method Voucher ID Many To One (N:1) Voucher ID
Account Auto Payment Method Many To One (N:1) Payment Method ID
Alternate Payment Payment Method ID Many To One (N:1) Payment Method ID
Bank Transfer Tender Payment Method ID Many To One (N:1) Payment Method ID
402
Model Data in Data Cloud Payment Method DMO
DMO Label DMO Field Label Cardinality Related DMO Label Related DMO Field
Label
Cash Tender Payment Method ID Many To One (N:1) Payment Method ID
Check Tender Payment Method ID Many To One (N:1) Payment Method ID
Credit Tender Payment Method ID Many To One (N:1) Payment Method ID
Digital Wallet Payment Method ID Many To One (N:1) Payment Method ID
Gift Commitment Payment Method ID Many To One (N:1) Payment Method ID
Schedule
Gift Entry Payment Method ID Many To One (N:1) Payment Method ID
Gift Transaction Payment Method ID Many To One (N:1) Payment Method ID
Prepaid Card Payment Method ID Many To One (N:1) Payment Method ID
Retail Store Payment Method ID Many To One (N:1) Payment Method ID
Sales Order Payment Payment Method ID Many To One (N:1) Payment Method ID
Summary
Trade In Tender Payment Method ID Many To One (N:1) Payment Method ID
Voucher Payment Method ID Many To One (N:1) Payment Method ID
Fields
Label API Name Description Data
Type
Account ssot__AccountId__c The account ID. Text
Comments ssot__Comments__c Users can add comments to provide Text
additional details about a record.
Company Name ssot__CompanyName__c The company of the cardholder. Text
Created Date ssot__CreatedDate__c The date and time the record was created. Date Time
External Record ID ssot__ExternalRecordId__c The external record ID. Text
First Name ssot__FirstName__c The customer’s first name. Text
Payment Method ID ssot__Id__c The payment method ID. Text
Implementer Type ssot__ImplementerType__c The implementer type. Text
Is Auto Pay Enabled ssot__IsAutoPayEnabled__c Indicates whather auto pay is enabled. Text
Is Deleted ssot__IsDeleted__c Indicates whether the record is deleted. Text
Last Modified Date ssot__LastModifiedDate__c The date the record was last modified. Date Time
Last Name ssot__LastName__c The customer’s last name. Text
403
Model Data in Data Cloud Person Life Event DMO
Label API Name Description Data
Type
Name ssot__Name__c The customer’s name. Text
Nick Name ssot__NickName__c The nick name. Text
Payment Method Address ssot__PaymentMethodAddress__c The address of the payment method. Text
Payment Method City ssot__PaymentMethodCity__c The city of the payment method. Text
Payment Method Country ssot__PaymentMethodCountry__c The country of the payment method. Text
Payment Method Country ssot__PaymentMethodCountryCode__c The country code of the payment Text
Code method.
Payment Method Details ssot__PaymentMethodDetails__c The details of the payment method. Text
Payment Method Geocode ssot__PaymentMethodGeocodeAccuracy__c The geocode accuracy of the payment Text
Accuracy method.
Payment Method Latitude ssot__PaymentMethodLatitude__c The latitude of the payment method. Text
Payment Method ssot__PaymentMethodLongitude__c The longitude of the payment method. Text
Longitude
Payment Method Postal ssot__PaymentMethodPostalCode__c The postal code of the payment method. Text
Code
Payment Method State ssot__PaymentMethodState__c The state of the payment method. Text
Payment Method State ssot__PaymentMethodStateCode__c The state code of the payment method. Text
Code
Payment Method Street ssot__PaymentMethodStreet__c The street of the payment method. Text
Payment Method Sub Type ssot__PaymentMethodSubType__c The sub-type of the payment method. Text
Payment Method Type ssot__PaymentMethodType__c The type of the payment method. Text
Payment Policy ssot__PaymentPolicy__c The payment policy. Text
Saved Payment Method ssot__SavedPaymentMethod__c The saved payment method. Text
Status ssot__Status__c The status of the payment method. Text
System Modstamp ssot__SystemModstamp__c The system modstamp. Date Time
Person Life Event DMO
Represents a major life event for an individual. Provided in the Financial Services Cloud Data Kit. This DMO is available in API version 58
and later.
API Name
ssot__PersonLifeEvent__dlm
404
Model Data in Data Cloud Person Life Event DMO
Category
Profile
Primary Subject Area
Add value
Primary Key Label
Person Life Event (ssot_Id_c).
Relationships
DMO Label DMO Field Label Cardinality Related DMO Related DMO Data Bundle or
Label Field Label Origin
Person Life Event Individual ID Many To One (N:1) Individual ID Financial Services
Cloud
Fields
Label API Name Description Data Data
Type Bundle
or
Origin
Event Expiry Date ssot__EventExpiryDate__c The date when the life event expires. Date Financial
Time Services
Cloud
Person Life Event ID ssot__Id__c The primary key. Text Financial
Services
Cloud
Individual ID ssot__IndividualId__c The party ID associated to the life Text Financial
event. Services
Cloud
Is Event Expired ssot__IsEventExpired__c Indicates if the event is expired. Text Financial
Services
Cloud
Person Life Event Date ssot__PersonLifeEventDateTime__c The date of the life event. Date Financial
Time Time Services
Cloud
Person Life Event Type ssot__PersonLifeEventType__c The type of the life event. Text Financial
Services
Cloud
405
Model Data in Data Cloud Privacy Consent Log DMO
Label API Name Description Data Data
Type Bundle
or
Origin
Is Next Major Life Event ssot__isNextMajorLifeEvent__c Indicates if the record is the next Text Financial
major life event. Services
Cloud
Privacy Consent Log DMO
The Privacy Consent Log DMO is a Data Cloud data model object (DMO) for information about a user’s requested consent and privacy
information.
Object API Name
ssot__PrivacyConsentLog__dlm
Category
Other
Primary Subject Area
Privacy
Primary Key
Privacy Consent Log ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Privacy Consent Log Consent Action Many To One: N:1 Consent Action Consent Action ID
Privacy Consent Log Contact Point Many To One: N:1 Contact Point Address Contact Point Address ID
Privacy Consent Log Contact Point Many To One: N:1 Contact Point App Contact Point App ID
Privacy Consent Log Contact Point Many To One: N:1 Contact Point Email Contact Point Email ID
Privacy Consent Log Contact Point Many To One: N:1 Contact Point Phone Contact Point Phone ID
Privacy Consent Log Contact Point Many To One: N:1 Contact Point Social Contact Point Social ID
Privacy Consent Log Engagement Channel Many To One: N:1 Engagement Channel Engagement Channel
Type Type Type Id
Privacy Consent Log Individual Many To One: N:1 Individual Individual ID
406
Model Data in Data Cloud Privacy Consent Log DMO
All Fields
Field Name Field API Name Description Data
Type
Consent Action ssot__ConsentActionId__c A reference ID to the types of actions a text
user allows, like data collection.
Consent Triggering Event ssot__ConsentTriggeringEventTypeId__c A reference ID to the task the user was text
Type performing when they provided a privacy
consent decision.
Contact Point ssot__ContactPointId__c A reference ID to specific email address, text
phone number, or other contact method
used to communicate with a party.
Created Date ssot__CreatedDate__c The date when the record was created. dateTime
Data Source ssot__DataSourceId__c reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
Device Latitude ssot__DeviceLat__c The north or south geographic coordinate number
of user's device during session.
Device Longitude ssot__DeviceLgtd__c The east or west geographic coordinate number
of user's device during session.
Engagement Channel ssot__EngagementChannelActionId__c A reference ID to an activity or operation text
Action performed by channel.
Engagement Channel Type ssot__EngagementChannelTypeId__c A reference ID to the method of message text
delivery, for example an email, call, or ad.
External Record ID ssot__ExternalRecordId__c A reference ID to an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Individual ssot__IndividualId__c A reference ID to the account’s contact. text
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
business account.
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the dateTime
record.
Privacy Consent Activity ssot__PrivacyConsentActivityDttm__c The date and time of activity that resulted dateTime
Date Time in log entry.
407
Model Data in Data Cloud Product Browse Engagement DMO
Field Name Field API Name Description Data
Type
Privacy Consent Log ssot__PrivacyConsentLogCategoryId__c A reference ID to category of privacy text
Category consent log, for example, profile or
behavioral.
Privacy Consent Log ID ssot__Id__c A unique ID used as primary key for the text
Privacy Consent Log DMO.
Privacy Consent Status ssot__PrivacyConsentStatusId__c A reference ID for the status of privacy text
consent, for example opted in or opted
out.
Product Browse Engagement DMO
Product Browse Engagement DMO is a Data Cloud data model object (DMO) for data captured from a user action, such as searching for
products or viewing a list of products.
Object API Name
ssot__ProductBrowseEngagement__dlm
Category
Engagement
Primary Subject Area
Engagement
Primary Key
Product Browse Engagement ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Engagement Topic Engagement Many To One: N:1 Product Browse Product Browse
Engagement Engagement ID
Product Browse Product Many To One: N:1 Goods Product Goods Product ID
Engagement
Product Browse Product Many To One: N:1 Bundle Product Bundle Product ID
Engagement
Product Browse Engagement Channel Many To One: N:1 Engagement Channel Engagement Channel
Engagement Type Type Type ID
408
Model Data in Data Cloud Product Browse Engagement DMO
Object Field Cardinality Related Object Related Field
Product Browse Account Contact Many To One: N:1 Account Contact Account Contact ID
Engagement
Product Browse Case Many To One: N:1 Case Case ID
Engagement
Product Browse Contact Point Many To One: N:1 Contact Point Address Contact Point Address ID
Engagement
Product Browse Contact Point Many To One: N:1 Contact Point App Contact Point App ID
Engagement
Product Browse Contact Point Many To One: N:1 Contact Point Email Contact Point Email ID
Engagement
Product Browse Contact Point Many To One: N:1 Contact Point Phone Contact Point Phone ID
Engagement
Product Browse Contact Point Many To One: N:1 Contact Point Social Contact Point Social ID
Engagement
Product Browse Engagement Asset Many To One: N:1 Device Application Device Application
Engagement Template Template ID
Product Browse Engagement Publication Many To One: N:1 Email Publication Email Publication ID
Engagement
Product Browse Engagement Asset Many To One: N:1 Email Template Email Template ID
Engagement
Product Browse Lead Many To One: N:1 Lead Lead ID
Engagement
Product Browse Market Journey Activity Many To One: N:1 Market Journey Activity Market Journey Activity
Engagement ID
Product Browse Market Segment Many To One: N:1 Market Segment Market Segment ID
Engagement
Product Browse Engagement Asset Many To One: N:1 SMS Template SMS Template ID
Engagement
Product Browse Individual Many To One: N:1 Individual Individual ID
Engagement
Product Browse Sales Order Many To One: N:1 Sales Order Sales Order ID
Engagement
Product Browse Product Many To One: N:1 Master Product Master Product ID
Engagement
409
Model Data in Data Cloud Product Browse Engagement DMO
All Fields
Field Name Field API Name Description Data
Type
Account Contact ssot__AccountContactId__c A reference ID to account contact. text
Action Cadence Step ssot__ActionCadenceStepId__c A reference ID to action cadence step. text
Case ssot__CaseId__c A reference ID to a recorded issue, for text
example laptop connectivity.
Contact Point ssot__ContactPointId__c A reference ID to accounts’ contact point, text
for example physical address, email
address, or phone number.
Created Date ssot__CreatedDate__c The date a record was created. dateTime
Data Source ssot__DataSourceId__c A reference ID to logical name for system text
that is source of records identified by
External Record Id.
Data Source Object ssot__DataSourceObjectId__c A reference ID to logical name of object text
where record originated, for example a
cloud storage file or another connector’s
external object.
Device Country ssot__DeviceCountryId__c A reference ID to country where device text
is located.
Device IP Address ssot__DeviceIPAddress__c The IP address of device. text
Device Latitude ssot__DeviceLatitude__c The geo latitude of the device when the Number
engagement was recorded.
Device Locale ssot__DeviceLocaleId__c A reference ID to user locale configured text
on device.
Device Longitude ssot__DeviceLongitude__c The geo longitude of device when Number
engagement was recorded.
Device Postal Code ssot__DevicePostalCode__c The postal code associated with device. text
Engagement Asset ssot__EngagementAssetId__c A reference ID for the type of text
engagement asset.
Engagement Channel ssot__EngagementChannelId__c A reference ID for the engagement text
channel.
Engagement Channel ssot__EngagementChannelActionId__c A reference ID for the engagement action. text
Action
Engagement Channel Type ssot__EngagementChannelTypeId__c A reference ID for the engagement text
channel type.
Engagement Date Time ssot__EngagementDateTm__c The date and time of the engagement. dateTime
410
Model Data in Data Cloud Product Browse Engagement DMO
Field Name Field API Name Description Data
Type
Engagement Event ssot__EngagementEventDirectionId__c The engagement event direction where text
Direction values are inbound or outbound.
Engagement Notes ssot__EngagementNotesTxt__c The details about what transpired during text
the engagement.
Engagement Number ssot__EngagementNbr__c A user-facing ID that isn’t automatically text
set using auto-number.
Engagement Publication ssot__EngagementPublicationId__c A reference ID for a background process text
that generates volumes of emails, SMS,
or other engagement types.
Engagement Type ssot__EngagementTypeId__c A reference ID to type of engagement, for text
example email or phone.
Engagement Vehicle ssot__EngagementVehicleId__c A reference ID for the vehicle through text
which the engagement was recorded.
External Record ID ssot__ExternalRecordId__c A reference ID to an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Individual ssot__IndividualId__c A reference ID to contact for account. text
Internal Engagement Actor ssot__InternalEngagementActorId__c A reference ID to engagement actor that text
groups the different types of individuals
targeted for marketing engagements, for
example leads and account contacts.
Internal Organization ssot__InternalOrganizationId__c A reference ID to business unit or other text
internal organization that owns the
business account.
Is Test Send ssot__IsTestSend__c An indicator if the engagement record text
was generated as part of testing.
Keyword Search ssot__KeywordSearch__c The words or terms provided by user for text
text-based search.
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the dateTime
record.
Lead ssot__LeadlId__c A reference ID to person or company that text
showed interest in products.
Link URL ssot__LinkURL__c The URL that was used to access a text
software application or web page.
Market Audience ssot__MarketAudienceId__c A reference ID to intended audience that text
engagement was designed to reach.
411
Model Data in Data Cloud Product Browse Engagement DMO
Field Name Field API Name Description Data
Type
Market Journey Activity ssot__MarketJourneyActivityId__c A reference ID to step or activity that text
customer configures in Salesforce Journey
Builder tool for marketing associated with
engagement.
Market Segment ssot__MarketSegmentId__c A reference ID to group of people who text
share one or more common
characteristics, and are grouped for
marketing associated with engagement.
Marketing Email List ssot__MarketingEmailListId__c A reference ID for a set of email addresses text
that is used for marketing
communications.
Name ssot__Name__c The name of the engagement. text
Product ssot__ProductId__c A reference ID to product intended to be text
sold, for example goods, services,
bundles, or made-to-order products.
Product Brand ssot__ProductBrandName__c The brand of a product, for example text
Northern Trail Outfitters.
Product Browse ssot__Id__c A unique ID used as primary key for the text
Engagement ID Product Browse Engagement DMO.
Product Category ssot__ProductCategoryName__c The class of products, such as shoes or text
hats.
Product Color ssot__ProductColorName__c The color variant of product displayed on text
search result.
Product Display Position ssot__ProductDisplayPosition__c The numeric position of product in list number
displayed.
Product Image URL ssot__ProductImageURL__c A link to the page that hosts product text
photo or image.
Product List ID ssot__ProductListId__c A reference ID to the product list text
identifier.
Product Price ssot__ProductPriceAmount__c The product price displayed on search number
result.
Product Quantity ssot__ProductQuantity__c The product package quantity displayed number
on search result.
Product SKU ssot__ProductSKU__c The Stock Keeping Unit (SKU) of product text
displayed on search result.
Product Style ssot__ProductStyleName__c The product style displayed on search text
result.
412
Model Data in Data Cloud Product Browse Engagement DMO
Field Name Field API Name Description Data
Type
Product View URL ssot__ProductViewURL__c A link to the detail page about product text
displayed on search result.
Referrer ssot__Referrer__c A container that stores contextual data text
about the user's usage of the site or the
application that referred them to the
software application that generated the
engagement. For example, a campaign
or search advertisement.
Referrer URL ssot__ReferrerURL__c The URL of application that directed user text
to software application that generated
engagement.
Sales Order ssot__SalesOrderId__c An internal document generated by seller text
indicating that customer is ready to
purchase products and services.
Search Filter Type ssot__SearchFilterTypeId__c A reference ID to search filter types such text
as price or color.
Search Filter Value ssot__SearchFilterValue__c The value associated with a search filter. text
Search Result Filter Type ssot__SearchResultFilterTypeId__c A reference ID to the types filtered in text
search results.
Search Result Sort Type ssot__SearchResultSortTypeId__c A reference ID to types sorted in search text
results.
Search Result Sort Value ssot__SearchResultSortValue__c The values sorted in search results. text
Sent Date Time ssot__SentDateTm__c The date and time when the publication dateTime
or communication was sent.
Session ssot__SessionId__c A reference ID for the session used to text
group related events together.
Shopping Cart ssot__ShoppingCartId__c A reference ID to shopping cart for data text
captured from user actions, for example
adding or removing items from shopping
cart.
Target Engagement Actor ssot__TargetEngagementActorId__c A reference ID to engagement actor that text
groups different types of individuals
targeted for marketing associated with
engagement, for example leads and
account contacts.
Task ssot__TaskId__c A reference ID to business activity, for text
example making a phone call.
413
Model Data in Data Cloud Product Catalog DMO
Field Name Field API Name Description Data
Type
Web Cookie ssot__WebCookieId__c A reference ID to small piece of data sent text
from website and stored on user's
computer by user's web browser while
user is browsing.
Workflow ssot__WorkflowId__c A reference ID to sequence of steps or text
processes in software application.
Product Catalog DMO
The Product Catalog DMO is a Data Cloud data model object (DMO) for a company’s inventory or merchandising catalog.
Object API Name
ssot__ProductCatalog__dlm
Category
Other
Primary Subject Area
Product
Primary Key
Product Catalog ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Product Category Product Catalog Many To One: N:1 Product Catalog Product Catalog ID
All Fields
Field Name Field API Name Description Data
Type
Active From Date ssot__ActiveFromDate__c The date the catalog is available for use. dateTime
Active to Date ssot__ActiveToDate__c The date the catalog is unavailable. dateTime
Created Date ssot__CreatedDate__c The date when a record was created. dateTime
414
Model Data in Data Cloud Product Catalog Category DMO
Field Name Field API Name Description Data
Type
Data Source ssot__DataSourceId__c A reference ID to logical name for system text
that is source of records identified by
external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID to logical name of object text
where record originated, for example a
cloud storage file or another connector’s
external object.
External Record ID ssot__ExternalRecordId__c A reference ID to an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID to system that External text
Record ID was assigned.
Internal Organization ssot__InternalOrganizationId__c A reference ID to business unit or other text
internal organization that owns the
business account.
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the dateTime
record.
Product Catalog ID ssot__Id__c A unique ID used as primary key for the text
Product Catalog DMO.
Product Catalog Name ssot__Name__c The name of the product catalog. text
Product Catalog ssot__ProductCatalogTranslations__c text
Translations Relationship
Product Catalog Category DMO
The Product Catalog Category DMO is a Data Cloud data model object (DMO) for the category of the product catalog, such as shoes,
trucks, or housewares.
Object API Name
ssot__ProductCatalogCategory__dlm
Category
Other
Primary Subject Area
Product
415
Model Data in Data Cloud Product Category DMO
Primary Key
Product Catalog Category ID (ssot__Id__c)
Relationships
There are no relationships related to this DMO.
All Fields
Field Name Field API Name Description Data
Type
Created Date ssot__CreatedDate__c The date the record was created. dateTime
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
External Record ID ssot__ExternalRecordId__c A reference ID for an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
data record.
Last Modified Date ssot__LastModifiedDate__c he date when a user last modified the dateTime
record.
Product Catalog Category ssot__Id__c A unique ID used as primary key for the text
ID Product Catalog Category DMO.
Product Category DMO
The Product Category data model object (DMO) is a Data Cloud DMO for the types of products a company has or offers, such as shoes
or types of services.
Important: Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain
terms to avoid any effect on customer implementations.
Object API Name
ssot__ProductCategory__dlm
416
Model Data in Data Cloud Product Category DMO
Category
Other
Primary Subject Area
Product
Primary Key
Product Category ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Master Product Primary Product Category Many To One: N:1 Product Category Product Category ID
Product Category Parent Category Many To One: N:1 Product Category Product Category ID
Product Category Product Catalog Many To One: N:1 Product Catalog Product Catalog ID
Product Category Product Product Category Many To One: N:1 Product Category Product Category ID
Bundle Product Primary Product Category Many To One: N:1 Product Category Product Category ID
Goods Product Primary Product Category Many To One: N:1 Product Category Product Category ID
All Fields
Field Name Field API Name Description Data
Type
Active From Date ssot__ActiveFromDate__c The date the catalog is available for use. dateTime
Active to Date ssot__ActiveToDate__c The date that the catalog is unavailable. dateTime
Category Name ssot__Name__c The name of the category. text
Created Date ssot__CreatedDate__c The date and time when the record was dateTime
created.
Data Source ssot__DataSourceId__c A reference ID to a system’s logical name text
that is a source of records identified by
an external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID to an object’s logical name text
where a record originated, for example,
a cloud storage file or another connector’s
external object.
417
Model Data in Data Cloud Product Category Product DMO
Field Name Field API Name Description Data
Type
External Record ID ssot__ExternalRecordId__c A reference ID to an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID to a system that an external text
record ID was assigned.
Internal Organization ssot__InternalOrganizationId__c A reference ID to a business unit or other text
internal organization that owns the
business account.
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the dateTime
record.
Parent Category ssot__ParentCategoryID__c A reference ID to the product category of text
a parent record.
Product Catalog ssot__ProductCatalogID__c A reference ID to the product catalog text
where the category is included.
Product Category ID ssot__Id__c A unique ID used as the primary key for text
the Product Category DMO.
Product Category Attribute ssot__ProductCategoryAttributeSets__c text
Sets
Product Category sssot__ProductCategoryTranslations__c text
Translations Relationship
Product Category Product DMO
The Product Category Product data model object (DMO) is a Data Cloud DMO used to identify how products are assigned to categories.
For example, Northern Trail Outfitters can use this DMO to identify how a specific running shoe is assigned to a shoe and running
categories.
Important: Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain
terms to avoid any effect on customer implementations.
Object API Name
ssot__ProductCategoryProduct__dlm
Category
Other
Primary Subject Area
Product
418
Model Data in Data Cloud Product Category Product DMO
Primary Key
Product Category Product ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Product Category Product Product Category Many To One: N:1 Product Category Product Category ID
Product Category Product Product Many To One: N:1 Goods Product Goods Product ID
Product Category Product Product Many To One: N:1 Bundle Product Bundle Product ID
Product Category Product Product Many To One: N:1 Master Product Master Category ID
All Fields
Field Name Field API Name Description Data
Type
Active From Date ssot__ActiveFromDate__c The date the catalog is available for use. dateTime
Active to Date ssot__ActiveToDate__c The date that the catalog is unavailable. dateTime
Created Date ssot__CreatedDate__c The record’s creation date. dateTime
Data Source ssot__DataSourceId__c A reference ID to a system’s logical name text
that is the source of records identified by
external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID to an object’s logical name text
where a record originated, for example,
a cloud storage file or another connector’s
external object.
External Record ID ssot__ExternalRecordId__c A reference ID to an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID to a system that an external text
record ID was assigned.
Internal Organization ssot__InternalOrganizationId__c A reference ID to a business unit or other text
internal organization that owns the
business account.
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the dateTime
record.
Product ssot__ProductId__c A reference ID to the product assigned to text
a category.
Product Category ssot__ProductCategoryID__c A reference ID to the product category. text
419
Model Data in Data Cloud Product Order Engagement DMO
Field Name Field API Name Description Data
Type
Product Category Product ssot__Id__c A unique ID used as the primary key for text
ID the Product Category Product DMO.
Product Order Engagement DMO
The Product Order Engagement DMO is a Data Cloud data model object (DMO) for a user’s online shopping order data.
Object API Name
ssot__ProductOrderEngagement__dlm
Category
Engagement
Primary Subject Area
Engagement
Primary Key
Product Order Engagement ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Engagement Topic Engagement Many To One: N:1 Product Order Product Order
Engagement Engagement ID
Product Order Account Contact Many To One: N:1 Account Contact Account Contact ID
Engagement
Product Order Case Many To One: N:1 Case Case ID
Engagement
Product Order Contact Point Many To One: N:1 Contact Point Address Contact Point Address ID
Engagement
Product Order Contact Point Many To One: N:1 Contact Point App Contact Point App ID
Engagement
Product Order Contact Point Many To One: N:1 Contact Point Email Contact Point Email ID
Engagement
Product Order Contact Point Many To One: N:1 Contact Point Phone Contact Point Phone ID
Engagement
420
Model Data in Data Cloud Product Order Engagement DMO
Object Field Cardinality Related Object Related Field
Product Order Contact Point Many To One: N:1 Contact Point Social Contact Point Social ID
Engagement
Product Order Engagement Asset Many To One: N:1 Device Application Device Application
Engagement Template Template ID
Product Order Engagement Publication Many To One: N:1 Email Publication Email Publication ID
Engagement
Product Order Engagement Asset Many To One: N:1 Email Template Email Template ID
Engagement
Product Order Engagement Channel Many To One: N:1 Engagement Channel Engagement Channel
Engagement Type Type Type ID
Product Order Lead Many To One: N:1 Lead Lead ID
Engagement
Product Order Market Journey Activity Many To One: N:1 Market Journey Activity Market Journey Activity
Engagement ID
Product Order Market Segment Many To One: N:1 Market Segment Market Segment ID
Engagement
Product Order Engagement Asset Many To One: N:1 SMS Template SMS Template ID
Engagement
Product Order Individual Many To One: N:1 Individual Individual ID
Engagement
Product Order Sales Order Many To One: N:1 Sales Order Sales Order ID
Engagement
Sales Order Product Product Order Many To One: N:1 Product Order Product Order
Engagement Engagement Engagement Engagement ID
All Fields
Field Name Field API Name Description Data
Type
Account Contact ssot__AccountContactId__c A reference ID to account contact. text
Action Cadence Step ssot__ActionCadenceStepId__c A reference ID to action cadence step. text
Adjusted Total Product ssot__AdjustedTotalProductAmount__c The total amount of a product after number
Amount adjustments.
Case ssot__CaseId__c A reference ID to a recorded issue, for text
example laptop connectivity.
421
Model Data in Data Cloud Product Order Engagement DMO
Field Name Field API Name Description Data
Type
Contact Point ssot__ContactPointId__c A reference ID to accounts’ contact point, text
for example physical address, email
address, or phone number.
Created Date ssot__CreatedDate__c The date the record was created. dateTime
Currency ssot__CurrencyId__c A reference ID to the currency of an order. text
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
Device Country ssot__DeviceCountryId__c A reference ID to country where device text
is located.
Device IP Address ssot__DeviceIPAddress__c The IP address of a device. text
Device Latitude ssot__DeviceLatitude__c The geo latitude of the device when the number
engagement was recorded.
Device Locale ssot__DeviceLocaleId__c A reference ID to user locale configured text
on device.
Device Longitude ssot__DeviceLongitude__c The geo longitude of the device when number
the engagement was recorded.
Device Postal Code ssot__DevicePostalCode__c The postal code associated with device. text
Engagement Asset ssot__EngagementAssetId__c A reference ID for the type of text
engagement asset.
Engagement Channel ssot__EngagementChannelId__c A reference ID for the engagement text
channel.
Engagement Channel ssot__EngagementChannelActionId__c A reference ID for the engagement action. text
Action
Engagement Channel Type ssot__EngagementChannelTypeId__c A reference ID for the engagement text
channel type.
Engagement Date Time ssot__EngagementDateTm__c The date and time of the engagement. dateTime
Engagement Event ssot__EngagementEventDirectionId__c The engagement event direction where text
Direction values are inbound or outbound.
Engagement Notes ssot__EngagementNotesTxt__c The details about what transpired during text
engagement.
422
Model Data in Data Cloud Product Order Engagement DMO
Field Name Field API Name Description Data
Type
Engagement Number ssot__EngagementNbr__c A user-facing ID that isn’t automatically text
set using auto-number.
Engagement Publication ssot__EngagementPublicationId__c A reference ID for a background process text
that generates volumes of emails, SMS,
or other engagement types.
Engagement Type ssot__EngagementTypeId__c A reference ID to type of engagement, for text
example email or phone.
Engagement Vehicle ssot__EngagementVehicleId__c A reference ID for the vehicle through text
which the engagement was recorded.
External Record ID ssot__ExternalRecordId__c A reference ID to an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Individual ssot__IndividualId__c A reference ID to contact for account. text
Internal Engagement Actor ssot__InternalEngagementActorId__c A reference ID for an internal engagement text
actor that groups the different types of
individuals who are targets of marketing
engagements.
Internal Organization ssot__InternalOrganizationId__c A reference ID to business unit or other text
internal organization that owns the
business account.
Is Gift Order ssot__IsGiftOrder__c An indicator if the order is a gift. text
Is Test Send ssot__IsTestSend__c An indicator if the engagement record text
was generated as part of testing.
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the dateTime
record.
Lead ssot__LeadlId__c A reference ID to person or company that text
showed interest in products.
Link URL ssot__LinkURL__c The URL that was used to access a text
software application or web page.
Market Audience ssot__MarketAudienceId__c A reference ID to intended audience that text
engagement was designed to reach.
Market Journey Activity ssot__MarketJourneyActivityId__c A reference ID to step or activity that text
customer configures in Salesforce Journey
Builder tool for marketing associated with
engagement.
423
Model Data in Data Cloud Product Order Engagement DMO
Field Name Field API Name Description Data
Type
Market Segment ssot__MarketSegmentId__c A reference ID to group of people who text
share one or more common
characteristics, and are grouped for
marketing associated with engagement.
Marketing Email List ssot__MarketingEmailListId__c A reference ID for a set of email addresses text
that is used for marketing
communications.
Name ssot__Name__c The name of the engagement. text
Net Order Amount ssot__NetOrderAmount__c The total order amount. number
Product Order Engagement ssot__Id__c A reference ID for the Product Order text
ID Engagement DMO.
Product Order Event Type ssot__ProductOrderEventTypeId__c A reference ID to the product order event text
type.
Referrer ssot__Referrer__c A container that stores contextual data text
about the user's usage of the site or the
application that referred them to the
software application that generated the
engagement. For example, a campaign
or search advertisement.
Referrer URL ssot__ReferrerURL__c The URL of application that directed user text
to software application that generated
engagement.
Sales Order ssot__SalesOrderId__c An internal document generated by seller text
indicating that customer is ready to
purchase products and services.
Sent Date Time ssot__SentDateTm__c The date and time when the publication dateTime
or communication was sent.
Session ssot__SessionId__c A reference ID for the session used to text
group related events together.
Shopping Cart ssot__ShoppingCartId__c A reference ID to shopping cart for data text
captured from user actions, for example
adding or removing items from shopping
cart.
Target Engagement Actor ssot__TargetEngagementActorId__c A reference ID to engagement actor that text
groups different types of individuals
targeted for marketing associated with
engagement, for example leads and
account contacts.
424
Model Data in Data Cloud Promotion DMO
Field Name Field API Name Description Data
Type
Task ssot__TaskId__c A reference ID to business activity, for text
example making a phone call.
Total Adjustment Amount ssot__TotalAdjustmentAmount__c The total amount of an order after number
adjustments.
Total Delivery Amount ssot__TotalDeliveryAmount__c The total amount of delivery for an order. number
Total Product Tax Amount ssot__TotalProductTaxAmount__c The total amount of tax on a product. number
Total Tax Amount ssot__TotalTaxAmount__c The total amount of tax on an order. number
Web Cookie ssot__WebCookieId__c A reference ID to small piece of data sent text
from website and stored on user's
computer by user's web browser while
user is browsing.
Workflow ssot__WorkflowId__c A reference ID to the sequence of steps text
or processes in software application.
Promotion DMO
The Promotion DMO is a Data Cloud data model object (DMO) for loyalty promotion details such as the type of promotion.
Object API Name
ssot__Promotion__dlm
Category
Other
Primary Subject Area
Loyalty
Primary Key
Promotion ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Engagement Topic Promotion Many To One: N:1 Promotion Promotion ID
Promotion Lead Many To One: N:1 Lead Lead ID
425
Model Data in Data Cloud Promotion DMO
Object Field Cardinality Related Object Related Field
Promotion Loyalty Program Currency Many To One: N:1 Loyalty Program Currency Loyalty Program Currency
ID
Promotion Loyalty Program Many To One: N:1 Loyalty Program Loyalty Program ID
Promotion Default Voucher Many To One: N:1 Voucher Definition Voucher Definition ID
Definition
Promotion Loyalty Promotion Many To One: N:1 Promotion Promotion ID
Partner Product
Voucher Promotion Many To One: N:1 Promotion Promotion ID
All Fields
Field Name Field API Name Description Data
Type
Active Promotion ssot__ActivePromotionStartDate__c The start date of the promotion. dateTime
Created Date ssot__CreatedDate__c The date the record was created. dateTime
Cumulative Usage Target ssot__CumulativeUsageTargetAmount__c The target value of promotion based on number
Amount frequency of participation.
Currency ssot__CurrencyId__c A reference ID to denomination of text
currency defined in promotion, for
example, dollars or Euro.
Data Source ssot__DataSourceId__c A reference ID for the logical name text
referring to the source of records also
identified as the external source ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
Default Voucher Definition ssot__DefaultVoucherDefinitionId__c A reference ID to the main voucher where text
other vouchers are awarded to
individuals.
Description ssot__Description__c The description of the promotion. text
Discount Buy Amount ssot__DiscountBuyAmount__c The order value, before surcharges, number
required to receive a discount.
Discount Buy Count ssot__DiscountBuyCount__c The quantity that must be purchased to number
receive discount or quantity of free
product.
426
Model Data in Data Cloud Promotion DMO
Field Name Field API Name Description Data
Type
Discount Exclusivity Type ssot__DiscountExclusivityTypeId__c A reference ID to cases where promotion text
recipients qualify for discounts in more
than one way.
Discount Type ssot__DiscountTypeId__c A reference ID to types of discounts text
available in promotion, for example fixed
price or percentage-off.
Discount Value Amount ssot__DiscountValueAmt__c The amount deducted from an order number
subtotal if conditions are met.
End Date ssot__EndDate__c The last date the promotion is available dateTime
to customers.
Enrollment End Date ssot__EnrollmentEndDate__c The last date when customers can enroll dateTime
in the promotion.
Enrollment Start Date ssot__EnrollmentStartDate__c The first date when customers can enroll dateTime
in the promotion.
Evaluation Order Rank ssot__EvaluationOrderRankNbr__c The order of applying promotions to the number
product cost.
External Record ID ssot__ExternalRecordId__c A reference ID to an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Fulfillment Action ssot__FulfillmentActionId__c A reference ID to how marketing text
promotion provides values to customer,
for example via loyalty points, cash
discounts, or voucher.
Inactive Promotion ssot__InactivePromotionEndDate__c The date when the promotion becomes dateTime
inactive.
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
business account.
Is Active ssot__IsActive__c An indicator if the promotion is available text
to customers.
Is Enrollment Required ssot__IsEnrollmentRequired__c An indicator if the promotion can only be text
applied to persons who have enrolled in
it.
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the dateTime
record.
Lead ssot__LeadId__c A reference ID to person or company that text
showed interest in company's products.
427
Model Data in Data Cloud Promotion DMO
Field Name Field API Name Description Data
Type
Lead Source ssot__LeadSourceId__c A reference ID to the source where the text
lead was obtained.
Loyalty Program ssot__LoyaltyProgramId__c A reference ID to marketing strategy text
designed to encourage customers to
continue shopping at or use services of a
business associated with the program.
Loyalty Program Currency ssot__LoyaltyProgramCurrencyId__c A reference ID to the value or currency text
the loyalty program offers to customers.
Name ssot__Name__c The promotion’s name. text
Objective ssot__Objectivetext__c The business goal of the promotion, for text
example, a "10% increase in product
revenue."
Points Quantity ssot__PointsQuantity__c The points awarded during a promotion. number
Primary Campaign ssot__PrimaryCampaignId__c A reference ID to a marketing project that text
you want to plan, manage, and track.
Promotion Class ssot__PromotionClassId__c A reference ID to categories of text
promotions, for example, product, order,
or shipping.
Promotion Id ssot__Id__c A unique ID used as primary key for the text
Promotion DMO.
Promotion Method ssot__PromotionMethodId__c A reference ID to the method of text
promotion, for example, displays,
coupons, or a contest.
Promotion Reason ssot__PromotionReasonId__c A reference ID to why promotion was text
created, for example advertising or
publicity.
Promotion Status ssot__PromotionStatusId__c A reference ID to status of marketing text
promotion, for example draft, activated,
or complete.
Promotion Type ssot__PromotionTypeId__c A reference ID to type of promotion. text
Promotional Image ssot__PromotionalImage__c A graphic used to enhance promotion in text
a digital format.
Promotional Message ssot__PromotionalMessage__c A message displayed to possible text
consumers of promotion, for example,
"20% off all shoes for Mother's Day".
PromotionMarketSegments ssot__PromotionMarketSegments__c text
relationship
428
Model Data in Data Cloud Record Alert DMO
Field Name Field API Name Description Data
Type
Start Date ssot__StartDate__c The date the promotion is available to dateTime
customers.
Total Reward Value ssot__TotalRewardValueAmount__c The total savings or reward value number
Amount accumulated for promotion.
Record Alert DMO
Represents record alerts for an account. Provided in the Financial Services Cloud Data Kit. This DMO is available in API version 58 and
later.
API Name
ssot__RecordAlert__dlm
Category
Profile
Primary Subject Area
Financial Account
Primary Key Label
Record Alert ID (ssot_Id_c).
Relationships
DMO Label DMO Field Label Cardinality Related DMO Related DMO Data Bundle or
Label Field Label Origin
Record Alert Account ID Many To One (N:1) Account ID Financial Services
Cloud
Record Alert Reference Context ID Many To One (N:1) Financial Account ID Financial Services
Cloud
429
Model Data in Data Cloud Promotion Loyalty Partner Product DMO
Fields
Label API Name Description Data Data
Type Bundle
or
Origin
Account ID ssot__AccountId__c The associated account for which the Text Financial
alert is generated. Services
Cloud
Description ssot__Description__c Description of the record alert. Text Financial
Services
Cloud
Is Active ssot__isActive__c Indicates if the alert is active. Text Financial
Services
Cloud
Message Text ssot__MessageText__c Main content of the alert. Text Financial
Services
Cloud
Name ssot__Name__c Name of the record alert. Text Financial
Services
Cloud
Record Alert ID ssot__Id__c The primary key. Text Financial
Services
Cloud
Record Alert Priority ssot__RecordAlertPriority__c The record alert priority. Text Financial
Services
Cloud
Record Alert Severity ssot__RecordAlertSeverity__c The record alert severity. Text Financial
Services
Cloud
Reference Context ssot__ReferenceContextId__c The associated context object, for Text Financial
example financial account Services
Cloud
Promotion Loyalty Partner Product DMO
The Promotion Loyalty Partner Product DMO is a Data Cloud data model object (DMO) for the promotion of a product that a partner is
co-marketing to loyalty program members.
Object API Name
ssot__PromotionLoyaltyPartnerProduct__dlm
430
Model Data in Data Cloud Promotion Loyalty Partner Product DMO
Category
Other
Primary Subject Area
Loyalty
Primary Key
Promotion Loyalty Partner Product ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Promotion Loyalty Promotion Many To One: N:1 Promotion Promotion ID
Partner Product
Promotion Loyalty Loyalty Partner Product Many To One: N:1 Loyalty Program Partner Loyalty Program Partner
Partner Product ID
All Fields
Field Name Field API Name Description Data
Type
Created Date ssot__CreatedDate__c The date the record was created. dateTime
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
External Record ID ssot__ExternalRecordId__c A reference ID for an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
data record.
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the dateTime
record.
431
Model Data in Data Cloud Sales Order DMO
Field Name Field API Name Description Data
Type
Loyalty Partner Product ssot__LoyaltyPartnerProductId__c A reference ID to product offered by text
loyalty program partner that's
co-marketed with products marketed to
loyalty program members.
Promotion ssot__PromotionId__c A reference ID to type of marketing text
communication used to inform or
persuade target audiences of relative
merits of product, service, brand, or issue.
Promotion Loyalty Partner ssot__Id__c A unique ID used as primary key for the text
Product ID Promotion Loyalty Partner Product DMO.
Sales Order DMO
The Sales Order DMO is a Data Cloud data model object (DMO) that provides information around current and pending sales orders.
Object API Name
ssot__SalesOrder__dlm
Category
Other
Primary Subject Area
Sales Order
Primary Key
Sales Order ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Sales Order Bill To Account Many To One (N:1) Account Account ID
Sales Order Sold To Customer Many To One (N:1) Individual Individual ID
Sales Order Product Sales Order Many To One (N:1) Sales Order Sales Order ID
432
Model Data in Data Cloud Sales Order DMO
All Fields
Field Name Field API Name Description Data
Type
Activated By User ssot__ActivatedByUserId__c A reference ID to user who activated text
order.
Adjusted Product Tax ssot__AdjustedProductTaxAmount__c The total product tax plus the total number
Amount adjustment tax amount.
Adjusted Total Product ssot__AdjustedTotalProductAmount__c The total product amount plus the total number
Amount adjustment amount.
Bill To Account ssot__BillToAccountId__c A reference ID to account billed for order. text
Can only be updated when order's
StatusCode value is Draft.
Bill To Address ssot__BillToAddressId__c A reference ID to billing address. text
Bill To Contact ssot__BillToContactId__c A reference ID to customer billed for text
order.
Bill to Email ssot__BilltoEmailId__c A reference ID to email address of text
customer billed for order.
Bill to Phone Number ssot__BilltoPhoneNumberId__c A reference ID to phone number of text
customer billed for order.
Billing Day of the Month ssot__BillingDayOfTheMonth__c The day of the month that customer is number
invoiced.
Can Bill Now ssot__CanBillNow__c An indicator if a customer is eligible to text
bill.
CompanyAuthorizedBy ssot__CompanyAuthorizedById__c A reference ID to user who authorized the text
account associated with order.
Confirmation Recipient ssot__ConfirmationRecipientEmailtext__c A list of email addresses to send messages text
Email for order confirmation. Not for large
volume implementations
Contract ssot__ContractId__c A reference ID to contract associated with text
order. Can only be updated when the
order's Status Code value is Draft.
Created Date ssot__CreatedDate__c The date the record was created. dateTime
Currency Code ssot__CurrencyCode__c A reference ID to currency code for order. text
Currency code is used for all child objects,
such as sales order product and sales
order price adjustments.
CustomerAuthorizedBy ssot__CustomerAuthorizedById__c A reference ID to contact who authorized text
order.
433
Model Data in Data Cloud Sales Order DMO
Field Name Field API Name Description Data
Type
Data Source ssot__DataSourceId__c A reference ID to logical name for system text
that is source of records identified by
External Record Id.
Data Source Object ssot__DataSourceObjectId__c A reference ID to logical name of object text
where record originated, for example a
cloud storage file or another connector’s
external object.
Description ssot__Description__c The order’s description. text
Device ssot__DeviceId__c A reference ID to electronic unit where text
signals are tracked, for example fridge,
watch or car.
External Record ID ssot__ExternalRecordId__c A reference ID for external data source text
record.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Filed Date ssot__FiledDate__c The date the order was filed. dateTime
Grand Total Amount ssot__GrandTotalAmount__c The total amount of the order. number
Internal Business Unit ssot__InternalBusinessUnitId__c A reference ID to business unit within text
seller organization responsible for order.
Internal Organization ssot__InternalOrganizationId__c A reference ID to business unit or other text
internal organization that owns business
account.
Is Alerted ssot__IsAlerted__c An indicator if a user is notified when text
something went wrong during order
workflow.
Is Anonymous ssot__IsAnonymous__c An indicator if the order was placed by text
unregistered guest user.
Is Closed ssot__IsClosed__c An indicator if the order is closed. Used text
to drive and halt workflows.
Is Contracted ssot__IsContracted__c An indicator if the order placed is under text
the terms of a contract.
Is Historical Only ssot__IsHistoricalOnly__c An indicator for when an order is text
historical and can’t be changed.
Is Suspended ssot__IsSuspended__c An indicator for when an order is text
suspended.
Is Tax Exempt ssot__IsTaxExempt__c An indicator for whether taxes apply to text
order.
434
Model Data in Data Cloud Sales Order DMO
Field Name Field API Name Description Data
Type
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the dateTime
record.
Name ssot__Name__c The order name. text
Opportunity ssot__OpportunityId__c A reference ID to the opportunity text
associated with order.
Order End Date ssot__OrderEndDate__c The date when the order ends, such as dateTime
for a subscription.
Order insurance Amount ssot__OrderinsuranceAmountCurrency__c A reference ID to the currency of the order text
Currency insurance amount.
Order Number ssot__OrderNumber__c A unique number assigned to order and text
displayed to end users.
Order Start Date ssot__OrderStartDate__c The date when order becomes effective, dateTime
such as when a subscription begins.
Original Order ssot__OriginalOrderId__c A reference ID to the parent order. text
Owner User Id ssot__OwnerUserId__c A reference ID to the user or entity who text
owns this order.
Price Calculation Status ssot__PriceCalculationStatusMessagetext__c The status message describing the state text
Message of the order’s price calculation.
Promise Date ssot__PromiseDate__c The date the order was promised. dateTime
Purchase Order Date ssot__PurchaseOrderDate__c The date of purchase order. dateTime
Purchase Order Number ssot__PurchaseOrderNumber__c The number identifying a purchase order. text
Quote ssot__QuoteId__c A reference ID to quote associated with text
order.
Renewal Term ssot__RenewalTermId__c A reference ID to length of renewal term text
for renewal orders.
Renewal Uplift Rate ssot__RenewalUpliftRate__c For renewal orders, percentage of number
increase or decrease in order quantity.
Requested Start Date ssot__RequestedStartDate__c The customer's preferred date for order dateTime
fulfillment.
Sales Channel ssot__SalesChannelId__c A reference ID to the sales channel used text
to place order.
Sales Order Confirmation ssot__SalesOrderConfirmationStatusId__c A reference ID to what stage of customer text
Status approval and finalization has been
achieved.
435
Model Data in Data Cloud Sales Order DMO
Field Name Field API Name Description Data
Type
Sales Order Id ssot__Id__c A unique ID used as primary key for Sales text
Order DMO.
Sales Order Status ssot__SalesOrderStatusId__c Current order status, for example, draft, text
ready for review, or placed.
Sales Order System Status ssot__SalesOrderSystemStatusId__c A reference ID to order status with fixed text
values such as draft or activated.
Sales Order Type ssot__SalesOrderTypeId__c A reference ID to type of order, for text
example, change, renewal, or
amendment.
Sales Store ssot__SalesStoreId__c A reference ID to the store used to place text
order.
Sales Order Change Logs ssot__SalesOrderChangeLogs__c text
Relationship
Sales Order Delivery ssot__SalesOrderDeliveryGroups__c text
Groups Relationship
Sales Order Payment ssot__SalesOrderPaymentSummaries__c text
Summaries Relationship
Sales Order Price ssot__SalesOrderPriceAdjustments__c text
Adjustments Relationship
Seller ssot__SellerId__c A reference ID to order seller. text
Ship To Address ssot__ShipToAddressId__c A reference ID to location where order is text
shipped.
Ship To Contact ssot__ShipToContactId__c A reference ID to contact entity to whom text
order is shipped.
Ship To Email ssot__ShipToEmailId__c A reference ID to email of contact entity text
to whom order is shipped.
Shopping Cart Id ssot__ShoppingCartId__c A reference ID to shopping cart that text
customer used to select products in order,
before placing order.
Sold To Customer ssot__SoldToCustomerId__c A reference ID to the customer. text
Total Adjusted Delivery Tax ssot__TotalAdjustedDeliveryTaxAmount__c The total delivery tax amount, if adjusted. number
Amount
Total Adjustment Amount ssot__TotalAdjustmentAmount__c The sum of all order price adjustments, number
excluding taxes on any adjustments.
Total Adjustment Tax ssot__TotalAdjustmentTaxAmount__c The total tax amount, if adjusted. number
Amount
436
Model Data in Data Cloud Sales Order Product DMO
Field Name Field API Name Description Data
Type
Total Amount Currency ssot__TotalAmountCurrencyId__c A reference ID to the currency of the total text
amount.
Total Booking Amount ssot__TotalBookingAmount__c The total amount of a sales order product number
booking.
Total Canceled Billing ssot__TotalCancelledBillingAmount__c The total of all canceled orders. number
Amount
Total Delivery Amount ssot__TotalDeliveryAmount__c A total of product, adjustment, and number
delivery fee amounts, but excluding taxes.
Total Delivery Amount ssot__TotalDeliverytAmountCurrencyId__c A reference ID to the currency of the total text
Currency delivery amount.
Total Delivery Fee Amount ssot__TotalDeliveryFeeAmount__c The total fee for delivery. number
Total Delivery Fee Currency ssot__TotalDeliveryFeeCurrencyId__c A reference ID to currency of the total text
delivery amount.
Total Delivery Tax Amount ssot__TotalDeliveryTaxAmount__c The total amount of delivery tax. number
Total Pending Billing ssot__TotalPendingBillingAmount__c The total pending for all orders. number
Amount
Total Product Amount ssot__TotalProductAmount__c The total cost of the product. number
Total Product Amount ssot__TotalProductAmountCurrencyId__c A reference ID to currency of the total text
Currency product amount.
Total Product Tax Amount ssot__TotalProductTaxAmount__c The total amount of taxes for all product. number
Total Product Tax Amount ssot__TotalProductTaxAmountCurrencyId__c A reference ID to currency of the total text
Currency product tax amount.
Total Tax Amount ssot__TotalTaxAmount__c The total amount of taxes. number
User Device Session ssot__UserDeviceSessionId__c text
Sales Order Product DMO
The Sales Order Product DMO is a Data Cloud data model object (DMO) for the component of a sales order that identifies a product or
service to be sold to the customer.
Object API Name
ssot__SalesOrderProduct__dlm
Category
Other
437
Model Data in Data Cloud Sales Order Product DMO
Primary Subject Area
Sales Order
Primary Key
Sales Order Product ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Loyalty Transaction Sales Order Product Many To One: N:1 Sales Order Product Sales Order Product ID
Journal
Sales Order Product Seller Account Many To One: N:1 Account Account ID
Sales Order Product Original Order product Many To One: N:1 Sales Order Product Sales Order Product ID
Sales Order Product Sales Order Many To One: N:1 Sales Order Sales Order ID
Sales Order Product Product Many To One: N:1 Goods Product Goods Product ID
Sales Order Product Product Many To One: N:1 Master Product Master Product ID
Sales Order Product Product Many To One: N:1 Bundle Product Bundle Product ID
All Fields
Field Name Field API Name Description Data
Type
Adjusted Delivery Tax ssot__AdjustedDeliveryTaxAmount__c The roll up number of sales order product number
Amount tax rows associated with delivery fees.
Allocated Quantity ssot__AllocatedQuantity__c The quantity allocated for fulfillment. number
Available Quantity ssot__AvailableQuantity__c The quantity of product available. number
Comments ssot__Commenttext__c A message that is displayed to the text
customer during order creation.
Created Date ssot__CreatedDate__c The date the record was created. dateTime
Data Source ssot__DataSourceId__cc A reference ID for the logical name for a text
system that is the source of records
identified by an external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
438
Model Data in Data Cloud Sales Order Product DMO
Field Name Field API Name Description Data
Type
Delivery Tax Amount ssot__DeliveryTaxAmount__c The amount of tax owed for delivery. number
Description ssot__Description__c The description of the sales order product. text
Discount Amount ssot__DiscountAmount__c The discount amount applied to each number
order line item.
Discount Amount Currency ssot__DiscountAmountCurrency__c A reference ID to the denomination of text
currency for the discount amount.
External Record ID ssot__ExternalRecordId__c A reference ID to an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID to system that External text
Record ID was assigned.
Gift Order Message ssot__GiftOrderMessagetext__c The text message on a gift order. text
Gift Recipient Telephone ssot__GiftRecipientTelephonenumber__c The phone number of a gift recipient. text
number
Handling Cost Amount ssot__HandlingCostAmountCurrency__c A reference ID to the denomination of text
Currency currency for the handling cost amount.
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
business account.
Is Automatically Renewed ssot__IsAutomaticallyRenewed__c An indicator if a subscription-type text
product can be automatically renewed
or was selected for auto-renewal.
Is Bonus Product ssot__IsBonusProduct__c An indicator if the sales order item is a text
bonus or free product added to an order.
Is Bundle Root ssot__IsBundleRoot__c An indicator whether it’s an element of a text
bundled product.
Is Gift ssot__IsGift__c An indicator that the sales order is a gift. text
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the dateTime
record.
Line Adjustment SubTotal ssot__LineAdjustmentSubTotalAmount__c The subtotal amount of a line adjustment. number
Amount
List Price Amount ssot__ListPriceAmount__c The list price amount for one unit of a number
sales order product.
List Price Amount Currency ssot__ListPriceAmountCurrency__c The denomination of currency for the list text
price amount.
439
Model Data in Data Cloud Sales Order Product DMO
Field Name Field API Name Description Data
Type
List Price Quantity Unit of ssot__ListPriceQuantityUOMId__c A reference ID to a unit of measure for the text
Measure list price of a physical product, for
example, a box, case, or palette.
List Price Term Unit of ssot__ListPriceTermUOMId__c A reference ID to a unit of measure for list text
Measure price for a product with a subscription
term, for example, monthly, quarterly, or
yearly.
Order Adjustment SubTotal ssot__OrderAdjustmentSubTotalAmount__c number
Amount
Order Manual Adjustment ssot__OrderManualAdjustmentSubTotalAmount__c number
SubTotal Amount
Order Product number ssot__OrderProductnumber__c An automatically generated number that text
identifies a sales order product.
Ordered Quantity ssot__OrderedQuantity__c The number of units of sales order number
product.
Original Order Product ssot__OriginalOrderProductId__c A reference ID to the original sales order text
product being reduced.
Pricebook Entry ssot__PricebookEntryId__c A reference ID related to an entry within text
a price book.
Product ssot__ProductId__c A reference ID to what's being sold, for text
example, goods, services, bundles, and
made-to-order products.
Promised Date ssot__PromisedDate__c The start date for sales order product. dateTime
Provisioning Date ssot__ProvisioningDate__c The date when the seller expects to dateTime
provision a service or product.
Quantity Fulfilled ssot__QuantityFulfilled__c The quantity of a sales order product that number
is provided.
Quantity Ordered Unit Of ssot__QuantityOrderedUOMId__c A reference ID to a unit of measure for text
Measure quantity of sales order product ordered,
for example item, box, or palette.
Quote Line Item ssot__QuoteLineItemId__c A reference ID to the associated quote text
line item.
Recurring Price Amount ssot__RecurringPriceAmount__c A charge incurred by the buyer on a number
recurring basis.
Requested End Date ssot__RequestedEndDate__c The date when a product or service ends. dateTime
Requested Start Date ssot__RequestedStartDate__c The date when a product or service dateTime
begins, from a sales order perspective.
440
Model Data in Data Cloud Sales Order Product DMO
Field Name Field API Name Description Data
Type
Sales Order ssot__SalesOrderId__c A reference ID to the related sales order. text
Sales Order Delivery Group ssot__SalesOrderDeliveryGroupId__c A reference ID to the sales order delivery text
group.
Sales Order Product ssot__SalesOrderProductAdjustedTaxAmount__c The amount of taxes including any number
Adjusted Tax Amount adjustments.
Sales Order Product Id ssot__Id__c A unique ID used as the primary key for text
the Sales Order Product DMO.
Sales Order Product Reason ssot__SalesOrderProductReasonId__c A reference ID to the reason code for sales text
order product.
Sales Order Product Status ssot__SalesOrderProductStatusId__c A reference ID to status of sales order text
product in order, for example Placed or
Activated.
SalesOrderProductIdentifications ssot__SalesOrderProductIdentifications__c text
SalesOrderProductNotes ssot__SalesOrderProductNotes__c Any notes related to a sales order. text
relationship
SalesOrderProductPriceAdjustments ssot__SalesOrderProductPriceAdjustments__c text
SalesOrderProductRelatedProducts ssot__SalesOrderProductRelatedProducts__c text
SalesOrderProductTaxes ssot__SalesOrderProductTaxes__c text
relationship
Segment Index ssot__SegmentIndexId__c A reference ID to the number used with number
segment indexes for pricing subscriptions.
Segment Index number ssot__SegmentIndexnumber__c A number used for pricing subscriptions, number
where subperiods of the overall
subscription are priced differently, and
the pricing can change.
Seller Account ssot__SellerAccountId__c A reference ID to the seller account text
assigned to a sales order product.
Shipping Cost Amount ssot__ShippingCostAmountCurrency__c A denomination of currency for shipping text
Currency cost amount.
Shipping Tax Amount ssot__ShippingTaxAmountCurrency__c The denomination of currency for text
Currency shipping tax amount.
Subscription Renewal ssot__SubscriptionRenewalMonthQuantity__c The length of time of subscription, in number
Month Quantity months, of sales order item.
Subscription Term Quantity ssot__SubscriptionTermQuantity__c The quantity of a subscription term. number
Subscription Term Unit of ssot__SubscriptionTermUnitId__c A reference ID to a unit of measure for a text
Measure subscription term.
441
Model Data in Data Cloud Sales Order Product DMO
Field Name Field API Name Description Data
Type
Total Adjustment Amount ssot__TotalAdjustmentAmount__c The total amount including adjustments. number
Total Adjustment Tax ssot__TotalAdjustmentTaxAmount__c The total amount of taxes after number
Amount adjustment.
Total Distributed ssot__TotalDistributedAdjustmentAmount__c number
Adjustment Amount
Total Distributed ssot__TotalDistributedAdjustmentTaxAmount__c number
Adjustment Tax Amount
Total Distributed Tax ssot__TotalDistributedTaxAmount__c The total line level taxes on distributed number
Amount adjustments.
Total Line Adjustment ssot__TotalLineAdjustmentAmount__c The amount of any adjustment on a line number
Amount item of an order.
Total Line Amount ssot__TotalLineAmount__c The amount of a line item of an order. number
Total List Price Amount ssot__TotalListPriceAmount__c The list price of a product. number
Total Manual Adjustment ssot__TotalManualAdjustmentAmount__c The total amount of any adjustments. number
Amount
Total Price Amount ssot__TotalPriceAmount__c The total price of an order. number
Total Product Tax Amount ssot__TotalProductTaxAmount__c The total tax amount on a specific number
product.
Total Recurring Price ssot__TotalRecurringPriceAmount__c The total price of recurring charges for number
Amount subscription products that have recurring
charges.
Total Tax Amount ssot__TotalTaxAmount__c The total tax owed on an order. number
Total Unit Price Amount ssot__TotalUnitPriceAmount__c The total amount of the unit price. number
Unit Price Amount ssot__UnitPriceAmount__c The cost of one unit of product for each number
customer, which overrides the standard
list price.
Unit Price Amount ssot__UnitPriceAmountCurrency__c A reference ID to the denomination of text
Currency currency for the unit price amount.
Unit Tax Amount ssot__UnitTaxAmount__c The unit tax amount for sales order number
product.
Unit Tax Amount Currency ssot__UnitTaxAmountCurrency__c A reference ID to the denomination of text
currency for the unit tax amount.
442
Model Data in Data Cloud Sales Store DMO
Sales Store DMO
The Sales Store DMO is a Data Cloud data model object (DMO) that provides information regarding a retail establishment selling items
to the public.
Object API Name
ssot__SalesStore__dlm
Category
Other
Primary Subject Area
Sales Order
Primary Key
Sales Store ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Sales Order Sales Store Many To One: N:1 Sales Store Sales Store ID
All Fields
Field Name Field API Name Description Data
Type
Created Date ssot__CreatedDate__c The date a record was created. dateTime
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
External Record ID ssot__ExternalRecordId__c A reference ID for external data source text
record.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
443
Model Data in Data Cloud Service Presence Status DMO
Field Name Field API Name Description Data
Type
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
data record.
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the dateTime
record.
Name ssot__Name__c The store name. text
Sales Order ID ssot__Id__c A unique ID used as primary key for Sales text
Order DMO.
Service Presence Status DMO
The Service Presence Status DMO is a Data Cloud data model object (DMO) for a presence status that can be assigned to a service channel.
For example, Available for Leads, Out for Lunch, or Busy.
Object API Name
ssot__ServicePresenceStatus__dlm
Category
Other
Primary Subject Area
Primary Key
Agent Work Status Id (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Agent Service Presence Service Presence Status Many To One: N:1 Service Presence Status Agent Work Status Id
All Fields
Field Name Field API Name Description Data
Type
Agent Work Status Id ssot__Id__c A unique ID used as the primary key for text
the service presence status DMO.
444
Model Data in Data Cloud Shopping Cart Engagement DMO
Field Name Field API Name Description Data
Type
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
Description ssot__Description__c The service presence status description. text
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
service presence status.
Name ssot__Name__c The name of the service presence status. text
Shopping Cart Engagement DMO
The Shopping Cart Engagement DMO is a Data Cloud Data Platform data model object (DMO) for data captured from user actions, such
as adding and removing items from a shopping cart.
Object API Name
ssot__ShoppingCartEngagement__dlm
Category
Engagement
Primary Subject Area
Engagement
Primary Key
Shopping Cart Engagement ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Engagement Topic Engagement Many To One: N:1 Shopping Cart Shopping Cart
Engagement Engagement ID
445
Model Data in Data Cloud Shopping Cart Engagement DMO
Object Field Cardinality Related Object Related Field
Loyalty Transaction Engagement Many To One: N:1 Shopping Cart Shopping Cart
Journal Engagement Engagement ID
Shopping Cart Product Many To One: N:1 Goods Product Goods Product ID
Engagement
Shopping Cart Product Many To One: N:1 Bundle Product Bundle Product ID
Engagement
Shopping Cart Engagement Channel Many To One: N:1 Engagement Channel Engagement Channel
Engagement Type Type Type ID
Shopping Cart Account Contact Many To One: N:1 Account Contact Account Contact ID
Engagement
Shopping Cart Case Many To One: N:1 Case Case ID
Engagement
Shopping Cart Contact Point Many To One: N:1 Contact Point Address Contact Point Address ID
Engagement
Shopping Cart Contact Point Many To One: N:1 Contact Point App Contact Point App ID
Engagement
Shopping Cart Contact Point Many To One: N:1 Contact Point Email Contact Point Email ID
Engagement
Shopping Cart Contact Point Many To One: N:1 Contact Point Phone Contact Point Phone ID
Engagement
Shopping Cart Engagement Asset Many To One: N:1 Contact Point Social Contact Point Social ID
Engagement
Shopping Cart Engagement Publication Many To One: N:1 Device Application Device Application
Engagement Template Template ID
Shopping Cart Engagement Asset Many To One: N:1 Email Publication Email Publication ID
Engagement
Shopping Cart Lead Many To One: N:1 Email Template Email Template ID
Engagement
Shopping Cart Market Journey Activity Many To One: N:1 Lead Lead ID
Engagement
Shopping Cart Market Segment Many To One: N:1 Market Journey Activity Market Journey Activity
Engagement ID
Shopping Cart Product Many To One: N:1 Market Segment Market Segment ID
Engagement
Shopping Cart Engagement Publication Many To One: N:1 Master Product Master Product ID
Engagement
446
Model Data in Data Cloud Shopping Cart Engagement DMO
Object Field Cardinality Related Object Related Field
Shopping Cart Engagement Asset Many To One: N:1 SMS Publication SMS Publication ID
Engagement
Shopping Cart Sales Order Many To One: N:1 SMS Template SMS Template ID
Engagement
Shopping Cart Individual Many To One: N:1 Individual Individual ID
Engagement
Shopping Cart Product Shopping Cart Many To One: N:1 Shopping Cart Shopping Cart
Engagement Engagement Engagement Engagement ID
All Fields
Field Name Field API Name Description Data
Type
Account Contact ssot__AccountContactId__c A reference ID to account contact. text
Action Cadence Step ssot__ActionCadenceStepId__c A reference ID to action cadence step. text
Adjusted Total Product ssot__AdjustedTotalProductAmount__c The total product amount after any number
Amount adjustments.
Case ssot__CaseId__c A reference ID to a recorded issue, for text
example laptop connectivity.
Contact Point ssot__ContactPointId__c A reference ID to the accounts’ contact text
point, for example physical address, email
address, or phone number.
Created Date ssot__CreatedDate__c The date the record was created. dateTime
Currency ssot__CurrencyId__c A reference ID to the type of currency text
used.
Data Source ssot__DataSourceId__c A reference ID for the logical name text
referring to the source of records also
identified as the external source ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
Device Country ssot__DeviceCountryId__c A reference ID to the country where the text
device is located.
Device IP Address ssot__DeviceIPAddress__c The IP address of the device. text
Device Latitude ssot__DeviceLatitude__c The Geo latitude of the device when number
engagement was recorded.
447
Model Data in Data Cloud Shopping Cart Engagement DMO
Field Name Field API Name Description Data
Type
Device Locale ssot__DeviceLocaleId__c A reference ID to the user locale text
configured on the device.
Device Longitude ssot__DeviceLongitude__c The Geo longitude of device when number
engagement was recorded.
Device Postal Code ssot__DevicePostalCode__c The postal code associated with the text
device.
Engagement Asset ssot__EngagementAssetId__c A reference ID to the engagement asset. text
Engagement Channel ssot__EngagementChannelId__c A reference ID to the engagement text
channel.
Engagement Channel ssot__EngagementChannelActionId__c A reference ID to the action taken in the text
Action engagement channel.
Engagement Channel Type ssot__EngagementChannelTypeId__c A reference ID to the type of engagement text
channel.
Engagement Date Time ssot__EngagementDateTm__c The date and time of engagement. Since dateTime
the engagement happens after send, the
engagement date must be after the Send
Date Time.
Engagement Event ssot__EngagementEventDirectionId__c A reference ID to the engagement event text
Direction direction, such as inbound or outbound.
Engagement Notes ssot__EngagementNotesTxt__c The details and notes about the text
engagement.
Engagement Number ssot__EngagementNbr__c A non-automatic, user-facing ID. text
Engagement Publication ssot__EngagementPublicationId__c A reference ID to a background process text
that generates volumes of email
messages, SMS messages, or other
Engagement Vehicle types.
Engagement Type ssot__EngagementTypeId__c A reference ID to the type of engagement, text
for example email or phone.
Engagement Vehicle ssot__EngagementVehicleId__c A reference ID to the vehicle where the text
engagement was recorded.
External Record ID ssot__ExternalRecordId__c A reference ID to an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID to system that External text
Record Id was assigned.
Individual ssot__IndividualId__c A reference ID to a contact for the text
account.
448
Model Data in Data Cloud Shopping Cart Engagement DMO
Field Name Field API Name Description Data
Type
Internal Engagement Actor ssot__InternalEngagementActorId__c A reference ID to an engagement actor text
that groups the different types of
individuals targeted for marketing
engagements, for example leads and
account contacts.
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
business account.
Is Gift Order ssot__IsGiftOrder__c A flag to indicate if the order is a gift. text
Is Test Send ssot__IsTestSend__c A flag to indicate if an engagement record text
was generated as part of testing.
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the dateTime
record.
Lead ssot__LeadlId__c A reference ID to a person or company text
that showed interest in products.
Link URL ssot__LinkURL__c A link to the web page accessed during text
the engagement.
Market Audience ssot__MarketAudienceId__c A reference ID to the intended audience text
that engagement was designed to reach.
Market Journey Activity ssot__MarketJourneyActivityId__c A reference ID to a step or activity that a text
customer configures in Salesforce Journey
Builder tool for marketing associated with
engagement.
Market Segment ssot__MarketSegmentId__c A reference ID to a group of people who text
share one or more common
characteristics, and are grouped for
marketing associated with engagement.
Marketing Email List ssot__MarketingEmailListId__c A reference ID to the marketing email list text
used for the engagement.
Name ssot__Name__c The name of the engagement. text
Net Order Amount ssot__NetOrderAmount__c The order amount. number
Product ssot__ProductId__c A reference ID to a product intended to text
be sold, for example goods, services,
bundles, or made-to-order products.
Product Brand ssot__ProductBrandName__c The brand of a product, for example text
Northern Trail Outfitters.
Product Category ssot__ProductCategoryName__c The class of products, such as shoes or text
hats.
449
Model Data in Data Cloud Shopping Cart Engagement DMO
Field Name Field API Name Description Data
Type
Product Color ssot__ProductColorName__c The color variant of a product displayed text
on the search result.
Product Display Position ssot__ProductDisplayPositionNumber__c The position number where the product number
Number is displayed.
Product Display Position ssot__ProductDisplayPosition__c The numeric position of the product in number
the displayed list.
Product Image URL ssot__ProductImageURL__c A link to the page that hosts the product text
photo or image.
Product Price ssot__ProductPriceAmount__c The price of the product displayed on the number
search result.
Product Quantity ssot__ProductQuantity__c The product package quantity that is number
displayed on the search result.
Product SKU ssot__ProductSKU__c A product’s Stock Keeping Unit (SKU). text
Product SKU ssot__ProductSKUNumber__c The Stock Keeping Unit (SKU) number. text
Product Style ssot__ProductStyleName__c The product style displayed on the search text
result.
Product View URL ssot__ProductViewURL__c A link to the detail page about the text
product displayed on the search result.
Promotion Coupon ssot__PromotionCouponId__c A reference ID to payment in the form of text
a voucher entitling the holder to a
discount on a particular product.
Referrer URL ssot__ReferrerURL__c The URL of an application that directed text
the user to the software application that
generated engagement.
Sales Order ssot__SalesOrderId__c An internal document generated by the text
seller indicating that the customer is
ready to purchase products and services.
Sent Date Time ssot__SentDateTm__c The date and time of send. dateTime
Session ssot__SessionId__c A reference ID to a session used to group text
related events together.
Shopping Cart ssot__ShoppingCartId__c A reference ID to the shopping cart for text
data captured from user actions, for
example adding or removing items from
the shopping cart.
Shopping Cart ssot__Id__c A unique ID used as the primary key for text
Engagement ID the Shopping Cart Engagement DMO.
450
Model Data in Data Cloud Shopping Cart Event Type DMO
Field Name Field API Name Description Data
Type
Shopping Cart Event Type ssot__ShoppingCartEventTypeId__c A reference ID to the type of shopping text
cart interaction.
Target Engagement Actor ssot__TargetEngagementActorId__c A reference ID to an engagement actor text
that groups different types of individuals
targeted for marketing associated with
engagement, for example leads and
account contacts.
Task ssot__TaskId__c A reference ID to business activity, for text
example making a phone call. In the user
interface, tasks and event records are
collectively referred to as activities.
Total Adjustment Amount ssot__TotalAdjustmentAmount__c The total amount after any adjustments. number
Total Delivery Amount ssot__TotalDeliveryAmount__c The total amount of delivery costs. number
Total Product Amount ssot__TotalProductAmount__c The total product amount. number
Total Product Quantity ssot__TotalProductQuantity__c The total number of a product. number
Total Product Tax Amount ssot__TotalProductTaxAmount__c The total tax amount of the product. number
Total Tax Amount ssot__TotalTaxAmount__c The total tax amount. number
Web Cookie ssot__WebCookieId__c A reference ID to a small piece of data text
sent from a website and stored on the
user's computer by the user's web
browser while the user is browsing.
Workflow ssot__WorkflowId__c A reference ID to the sequence of steps text
or processes from initiation to
completion.
Shopping Cart Event Type DMO
The Shopping Cart Event Type DMO is a Data Cloud data model object (DMO) for when a customer interacts with a commerce site’s
shopping cart.
Object API Name
ssot__ShoppingCartEventType__dlm
Category
Other
451
Model Data in Data Cloud Shopping Cart Product Engagement DMO
Primary Subject Area
Sales Order
Primary Key
Shopping Cart Event Type ID (ssot__Id__c)
Relationships
There are no relationships related to this DMO.
All Fields
Field Name Field API Name Description Data
Type
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
business account.
Name ssot__Name__c The name of the shopping cart event text
type, for example added product to cart,
cart viewed, or product removed from
cart.
Shopping Cart Event Type ssot__Id__c A unique ID used as primary key for the text
ID Shopping Cart Event Type DMO.
Shopping Cart Product Engagement DMO
The Shopping Cart Product Engagement DMO is a Data Cloud data model object (DMO) for data captured from user actions, such as
adding and removing items from a shopping cart.
Object API Name
ssot__ShoppingCartProductEngagement__dlm
452
Model Data in Data Cloud Shopping Cart Product Engagement DMO
Category
Engagement
Primary Subject Area
Engagement
Primary Key
Shopping Cart Product Engagement ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Shopping Cart Product Shopping Cart Many To One: N:1 Shopping Cart Shopping Cart
Engagement Engagement Engagement Engagement ID
All Fields
Field Name Field API Name Description Data
Type
Adjusted Total Product ssot__AdjustedTotalProductAmount__c The product’s adjusted price, if applicable. number
Amount
Adjustment Amount ssot__AdjustmentAmount__c The amount the prices was adjusted, if number
applicable.
Currency ssot__CurrencyId__c A reference ID to the currency. text
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
Delivery Amount ssot__DeliveryAmount__c The delivery amount for each item. number
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
business account.
Is Gift Order ssot__IsGiftOrder__c An indicator if an order is a gift. text
453
Model Data in Data Cloud Shopping Cart Product Engagement DMO
Field Name Field API Name Description Data
Type
Product ssot__ProductId__c A reference ID to what's intended to be text
sold, for example goods, services,
bundles, and made-to-order products.
Product Amount ssot__ProductAmount__c The product quantity unit price for line number
item.
Product Brand ssot__ProductBrandName__c The brand name of a product. text
Product Category ssot__ProductCategoryName__c The product category, such as shoes and text
hats, within a larger catalog.
Product Color ssot__ProductColorName__c The product color for search results. text
Product Display Position ssot__ProductDisplayPositionnumber__c The position number the product is number
shown on a list.
Product Image URL ssot__ProductImageURL__c The link to page that hosts the product text
photo or image.
Product Price ssot__ProductPrice__c The product price displayed on a search number
result.
Product Quantity ssot__ProductQuantity__c The product package quantity displayed number
on a search result.
Product SKU ssot__ProductSKUnumber__c The stock keeping unit (SKU) of a text
displayed product.
Product Style ssot__ProductStyleName__c The product style displayed on a search text
result.
Product Tax Amount ssot__ProductTaxAmount__c The amount of tax on product line item. number
Product View URL ssot__ProductViewURL__c The link to detail page about the text
displayed product.
Promotion Coupon ssot__PromotionCouponId__c A reference ID to payment in the form of text
a voucher entitling holder to a discount
on particular product.
Shopping Cart ssot__ShoppingCartEngagementId__c A reference ID to data retrieved from user text
Engagement action at ordering stage of online
shopping process.
Shopping Cart Product ssot__Id__c A unique ID used as primary key for the text
Engagement Id Shopping Cart Product Engagement
DMO.
Shopping Cart Product ssot__ShoppingCartProductItemName__c The name given to product in a shopping text
Item Name cart.
454
Model Data in Data Cloud Skill DMO
Skill DMO
The Skill DMO is a Data Cloud data model object (DMO) for proficiency, competence, or expertise that an employee possesses, which is
useful to the mission of an organization.
Object API Name
ssot__Skill__dlm
Category
Other
Primary Subject Area
Primary Key
Skill Id (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Agent Work Skill Skill Many To One: N:1 Skill Skill ID
All Fields
Field Name Field API Name Description Data
Type
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
service presence status.
Name ssot__Name__c The name of the skill. text
Skill ID ssot__Id__c A unique ID used as the primary key for text
the skill DMO.
455
Model Data in Data Cloud SMS Publication DMO
SMS Publication DMO
The SMS Publication DMO is a Data Cloud data model object (DMO) for the process that sends out a set of SMS messages to multiple
recipients.
Object API Name
ssot__SMSPublication__dlm
Category
Other
Primary Subject Area
Engagement
Primary Key
SMS Publication ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Device Application Engagement Publication Many To One: N:1 SMS Publication SMS Publication ID
Engagement
Email Engagement Engagement Publication Many To One: N:1 SMS Publication SMS Publication ID
Email Publication Parent Engagement Many To One: N:1 SMS Publication SMS Publication ID
Publication
Message Engagement Engagement Publication Many To One: N:1 SMS Publication SMS Publication ID
Product Browse Engagement Publication Many To One: N:1 SMS Publication SMS Publication ID
Engagement
Product Order Engagement Publication Many To One: N:1 SMS Publication SMS Publication ID
Engagement
Shopping Cart Engagement Publication Many To One: N:1 SMS Publication SMS Publication ID
Engagement
SMS Publication Engagement Asset Many To One: N:1 Device Application Device Application
Template Template ID
SMS Publication Engagement Asset Many To One: N:1 SMS Template SMS Template ID
SMS Publication Parent Engagement Many To One: N:1 Email Publication Email Publication ID
Publication
456
Model Data in Data Cloud SMS Publication DMO
Object Field Cardinality Related Object Related Field
SMS Publication Engagement Channel Many To One: N:1 Engagement Channel Engagement Channel
Type Type Type ID
SMS Publication Engagement Asset Many To One: N:1 Device Application Device Application
Template Template ID
SMS Publication Parent Engagement Many To One: N:1 SMS Publication SMS Publication ID
Publication
SMS Publication Engagement Asset Many To One: N:1 Email Template Email Template ID
Web Search Engagement Engagement Publication Many To One: N:1 SMS Publication SMS Publication ID
Website Engagement Engagement Publication Many To One: N:1 SMS Publication SMS Publication ID
All Fields
Field Name Field API Name Description Data
Type
Created Date ssot__CreatedDate__c The date when the record was created. dateTime
Data Source ssot__DataSourceId__c A reference ID to a logical name for a text
system that is the source of records
identified by External Record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID to the logical name of the text
object where the record originated, for
example a cloud storage file or another
connector’s external object.
Description ssot__Description__c A description of the SMS publication. text
Duration Seconds Quantity ssot__DurationSecondsQty__c The number of seconds related to the number
message.
Engagement Asset ssot__EnagementAssetId__c A reference ID to the engagement asset. text
Engagement Asset Content ssot__EnagementAssetContentId__c A reference ID to the engagement asset text
content.
Engagement Channel Type ssot__EngagementChannelTypeId__c A reference ID to the type of engagement text
channel.
Engagement Publication ssot__EngagementPublicationNbr__c The number or identifier of an text
Number engagement publication.
Engagement Publication ssot__EngagementPublicationStatusId__c A reference ID to the status of the text
Status engagement publication.
Engagement Publication ssot__EnagementPublicationTypeId__c A reference ID to the type of engagement text
Type publication.
457
Model Data in Data Cloud SMS Template DMO
Field Name Field API Name Description Data
Type
Engagement Topic Group ssot__EngagementTopicGroupId__c A reference ID to a group of engagement text
topics.
Error Message Text ssot__ErrorMessageTxt__c The text’s error message. text
External Record ID ssot__ExternalRecordId__c A reference ID for an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Failed Record Count ssot__FailedRecordCt__c The number of failed records. number
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
business account.
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the dateTime
record.
Name ssot__Name__c The name of the SMS publication. text
Parent Engagement ssot__ParentEngagementPublicationId__c A reference ID to the parent record’s text
Publication engagement publication.
Publication Attempts ssot__PublicationAttemptsNbr__c The number of attempts to send the number
Number publication.
Publication Status Date ssot__PublicationStatusDt__c The date of SMS publication. dateTime
Send Classification ssot__SendClassificationId__c A reference ID to how consent is checked text
for example transactional or commercial.
SMS Publication ID ssot__Id__c A unique ID used as the primary key for text
the SMS Publication DMO.
Successful Record Count ssot__SuccessfulRecordCt__c The number of successful records. number
Total Publication Items ssot__TotalPublicationItemsCt__c The total number of publication items. number
Count
SMS Template DMO
The SMS Template DMO is a Data Cloud data model object (DMO) for a reusable, standard format for text (SMS) messages.
Object API Name
ssot__SMSTemplate__dlm
458
Model Data in Data Cloud SMS Template DMO
Category
Other
Primary Subject Area
Engagement
Primary Key
SMS Template ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Device Application Engagement Asset Many To One (N:1) SMS Template SMS Template ID
Engagement
Email Engagement Engagement Asset Many To One (N:1) SMS Template SMS Template ID
Message Engagement Engagement Asset Many To One (N:1) SMS Template SMS Template ID
Device Application Device Application Many To One (N:1) SMS Template SMS Template ID
Template Template ID
SMS Template Parent Engagement Asset Many To One (N:1) Device Application Device Application
Template Template ID
Email Publication Engagement Asset Many To One (N:1) SMS Template SMS Template ID
SMS Template Parent Engagement Asset Many To One (N:1) Email Template Email Template ID
ID
Email Template Parent Engagement Asset Many To One (N:1) SMS Template SMS Template ID
Product Browse Engagement Asset Many To One (N:1) SMS Template SMS Template ID
Engagement
Product Order Engagement Asset ID Many To One (N:1) SMS Template SMS Template ID
Engagement
Shopping Cart Engagement Asset ID Many To One (N:1) SMS Template SMS Template ID
Engagement
SMS Publication Engagement Asset ID Many To One (N:1) SMS Template SMS Template ID
459
Model Data in Data Cloud SMS Template DMO
All Fields
Field Name Field API Name Description Data
Type
Created Date ssot__CreatedDate__c The date the record was created. dateTime
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
Engagement Asset ssot__EngagementAssetNbr__c The engagement asset number. text
Number
Engagement Asset Type ssot__EngagementAssetTypeId__c A reference ID to the type of engagement text
asset
Engagement Message ssot__EngagementMessageTypeId__c A reference ID to the engagement text
Type message type.
External Record ID ssot__ExternalRecordId__c A reference ID to an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Internal Organization ssot__InternalOrganizationId__c A reference ID to business unit or other text
internal organization that owns the
business account.
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the dateTime
record.
Message Format Type ssot__MessageFormatTypeId__c A reference ID to the format type of the text
message.
Name ssot__Name__c The name of the SMS engagement. text
Parent Engagement Asset ssot__ParentEngagementAssetId__c A reference ID to the associated parent text
engagement asset.
Send Classification ssot__SendClassificationId__c A reference ID to the two types of send text
classifications: Transactional (placing an
order implies opt-in for an order
confirmation email) or Commercial
(promotional email requiring opt-in).
SMS Template Body text ssot__SMSTemplateBodyTxt__c The body of the SMS message. text
SMS Template ID ssot__Id__c A unique ID used as primary key for the text
SMS Template DMO.
460
Model Data in Data Cloud Software Application DMO
Software Application DMO
The Software Application DMO is a Data Cloud data model object (DMO) for defining programs created for the end user, such as an app
for Northern Trail Outfitters loyalty members.
Object API Name
ssot__SoftwareApplication__dlm
Category
Other
Primary Subject Area
Software Application
Primary Key
Software Application ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Contact Point App Software Application Many To One: N:1 Software Application Software Application ID
Device Application Software Application Many To One: N:1 Software Application Software Application ID
Engagement
Software Application Product Many To One: N:1 Goods Product Goods Product ID
Software Application Product Many To One: N:1 Bundle Product Bundle Product ID
Software Application Product Many To One: N:1 Master Product Master Product ID
All Fields
Field Name Field API Name Description Data
Type
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
461
Model Data in Data Cloud Survey DMO
Field Name Field API Name Description Data
Type
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
data record.
Product ssot__ProductId__c A reference ID to the associated product. text
Provider Token ssot__ProviderTokenText__c The token of the software provider. text
Software Application ID ssot__ID__c A unique ID used as primary key for Sales text
Order DMO.
Software Application Name ssot__SoftwareApplicationName__c The name of the application. text
Survey DMO
The Survey DMO is a Data Cloud data model object (DMO) for a survey.
Object API Name
ssot__Survey__dlm
Category
Other
Primary Subject Area
Primary Key
Survey Id (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Survey Active Survey Version Many To One: N:1 Survey Version Survey Version ID
Survey Subject Survey Many To One: N:1 Survey Survey ID
Survey Version Survey Many To One: N:1 Survey Survey ID
462
Model Data in Data Cloud Survey Invitation DMO
All Fields
Field Name Field API Name Description Data
Type
Active Survey Version ssot__ActiveSurveyVersionId__c A reference ID to the active version for text
the survey.
Created Date ssot__CreatedDate__c The date the record was created. dateTime
Data Source ssot__DateSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DateSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
Description ssot__Description__c The survey description. text
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
survey.
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the dateTime
record.
Name ssot__Name__c The name of the survey. text
Name Prefix ssot__NamePrefix__c The name prefix of the survey. text
Survey Id ssot__Id__c A unique ID used as the primary key for text
the survey DMO.
Survey Type ssot__SurveyType__c The type of the survey. text
Survey Invitation DMO
The Survey Invitation DMO is a Data Cloud data model object (DMO) for the invitation sent to a participant to complete the survey.
Object API Name
ssot__SurveyInvitation__dlm
Category
Other
463
Model Data in Data Cloud Survey Invitation DMO
Primary Subject Area
Primary Key
Survey Invitation Id (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Survey Invitation Participant Many To One: N:1 Account Contact Account Contact ID
Survey Response Survey Invitation Many To One: N:1 Survey Invitation Survey Invitation ID
Survey Subject Survey Parent Many To One: N:1 Survey Invitation Survey Invitation ID
All Fields
Field Name Field API Name Description Data
Type
Can Guest User Respond ssot__CanGuestUserRespond__c An indicator if a guest user can respond text
to a survey invitation.
Can Participant Access ssot__CanParticipantAccessResponse__c An indicator if a participant can access text
Response their survey response.
Can Participant Respond ssot__CanParticipantRespondAnonymously__c An indicator if a participant can respond text
Anonymously anonymously to a survey invitation.
Created Date ssot__CreatedDate__c The date the record was created. dateTime
Data Source ssot__DateSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DateSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
Description ssot__Description__c The survey invitation description. text
Invitation Expires On ssot__InviteExpiryDateTime__c The date the survey invitation expires on. dateTime
Invitation Link ssot__InvitationLink__c The link to the survey invitation. text
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the dateTime
record.
Name ssot__Name__c The name of the survey invitation. text
Participant ssot__ParticipantId__c A reference ID to the survey participant. text
464
Model Data in Data Cloud Survey Question DMO
Field Name Field API Name Description Data
Type
Participant Object ssot__ParticipantObject__c The object representing the survey text
participant.
Survey ssot__SurveyId__c A reference ID to the survey for the text
invitation.
Survey Invitation Id ssot__Id__c A unique ID used as the primary key for text
the survey invitation DMO.
Survey Response Status ssot__SurveyResponseStatus__c The status of the survey response. text
Survey Question DMO
The Survey Question DMO is a Data Cloud data model object (DMO) for a question in a survey under a section.
Object API Name
ssot__SurveyQuestion__dlm
Category
Other
Primary Subject Area
Primary Key
Survey Question Id (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Survey Question Survey Question Section Many To One: N:1 Survey Question Section Survey Question ID
Survey Question Survey Question Many To One: N:1 Survey Question Survey Question ID
Response
All Fields
Field Name Field API Name Description Data
Type
Created Date ssot__CreatedDate__c The date the record was created. dateTime
465
Model Data in Data Cloud Survey Question Response DMO
Field Name Field API Name Description Data
Type
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
Deprecated ssot__IsDeprecated__c An indicator if the survey question is text
deprecated.
Description ssot__Description__c The survey question description. text
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
survey question.
Last Modified Date ssot__Last ModifiedDate__c The date when a user last modified the dateTime
record.
Name ssot__Name__c The name of the survey question. text
Survey Question Id ssot__Id__c A unique ID used as the primary key for text
the survey question DMO.
Survey Question Section ssot__SurveyQuestionSectionId__c A reference ID to the survey section for text
the question.
Survey Question Type ssot__SurveyQuestionType__c The type of the survey question. text
Survey Question Response DMO
The Survey Question Response DMO is a Data Cloud data model object (DMO) for participants who answer specific questions.
Object API Name
ssot__SurveyQuestionResponse__dlm
Category
Other
Primary Subject Area
Primary Key
Survey Question Response Id (ssot__Id__c)
466
Model Data in Data Cloud Survey Question Response DMO
Relationships
Object Field Cardinality Related Object Related Field
Survey Question Survey Question Many To One: N:1 Survey Question Survey Question ID
Response
Survey Question Survey Response Many To One: N:1 Survey Response Survey Response ID
Response
All Fields
Field Name Field API Name Description Data
Type
Boolean Value ssot__BooleanValue__c The response value for a boolean text
question.
Created Date ssot__CreatedDate__c The date the record was created. dateTime
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
Data Type ssot__DataType__c The data type of the survey question text
response.
Description ssot__Description__c The survey question response description. text
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
survey question response.
Last Modified Date ssot__Last ModifiedDate__c The date when a user last modified the dateTime
record.
Name ssot__Name__c The name of the survey question text
response.
Number Value ssot__NumberValue__c The response value for a numeric number
question.
Rank Number ssot__RankNumber__c The rank value of the survey response number
question.
Response Value ssot__ResponseValue__c The response value for a text question. text
Survey Question ssot__SurveyQuestionId__c A reference ID to the survey question for text
the response.
467
Model Data in Data Cloud Survey Question Section DMO
Field Name Field API Name Description Data
Type
Survey Question Response ssot__Id__c A unique ID used as the primary key for text
Id the survey question response DMO.
Survey Reponse ssot__SurveyResponseId__c A reference ID to the survey response for text
the question.
Survey Question Section DMO
The Survey Question Section DMO is a Data Cloud data model object (DMO) for a section, such as the title section or a question section,
in a survey.
Object API Name
ssot__SurveyQuestionSection__dlm
Category
Other
Primary Subject Area
Primary Key
Survey Question Section Id (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Survey Question Survey Question Section Many To One: N:1 Survey Question Section Survey Question Section
ID
Survey Question Section Survey Version Many To One: N:1 Survey Version Survey Version ID
All Fields
Field Name Field API Name Description Data
Type
Created Date ssot__CreatedDate__c The date the record was created. dateTime
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
468
Model Data in Data Cloud Survey Response DMO
Field Name Field API Name Description Data
Type
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
Description ssot__Description__c The survey question section description. text
Display Order Number ssot__DisplayOrderNumber__c The display order value of the survey text
question section.
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
survey question section.
Last Modified Date ssot__Last ModifiedDate__c The date when a user last modified the dateTime
record.
Name ssot__Name__c The name of the survey question section. text
Survey Page ssot__SurveyPageId__c A reference ID to the survey page for the text
section.
Survey Question Section Id ssot__Id__c A unique ID used as the primary key for text
the survey question section DMO.
Survey Version ssot__SurveyVersionId__c A reference ID to the survey version of the text
section.
Survey Response DMO
The Survey Response DMO is a Data Cloud data model object (DMO) for an answer to a survey question.
Object API Name
ssot__SurveyResponse__dlm
Category
Other
Primary Subject Area
Primary Key
Survey Response Id (ssot__Id__c)
469
Model Data in Data Cloud Survey Response DMO
Relationships
Object Field Cardinality Related Object Related Field
Survey Question Survey Response Many To One: N:1 Survey Response Survey Response ID
Response
Survey Response Submitter Many To One: N:1 Account Contact Account Contact ID
Survey Response Survey Invitation Many To One: N:1 Survey Invitation Survey Invitation Id
Survey Response Survey Version Many To One: N:1 Survey Version Survey Invitation Id
All Fields
Field Name Field API Name Description Data
Type
Completion Date ssot__CompletionDateTime__c The date and time the survey response dateTime
was completed.
Created Date ssot__CreatedDate__c The date the record was created. dateTime
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
Description ssot__Description__c The survey response description. text
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
survey response.
Last Modified Date ssot__Last ModifiedDate__c The date when a user last modified the dateTime
record.
Name ssot__Name__c The name of the survey response. text
Submitter ssot__SubmitterId__c A reference ID to the submitter of the text
response.
Submitter Object ssot__SubmitterObject__c The submitter object for the response. text
Survey Invitation ssot__SurveyInvitationId__c A reference ID to the survey invitation for text
the response.
Survey Response Id ssot__Id__c A unique ID used as the primary key for text
the survey response DMO.
470
Model Data in Data Cloud Survey Subject DMO
Field Name Field API Name Description Data
Type
Survey Response Status ssot__SurveyResponseStatus__c The status of the survey response. text
Survey Version ssot__SurveyVersionId__c A reference ID to the survey version of the text
response.
Survey Subject DMO
The Survey Subject DMO is a Data Cloud data model object (DMO) for a relationship between a survey and another object, such as an
account or a case.
Object API Name
ssot__SurveySubject__dlm
Category
Other
Primary Subject Area
Primary Key
Survey Subject Id (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Survey Subject Survey Many To One: N:1 Survey Survey ID
Survey Subject Survey Parent Many To One: N:1 Survey Invitation Survey Invitation ID
Survey Subject Survey Subject Many To One: N:1 Account Contact Account Contact ID
All Fields
Field Name Field API Name Description Data
Type
Created Date ssot__CreatedDate__c The date the record was created. dateTime
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
471
Model Data in Data Cloud Survey Version DMO
Field Name Field API Name Description Data
Type
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
Description ssot__Description__c The survey subject description. text
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
survey subject.
Last Modified Date ssot__Last ModifiedDate__c The date when a user last modified the dateTime
record.
Name ssot__Name__c The name of the survey subject. text
Survey ssot__SurveyId__c A reference ID to the survey for the text
subject.
Survey Parent ssot__SurveyParentId__c A reference ID to the survey parent for text
the subject.
Survey Subject ssot__SurveySubjectId__c A reference ID to the subject for the text
survey subject.
Survey Subject Id ssot__Id__c A unique ID used as the primary key for text
the survey subject DMO.
Survey Subject Object ssot__SurveySubjectObject__c The subject object for the survey subject. text
Survey Version DMO
The Survey Version DMO is a Data Cloud data model object (DMO) for a version of the survey.
Object API Name
ssot__SurveyVersion__dlm
Category
Other
Primary Subject Area
Primary Key
Survey Version Id (ssot__Id__c)
472
Model Data in Data Cloud Survey Version DMO
Relationships
Object Field Cardinality Related Object Related Field
Survey Active Survey Version Many To One: N:1 Survey Version Survey Version ID
Survey Question Section Survey Version Many To One: N:1 Survey Version Survey Version ID
Survey Response Survey Version Many To One: N:1 Survey Version Survey Version ID
Survey Version Survey Many To One: N:1 Survey Survey ID
All Fields
Field Name Field API Name Description Data
Type
Created Date ssot__CreatedDate__c The date the record was created. dateTime
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
Description ssot__Description__c The survey version description. text
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
survey version.
Last Modified Date ssot__Last ModifiedDate__c The date when a user last modified the dateTime
record.
Name ssot__Name__c The name of the survey version. text
Survey ssot__SurveyId__c A reference ID to the survey for the text
version.
Survey Status ssot__SurveyStatus__c A status of the survey version. text
Survey Subject ssot__SurveySubjectId__c A reference ID to the subject for the text
survey subject.
Survey Version Id ssot__Id__c A unique ID used as the primary key for text
the survey version DMO.
Version Number ssot__VersionNumber__c A version number of the survey version. text
473
Model Data in Data Cloud User DMO
User DMO
The User DMO is a Data Cloud data model object (DMO) for an account, a person or a machine, that can log in to use the deployed
software system.
Object API Name
ssot__User__dlm
Category
Profile
Primary Subject Area
Primary Key
User Id (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Agent Service Presence User Many To One: N:1 User User ID
Agent Work User Many To One: N:1 User User ID
Case Assigned User Many To One: N:1 User User ID
Case Update Last Modified By Many To One: N:1 User User ID
Case Update Related Owner Many To One: N:1 User User ID
Email Message Created By Many To One: N:1 User User ID
Email Message Last Modified By Many To One: N:1 User User ID
User User Group Many To One: N:1 User Group User Group ID
All Fields
Field Name Field API Name Description Data
Type
About Me ssot__AboutMe__c The about me information for the user. text
Account ssot__AccountId__c A reference ID to the account for the user. text
Alias ssot__Alias__c The alias for the user. text
Badge Text ssot__BadgeText__c The badge text for the user. text
474
Model Data in Data Cloud User DMO
Field Name Field API Name Description Data
Type
Call Center ssot__CallCenterId__c A reference ID to the call center for the text
user.
Community Nickname ssot__CommunityNickname__c The community nickname for the user. dateTime
Company Name ssot__CompanyName__c The company name for the user. text
Contact ssot__ContactId__c A reference ID to the contact for the user. text
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DateSourceObjectId___c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
Delegated Approver ssot__DelegatedApproverId__c A reference ID to the delegated approver text
for the user.
Department ssot__Department__c The department for the user. text
Email ssot__Email__c The email address for the user. text
Email Encoding Key ssot__EmailEncodingKey__c The email encoding key for the user. text
Email Signature ssot__EmailSignature__c The email signature for the user. text
Extension ssot__Extension__c The phone extension for the user. text
First Name ssot__FirstName__c The first name for the user. text
Forecast Enabled ssot__ForecastEnabled__c An indicator if the forecast for the user is text
enabled.
Full Name ssot__FullName__c The full name for the user. text
Full Photo Url ssot__FullPhotoUrl__c The full photo URL for the user. text
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
user.
Is Active ssot__IsActive__c An indicator if the record is active. text
Language ssot__Language__c The language of the user. text
Last Login Date ssot__LastLoginDate__c The date when the user last logged in. dateTime
Last Name ssot__LastName__c The last name for the user. text
Last Password Change ssot__LastPasswordChangeDate__c The date when the user’s password was dateTime
Date last changed.
475
Model Data in Data Cloud User Group DMO
Field Name Field API Name Description Data
Type
Offline Pda Trial Expiration ssot__Offline The date when the user’s offline PDA trial dateTime
Date PdaTrialExpirationDate__c expires.
Offline Trial Expiration Date ssot__Offline The date when the user’s offline trial dateTime
TrialExpirationDate__c expires.
Receives Admin Info Emails ssot__ReceivesAdminInfoEmails__c An indicator if the user receives admin text
information emails.
Receives Info Emails ssot__ReceivesInfoEmails__c An indicator if the user receives text
information emails.
Sender Name ssot__SenderName__c The sender name for the user. text
Small Photo Url ssot__SmallPhotUrl__c The small photo URL for the user. text
Stay In Touch Note ssot__StayInTouchNote__c The text for the user’s stay in touch text
message.
Stay In Touch Signature ssot__StayInTouchSignature__c The signature for the user’s stay in touch text
message.
Stay In Touch Subject ssot__StayInTouchSubject__c The subject for the user’s stay in touch text
message.
Timezone ssot__Timezone__c The timezone for the user. text
Title ssot__Title__c The title for the user. text
User Group ssot__UserGroupId__c A reference ID to the user group for the text
user.
User Id ssot__Id__c A unique ID used as the primary key for text
the user DMO.
Username ssot__Username__c The username for the user. text
User Group DMO
The User Group DMO is a Data Cloud data model object (DMO) for a set of system users with common characteristics. User Groups are
often created to simplify the granting of system privileges and granting access to resources.
Object API Name
ssot__UserGroup__dlm
Category
Profile
476
Model Data in Data Cloud User Group DMO
Primary Subject Area
Primary Key
User Group Id (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Agent Work User Group Many To One: N:1 User Group User Group ID
User User Group Many To One: N:1 User Group User Group ID
User Group User Group Many To One: N:1 User Group User Group ID
All Fields
Field Name Field API Name Description Data
Type
Alias ssot__Alias__c The alias for the user group. text
Created Date ssot__CreatedDate__c The date the record was created. dateTime
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID for the logical name of the text
object where this record came from,
whether that is a name of a cloud storage
file or another connector’s external object.
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
user group.
Is Queue ssot__IsQueue__c An indicator if the user group is a queue. dateTime
Is Regular Group ssot__IsRegularGroup__c An indicator if the user group is a regular text
group.
Is Role ssot__IsRole__c An indicator if the user group is a role. text
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the dateTime
record.
Name ssot__Name___c The name of the user group. text
User Group ssot__UserGroupId__c A reference ID to the user group for the text
user group.
477
Model Data in Data Cloud Voucher DMO
Field Name Field API Name Description Data
Type
User Group ID ssot__Id__c A unique ID used as the primary key for text
the user group DMO.
Voucher DMO
The Voucher DMO is a Data Cloud data model object (DMO) for a loyalty program’s voucher.
Object API Name
ssot__Voucher__dlm
Category
Other
Primary Subject Area
Loyalty
Primary Key
Voucher ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Account Auto Payment Method Many To One: N:1 Voucher Voucher ID
Loyalty Transaction Payment Method Many To One: N:1 Voucher Voucher ID
Journal
Voucher Party Many To One: N:1 Individual Individual ID
Voucher Loyalty Benefit Many To One: N:1 Loyalty Benefit Loyalty Benefit ID
Voucher Loyalty Journal Subtype Many To One: N:1 Loyalty Journal Subtype Loyalty Journal Subtype
ID
Voucher Loyalty Transaction Many To One: N:1 Loyalty Transaction Loyalty Transaction
Journal Journal Journal ID
Voucher Promotion Many To One: N:1 Promotion Promotion ID
Voucher Account Many To One: N:1 Account Account ID
478
Model Data in Data Cloud Voucher DMO
All Fields
Field Name Field API Name Description Data
Type
Account ssot__AccountID__c A reference ID to the account where this text
voucher is associated with.
Created Date ssot__CreatedDate__c The date when the record was created. dateTime
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID to logical name of object text
where record originated, for example a
cloud storage file or another connector’s
external object.
Discount Percent ssot__DiscountPercent__c The reduction in price that the voucher number
holder is entitled to use, typically a
fraction of the original price.
Effective Date ssot__EffectiveDate__c The date when voucher goes into effect. dateTime
Expiration Date ssot__ExpirationDate__c The date when voucher expires. dateTime
External Record ID ssot__ExternalRecordId__c A reference ID to an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Face Value Amount ssot__FaceValueAmount__c The value amount of a voucher. number
Internal Organization ssot__InternalOrganizationId__c A reference ID to business unit or other text
internal organization that owns the
business account.
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the dateTime
record.
Loyalty Benefit ssot__LoyaltyBenefitId__c A reference ID to perk or betterment text
available to loyalty program members.
Examples include waived airline baggage
fees, complimentary hotel stays, or rental
car upgrades.
Loyalty Journal Subtype ssot__LoyaltyJournalSubtypeId__c A reference ID to subtype of the loyalty text
journal type entry, for example, a watched
video or a product review.
Loyalty Program Member ssot__LoyaltyProgramMemberId__c A reference ID to person who joined text
loyalty program.
479
Model Data in Data Cloud Voucher Definition DMO
Field Name Field API Name Description Data
Type
Loyalty Transaction Journal ssot__LoyaltyTransactionJournalId__c A reference ID to all transactions related text
to loyalty program.
Name ssot__Name__c The name of the voucher. text
Notes ssot__Notestext__c The reason why voucher was issued. text
Party ssot__PartyId__c A reference ID to the parent party, for text
example, an individual, business, or
affiliation group.
Payment Method Status ssot__PaymentMethodStatus__c The status of the payment method related text
to the voucher.
Payment Method Type ssot__PaymentMethodTypeId__c A reference ID to the type of voucher text
payment method.
Promotion ssot__PromotionId__c A reference ID to campaign that provides text
discounts or other reasons for adjusting
an order.
Used Date ssot__UsedDate__c The date when the voucher was used. dateTime
Voucher Definition ssot__VoucherDefinitionId__c A reference ID to main voucher from text
which instance vouchers awarded to
individual people are derived.
Voucher ID ssot__Id__c A unique ID used as primary key for the text
Voucher DMO.
Voucher Status ssot__VoucherStatusId__c A reference ID to status of voucher, for text
example, issued or expired.
Voucher Type ssot__VoucherTypeId__c A reference ID to type of voucher, for text
example, accrual or manual action.
Voucher Definition DMO
The Voucher Definition DMO is a Data Cloud data model object (DMO) for details about a voucher definition associated with a loyalty
program.
Object API Name
ssot__VoucherDefinition__dlm
Category
Other
480
Model Data in Data Cloud Voucher Definition DMO
Primary Subject Area
Loyalty
Primary Key
Voucher Definition ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Voucher Definition Partner Account Many To One: N:1 Account Account ID
Voucher Definition Voucher Expiration Type Many To One: N:1 Voucher Definition Voucher Definition ID
Promotion Default Voucher Many To One: N:1 Voucher Definition Voucher Definition ID
Definition
Voucher Definition Loyalty Program Many To One: N:1 Loyalty Program Loyalty Program ID
Voucher Voucher Definition Many To One: N:1 Voucher Definition Voucher Definition ID
All Fields
Field Name Field API Name Description Data
Type
Created Date ssot__CreatedDate__c The date when the record was created. dateTime
Data Source ssot__DataSourceId__c A reference ID for the logical name for a text
system that is the source of records
identified by external record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID to logical name of object text
where record originated, for example a
cloud storage file or another connector’s
external object.
Description ssot__Description__c The description of the voucher. text
Discount Percent ssot__DiscountPercent__c The reduction in price that a voucher number
holder is entitled to, typically shown as a
fraction of original price.
Effective Date ssot__EffectiveDate__c The date when voucher goes into effect. dateTime
Expiration Date ssot__ExpirationDate__c The date when voucher expires. dateTime
Expiration Period ssot__ExpirationPeriodnumber__c The quantity of time units defined by number
Expiration Period UOM.
481
Model Data in Data Cloud Web Search Engagement DMO
Field Name Field API Name Description Data
Type
Expiration Period UOM ssot__ExpirationPeriodUOM__c A reference ID to unit of time used to text
define expiration period of voucher, for
example days, weeks, or months.
External Record ID ssot__ExternalRecordId__c A reference ID to an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Face Value Amount ssot__FaceValueAmount__c The value amount of a voucher. number
Internal Organization ssot__InternalOrganizationId__c A reference ID to business unit or other text
internal organization that owns the
business account.
Is Active ssot__IsActive__c An indicator if the voucher is active. text
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the dateTime
record.
Loyalty Program ssot__LoyaltyProgramId__c A reference ID to marketing strategy text
designed to encourage customers to
continue shopping at or use services of a
business associated with the program.
Name ssot__Name__c The name of the voucher. text
Partner Account ssot__PartnerAccountId__c A reference ID to account of organization text
that partners in offering voucher.
Voucher Definition ID ssot__Id__c A unique ID used as primary key for the text
Voucher Definition DMO.
Voucher Expiration Type ssot__VoucherExpirationTypeId__c A reference ID to the expiration type. text
Voucher Status ssot__VoucherStatusId__c A reference ID to status of voucher, for text
example, issued, expired, or redeemed.
Voucher Type ssot__VoucherTypeId__c A reference ID to type of voucher, for text
example accrual or redemption.
Web Search Engagement DMO
The Web Search Engagement DMO is a Data Cloud data model object (DMO) for web search engagement data.
Object API Name
ssot__WebSearchEngagement__dlm
482
Model Data in Data Cloud Web Search Engagement DMO
Category
Engagement
Primary Subject Area
Engagement
Primary Key
Web Search Engagement ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Engagement Topic Engagement Many To One: N:1 Web Search Engagement Web Search Engagement
ID
Loyalty Transaction Engagement Many To One: N:1 Web Search Engagement Web Search Engagement
Journal ID
Web Search Engagement Account Contact Many To One: N:1 Account Contact Account Contact ID
Web Search Engagement Case Many To One: N:1 Case Case ID
Web Search Engagement Contact Point Many To One: N:1 Contact Point Address Contact Point Address ID
Web Search Engagement Contact Point Many To One: N:1 Contact Point App Contact Point App ID
Web Search Engagement Contact Point Many To One: N:1 Contact Point Email Contact Point Email ID
Web Search Engagement Contact Point Many To One: N:1 Contact Point Phone Contact Point Phone ID
Web Search Engagement Contact Point Many To One: N:1 Contact Point Social Contact Point Social ID
Web Search Engagement Engagement Asset Many To One: N:1 Device Application Device Application
Template Template ID
Web Search Engagement Engagement Publication Many To One: N:1 Email Publication Email Publication ID
Web Search Engagement Engagement Asset Many To One: N:1 Email Template Email Template ID
Web Search Engagement Engagement Channel Many To One: N:1 Engagement Channel Engagement Channel
Type Type Type ID
Web Search Engagement Individual Many To One: N:1 Individual Individual ID
Web Search Engagement Lead Many To One: N:1 Lead Lead ID
Web Search Engagement Market Journey Activity Many To One: N:1 Market Journey Activity Market Journey Activity
ID
Web Search Engagement Market Segment Many To One: N:1 Market Segment Market Segment ID
Web Search Engagement Engagement Publication Many To One: N:1 SMS Publication SMS Publication ID
483
Model Data in Data Cloud Web Search Engagement DMO
Object Field Cardinality Related Object Related Field
Web Search Engagement Engagement Asset Many To One: N:1 SMS Template SMS Template ID
Web Search Engagement Sales Order Many To One: N:1 Sales Order Sales Order ID
All Fields
Field Name Field API Name Description Data
Type
Account Contact ssot__AccountContactId__c A reference ID for the account contact. text
Action Cadence Step ssot__ActionCadenceStepId__c A reference ID for the action cadence text
step.
Browser Name ssot__BrowserName__c The name of client browser using website, text
entered as free text.
Case ssot__CaseId__c A reference ID to a support case. text
Contact Point ssot__ContactPointId__c A reference ID for the accounts’ contact text
point, for example, an address, an email,
social network handle.
Country ssot__CountryId__c A reference ID to country code associated text
with client's IP address.
Country Region Name ssot__CountryRegionId__c A reference ID to the region name text
associated with a client's IP address.
Created Date ssot__CreatedDate__c The date when the record was created. dateTime
Data Source ssot__DataSourceId__c A reference ID to logical name for system text
that is source of records identified by
External Record Id.
Data Source Object ssot__DataSourceObjectId__c A reference ID to logical name of object text
where record originated, for example a
cloud storage file or another connector’s
external object.
Device Country ssot__DeviceCountryId__c A reference ID for the country of a specific text
device.
Device IP Address ssot__DeviceIPAddress__c The IP address of the device. text
Device Latitude ssot__DeviceLatitude__c The geo latitude of the device when the number
engagement was recorded.
Device Locale ssot__DeviceLocaleId__c A reference ID for the user locale text
configured on the device.
Device Longitude ssot__DeviceLongitude__c The geo longitude of the device when number
the engagement was recorded.
484
Model Data in Data Cloud Web Search Engagement DMO
Field Name Field API Name Description Data
Type
Device Postal Code ssot__DevicePostalCode__c The postal code associated with the text
device.
Device Type ssot__DeviceTypeTxt__c The name of client device type using text
website, entered as free text.
Domain Name ssot__DomainName__c The domain name associated with client's text
IP address.
Engagement Asset ssot__EngagementAssetId__c A reference ID for the type of text
engagement asset.
Engagement Channel ssot__EngagementChannelId__c A reference ID for the engagement text
channel.
Engagement Channel ssot__EngagementChannelActionId__c A reference ID for the engagement action. text
Action
Engagement Channel Type ssot__EngagementChannelTypeId__c A reference ID for the engagement text
channel type.
Engagement Date Time ssot__EngagementDateTm__c The date and time of engagement. dateTime
Engagement Event ssot__EngagementEventDirectionId__c A reference ID for the engagement event text
Direction direction, for example, inbound or
outbound.
Engagement Notes ssot__EngagementNotesTxt__c The details about what transpired during text
the engagement.
Engagement Number ssot__EngagementNbr__c A user-facing ID for an engagement. text
Engagement Publication ssot__EngagementPublicationId__c A reference ID for a background process text
that generates volumes of emails, SMS,
or other engagement types.
Engagement Type ssot__EngagementTypeId__c A reference ID for one of the defined text
varieties of engagement, for example, an
email or phone engagement.
Engagement Vehicle ssot__EngagementVehicleId__c A reference ID for the vehicle through text
which the engagement was recorded.
External Record ID ssot__ExternalRecordId__c A reference ID to an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID for the system in which the text
external record ID was assigned.
Individual ssot__IndividualId__c A reference ID to contact for account. text
Internal Engagement Actor ssot__InternalEngagementActorId__c A reference ID for an internal engagement text
actor that groups the different types of
485
Model Data in Data Cloud Web Search Engagement DMO
Field Name Field API Name Description Data
Type
individuals who are targets of marketing
engagements.
Internal Organization ssot__InternalOrganizationId__c A reference ID to the business unit or text
other internal organization that owns the
business account.
IP Address ssot__IPAddr__c The IP address of a client using website. text
Is Test Send ssot__IsTestSend__c An indicator if the engagement record text
was generated as part of testing.
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the dateTime
record.
Lead ssot__LeadlId__c A reference ID for a person or company text
that showed interest in the company's
products.
Link URL ssot__LinkURL__c The URL that was used to access a text
software application or web page.
Market Audience ssot__MarketAudienceId__c A reference ID to a market audience or text
the people you want to reach with
marketing communication.
Market Journey Activity ssot__MarketJourneyActivityId__c A reference ID for a step or activity that a text
customer configures in the Salesforce
Journey Builder tool.
Market Segment ssot__MarketSegmentId__c A reference ID for a group of people who text
share one or more common
characteristics, grouped for marketing
purposes who are associated with this
engagement.
Marketing Email List ssot__MarketingEmailListId__c A reference ID for a set of email addresses text
that is used for marketing
communications.
Name ssot__Name__c The name of the engagement. text
OS Name ssot__OSName__c The name of operating system on a text
client’s device using the website.
Referrer ssot__Referrer__c A container that stores contextual data text
about the user's usage of the site or the
application that referred them to the
software application that generated the
engagement. For example, a campaign
or search advertisement.
486
Model Data in Data Cloud Web Search Engagement DMO
Field Name Field API Name Description Data
Type
Referrer URL text ssot__ReferrerURL__c The URL of the application that the user text
was using before being directed to the
software application that generated this
engagement.
Sales Order ssot__SalesOrderId__c A reference ID for the internal document text
generated by the seller.
Search Engine Name ssot__SearchEngineName__c The name of the search engine used by text
client, entered as free text.
Search Keywords text ssot__SearchKeywordsTxt__c The keywords used by client when text
searching.
Sent Date Time ssot__SentDateTm__c The date and time when the publication dateTime
or communication was sent.
Session ssot__SessionId__c A reference ID for the session used to text
group related events together.
Shopping Cart ssot__ShoppingCartId__c A reference ID for the shopping cart for text
data captured from user actions such as
adding and removing items from a
shopping cart.
Target Engagement Actor ssot__TargetEngagementActorId__c A reference ID for how groups of text
individuals are targeted for marketing
engagements, for example, leads.
Task ssot__TaskId__c A reference ID that represents a business text
activity such as making a phone call or
other to-do items.
Web Cookie ssot__WebCookieId__c A reference ID for a small piece of data text
sent from a website and stored on the
user's computer by the user's web
browser while the user is browsing.
Web Search Engagement ssot__Id__c A unique ID used as primary key for the text
ID Web Search Engagement DMO.
Web Session ID ssot__WebSessionId__c A reference ID to the web session text
identifier used to group related web
events together.
Workflow ssot__WorkflowId__c A reference ID for a sequence of steps or text
processes in a software application
through which a piece of work passes
from initiation to completion.
487
Model Data in Data Cloud Website Engagement DMO
Website Engagement DMO
The Website Engagement DMO is a Data Cloud data model object (DMO) for any data associated with website engagement, such as
views or clicks.
Object API Name
ssot__WebsiteEngagement__dlm
Category
Engagement
Primary Subject Area
Engagement
Primary Key
Website Engagement ID (ssot__Id__c)
Relationships
Object Field Cardinality Related Object Related Field
Engagement Topic Engagement Many To One: N:1 Website Engagement Website Engagement ID
Website Engagement Contact Point Many To One: N:1 Contact Point App Contact Point App ID
Website Engagement Contact Point Many To One: N:1 Contact Point Email Contact Point Email ID
Website Engagement Contact Point Many To One: N:1 Contact Point Social Contact Point Social ID
Website Engagement Contact Point Many To One: N:1 Contact Point Address Contact Point Address ID
Website Engagement Contact Point Many To One: N:1 Contact Point Phone Contact Point Phone ID
Engagement Individual Many To One: N:1 Individual Individual ID
Website Engagement Sales Order Many To One: N:1 Sales Order Sales Order ID
Website Engagement Account Contact Many To One: N:1 Account Contact Account Contact ID
Website Engagement Case Many To One: N:1 Case Case ID
Website Engagement Engagement Asset Many To One: N:1 Device Application Device Application
Template Template ID
Website Engagement Lead Many To One: N:1 Lead Lead ID
Website Engagement Engagement Asset ID Many To One: N:1 SMS Template SMS Template ID
Website Engagement Engagement Publication Many To One: N:1 Email Publication Email Publication ID
ID
488
Model Data in Data Cloud Website Engagement DMO
Object Field Cardinality Related Object Related Field
Website Engagement Engagement Asset ID Many To One: N:1 Email Template Email Template ID
Website Engagement Engagement Channel Many To One: N:1 Engagement Channel Engagement Channel
Type Type Type ID
Website Engagement Website Engagement ID Many To One: N:1 Loyalty Transaction Engagement ID
Journal
Website Engagement Market Journey Activity Many To One: N:1 Market Journey Activity Market Journey Activity
ID ID
Website Engagement Market Segment Many To One: N:1 Market Segment Market Segment ID
Website Engagement Engagement Publication Many To One: N:1 SMS Publication SMS Publication ID
All Fields
Field Name Field API Name Description Data
Type
Account Contact ssot__AccountContactId__c A reference ID to account contact. text
Action Cadence Step ssot__ActionCadenceStepId__c A reference ID to action cadence step. text
Browser Name ssot__BrowserName__c The name of the user’s browser. text
Case ssot__CaseId__c A reference ID to a recorded issue, for text
example laptop connectivity.
Contact Point ssot__ContactPointId__c A reference ID to accounts’ contact point, text
for example physical address, email
address, or phone number.
Country ssot__CountryId__c A reference ID to country derived from IP text
address of client.
Country Region ssot__CountryRegionId__c A reference ID for the country or region. text
Created Date ssot__CreatedDate__c The date a record was created. dateTime
Data Source ssot__DataSourceId__c A reference ID to logical name for system text
that is source of records identified by
External Record ID.
Data Source Object ssot__DataSourceObjectId__c A reference ID to logical name of object text
where record originated, for example a
cloud storage file or another connector’s
external object.
Device Country ssot__DeviceCountryId__c A reference ID to country where device text
is located.
Device IP Address ssot__DeviceIPAddress__c The IP address of device. text
489
Model Data in Data Cloud Website Engagement DMO
Field Name Field API Name Description Data
Type
Device Latitude ssot__DeviceLatitude__c The geo latitude of device when number
engagement was recorded.
Device Locale ssot__DeviceLocaleId__c A reference ID to user locale configured text
on device.
Device Longitude ssot__DeviceLongitude__c The geo longitude of device when number
engagement was recorded.
Device OS Name ssot__DeviceOSName__c The name of the device’s operating text
system.
Device Postal Code ssot__DevicePostalCode__c The postal code associated with device. text
Device Type ssot__DeviceTypeTxt__c A reference ID to type of device. text
Domain Name ssot__DomainName__c The domain name used for the text
engagement.
Engagement Asset ssot__EngagementAssetId__c A reference ID to engagement asset. text
Engagement Channel ssot__EngagementChannelId__c A reference ID to engagement channel. text
Engagement Channel ssot__EngagementChannelActionId__c A reference ID to engagement channel text
Action action.
Engagement Channel Type ssot__EngagementChannelTypeId__c A reference ID to the type of engagement text
channel.
Engagement Date Time ssot__EngagementDateTm__c The date and time of the user’s dateTime
engagement.
Engagement Event ssot__EngagementEventDirectionId__c A reference ID for the engagement event text
Direction direction, for example, inbound or
outbound.
Engagement Notes ssot__EngagementNotesTxt__c The details about what transpired during text
engagement.
Engagement Number ssot__EngagementNbr__c A user-facing ID that isn’t automatically text
set.
Engagement Publication ssot__EngagementPublicationId__c A reference ID to background process that text
generates volumes of email messages,
SMS messages, or other engagement
vehicle types.
Engagement Type ssot__EngagementTypeId__c A reference ID to the type of engagement, text
for example email or phone.
Engagement Vehicle ssot__EngagementVehicleId__c A reference ID to vehicle where text
engagement was recorded.
490
Model Data in Data Cloud Website Engagement DMO
Field Name Field API Name Description Data
Type
External Record ID ssot__ExternalRecordId__c A reference ID to an external data source text
system.
External Source ID ssot__ExternalSourceId__c A reference ID to the system’s external text
record ID.
Individual ssot__IndividualId__c A reference ID to contact for account. text
Internal Engagement Actor ssot__InternalEngagementActorId__c A reference ID to engagement actor that text
groups the different types of individuals
targeted for marketing engagements, for
example leads and account contacts.
Internal Organization ssot__InternalOrganizationId__c A reference ID to business unit or other text
internal organization that owns the
business account.
IP Address ssot__IPAddr__c The IP address of client visiting website. text
Is Test Send ssot__IsTestSend__c An indicator if the engagement record text
was generated as part of testing.
Last Modified Date ssot__LastModifiedDate__c The date when a user last modified the dateTime
record.
Lead ssot__LeadlId__c A reference ID to person or company that text
showed interest in products.
Link URL ssot__LinkURL__c A link where software application or web text
page accessed generated engagement.
Market Audience ssot__MarketAudienceId__c A reference ID to intended audience that text
engagement was designed to reach.
Market Journey Activity ssot__MarketJourneyActivityId__c A reference ID to step or activity that text
customer configures in Salesforce Journey
Builder tool for marketing associated with
engagement.
Market Segment ssot__MarketSegmentId__c A reference ID to group of people who text
share one or more common
characteristics, and are grouped for
marketing associated with engagement.
Marketing Email List ssot__MarketingEmailListId__c A reference ID to the marketing email list. text
Name ssot__Name__c The engagement’s name. text
Page URL ssot__PageURL__c The URL of web page that was visited. text
Referrer ssot__Referrer__c The method that generated user text
engagement, for example, a campaign or
advertisement.
491
Model Data in Data Cloud Website Engagement DMO
Field Name Field API Name Description Data
Type
Referrer URL ssot__ReferrerURL__c The URL of application that directed user text
to software application that generated
engagement.
Sales Order ssot__SalesOrderId__c A reference ID referring to the sales order. text
Sent Date Time ssot__SentDateTm__c The sent date and time of the dateTime
engagement.
Session ssot__SessionId__c A reference ID to the user session. text
Shopping Cart ssot__ShoppingCartId__c A reference ID to shopping cart for data text
captured from user actions, for example
adding or removing items from shopping
cart.
Target Engagement Actor ssot__TargetEngagementActorId__c A reference ID to engagement actor that text
groups different types of individuals
targeted for marketing associated with
engagement, for example leads and
account contacts.
Task ssot__TaskId__c A reference ID to business activity, for text
example making a phone call. In the user
interface, tasks and event records are
collectively referred to as activities.
Web Cookie ssot__WebCookieId__c A reference ID to small piece of data sent text
from website and stored on user's
computer by user's web browser while
user is browsing.
Web Session ID ssot__WebSessionId__c A reference ID for the web session. text
Website Engagement Id ssot__Id__c A unique ID used as primary key for the text
Website Engagement DMO.
Website Visit End Time ssot__VisitEndTm__c The date and time when the page was dateTime
last visited.
Website Visit Start Time ssot__VisitStartTm__c The date and time when the page was dateTime
first visited.
Workflow ssot__WorkflowId__c A reference ID to the sequence of steps text
or processes from initiation to
completion.
492
Model Data in Data Cloud Starter Data Bundles
Starter Data Bundles
A starter data bundle is a Salesforce-defined data stream definition that includes mapping from a data source to the Data Cloud DMO
structure. Bundles can be customized and some connectors offer multiple data bundle options.
When data is ingested from a data source, it’s stored in a data lake object (DLO). These DLOs represent your source data, whether that
is from a Salesforce source or an external data source. Find reference information about the starter bundles available for Data Cloud.
B2C Commerce: Bundles Product Mapping
After a data stream is deployed, the Salesforce B2C Commerce Order starter data bundle automatically maps source objects from
B2C Commerce to data model objects (DMO)s in Data Cloud. The Bundles Product object represents products that can be purchased
as a group. Bundle products can contain independent inventory records for the bundle and the product that make up the bundle.
B2C Commerce: Goods Product Mapping
After a data stream is deployed, the Salesforce B2C Commerce Order starter data bundle automatically maps source objects from
B2C Commerce to data model objects (DMO)s in Data Cloud. The Goods Product object represents hard goods that can be purchased.
B2C Commerce: Master Product Mapping
After a data stream is deployed, the Salesforce B2C Commerce Order starter data bundle automatically maps source objects from
B2C Commerce to data model objects (DMO)s in Data Cloud. The Master Product object is a container for some types of products.
Master products don’t have inventory records.
B2C Commerce: Product Catalog Mapping
After a data stream is deployed, the Salesforce B2C Commerce Order starter data bundle automatically maps source objects from
B2C Commerce to data model objects (DMO)s in Data Cloud. The Product Catalog object represents categories and products used
to organize merchandise.
B2C Commerce: Product Category Mapping
After a data stream is deployed, the Salesforce B2C Commerce Order starter data bundle automatically maps source objects from
B2C Commerce to data model objects (DMO)s in Data Cloud. The Product Category object represents categories of products.
B2C Commerce: Product Category Product Mapping
After a data stream is deployed, the Salesforce B2C Commerce Order starter data bundle automatically maps source objects from
B2C Commerce to data model objects (DMO)s in Data Cloud. The Product Category Product object represents categories of products.
B2C Commerce: Sales Order Mapping
After a data stream is deployed, the Salesforce B2C Commerce Order starter data bundle automatically maps source objects from
B2C Commerce to data model objects (DMO)s in Data Cloud. The Sales Order object represents an order.
B2C Commerce: Sales Order Customer Mapping
After a data stream is deployed, the Salesforce B2C Commerce Order starter data bundle automatically maps source objects from
B2C Commerce to data model objects (DMO)s in Data Cloud. The Sales Order Customer object represents a customer making an
order.
B2C Commerce: Sales Order Product Mapping
After a data stream is deployed, the Salesforce B2C Commerce Order starter data bundle automatically maps source objects from
B2C Commerce to data model objects (DMO)s in Data Cloud. The Sales Order Product object represents an order.
Commerce: Account Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Account data indicates how a shopper interacts with a store. For example, billing and shipping
information.
493
Model Data in Data Cloud Starter Data Bundles
Commerce: Coupon Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Coupon data shows the method for a buyer to compensate a seller for a purchased good or service.
Commerce: Fulfillment Order Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Fulfillment Order data is information about how a sales order is delivered to a customer and who
delivers it. For example, the warehouse that fills an order and the required information about the process.
Commerce: Fulfillment Order Line Item
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Fulfillment Order Line data is a shippable product or service that is part of a fulfillment order.
Commerce: Fulfillment Order Item Adjustment
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Fulfillment Order Item Adjustment data is a price adjustment that is calculated at the level of a specific
fulfillment order product.
Commerce: Fulfillment Order Item Tax
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Fulfillment Order Item Tax data is a tax that is calculated on the base price of a fulfillment order product.
Commerce: Location Group Product Exclusion Change Mapping
The Omnichannel Inventory connector for Data Cloud automatically maps the data source objects to the data model objects (DMO)
and establishes DMO relationships. The Location Group Product Exclusion Change object represents a change to the Location Group
Product Exclusion list.
Commerce: Location Group Product Inventory Change Mapping
The Omnichannel Inventory connector for Data Cloud automatically maps the data source objects to the data model objects (DMO)
and establishes DMO relationships. The Location Group Product Inventory Change object represents a change to product inventory
at a location group.
Commerce: Location Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Location data is the location that fulfills orders, such as a warehouse or a retail store.
Commerce: Location Product Inventory Change Mapping
The Omnichannel Inventory connector for Data Cloud automatically maps the data source objects to the data model objects (DMO)
and establishes DMO relationships. The Location Product Inventory Change object represents a change to product inventory at a
location.
Commerce: Order Adjustment Group Summary Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Order Adjustment Group Summary data is a change to the price of a product that’s made before order
fulfillment. A sales order price adjustment can be composed of sales order Product price adjustments that allocate the overall
adjustment amount to products and services.
Commerce: Order Delivery Method Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Order Delivery Method data is a standardized method for transferring purchased products or services
to the fulfillment destination. A delivery method characterized by the type of transportation used and by the delivering organization
or group.
494
Model Data in Data Cloud Starter Data Bundles
Commerce: Order Delivery Group Summary Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Order Delivery Group Summary data is information about the method that the buyer uses to compensate
a seller for a service or product purchased.
Commerce: Order Item Adjustment Line Summary Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Order Item Adjustment Line Summary data is information about a change to the price of a sales order
product that is made before order fulfillment. A sales order product price adjustment can stand alone or be related to a sales order
level adjustment.
Commerce: Order Item Summary Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Order Item Summary data is information about a component of a sales order that identifies a product
or service sold to the customer.
Commerce: Order Item Summary Change Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Order Item Summary Change data is a change log for a sales order.
Commerce: Order Item Tax Line Item Summary Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Order Item Tax Line Item Summary data is a charge imposed by a government entity. The tax types
are aligned to phases of the process: SalesOrderTax, FulfillmentProductTax, and ShipmentProductTax.
Commerce: Order Payment Summary Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Order Payment Summary data is about one or more payments that have the same payment method
applied to a single sales order.
Commerce: Order Summary Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Order Summary data is about an internal document generated by the seller indicating that the
customer is ready to purchase products and services.
Commerce: Payment Method Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Payment Method data refers to the method for a buyer to compensate a seller for a purchased good
or service.
Commerce: Process Exception Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Process Exception data is about events related to a business process or data that affects normal order
processing. Errors in programs or communication aren’t process exceptions, but can cause process exceptions.
Commerce: Product Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Product data is about the product that a company is selling. The Product object includes fields for
quantity and revenue.
Commerce: Product Attribute Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Product Attribute data is information about product attributes, for example, the type of material used
for ShoeXYZ.
495
Model Data in Data Cloud Starter Data Bundles
Commerce: Product Catalog Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Product Catalog data is a catalog used for a business process. For example, inventory or merchandising.
Commerce: Product Category Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Product Category data is about categories and subcategories organize and group products in your
catalog and on your storefront. For example, an outdoors outfitter site uses the Boots, Climbing Gear, and Outerwear categories to
organize products on their storefront.
Commerce: Product Category Product Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Product Category Product data is the assignment of a product to categories. For example, ShoeXYZ
is assigned to the Shoes and Running categories.
Commerce: Promotion Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Promotion data is any type of marketing communication used to inform or persuade target audiences
of the merits of a product, service, brand, or issue.
Commerce: Return Order Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Return Order data is about the return of order products in Salesforce Order Management.
Commerce: Return Order Item Adjustment Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Return Order Item Adjustment data is information about the change in price of the item in the return
order product.
Commerce: Return Order Item Tax Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Return Order Item Tax data is information about the tax amount adjustments made for the return
order product.
Commerce: Return Order Line Item Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Return Order Line Item data is information about a product that a customer has returned to the seller.
Commerce: Sales Channel Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Sales Channel data is the channel used to sell goods. For example, a web store or a retail store.
Commerce: Web Store Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Web Store data represents a Direct-to-Consumer (D2C) commerce store selling products to the public.
Commerce: Web Store Catalog Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Web Store Catalog data is information about the products available at a store. Each record in a
WebStoreCatalog data source object specifies a product catalog that organizes the products in a store.
Marketing Cloud Account Engagement: Email Activity Mapping
After a data stream is deployed, the Marketing Cloud Account Engagement data bundle maps source objects from Account
Engagement to data model objects (DMOs) in Data Cloud. The Email Activity object includes email engagement data.
496
Model Data in Data Cloud Starter Data Bundles
Marketing Cloud Engagement: Campaigns and Journeys Mappings
After a data stream is deployed, the Marketing Cloud Engagement starter data bundle automatically maps data from Marketing
Cloud Engagement to data model objects (DMO)s in Data Cloud. The Campaigns and Journeys data includes the following DLOs
and associated data streams: SFMC Campaign, SFMC Email Publication, SFMC Email Template, SFMC Journey, SFMC Journey Activity,
SFMC Push Template, SFMC SMS Template, and SFMC WhatsApp Message Template.
Marketing Cloud Engagement: Contact Mappings
After a data stream is deployed, the Marketing Cloud Engagement starter data bundle automatically maps data from Marketing
Cloud Engagement to data model objects (DMO)s in Data Cloud. Contact data includes the following system-generated DLOS and
associated data streams: SFMC Contact Point App, SFMC Contact Point Email, SFMC Contact Point Phone, SFMC Contact Point
WhatsApp, and SFMC Subscriber.
Marketing Cloud Engagement: Engagement Mappings
After a data stream is deployed, the Marketing Cloud Engagement starter data bundle automatically maps data from Marketing
Cloud Engagement to data model objects (DMO)s in Data Cloud. Engagement data includes the following system-generated DLOS
and associated data streams: SFMC EES Email Snapshot, SFMC EES Push Snapshot, SFMC Einstein Email Scores, SFMC Email Complaint,
SFMC Email Engagement Bounce, SFMC Email Engagement Click, SFMC Email Engagement Open, SFMC Email Engagement Send,
SFMC Email Unsubscribe, SFMC Msg Engagement Event, SFMC Push Engagement Event, SFMC Push Undeliver Event, SFMC WhatsApp
Tracking Event, SFMC WhatsApp MO Event, and SFMC WhatsApp Send Event.
Salesforce CRM: Account Mappings
After a data stream is deployed, the Salesforce CRM starter data bundle automatically maps data from Sales Cloud or Service Cloud
to data model objects (DMO)s in Data Cloud. The Sales Cloud and Service Cloud bundles deploy mappings to Contact Point type
DMOs. Identity Resolution uses the DMOs, which link multiple records into a unified customer profile.
Salesforce CRM: Agent Work Mapping
These data mappings are for the AgentWork DLO found in the Services bundle of the Salesforce CRM Connector for Data Cloud.
Salesforce CRM: Agent Work Skill Mapping
These data mappings are for the AgentWorkSkill DLO found in the Services bundle of the Salesforce CRM Connector for Data Cloud.
Salesforce CRM: Alert Mappings
These data mappings are for the Alert DLO found in the Financial Services Cloud bundle of the Salesforce CRM Connector for Data
Cloud.
Salesforce CRM: Benefit Mapping
These data mappings are for the Benefit DLO found in the Loyalty Management bundle of the Salesforce CRM Connector for Data
Cloud. Benefits are offered to members of a loyalty program. Benefits can be offered to members based on their assigned tier or
based on their engagement.
Salesforce CRM: Benefit Type Mapping
These data mappings are for the Benefit DLO found in the Loyalty Management bundle of the Salesforce CRM Connector for Data
Cloud. A benefit type is used to categorize benefits that are offered to members of the loyalty program.
Salesforce CRM: Business Hours
These data mappings are for the BusinessHours DLO found in the Services bundle of the Salesforce CRM Connector for Data Cloud.
Salesforce CRM: Card Mappings
These data mappings are for the Card DLO found in the Financial Services Cloud bundle of the Salesforce CRM Connector for Data
Cloud.
Salesforce CRM: Case Mappings
After a data stream is deployed, the Salesforce CRM starter data bundle automatically maps data from Sales Cloud or Service Cloud
to data model objects (DMO)s in Data Cloud. The Sales Cloud and Service Cloud bundles deploy mappings to Contact Point type
DMOs. Identity Resolution uses the DMOs, which link multiple records into a unified customer profile.
497
Model Data in Data Cloud Starter Data Bundles
Salesforce CRM: Case Article Mapping
These data mappings are for the CaseArticle DLO found in the Knowledge bundle of the Salesforce CRM Connector for Data Cloud.
Salesforce CRM: Case History 2 Mapping
These data mappings are for the CaseHistory2 DLO found in the Services bundle of the Salesforce CRM Connector for Data Cloud.
Salesforce CRM: Category Mapping
These data mappings are for the Category DLO found in the Loyalty Management bundle of the Salesforce CRM Connector for Data
Cloud. A category of products that the company sells.
Salesforce CRM: Contact Mappings
After a data stream is deployed, the Salesforce CRM starter data bundle automatically maps data from Sales Cloud or Service Cloud
to data model objects (DMO)s in Data Cloud. The Sales Cloud and Service Cloud bundles deploy mappings to Contact Point type
DMOs. Identity Resolution uses the DMOs, which link multiple records into a unified customer profile.
Salesforce CRM: Conversation Mapping
These data mappings are for the Conversation DLO found in the Services bundle of the Salesforce CRM Connector for Data Cloud.
Salesforce CRM: ConversationParticipant Mapping
These data mappings are for the ConversationParticipant DLO found in the Services bundle of the Salesforce CRM Connector for
Data Cloud.
Salesforce CRM: ConversationReason Mapping
These data mappings are for the ConversationReason DLO found in the Services bundle of the Salesforce CRM Connector for Data
Cloud.
Salesforce CRM: ConversationReasonExcerpt Mapping
These data mappings are for the ConversationReasonExcerpt DLO found in the Services bundle of the Salesforce CRM Connector
for Data Cloud.
Salesforce CRM: ConversationReasonGroup Mapping
These data mappings are for the ConverationReasonGroup DLO found in the Services bundle of the Salesforce CRM Connector for
Data Cloud.
Salesforce CRM: ConversationReasonReportDefinition Mapping
These data mappings are for the ConvReasonReportDefinition DLO used with the Salesforce CRM Connector found in the Services
bundle of the Salesforce CRM Connector for Data Cloud.
Salesforce CRM: ConvReasonReportSegmentDefinition Mapping
These data mappings are for the ConvReasonReportSegmentDefinition DLO found in the Services bundle of the Salesforce CRM
Connector for Data Cloud.
Salesforce CRM: Data Category Mapping
These data mappings are for the DataCategory DLO found in the Knowledge bundle of the Salesforce CRM Connector for Data Cloud.
Salesforce CRM: Email Message Mapping
These data mappings are for the EmailMessage DLO found in the Services bundle of the Salesforce CRM Connector for Data Cloud.
Salesforce CRM: Data Category Group Mapping
These data mappings are for the DataCategoryGroup DLO found in the Knowledge bundle of the Salesforce CRM Connector for Data
Cloud.
Salesforce CRM: Financial Account Mappings
These data mappings are for the FinancialAccount DLO found in Financial Services Cloud bundle of the Salesforce CRM Connector
for Data Cloud.
498
Model Data in Data Cloud Starter Data Bundles
Salesforce CRM: Financial Account Role Mappings
These data mappings are for the FinancialAccountRole DLO found in Financial Services Cloud bundle of the Salesforce CRM Connector
for Data Cloud.
Salesforce CRM: Financial Goal Mappings
These data mappings are for the FinancialGoal DLO found in Financial Services Cloud bundle of the Salesforce CRM Connector for
Data Cloud.
Salesforce CRM: Financial Goal Party Mappings
These data mappings are for the FinancialGoalParty DLO found in the Financial Services Cloud bundle of the Salesforce CRM Connector
for Data Cloud.
Salesforce CRM: Financial Holding Mappings
These data mappings are for the FinancialHolding DLO found in Financial Services Cloud bundle of the Salesforce CRM Connector
for Data Cloud.
Salesforce CRM: Group Mapping
These data mappings are for the Group DLO found in the Services bundle of the Salesforce CRM Connector for Data Cloud.
Salesforce CRM: Group Member Mapping
These data mappings are for the GroupMember DLO found in the Services bundle of the Salesforce CRM Connector for Data Cloud.
Salesforce CRM: Journal Subtype Mapping
These data mappings are for the Journal Subtype DLO found in the Loyalty Management bundle of the Salesforce CRM Connector
for Data Cloud. Journal subtypes help categorize the types of member activities for which transaction journals are created.
Salesforce CRM: Journal Type Mapping
These data mappings are for the Journal type DLO found in the Loyalty Management bundle of the Salesforce CRM Connector for
Data Cloud. A journal type is used to categorize transaction journals based on the types of members activities for which members
can be rewarded.
Salesforce CRM: Knowledge Article Mapping
These data mappings are for the Knowledge_ka DLO found in the Knowledge bundle of the Salesforce CRM Connector for Data
Cloud.
Salesforce CRM: Knowledge Article Engagement Mapping
The data mappings are for KnowledgeArticleView DLO created by the Knowledge Article Views Ingestion API for Data Cloud. The
mappings are for the KnowledgeArticleEngagement DMO
Salesforce CRM: Knowledge Article Version Mapping
These data mappings are for the Knowledge_kav DLO found in the Knowledge bundle of the Salesforce CRM Connector for Data
Cloud.
Salesforce CRM: Knowledge Data Category Selection Mapping
These data mappings are for the Knowledge_DataCategorySelection DLO found in the Knowledge bundle of the Salesforce CRM
Connector for Data Cloud.
Salesforce CRM: Linked Article Mapping
These data mappings are for the LinkedArticle DLO found in the Knowledge bundle of the Salesforce CRM Connector for Data Cloud.
Salesforce CRM: Lead Mappings
After a data stream is deployed, the Salesforce CRM starter data bundle automatically maps data from Sales Cloud or Service Cloud
to data model objects (DMO)s in Data Cloud. The Sales Cloud and Service Cloud bundles deploy mappings to Contact Point type
DMOs. Identity Resolution uses the DMOs, which link multiple records into a unified customer profile.
499
Model Data in Data Cloud Starter Data Bundles
Salesforce CRM: Loyalty Aggregated Point Expiration Ledger Mapping
These data mappings are for the Loyalty Aggregated Point Expiration Ledger DLO found in the Loyalty Management bundle of the
Salesforce CRM Connector for Data Cloud. A ledger that contains the details of a member’s fixed-type non-qualifying points that are
set to expire on a particular date.
Salesforce CRM: Loyalty Ledger Mapping
These data mappings are for the Loyalty Ledger DLO found in the Loyalty Management bundle of the Salesforce CRM Connector
for Data Cloud. A ledger contains information about credited, debited, or adjusted member activity points by transaction journals.
Salesforce CRM: Loyalty Member Currency Mapping
These data mappings are for the Loyalty Member Currency DLO found in the Loyalty Management bundle of the Salesforce CRM
Connector for Data Cloud. Information about the qualifying and non-qualifying currency points that are available in members’ point
balances.
Salesforce CRM: Loyalty Member Tier Mapping
These data mappings are for the Loyalty Member Tier DLO found in the Loyalty Management bundle of the Salesforce CRM Connector
for Data Cloud. A tier that is assigned to a member based on their engagement with the loyalty program.
Salesforce CRM: Loyalty Partner Product Mapping
These data mappings are for the Loyalty Partner Product DLO found in the Loyalty Management bundle of the Salesforce CRM
Connector for Data Cloud. This data refers to a product or service offered by a partner of the loyalty program to members of the
loyalty program. Members can accrue or redeem points by purchasing partner products or services.
Salesforce CRM: Loyalty Program Mapping
These data mappings are for the Loyalty Program DLO found in the Loyalty Management bundle of the Salesforce CRM Connector
for Data Cloud. This object includes data about a company’s loyalty program.
Salesforce CRM: Loyalty Program Badge Mapping
These data mappings are for the Loyalty Program Badge DLO found in the Loyalty Management bundle of the Salesforce CRM
Connector for Data Cloud. Data refers to a badge assigned to a member as a reward for engaging with the loyalty program.
Salesforce CRM: Loyalty Program Currency Mapping
These data mappings are for the Loyalty Program Currency DLO found in the Loyalty Management bundle of the Salesforce CRM
Connector for Data Cloud. Loyalty program credits points of a specific currency to members when they engage with the loyalty
program. Qualifying currency points help members qualify for tiers of the loyalty program. Members can redeem non-qualifying
currency points credited for their purchases.
Salesforce CRM: Loyalty Program Engagement Attribute Mapping
These data mappings are for the Loyalty Program Engagement Attribute DLO found in the Loyalty Management bundle of the
Salesforce CRM Connector for Data Cloud. An engagement attribute is used to track a member’s long-term behavior. For example,
an attribute can track a member’s cumulative monthly spend or the number of times the member has logged in to the company’s
shopping app.
Salesforce CRM: Loyalty Program Engagement Attribute Promotion Mapping
These data mappings are for the Loyalty Program Engagement Attribute Promotion DLO found in the Loyalty Management bundle
of the Salesforce CRM Connector for Data Cloud. Data refers to an association between a promotion and an engagement attribute.
Use engagement attributes to track the progress of loyalty program members towards achieving promotion targets.
Salesforce CRM: Loyalty Program Group Member Relationship Mapping
These data mappings are for the Loyalty Program Group Member Relationship DLO found in the Loyalty Management bundle of
the Salesforce CRM Connector for Data Cloud. This data includes the association between a loyalty program member and their
groups, along with details of a member’s points contribution towards the associated group.
500
Model Data in Data Cloud Starter Data Bundles
Salesforce CRM: Loyalty Program Member Mapping
These data mappings are for the Loyalty Program Member DLO found in the Loyalty Management bundle of the Salesforce CRM
Connector for Data Cloud. This data includes information about a member of the loyalty program and their individual or corporate
membership details.
Salesforce CRM: Loyalty Program Member Attribute Value Mapping
These data mappings are for the Loyalty Program Member Attribute Value DLO found in the Loyalty Management bundle of the
Salesforce CRM Connector for Data Cloud. This data refers to the value achieved by a loyalty program member for an engagement
attribute. A member’s progress towards the target for an engagement attribute is tracked across periods or for individual periods.
Salesforce CRM: Loyalty Program Member Badge Mapping
These data mappings are for the Loyalty Program Member Badge DLO found in the Loyalty Management bundle of the Salesforce
CRM Connector for Data Cloud. This data includes information about a badge assigned to a member as a reward for engaging with
the loyalty program.
Salesforce CRM: Loyalty Program Member Case Mapping
These data mappings are for the Loyalty Program Member Case DLO found in the Loyalty Management bundle of the Salesforce
CRM Connector for Data Cloud. Data refers to an association between a loyalty program member and a case created by the member.
Salesforce CRM: Loyalty Program Member Promotion Mapping
These data mappings are for the Loyalty Program Member Promotion DLO found in the Loyalty Management bundle of the Salesforce
CRM Connector for Data Cloud. Data about a member’s promotion usage. For cumulative type promotions, the member’s progress
is tracked towards achieving the target of the promotion.
Salesforce CRM: Loyalty Program Partner Mapping
These data mappings are for the Loyalty Program Partner DLO found in the Loyalty Management bundle of the Salesforce CRM
Connector for Data Cloud. Loyalty program partners offer their products and services to members of the loyalty program. Partners
can choose to allow members to accrue or redeem points by purchasing partner products. Partners can also run promotions in
collaboration with the loyalty program.
Salesforce CRM: Loyalty Program Partner Promotion Mapping
These data mappings are for the Loyalty Program Partner Promotion DLO found in the Loyalty Management bundle of the Salesforce
CRM Connector for Data Cloud. Data refers to a promotion that a loyalty program runs in collaboration with a loyalty program partner.
Salesforce CRM: Loyalty Tier Mapping
These data mappings are for the Loyalty Tier DLO found in the Loyalty Management bundle of the Salesforce CRM Connector for
Data Cloud. Tiers are used to categorize members based on their engagement with the loyalty program. The rewards and benefits
offered to members can differ based on their assigned tier. ...
Salesforce CRM: Loyalty Tier Benefit Mapping
These data mappings are for the Loyalty Tier Benefit DLO found in the Loyalty Management bundle of the Salesforce CRM Connector
for Data Cloud. A benefit that’s associated with a member’s tier in the loyalty program.
Salesforce CRM: Loyalty Tier Group Mapping
These data mappings are for the Loyalty Tier Group DLO found in the Loyalty Management bundle of the Salesforce CRM Connector
for Data Cloud. A tier group consists of a set of tiers that can be assigned to members based on their engagement with the loyalty
program.
Salesforce CRM: Member Benefit Mapping
These data mappings are for the Journal type DLO found in the Loyalty Management bundle of the Salesforce CRM Connector for
Data Cloud. A benefit that has been assigned to a member. Members are assigned benefits based on their tier or based on their
engagement with the loyalty program.
Salesforce CRM: Participant Mapping
These data mappings are for the Participant DLO found in the Services bundle of the Salesforce CRM Connector for Data Cloud.
501
Model Data in Data Cloud Starter Data Bundles
Salesforce CRM: Person Life Event Mappings
These data mappings are for the PersonLifeEvent DLO found in Financial Services Cloud bundle of the Salesforce CRM Connector
for Data Cloud.
Salesforce CRM: Product Mapping
These data mappings are for the Product DLO found in the Loyalty Management bundle of the Salesforce CRM Connector for Data
Cloud. A product that the company sells.
Salesforce CRM: Promotion Mapping
These data mappings are for the Promotion DLO found in the Loyalty Management bundle of the Salesforce CRM Connector for
Data Cloud. Information about a promotion that’s offered to members of a loyalty program.
Salesforce CRM: Promotion Loyalty Partner Product Mapping
These data mappings are for the Promotion Loyalty Partner Product DLO found in the Loyalty Management bundle of the Salesforce
CRM Connector for Data Cloud. A product that’s eligible for a promotion. Members are provided with the promotion’s reward when
they purchase a product that’s eligible for the promotion.
Salesforce CRM: Promotion Market Segment Mapping
These data mappings are for the Promotion Market Segment DLO found in the Loyalty Management bundle of the Salesforce CRM
Connector for Data Cloud. Promotions are associated with market segments that the promotions are targeted towards.
Salesforce CRM: Securities Mappings
These data mappings are for the Securities DLO found in Financial Services Cloud bundle of the Salesforce CRM Connector for Data
Cloud.
Salesforce CRM: Segment Mapping
These data mappings are for the Segment DLO found in the Loyalty Management bundle of the Salesforce CRM Connector for Data
Cloud. Segments in Data Cloud are used to determine the target audience for promotions and used to determine the type of rewards
provided to members.
Salesforce CRM: Service Presence Status Mapping
These data mappings are for the ServicePresenceStatus DLO found in the Services bundle of the Salesforce CRM Connector for Data
Cloud.
Salesforce CRM: Skill Mapping
These data mappings are for the Skill DLO found in the Services bundle of the Salesforce CRM Connector for Data Cloud.
Salesforce CRM: Survey Mapping
These data mappings are for the Survey DLO found in the Services bundle of the Salesforce CRM Connector for Data Cloud.
Salesforce CRM: Survey Invitation Mapping
These data mappings are for the SurveyInvitation DLO found in the Services bundle of the Salesforce CRM Connector for Data Cloud.
Salesforce CRM: Survey Page Mapping
These data mappings are for the SurveyPage DLO found in the Services bundle of the Salesforce CRM Connector for Data Cloud.
Salesforce CRM: Survey Question Mapping
These data mappings are for the SurveyQuestion DLO found in the Services bundle of the Salesforce CRM Connector for Data Cloud.
Salesforce CRM: Survey Question Response Mapping
These data mappings are for the SurveyQuestionResponse DLO found in the Services bundle of the Salesforce CRM Connector for
Data Cloud.
Salesforce CRM: Survey Response Mapping
These data mappings are for the SurveyResponse DLO found in the Services bundle of the Salesforce CRM Connector for Data Cloud.
502
Model Data in Data Cloud B2C Commerce: Bundles Product Mapping
Salesforce CRM: Survey Subject Mapping
These data mappings are for the SurveySubject DLO found in the Services bundle of the Salesforce CRM Connector for Data Cloud.
Salesforce CRM: Survey Version Mapping
These data mappings are for the SurveyVersion DLO found in the Services bundle of the Salesforce CRM Connector for Data Cloud.
Salesforce CRM: Topic Mappings
These data mappings are for the Topic DLO found in Financial Services Cloud bundle of the Salesforce CRM Connector for Data
Cloud.
Salesforce CRM: Transaction Journal Mapping
These data mappings are for the Transaction Journal DLO found in the Loyalty Management bundle of the Salesforce CRM Connector
for Data Cloud. Transaction journals are used to track member activities, member behavior, and adjustments.
Salesforce CRM: Unit of Measure Mapping
These data mappings are for the Unit of Measure DLO found in the Loyalty Management bundle of the Salesforce CRM Connector
for Data Cloud. The unit of measure for a product purchased by a loyalty program member.
Salesforce CRM: User Mapping
These data mappings are for the User DLO found in the Services bundle of the Salesforce CRM Connector for Data Cloud.
Salesforce CRM: User Role Mapping
These data mappings are for the UserRole DLO found in the Services bundle of the Salesforce CRM Connector for Data Cloud.
Salesforce CRM: User Service Presence Mapping
These data mappings are for the UserServicePresence DLO found in the Services bundle of the Salesforce CRM Connector for Data
Cloud.
Salesforce CRM: Voucher Mapping
These data mappings are for the Voucher DLO found in the Loyalty Management bundle of the Salesforce CRM Connector for Data
Cloud. Data is about a voucher issued to a loyalty program member.
Salesforce CRM: Voucher Definition Mapping
These data mappings are for the Voucher Definition DLO found in the Loyalty Management bundle of the Salesforce CRM Connector
for Data Cloud. A voucher definition is a template that used to issue vouchers to members of a loyalty program.
B2C Commerce: Bundles Product Mapping
After a data stream is deployed, the Salesforce B2C Commerce Order starter data bundle automatically maps source objects from B2C
Commerce to data model objects (DMO)s in Data Cloud. The Bundles Product object represents products that can be purchased as a
group. Bundle products can contain independent inventory records for the bundle and the product that make up the bundle.
DLO to DMO Mapping
These data mappings relate to the Bundles Product object used with the B2C Commerce connector. You can add or customize the data
mappings.
DLO Field DLO Field Data Type DMO DMO Field Name
brand text Bundle Product Brand
longDescription text Bundle Product Product Long Description
manufacturerName text Bundle Product Manufacturer Name
503
Model Data in Data Cloud B2C Commerce: Goods Product Mapping
DLO Field DLO Field Data Type DMO DMO Field Name
minOrderQuantityValue number Bundle Product Minimum Order Quantity
Count
name text Bundle Product Product Name
productId text Bundle Product Bundle Product Id
shortDescription text Bundle Product Product Description
sku text Bundle Product Product SKU
validFrom text Bundle Product Valid From Date
validTo text Bundle Product Valid To Date
B2C Commerce: Goods Product Mapping
After a data stream is deployed, the Salesforce B2C Commerce Order starter data bundle automatically maps source objects from B2C
Commerce to data model objects (DMO)s in Data Cloud. The Goods Product object represents hard goods that can be purchased.
DLO to DMO Mapping
These data mappings relate to the Goods Product object used with the B2C Commerce connector. You can add or customize the data
mappings.
DLO Field DLO Field Data Type DMO DMO Field Name
brand text Goods Product Brand
longDescription text Goods Product Product Long Description
manufacturerName text Goods Product Manufacturer Name
masterProductId text Goods Product Master Product
minOrderQuantityValue number Goods Product Minimum Order Quantity
Count
name text Goods Product Product Name
productId text Goods Product Product Id
shortDescription text Goods Product Product Description
sku text Goods Product Product SKU
validFrom text Goods Product Valid From Date
validTo text Goods Product Valid To Date
504
Model Data in Data Cloud B2C Commerce: Master Product Mapping
Note: Where possible, we changed noninclusive terms to align with our company value of Equality. We retained noninclusive
terms to document a third-party system, but we encourage the developer community to embrace more inclusive language. We
can update the term when it’s no longer required for technical accuracy.
B2C Commerce: Master Product Mapping
After a data stream is deployed, the Salesforce B2C Commerce Order starter data bundle automatically maps source objects from B2C
Commerce to data model objects (DMO)s in Data Cloud. The Master Product object is a container for some types of products. Master
products don’t have inventory records.
DLO to DMO Mapping
These data mappings relate to the Master Product object used with the B2C Commerce connector. You can add or customize the data
mappings.
DLO Field DLO Field Data Type DMO DMO Field Name
brand text Master Product Brand
longDescription text Master Product Product Long Description
manufacturerName text Master Product Manufacturer Name
minOrderQuantityValue number Master Product Minimum Order Quantity
Count
name text Master Product Product Name
productId text Master Product Master Product Id
shortDescription text Master Product Product Description
sku text Master Product Product SKU
validFrom text Master Product Valid From Date
validTo text Master Product Valid To Date
Note: Where possible, we changed noninclusive terms to align with our company value of Equality. We retained noninclusive
terms to document a third-party system, but we encourage the developer community to embrace more inclusive language. We
can update the term when it’s no longer required for technical accuracy.
B2C Commerce: Product Catalog Mapping
After a data stream is deployed, the Salesforce B2C Commerce Order starter data bundle automatically maps source objects from B2C
Commerce to data model objects (DMO)s in Data Cloud. The Product Catalog object represents categories and products used to organize
merchandise.
505
Model Data in Data Cloud B2C Commerce: Product Category Mapping
DLO to DMO Mapping
These data mappings relate to the Product Catalog object used with the B2C Commerce connector. You can add or customize the data
mappings.
DLO Field DLO Field Data Type DMO DMO Field Name
catalogId text Product Catalog Product Catalog Id
createdDate date Product Catalog Created Date
displayName text Product Catalog Product Catalog Name
B2C Commerce: Product Category Mapping
After a data stream is deployed, the Salesforce B2C Commerce Order starter data bundle automatically maps source objects from B2C
Commerce to data model objects (DMO)s in Data Cloud. The Product Category object represents categories of products.
DLO to DMO Mapping
These data mappings relate to the Product Category object used with the B2C Commerce connector. You can add or customize the
data mappings.
DLO Field DLO Field Data Type DMO DMO Field Name
catalogId text Product Category Product Catalog Id
name text Product Category Category Name
unique_id text Product Category Product Category Product
ID
unique_id text Product Category ProductCategoryProduct
Product
unique_parentCategoryId text Product Category Parent Category
unique_productCategoryId text Product Category Product Category
Product
validFrom date Product Category Active From Date
validTo date Product Category Active To Date
B2C Commerce: Product Category Product Mapping
After a data stream is deployed, the Salesforce B2C Commerce Order starter data bundle automatically maps source objects from B2C
Commerce to data model objects (DMO)s in Data Cloud. The Product Category Product object represents categories of products.
506
Model Data in Data Cloud B2C Commerce: Sales Order Mapping
DLO to DMO Mapping
These data mappings relate to the Product Category Product object used with the B2C Commerce connector. You can add or customize
the data mappings.
DLO Field DLO Field Data Type DMO DMO Field Name
unique_id text Product Category Product Category Product
Product Id
unique_productCategoryId text Product Category Product Category
Product
productId text Product Category Product
Product
B2C Commerce: Sales Order Mapping
After a data stream is deployed, the Salesforce B2C Commerce Order starter data bundle automatically maps source objects from B2C
Commerce to data model objects (DMO)s in Data Cloud. The Sales Order object represents an order.
DLO to DMO Mapping
These data mappings relate to the Sales Order object used with the B2C Commerce connector. You can add or customize the data
mappings.
DLO Field DLO Field Data Type DMO DMO Field Name
currencyCodeAlpha3 text Sales Order Currency Code
text Sales Order Total Product Amount
Currency
text Sales Order Total Product Tax Amount
Currency
number Sales Order Total Delivery Amount
Currency
text Sales Order Total Amount Currency
grandTotalGrossPrice number Sales Order Grand Total Amount
grossDiscountPrice number Sales Order Total Adjustment Amount
orderPlacedTimestamp date Sales Order Created Date
shippingGrossPrice number Sales Order Total Delivery Amount
shippingTax number Sales Order Total Delivery Tax Amount
subtotalGrossPrice number Sales Order Total Product Amount
subtotalTax number Sales Order Total Product Tax Amount
507
Model Data in Data Cloud B2C Commerce: Sales Order Customer Mapping
DLO Field DLO Field Data Type DMO DMO Field Name
unique_id text Sales Order Sales Order Id
visitorId text Sales Order Sold To Customer
text Sales Order Account Id
text Sales Order Bill to Account
text Sales Order Party
B2C Commerce: Sales Order Customer Mapping
After a data stream is deployed, the Salesforce B2C Commerce Order starter data bundle automatically maps source objects from B2C
Commerce to data model objects (DMO)s in Data Cloud. The Sales Order Customer object represents a customer making an order.
DLO to DMO Mapping
These data mappings relate to the Sales Order Customer object used with the B2C Commerce connector. You can add or customize the
data mappings. Ensure that these data model objects (DMO) fields are mapped as custom fields to the Individual DMO.
Note: These fields are case-sensitive.
The visitorID data field is mapped from the Sales Order Customer DLO to the Individual ID field on the Individual DMO via the Order
Bundle. This mapping is required for activation.
DLO Field DLO Field DMO DMO Field Name
Data Type
customerId text Individual CustomerId
customerListId text Individual CustomerListId
customerNo text Individual CustomerNo
usid number Individual UsId
buyerEmail text ContactPointEmail Email Address
customerProfileBirthday text Individual Birth Date
customerProfileCreationDate date Individual Created Date
date ContactPointPhone Created Date
customerProfileFirstName text Individual First Name
customerProfileLastName text Individual Last Name
customerProfilePhoneHome text ContactPointPhone Telephone Number
invoiceToAddressAddress1 text ContactPointAddress Address Line 1
invoiceToAddressAddress2 text ContactPointAddress Address Line 2
invoiceToAddressCity text ContactPointAddress City
508
Model Data in Data Cloud B2C Commerce: Sales Order Product Mapping
DLO Field DLO Field DMO DMO Field Name
Data Type
invoiceToAddressCountryCode text ContactPointAddress Country
invoiceToAddressPostalCode text ContactPointAddress Postal Code
invoiceToAddressPostBox text ContactPointAddress Address Line 3
invoiceToAddressStateCode text ContactPointAddress State Province
orderPlacedTimestamp date Individual Last Modified Date
orderPlacedTimestamp date ContactPointEmail Last Modified Date
visitorId text Individual Individual Id
text ContactPointEmail Contact Point Email Id
text ContactPointEmail Party
text ContactPointPhone Contact Point Phone Id
text ContactPointPhone Party
text ContactPointAddress Contact Point Address Id
text ContactPointAddress Party
B2C Commerce: Sales Order Product Mapping
After a data stream is deployed, the Salesforce B2C Commerce Order starter data bundle automatically maps source objects from B2C
Commerce to data model objects (DMO)s in Data Cloud. The Sales Order Product object represents an order.
DLO to DMO Mapping
These data mappings relate to the Sales Order Product object used with the B2C Commerce connector. You can add or customize the
data mappings.
DLO Field DLO Field DMO DMO Field Name
Data Type
currencyCodeAlpha3 text Sales Order Product Discount Amount Currency
text Sales Order Product List Price Amount Currency
text Sales Order Product Unit Price Amount Currency
text Sales Order Product Unit Tax Amount Currency
discountAmount number Sales Order Product Discount Amount
orderPlacedTimestamp date Sales Order Product Created Date
date Sales Order Product Last Modified Date
productId text Sales Order Product Product
509
Model Data in Data Cloud Commerce: Account Mapping
DLO Field DLO Field DMO DMO Field Name
Data Type
quantityValue number Sales Order Product Ordered Quantity
unique_id text Sales Order Product Sales Order Product
unique_orderId text Sales Order Product Sales Order
unitGrossPrice number Sales Order Product List Price Amount
unitGrossPriceAfterDiscounts number Sales Order Product Unit Price Amount
unitTax number Sales Order Product Unit Price Amount
Commerce: Account Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Account data indicates how a shopper interacts with a store. For example, billing and shipping information.
DLO to DMO Mapping
These data mappings relate to the Account object included in the Salesforce Commerce connector and how that data connects to
DMOs.
DLO Field DLO Field Data Type DMO DMO Field Name
Id ID Account id
AccountNumber string Account AccountNumber
Description textarea Account Description
LastActivityDate date Account LastActivityDate
Name string Account Name
ParentId picklist Account ParentAccountId
Type picklist Account AccountTypeId
CreatedDate dateTime Account CreatedDate
LastModifiedDate dateTime Account LastModifiedDate
Commerce: Coupon Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Coupon data shows the method for a buyer to compensate a seller for a purchased good or service.
DLO to DMO Mapping
These data mappings relate to the Coupon object included in the Salesforce Commerce connector and how that data connects to DMOs.
510
Model Data in Data Cloud Commerce: Fulfillment Order Mapping
DLO Field DLO Field Data Type DMO DMO Field Name
Id ID Coupon and id
CouponDefinition
CurrencyIsoCode picklist Coupon and CurrencyCode
CouponDefinition
CouponCode string Coupon and CouponCode
CouponDefinition
CouponNumber string Coupon and ScanCode
CouponDefinition
PromotionId reference Coupon and PromotionId
CouponDefinition
Status picklist Coupon and CouponStatusId
CouponDefinition
Commerce: Fulfillment Order Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Fulfillment Order data is information about how a sales order is delivered to a customer and who delivers
it. For example, the warehouse that fills an order and the required information about the process.
DLO to DMO Mapping
These data mappings relate to the FulfillmentOrder object included in the Salesforce Commerce connector and how that data connects
to DMOs.
DLO Field DLO Field Data Type DMO DMO Field Name
Id ID FulfillmentOrder id
AccountNumber reference FulfillmentOrder AccountId
BillToContactId reference FulfillmentOrder BillToContactId
CurrencyIsoCode picklist FulfillmentOrder CurrencyCode
DeliveryMethodId reference FulfillmentOrder OrderDeliveryMethodId
FulfilledToCountry string FulfillmentOrder FufilledToCountryCodeId
FulfilledToEmailAddress email FulfillmentOrder FulfilledToEmailAddressId
FulfilledToLatitude double FulfillmentOrder FufilledToLatitudeCode
FulfilledToLongitude double FulfillmentOrder FufilledToLongitudeCode
FulfilledToName string FulfillmentOrder FulfilledToNm
FulfilledToPhone phone FulfillmentOrder FulfilledToPhoneId
511
Model Data in Data Cloud Commerce: Fulfillment Order Line Item
DLO Field DLO Field Data Type DMO DMO Field Name
FulfillmentOrderNumber string FulfillmentOrder FulfillmentOrderNumber
GrandTotalAmount currency FulfillmentOrder GrandTotalAmount
IsReship boolean FulfillmentOrder isReship
IsSuspended boolean FulfillmentOrder isSuspended
ItemCount double FulfillmentOrder TotalItemCount
OrderSummaryId reference FulfillmentOrder SalesOrderId?
Status picklist FulfillmentOrder FulfillmentStatusId
StatusCategory picklist FulfillmentOrder FulfillmentStatusCategoryId
TaxLocaleType picklist FulfillmentOrder TaxationPolicyId
TotalAdjustmentAmount currency FulfillmentOrder TotalAdjustmentAmount
TotalAdjustmentAmtWithTax FulfillmentOrder TotalAdjustmentWithTaxAmount
TotalAdjustmentTaxAmount FulfillmentOrder TotalAdjustmentTaxAmount
TotalAmount currency FulfillmentOrder TotalAmount
TotalDeliveryAdjustAmount currency FulfillmentOrder TotalDeliveryAdjAmount
TotalDeliveryAdjustAmtWithTax currency FulfillmentOrder ATotalDeliveryAdjstWithTaxAmount
TotalDeliveryAdjustTaxAmount currency FulfillmentOrder TotalDeliveryAdjTaxAmount
TotalDeliveryAmount currency FulfillmentOrder TotalDeliveryAmount
TotalDeliveryAmtWithTax currency FulfillmentOrder TotalDeliveryWithTaxAmount
TotalDeliveryTaxAmount currency FulfillmentOrder TotalDeliveryTaxAmount
TotalProductAmount currency FulfillmentOrder TotalProductAmount
TotalProductAmtWithTax currency FulfillmentOrder TotalProductWithTaxAmount
TotalProductTaxAmount currency FulfillmentOrder TotalProductTaxAmount
TotalTaxAmount currency FulfillmentOrder TotalTaxAmount
Type picklist FulfillmentOrder FulfillmentTypeId
TypeCategory picklist FulfillmentOrder FulfillmentTypeCategoryId
SystemModstamp dateTime FulfillmentOrder SystemModstamp
Commerce: Fulfillment Order Line Item
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Fulfillment Order Line data is a shippable product or service that is part of a fulfillment order.
512
Model Data in Data Cloud Commerce: Fulfillment Order Item Adjustment
DLO to DMO Mapping
These data mappings relate to the FulfillmentOrderLineItem object included in the Salesforce Commerce connector and how that data
connects to DMOs.
DLO Field DLO Field Data Type DMO DMO Field Name
Id ID FulfillmentOrderProduct id
Description string FulfillmentOrderProduct Description
EndDate dateTime FulfillmentOrderProduct RequestedEndDate
FulfillmentOrderId reference FulfillmentOrderProduct FulfillmentOrderId
FulfillmentOrderLineItemNumber string FulfillmentOrderProduct Number
GrossUnitPrice currency FulfillmentOrderProduct
OrderItemSummaryId reference FulfillmentOrderProduct SalesOrderProductId
CurrencyIsoCode picklist FulfillmentOrderProduct
OriginalQuantity double FulfillmentOrderProduct OriginalQuantity
Product2Id reference FulfillmentOrderProduct InventoryProductId
Quantity double FulfillmentOrderProduct FulfilledQuantity
QuantityUnitOfMeasure string FulfillmentOrderProduct QuantityUnitOfMeasureId
ServiceDate date FulfillmentOrderProduct ProvisioningDate
TotalAdjustmentAmount currency FulfillmentOrderProduct TotalAdjustmentAmount
TotalAdjustmentTaxAmount currency FulfillmentOrderProduct TotalOrderProductAdjTaxAmount
TotalAmount currency FulfillmentOrderProduct
TotalLineAmount currency FulfillmentOrderProduct ProductAmount
TotalLineAmountWithTax currency FulfillmentOrderProduct
TotalLineTaxAmount currency FulfillmentOrderProduct TotalProductTaxAmount
TotalPrice currency FulfillmentOrderProduct GrandTotalAmount
TotalTaxAmount currency FulfillmentOrderProduct TotalTaxAmount
UnitPrice currency FulfillmentOrderProduct UnitPriceAmount
SystemModstamp dateTime FulfillmentOrderProduct SystemModstamp
Commerce: Fulfillment Order Item Adjustment
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Fulfillment Order Item Adjustment data is a price adjustment that is calculated at the level of a specific
fulfillment order product.
513
Model Data in Data Cloud Commerce: Fulfillment Order Item Tax
DLO to DMO Mapping
These data mappings relate to the FulfillmentOrderItemAdjustment object included in the Salesforce Commerce connector and how
that data connects to DMOs.
DLO Field DLO Field Data Type DMO DMO Field Name
Id ID FulfilmentOrderProductPriceAdjustment id
FulfillmentOrderItemAdjustmentNumber string FulfilmentOrderProductPriceAdjustment FulfOrderProdtPriceAdjNbrText
FulfillmentOrderLineItemId reference FulfilmentOrderProductPriceAdjustment FulfillmentOrderProductId
OrderItemAdjustLineSummaryId reference FulfilmentOrderProductPriceAdjustment SalesOrderProductPriceAdjustment
Amount currency FulfilmentOrderProductPriceAdjustment AdjustmentAmount
TotalTaxAmount currency FulfilmentOrderProductPriceAdjustment TotalAdjustmentTaxAmount
TotalAmtWithTax currency FulfilmentOrderProductPriceAdjustment TotalAdjustmentAmount
Description reference FulfilmentOrderProductPriceAdjustment Description
SystemModstamp dateTime FulfilmentOrderProductPriceAdjustment SystemModstamp
Commerce: Fulfillment Order Item Tax
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Fulfillment Order Item Tax data is a tax that is calculated on the base price of a fulfillment order product.
DLO to DMO Mapping
These data mappings relate to the FulfillmentOrderItemTax object included in the Salesforce Commerce connector and how that data
connects to DMOs.
DLO Field DLO Field Data Type DMO DMO Field Name
Id ID FulfillmentOrderProductTax id
TaxEffectiveDate date FulfillmentOrderProductTax TaxEffectiveDate
FulfillmentOrderItemTaxNumber string FulfillmentOrderProductTax Number
FulfillmentOrderLineItemId reference FulfillmentOrderProductTax FulfillmentOrderProductId
Rate percent FulfillmentOrderProductTax TaxRatePercent
CurrencyIsoCode picklist FulfillmentOrderProductTax CurrencyIsoCode
Amount currency FulfillmentOrderProductTax FulfillmentOrderProductTaxAmount
Type picklist FulfillmentOrderProductTax FulfillmentOrderTaxType
SystemModstamp dateTime FulfillmentOrderProductTax SystemModstamp
514
Model Data in Data Cloud Commerce: Location Group Product Exclusion Change
Mapping
Commerce: Location Group Product Exclusion Change Mapping
The Omnichannel Inventory connector for Data Cloud automatically maps the data source objects to the data model objects (DMO) and
establishes DMO relationships. The Location Group Product Exclusion Change object represents a change to the Location Group Product
Exclusion list.
Usage and Data Bundle
These mappings are used to power Commerce Intelligence visualizations of inventory performance metrics.
Bundle:
• Salesforce CDP Salesforce Commerce
DLO to DMO Mapping
These data mappings relate to the Location Group Product Exclusion Change object used with the Omnichannel Inventory connector.
DLO Field DLO Field Data Type DMO DMO Field Name
Location_Grp_Product text Location Group Product Id
Exclusion_Change_Id Exclusion Change
CONCAT(Group, SKU,
Location,
Last_Modified_Date)
SKU text Location Group Product SKUNumber
Exclusion Change
Last_Modified_Date dateTime Location Group Product ChangeDateTime
Exclusion Change
Is_Deleted boolean Location Group Product IsDeleted
Exclusion Change
Group text Location Group Product ExternalLocationGroupIdentifier
Exclusion Change
Location text Location Group Product ExternalLocationIdentifier
Exclusion Change
Commerce: Location Group Product Inventory Change Mapping
The Omnichannel Inventory connector for Data Cloud automatically maps the data source objects to the data model objects (DMO) and
establishes DMO relationships. The Location Group Product Inventory Change object represents a change to product inventory at a
location group.
Usage and Data Bundle
These mappings are used to power Commerce Intelligence visualizations of inventory performance metrics.
Bundle:
515
Model Data in Data Cloud Commerce: Location Mapping
• Salesforce CDP Salesforce Commerce
DLO to DMO Mapping
These data mappings relate to the Location Group Product Inventory Change object used with the Omnichannel Inventory connector.
DLO Field DLO Field Data Type DMO DMO Field Name
Location_Grp_Product text Location Group Product Id
Inventory_Change_Id Inventory Change
CONCAT(Group, SKU,
Last_Modified_Date)
Available_to_Fulfill number Location Group Product AvailableToFulfillQuantity
Inventory Change
Availalbe_to_Order number Location Group Product AvailableToOrderQuantity
Inventory Change
On_Hand number Location Group Product OnHandQuantity
Inventory Change
SKU text Location Group Product SKUNumber
Inventory Change
Last_Modified_Date dateTime Location Group Product ChangeDateTime
Inventory Change
Group text Location Group Product ExternalLocationGroupIdentifier
Inventory Change
Is_Deleted boolean Location Group Product IsDeleted
Inventory Change
Soft_Reserved number Location Group Product GroupReservedQuantity
Inventory Change
Reserved number Location Group Product ReservedQuantity
Inventory Change
Shared_Soft_Reserved number Location Group Product SharedGroupReservedQuantity
Inventory Change
Safety_Stock_Count number Location Group Product SafetyStockQuantity
Inventory Change
Commerce: Location Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Location data is the location that fulfills orders, such as a warehouse or a retail store.
516
Model Data in Data Cloud Commerce: Location Product Inventory Change Mapping
DLO to DMO Mapping
These data mappings relate to the Location object included in the Salesforce Commerce connector and how that data connects to
DMOs.
DLO Field DLO Field Data Type DMO DMO Field
Id ID Location id
LocationType picklist Location LocationTypeId
Latitude double Location GeoLatitude
Longitude double Location GeoLongitude
ParentLocationId reference Location ParentLocationId
PossessionDate date Location PossessionDate
ConstructionStartDate date Location ConstructionStartDate
ConstructionEndDate date Location ConstructionEndDate
OpenDate date Location
CloseDate date Location CloseDate
RemodelStartDate date Location RemodelStartDate
RemodelEndDate date Location RemodelEndDate
AddressId reference Location VisitorAddressId
Commerce: Location Product Inventory Change Mapping
The Omnichannel Inventory connector for Data Cloud automatically maps the data source objects to the data model objects (DMO) and
establishes DMO relationships. The Location Product Inventory Change object represents a change to product inventory at a location.
Usage and Data Bundle
These mappings are used to power Commerce Intelligence visualizations of inventory performance metrics.
Bundle:
• Salesforce CDP Salesforce Commerce
DLO to DMO Mapping
These data mappings relate to the Location Product Inventory Change object used with the Omnichannel Inventory connector.
DLO Field DLO Field Data Type DMO DMO Field Name
Location_Product_Inventory_Change_Id text Location Product Id
Inventory Change
CONCAT(Location, SKU,
Last_Modified_Date)
517
Model Data in Data Cloud Commerce: Order Adjustment Group Summary Mapping
DLO Field DLO Field Data Type DMO DMO Field Name
Available_to_Fulfill number Location Product AvailableToFulfillQuantity
Inventory Change
Available_to_Order number Location Product AvailableToOrderQuantity
Inventory Change
Effective_Date dateTime Location Product EffectiveDateTime
Inventory Change
On_Hand number Location Product OnHandQuantity
Inventory Change
SKU text Location Product SKUNumber
Inventory Change
Last_Modified_Date dateTime Location Product ChangeDateTime
Inventory Change
Location text Location Product ExternalLocationIdentifier
Inventory Change
Is_Deleted boolean Location Product IsDeleted
Inventory Change
Reserved number Location Product ReservedQuantity
Inventory Change
Safety_Stock_Count number Location Product SafetyStockQuantity
Inventory Change
Commerce: Order Adjustment Group Summary Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Order Adjustment Group Summary data is a change to the price of a product that’s made before order
fulfillment. A sales order price adjustment can be composed of sales order Product price adjustments that allocate the overall adjustment
amount to products and services.
DLO to DMO Mapping
These data mappings relate to the OrderAdjustmentGroupSummary object included in the Salesforce Commerce connector and how
that data connects to DMOs.
DLO Field DLO Field DMO DMO Field Name
Data Type
Id ID PriceAdjustmentGroup id
Name string PriceAdjustmentGroup Name
Description textarea SalesOrderPriceAdjustment Description
PriceAdjustmentGroup
518
Model Data in Data Cloud Commerce: Order Delivery Method Mapping
DLO Field DLO Field DMO DMO Field Name
Data Type
CurrencyIsoCode picklist SalesOrderPriceAdjustment CurrencyId
PriceAdjustmentGroup
Type picklist PriceAdjustmentGroup SalesOrderPriceAdjustmentTypeID
OrderSummaryId picklist SalesOrderPriceAdjustment SalesOrderId
AdjustmentBasisReferenceId reference SalesOrderPriceAdjustment CouponId
AdjustmentCauseId reference SalesOrderPriceAdjustment PromotionId
OriginalOrderItemAdjGroupId reference SalesOrderPriceAdjustment OriginalPriceAdjustmentGroupId
GrandTotalAmount currency SalesOrderPriceAdjustment GrandTotalAmount
TotalAmount currency SalesOrderPriceAdjustment AdjustmentAmount
TotalTaxAmount currency SalesOrderPriceAdjustment TotalAdjustmentTaxAmount
SystemModstamp dateTime SalesOrderPriceAdjustment/PriceAdjustmentGroup SystemModstamp
Commerce: Order Delivery Method Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Order Delivery Method data is a standardized method for transferring purchased products or services to
the fulfillment destination. A delivery method characterized by the type of transportation used and by the delivering organization or
group.
DLO to DMO Mapping
These data mappings relate to the OrderDeliveryMethod object included in the Salesforce Commerce connector and how that data
connects to DMOs.
DLO Field DLO Data Type DMO DMO Field Name
Id ID OrderDeliveryMethod id
Name string OrderDeliveryMethod Name
ProductId reference OrderDeliveryMethod ProductId
Carrier picklist OrderDeliveryMethod OrderDeliverySupplierAccountId
ClassOfService picklist OrderDeliveryMethod SupplierClassOfService
Description textarea OrderDeliveryMethod Description
CreatedDate dateTime OrderDeliveryMethod CreatedDate
LastModifiedDate dateTime OrderDeliveryMethod LastModifiedDate
519
Model Data in Data Cloud Commerce: Order Delivery Group Summary Mapping
Commerce: Order Delivery Group Summary Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Order Delivery Group Summary data is information about the method that the buyer uses to compensate
a seller for a service or product purchased.
DLO to DMO Mapping
These data mappings relate to the OrderDeliveryGroupSummaryobject included in the Salesforce Commerce connector and how that
data connects to DMOs.
DLO Field DLO Field Data DMO DMO Field Name
Type
Id ID SalesOrderDeliveryGroup id
OrderSummaryId reference SalesOrderDeliveryGroup SalesOrderId
CurrencyIsoCode picklist SalesOrderDeliveryGroup TotalDeliveryChargeAmountCurrencyId
TotalDeliveryAmountCurrencyId
OrderDeliveryMethodId reference SalesOrderDeliveryGroup OrderDeliveryMethodId
OriginalOrderDeliveryGroupId reference SalesOrderDeliveryGroup OriginalDeliveryGroupId
Description textarea SalesOrderDeliveryGroup Description
SystemModstamp dateTime SalesOrderDeliveryGroup SystemModstamp
GiftMessage textarea SalesOrderDeliveryGroup GiftMessageText
IsGift boolean SalesOrderDeliveryGroup IsGift
DeliveryInstructions textarea SalesOrderDeliveryGroup DeliveryInstructionsText
DesiredDeliveryDate dateTime SalesOrderDeliveryGroup DesiredDeliveryDate
PromisedDeliveryDate dateTime SalesOrderDeliveryGroup PromisedDate
TotalLineAmount currency SalesOrderDeliveryGroup TotalDeliveryChargeAmount
TotalLineTaxAmount currency SalesOrderDeliveryGroup TotalDeliveryChargeTaxAmount
TotalAdjustmentAmount currency SalesOrderDeliveryGroup TotalDeliveryAdjustmentAmount
TotalAdjustmentTaxAmount currency SalesOrderDeliveryGroup TotalDeliveryAdjustmentTaxAmount
TotalAmount currency SalesOrderDeliveryGroup TotalPriceAmount
TotalTaxAmount currency SalesOrderDeliveryGroup TotalDeliveryTaxAmount
GrandTotalAmount currency SalesOrderDeliveryGroup GrandTotalDeliveryAmount
TotalAdjustmentAmtWithTax currency SalesOrderDeliveryGroup TotalWithTaxAdjustmentAmount
TotalLineAmt currency SalesOrderDeliveryGroup TotalWithTaxDelivChargeAmount
520
Model Data in Data Cloud Commerce: Order Item Adjustment Line Summary Mapping
Commerce: Order Item Adjustment Line Summary Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Order Item Adjustment Line Summary data is information about a change to the price of a sales order
product that is made before order fulfillment. A sales order product price adjustment can stand alone or be related to a sales order level
adjustment.
DLO to DMO Mapping
These data mappings relate to the OrderItemAdjustmentLineSummaryobject included in the Salesforce Commerce connector and how
that data connects to DMOs.
DLO Field DLO Field Data Type DMO DMO Field Name
Id ID SalesOrderProductPriceAdjustment id
ProductAdjustmentGroup
Name string PriceAdjustmentGroup Name
Description textarea SalesOrderProductPriceAdjustment Description
ProductAdjustmentGroup
OrderSummaryId picklist SalesOrderProductPriceAdjustment SalesOrderId
AdjustmentBasisReferenceId reference PriceAdjustmentGroup CouponId
AdjustmentCauseId reference PriceAdjustmentGroup PromotionId
OriginalOrderItemAdjustmentLineItemId reference PriceAdjustmentGroup OriginalPriceAdjustmentGroupId
TotalAmtWithTax currency SalesOrderProductPriceAdjustment SalesOrderProductPriceAdjustmentAmount
Amount currency SalesOrderProductPriceAdjustment AdjustmentAmount
ProductAdjustmentGroup
TotalTaxAmount currency SalesOrderProductPriceAdjustment AdjustmentTaxAmount
SystemModstamp dateTime SalesOrderProductPriceAdjustment SystemModstamp
ProductAdjustmentGroup
Commerce: Order Item Summary Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Order Item Summary data is information about a component of a sales order that identifies a product or
service sold to the customer.
DLO to DMO Mapping
These data mappings relate to the OrderItemSummary object included in the Salesforce Commerce connector and how that data
connects to DMOs.
521
Model Data in Data Cloud Commerce: Order Item Summary Mapping
DLO Field DLO Field Data DMO DMO Field Name
Type
Id ID SalesOrderProduct id
OrderSummaryId reference SalesOrderProduct SalesOrderId
CurrencyIsoCode picklist SalesOrderProduct UnitTaxAmountCurrency
ShippingCostAmountCurrency
ShippingTaxAmountCurrency
HandlingCostAmountCurrency
ListPriceAmountCurrency
DiscountAmountCurrency
UnitPriceAmountCurrency
OrderDeliveryGroupSummaryId reference SalesOrderProduct SalesOrderDeliveryGroupId
Product2Id reference SalesOrderProduct ProductId
ProductCode string SalesOrderProduct OrderProductNumber
Type picklist SalesOrderProduct SalesOrderProductTypeId
TypeCode picklist SalesOrderProduct SalesOrderProductSubTypeId
CreatedDate dateTime SalesOrderProduct CreatedDate
SystemModstamp dateTime SalesOrderProduct SystemModstamp
ListPrice currency SalesOrderProduct ListPriceAmount
UnitPrice currency SalesOrderProduct UnitPriceAmount
TotalPrice currency SalesOrderProduct TotalPriceAmount
AdjustedLineAmount currency SalesOrderProduct AdjustedSalesOrderProductAmount
TotalAdjustedLineTaxAmount currency SalesOrderProduct TotalTaxAmount
GrossUnitPrice currency SalesOrderProduct GrossUnitPriceAmount
TotalAdjustmentAmtWithTax currency SalesOrderProduct TotalWithTaxAdjustmentAmount
AdjustedLineAmtWithTax currency SalesOrderProduct WithTaxAdjustedLineAmount
TotalLineAdjustmentAmtWithTax currency SalesOrderProduct TotalWithTaxLineAdjustmentAmount
TotalAdjustmentDistAmtWithTax currency SalesOrderProduct TotalWithTaxDistAdjustmentAmount
TotalAmtWithTax currency SalesOrderProduct SalesOrderProductAdjustedTaxAmount
TotalLineAmountWithTax currency SalesOrderProduct TotalWithTaxLineAmount
QuantityAllocated double SalesOrderProduct AllocatedQuantity
522
Model Data in Data Cloud Commerce: Order Item Summary Change Mapping
DLO Field DLO Field Data DMO DMO Field Name
Type
QuantityOrdered double SalesOrderProduct OrderedQuantity
QuantityFulfilled double SalesOrderProduct QuantityFulfilled
QuantityReturned double SalesOrderProduct ProductReturnedQuantity
QuantityNetOrdered double SalesOrderProduct AvailableQuantity
TotalTaxAmount currency SalesOrderProduct TotalTaxAmount
TotalAdjustmentAmount currency SalesOrderProduct TotalAdjustmentAmount
TotalAdjustmentTaxAmount currency SalesOrderProduct TotalAdjustmentTaxAmount
TotalLineAmount currency SalesOrderProduct TotalLineAmount
TotalLineTaxAmount currency SalesOrderProduct TotalProductTaxAmount
TotalLineAdjustmentAmount currency SalesOrderProduct TotalLineAdjustmentAmount
TotalLineAdjustmentTaxAmount currency SalesOrderProduct TotalAdjustmentTaxAmount
TotalAdjustmentDistAmount currency SalesOrderProduct TotalDistributedAdjustmentAmount
TotalAdjustmentDistTaxAmount currency SalesOrderProduct TotalDistributedAdjustmentTaxAmount
ServiceDate date SalesOrderProduct PromisedDate
RequestedStartDate
Status picklist SalesOrderProduct SalesOrderProductStatusId
Description textarea SalesOrderProduct Description
PricebookEntryId reference SalesOrderProduct PricebookEntryId
Commerce: Order Item Summary Change Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Order Item Summary Change data is a change log for a sales order.
DLO to DMO Mapping
These data mappings relate to the OrderItemSummaryChange object included in the Salesforce Commerce connector and how that
data connects to DMOs.
DLO Field DLO Field Data Type DMO DMO Field Name
Id ID SalesOrderChangeLog id
ChangeOrderItemId reference SalesOrderChangeLog ChangeSalesOrderProductId
523
Model Data in Data Cloud Commerce: Order Item Tax Line Item Summary Mapping
DLO Field DLO Field Data Type DMO DMO Field Name
OrderSummaryId reference SalesOrderChangeLog RelatedSalesOrderId
ChangeSalesOrderId
OrderItemSummaryId reference SalesOrderChangeLog RelatedSalesOrderProductId
OrderItemSummaryChangeNumber string SalesOrderChangeLog SalesOrderChangeLogName
SystemModstamp dateTime SalesOrderChangeLog SystemModstamp
Commerce: Order Item Tax Line Item Summary Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Order Item Tax Line Item Summary data is a charge imposed by a government entity. The tax types are
aligned to phases of the process: SalesOrderTax, FulfillmentProductTax, and ShipmentProductTax.
DLO to DMO Mapping
These data mappings relate to the OrderItemTaxLineItemSummary object included in the Salesforce Commerce connector and how
that data connects to DMOs.
DLO Field DLO Field Data Type DMO DMO Field Name
Id ID SalesOrderProductTax id
Tax
Amount currency SalesOrderProductTax SalesOrderTaxAmount
TaxAmount
CurrencyIsoCode picklist Tax CurrencyId
Description textarea SalesOrderProductTax Description
Tax
Name string SalesOrderProductTax Name
Tax
OrderItemAdjustmentLineSummaryId reference Tax SalesOrderProductPriceAdjTaxId
OrderItemSummaryId reference SalesOrderProductTax SalesOrderProductId
OriginalOrderItemTaxLineItemId reference SalesOrderProductTax OriginalSalesOrderProductTaxId
Rate percent Tax TaxRatePercent
TaxEffectiveDate date SalesOrderProductTax TaxEffectiveDate
Type picklist SalesOrderProductTax SalesOrderTaxTypeId
Tax
524
Model Data in Data Cloud Commerce: Order Payment Summary Mapping
DLO Field DLO Field Data Type DMO DMO Field Name
SystemModstamp dateTime Tax SystemModstamp
Commerce: Order Payment Summary Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Order Payment Summary data is about one or more payments that have the same payment method
applied to a single sales order.
DLO to DMO Mapping
These data mappings relate to the OrderPaymentSummary object included in the Salesforce Commerce connector and how that data
connects to DMOs.
DLO Field DLO Field Data Type DMO DMO Field Name
Id ID SalesOrderPaymentSummary id
OrderSummaryId reference SalesOrderPaymentSummary SalesOrderId
CurrencyIsoCode picklist SalesOrderPaymentSummary PaymentAmountCurrency
Method string SalesOrderPaymentSummary Name
PaymentMethodId reference SalesOrderPaymentSummary PaymentMethodId
SystemModstamp dateTime SalesOrderPaymentSummary SystemModstamp
AuthorizationReversalAmount currency SalesOrderPaymentSummary AuthorizationReversalAmount
AuthorizationAmount currency SalesOrderPaymentSummary AuthorizationAmount
CapturedAmount currency SalesOrderPaymentSummary CapturedAmount
BalanceAmount currency SalesOrderPaymentSummary AvailableToApplyBalanceAmount
Commerce: Order Summary Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Order Summary data is about an internal document generated by the seller indicating that the customer
is ready to purchase products and services.
DLO to DMO Mapping
These data mappings relate to the OrderSummary object included in the Salesforce Commerce connector and how that data connects
to DMOs.
DLO Field DLO Field Data DMO DMO Field
Type
Id ID SalesOrder id
525
Model Data in Data Cloud Commerce: Order Summary Mapping
DLO Field DLO Field Data DMO DMO Field
Type
OwnerId reference SalesOrder OwnerUserId
CurrencyIsoCode picklist SalesOrder CurrencyCode
OrderNumber string SalesOrder OrderNumber
CreatedDate dateTime SalesOrder CreatedDate
SystemModstamp dateTime SalesOrder SystemModstamp
OriginalOrderId reference SalesOrder OriginalOrderId
AccountId reference SalesOrder SoldToCustomerId
TotalAmount currency SalesOrder TotalAmount
GrandTotalAmount currency SalesOrder GrandTotalAmount
TotalAdjDistAmount currency SalesOrder TotalAdjustmentAmount
TotalAdjDistTaxAmount currency SalesOrder TotalAdjustmentTaxAmount
TaxLocaleType picklist SalesOrder TaxationPolicyId
TaxationPolicy
OrderedDate dateTime SalesOrder CheckoutDate
TotalTaxAmount currency SalesOrder TotalTaxAmount
Status picklist SalesOrder SalesOrderStatusId
SalesOrderSystemStatusId
Description textarea SalesOrder Description
SalesStoreId reference SalesOrder SalesStoreId
MobileStoreSalesStoreId
RetailStoreSalesStoreId
WarehouseSalesStoreId
WebStoreSalesStoreId
SalesChannelId reference SalesOrder SalesChannelId
PoNumber string SalesOrder PurchaseOrderNumber
PoDate dateTime SalesOrder PurchaseOrderDate
TotalProductAmount currency SalesOrder TotalProductAmount
TotalDeliveryAmount currency SalesOrder TotalDeliveryAmount
TotalAdjustedProductAmount currency SalesOrder AdjustedTotalProductAmount
526
Model Data in Data Cloud Commerce: Payment Method Mapping
DLO Field DLO Field Data DMO DMO Field
Type
TotalAdjustedDeliveryAmount currency SalesOrder AdjustedTotalDeliveryAmount
TotalProductAdjDistAmount currency SalesOrder TotalProductAdjustmentDistAmount
TotalDeliveryAdjDistAmount currency SalesOrder TotalDeliveryAdjustmentDistAmount
TotalProductTaxAmount currency SalesOrder TotalProductTaxAmount
TotalDeliveryTaxAmount currency SalesOrder TotalDeliveryTaxAmount
TotalAdjustedProductTaxAmount currency SalesOrder AdjustedProductTaxAmount
TotalAdjustedDeliveryTaxAmount currency SalesOrder TotalAdjustedDeliveryTaxAmount
TotalProductAdjDistTaxAmount currency SalesOrder TotalProductAdjDistTaxAmount
TotalDeliveryAdjDistTaxAmount currency SalesOrder TotalDeliveryAdjDistTaxAmount
BillToContactId reference SalesOrder BillToContactId
ExternalReferenceIdentifier string SalesOrder externalRecordId
TotalProductAmountWithTax currency SalesOrder TotalWithTaxProductAmount
TotalDeliveryAmountWithTax currency SalesOrder TotalWithTaxDeliveryAmount
TotalAdjProductAmtWithTax currency SalesOrder TotalWithTaxProductAdjDistAmount
TotalAdjDeliveryAmtWithTax currency SalesOrder TotalWithTaxAdjDeliveryAmount
TotalProductAdjDistAmtWithTax currency SalesOrder TotalWithTaxAdjProductAmount
TotalDeliveryAdjDistAmtWithTax currency SalesOrder TotalWithTaxDeliveryAdjDistAmount
TotalAdjDistAmountWithTax currency SalesOrder OrderDiscount
IsSuspended boolean SalesOrder IsSuspended
BusinessModel picklist SalesOrder BusinessModel
Commerce: Payment Method Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Payment Method data refers to the method for a buyer to compensate a seller for a purchased good or
service.
DLO to DMO Mapping
These data mappings relate to the PaymentMethod object included in the Salesforce Commerce connector and how that data connects
to DMOs.
527
Model Data in Data Cloud Commerce: Process Exception Mapping
DLO Field DLO Field Data Type DMO DMO Field Name
Id ID PaymentMethod id
AccountId reference PaymentMethod AccountId
Status picklist PaymentMethod PaymentMethodStatus
Commerce: Process Exception Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Process Exception data is about events related to a business process or data that affects normal order
processing. Errors in programs or communication aren’t process exceptions, but can cause process exceptions.
DLO to DMO Mapping
These data mappings relate to the ProcessException object included in the Salesforce Commerce connector and how that data connects
to DMOs.
DLO Field DLO Field Data Type DMO DMO Field Name
Id ID ProcessException id
CaseId reference ProcessException CaseId
Category picklist ProcessException ProcessExceptionCategoryId
Description textarea ProcessException Description
ExternalReference string ProcessException Message
Message string ProcessException Message
OrderSummaryId reference ProcessException SalesOrderId
Priority picklist ProcessException ProcessExceptionPriorityId
Severity picklist ProcessException ProcessExceptionSeverityId
SeverityCategory picklist ProcessException ProcessExceptionSeverityCategoryId
Status picklist ProcessException ProcessExceptionStatusId
StatusCategory picklist ProcessException ProcessExceptionStatusCategoryId
SystemModstamp dateTime ProcessException SystemModstamp
Commerce: Product Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Product data is about the product that a company is selling. The Product object includes fields for quantity
and revenue.
528
Model Data in Data Cloud Commerce: Product Attribute Mapping
DLO to DMO Mapping
These data mappings relate to the Product object included in the Salesforce Commerce connector and how that data connects to DMOs.
DLO Field DLO Field Data Type DMO DMO Field Name
Id ID XProduct id
CurrencyIsoCode picklist XProduct mSRPAmountCurrency
Description textarea XProduct Description
Family picklist XProduct ProductFamilyId
Name string XProduct Name
ProductCode string XProduct ProductCode
QuantityUnitOfMeasure picklist XProduct QuantityUnitOfMeasure
StockKeepingUnit string XProduct productSKU
Type picklist XProduct productType
Serialized boolean XProduct IsSerialized
Commerce: Product Attribute Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Product Attribute data is information about product attributes, for example, the type of material used for
ShoeXYZ.
DLO to DMO Mapping
These data mappings relate to the ProductAttribute object included in the Salesforce Commerce connector and how that data connects
to DMOs.
DLO Field DLO Field Data Type DMO DMO Field Name
Id ID ProductAttribute id
ProductId reference ProductAttribute ProductId
VariantParentId reference ProductAttribute VariantParentId
Name string ProductAttribute Name
Commerce: Product Catalog Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Product Catalog data is a catalog used for a business process. For example, inventory or merchandising.
529
Model Data in Data Cloud Commerce: Product Category Mapping
DLO to DMO Mapping
These data mappings relate to the ProductCatalog object included in the Salesforce Commerce connector and how that data connects
to DMOs.
DLO Field DLO Field Data Type DMO DMO Field Name
Id ID ProductCatalog id
Name string ProductCatalog Name
CreatedDate dateTime ProductCatalog CreatedDate
LastModifiedDate dateTime ProductCatalog LastModifiedDate
Commerce: Product Category Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Product Category data is about categories and subcategories organize and group products in your catalog
and on your storefront. For example, an outdoors outfitter site uses the Boots, Climbing Gear, and Outerwear categories to organize
products on their storefront.
DLO to DMO Mapping
These data mappings relate to the ProductCategory object included in the Salesforce Commerce connector and how that data connects
to DMOs.
DLO Field DLO Field Data Type DMO DMO Field Name
Id ID ProductCategory id
CatalogId reference ProductCategory productCatalogId
ParentCategoryId reference ProductCategory parentCategoryId
Description textarea ProductCategory Description
Name string ProductCategory Name
CreatedDate dateTime ProductCategory CreatedDate
LastModifiedDate dateTime ProductCategory LastModifiedDate
Commerce: Product Category Product Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Product Category Product data is the assignment of a product to categories. For example, ShoeXYZ is
assigned to the Shoes and Running categories.
530
Model Data in Data Cloud Commerce: Promotion Mapping
DLO to DMO Mapping
These data mappings relate to the ProductCategoryProduct object included in the Salesforce Commerce connector and how that data
connects to DMOs.
DLO Field DLO Field Data Type DMO DMO Field Name
Id ID ProductCategoryProduct id
ProductCategoryId reference ProductCategoryProduct productCategoryId
CreatedDate dateTime ProductCategoryProduct CreatedDate
LastActivityDate dateTime ProductCategoryProduct lastModifiedDate
ProductId reference ProductCategoryProduct productId
Commerce: Promotion Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Promotion data is any type of marketing communication used to inform or persuade target audiences of
the merits of a product, service, brand, or issue.
DLO to DMO Mapping
These data mappings relate to the Promotion object included in the Salesforce Commerce connector and how that data connects to
DMOs.
DLO Field DLO Field Data Type DMO DMO Field Name
Id ID Promotion id
CurrencyIsoCode picklist Promotion LoyaltyProgramCurrencyId
CurrencyId
DisplayName string Promotion DisplayName
Objective textarea Promotion ObjectiveText
Description string Promotion Description
EndDateTime dateTime Promotion EndDate
StartDateTime dateTime Promotion StartDate
IsActive boolean Promotion IsActive
IsAutomatic boolean Promotion IsAutomatic
IsCommercePromotion boolean Promotion IsCommercePromotion
Name string Promotion Name
PriorityNumber int Promotion EvaluationOrderRankNbr
531
Model Data in Data Cloud Commerce: Return Order Mapping
DLO Field DLO Field Data Type DMO DMO Field Name
QualifierCriteria picklist Promotion DiscountExclusivityTypeId
CreatedDate dateTime Promotion CreatedDate
LastModifiedDate dateTime Promotion LastModifiedDate
Commerce: Return Order Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Return Order data is about the return of order products in Salesforce Order Management.
DLO to DMO Mapping
These data mappings relate to the ReturnOrder object included in the Salesforce Commerce connector and how that data connects to
DMOs.
DLO Field DLO Field Data Type DMO DMO Field Name
Id id ReturnOrder Id
CaseId reference ReturnOrder CaseId
CurrencyIsoCode picklist ReturnOrder CurrencyCode
ExpectedArrivalDate dateTime ReturnOrder ExpectedArrivalDate
OrderSummaryId reference ReturnOrder SalesOrderId
ReturnOrderNumber string ReturnOrder ReturnAutorizationNumber
TotalFeeAdjustAmount currency ReturnOrder TotalFeeAdjustAmount
TotalFeeAdjustAmtWithTax currency ReturnOrder TotalFeeAdjustAmtWithTax
TotalFeeAdjustTaxAmount currency ReturnOrder TotalFeeAdjustTaxAmount
TotalFeeAmount currency ReturnOrder TotalFeeAmount
TotalFeeAmtWithTax currency ReturnOrder TotalFeeAmtWithTax
TotalFeeTaxAmount currency ReturnOrder TotalFeeTaxAmount
SystemModstamp dateTime ReturnOrder SystemModstamp
AccountId reference ReturnOrder CustomerAccountId
TotalAmount currency ReturnOrder TotalAmount
GrandTotalAmount currency ReturnOrder GrandTotalAmount
TotalDeliveryAdjustAmount currency ReturnOrder TotalDeliveryAdjustAmount
TotalDeliveryAdjustAmtWithTax currency ReturnOrder TotalDeliveryAdjustAmtWithTax
TotalDeliveryAdjustTaxAmount currency ReturnOrder TotalDeliveryAdjustTaxAmount
532
Model Data in Data Cloud Commerce: Return Order Item Adjustment Mapping
DLO Field DLO Field Data Type DMO DMO Field Name
TotalDeliveryAmount currency ReturnOrder TotalDeliveryAmount
TotalDeliveryAmtWithTax currency ReturnOrder TotalDeliveryAmtWithTax
TotalDeliveryTaxAmount currency ReturnOrder TotalDeliveryTaxAmount
TotalProductAdjustAmount currency ReturnOrder TotalProductAdjustAmount
TotalProductAdjustAmtWithTax currency ReturnOrder TotalProductAdjustAmtWithTax
TotalProductAdjustTaxAmount currency ReturnOrder TotalProductAdjustTaxAmount
TotalTaxAmount currency ReturnOrder TotalTaxAmount
Status picklist ReturnOrder ReturnOrderStatusId
StatusCategory picklist ReturnOrder StatusCategory
Description textarea ReturnOrder Description
TotalProductAmount currency ReturnOrder TotalProductAmount
TotalProductAmtWithTax currency ReturnOrder TotalProductAmtWithTax
TotalProductTaxAmount currency ReturnOrder TotalProductTaxAmount
Commerce: Return Order Item Adjustment Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Return Order Item Adjustment data is information about the change in price of the item in the return
order product.
DLO to DMO Mapping
These data mappings relate to the ReturnOrderItemAdjustment object included in the Salesforce Commerce connector and how that
data connects to DMOs.
DLO Field DLO Data Field Type DMO DMO Field Name
Id ID ReturnOrderProductPriceAdjustment id
CurrencyIsoCode picklist ReturnOrderProductPriceAdjustment Currency
ReturnOrderLineItemId reference ReturnOrderProductPriceAdjustment ReturnOrderItemId
OrderItemAdjustLineSummaryId reference ReturnOrderProductPriceAdjustment SalesOrderProductPriceAdjustmentId
Amount currency ReturnOrderProductPriceAdjustment AdjustmentAmount
TotalTaxAmount currency ReturnOrderProductPriceAdjustment TotalTaxAmount
TotalAmtWithTax currency ReturnOrderProductPriceAdjustment WithTaxTotalAmount
Description textarea ReturnOrderProductPriceAdjustment Description
533
Model Data in Data Cloud Commerce: Return Order Item Tax Mapping
DLO Field DLO Data Field Type DMO DMO Field Name
SystemModstamp dateTime ReturnOrderProductPriceAdjustment SystemModstamp
Commerce: Return Order Item Tax Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Return Order Item Tax data is information about the tax amount adjustments made for the return order
product.
DLO to DMO Mapping
These data mappings relate to the ReturnOrderItemTax object included in the Salesforce Commerce connector and how that data
connects to DMOs.
DLO Field DLO Field Data Type DMO DMO Field Name
Id ID ReturnOrderProductTax id
TaxEffectiveDate date ReturnOrderProductTax
ReturnOrderItemAdjustmentId reference ReturnOrderProductTax ReturnOrderProductAdjustmentid
ReturnOrderItemTaxNumber string ReturnOrderProductTax
ReturnOrderLineItemId reference ReturnOrderProductTax ReturnOrderItemId
OrderItemTaxLineItemSummaryId reference ReturnOrderProductTax SalesOrderProductTaxId
Rate percent ReturnOrderProductTax TaxRatePercent
CurrencyIsoCode picklist ReturnOrderProductTax Currency
Amount currency ReturnOrderProductTax TaxAmount
Type picklist ReturnOrderProductTax ReturnOrderProductTaxType
Description textarea ReturnOrderProductTax Description
SystemModstamp dateTime ReturnOrderProductTax SystemModstamp
Commerce: Return Order Line Item Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Return Order Line Item data is information about a product that a customer has returned to the seller.
DLO to DMO Mapping
These data mappings relate to the ReturnOrderLineItem object included in the Salesforce Commerce connector and how that data
connects to DMOs.
534
Model Data in Data Cloud Commerce: Sales Channel Mapping
DLO Field DLO Field Data DMO DMO Field Name
Type
Id ID ReturnOrderProduct id
CurrencyIsoCode picklist ReturnOrderProduct RepaymentAmountCurrency
OrderItemSummaryId reference ReturnOrderProduct
Product2Id reference ReturnOrderProduct ProductId
QuantityReturned double ReturnOrderProduct ReturnedQuantityCount
QuantityUnitOfMeasure picklist ReturnOrderProduct ReturnedQuantityUOM
ReasonForReturn picklist ReturnOrderProduct ReturnReasonCode
RepaymentMethod picklist ReturnOrderProduct RepaymentMethod
ReturnOrderId reference ReturnOrderProduct ReturnOrderId
ReturnOrderLineItemNumber string ReturnOrderProduct ReturnOrderItemNumber
SystemModstamp dateTime ReturnOrderProduct SystemModstamp
TotalPrice currency ReturnOrderProduct
TotalLineAmountWithTax currency ReturnOrderProduct
TotalTaxAmount currency ReturnOrderProduct
TotalAdjustmentAmount currency ReturnOrderProduct
TotalAdjustmentAmountWithTax currency ReturnOrderProduct
TotalAdjustmentTaxAmount currency ReturnOrderProduct
TotalAmount currency ReturnOrderProduct RepaymentAmount
TotalLineAmount currency ReturnOrderProduct
TotalLineTaxAmount currency ReturnOrderProduct
Description textarea ReturnOrderProduct Description
Commerce: Sales Channel Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Sales Channel data is the channel used to sell goods. For example, a web store or a retail store.
DLO to DMO Mapping
These data mappings relate to the SalesChannel object included in the Salesforce Commerce connector and how that data connects
to DMOs.
535
Model Data in Data Cloud Commerce: Web Store Mapping
DLO Field DLO Field Data Type DMO DMO Field Name
Id ID SalesChannel id
SalesChannelName string SalesChannel Name
Description textarea SalesChannel Description
Type picklist SalesChannel SalesChannelTypeId
TypeCategory picklist SalesChannel BusinessModelId
ExternalChannelNumber string SalesChannel ExternalRecordId
Commerce: Web Store Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Web Store data represents a Direct-to-Consumer (D2C) commerce store selling products to the public.
DLO to DMO Mapping
These data mappings relate to the WebStore object included in the Salesforce Commerce connector and how that data connects to
DMOs.
DLO Field DLO Field Data Type DMO DMO Field Name
Id ID Webstore id
Name String Webstore Name
CurrencylsoCode picklist Webstore CurrencyId
Description textarea Webstore Description
Type Picklist Webstore WebStoreTypeId
DefaultLanguage Picklist Webstore DefaultLanguageId
SupportedLanguages textarea Webstore SupportedLanguagesText
SupportedCurrencies textarea Webstore SupportedCurrenciesText
OptionsGuestBrowsingEnabled boolean Webstore IsGuestBrowsingEnabled
Commerce: Web Store Catalog Mapping
After a data stream is deployed, the Commerce starter data bundle automatically maps data from Commerce Cloud to data model
objects (DMO)s in Data Cloud. Web Store Catalog data is information about the products available at a store. Each record in a
WebStoreCatalog data source object specifies a product catalog that organizes the products in a store.
536
Model Data in Data Cloud Marketing Cloud Account Engagement: Email Activity
Mapping
DLO to DMO Mapping
These data mappings relate to the WebStoreCatalog object included in the Salesforce Commerce connector and how that data connects
to DMOs.
DLO Field DLO Field Data Type DMO DMO Field Name
Id ID WebStoreProductCatalog Field Name
ProductCatalogId reference WebStoreProductCatalog ProductCatalogId
Name string WebStoreProductCatalog Name
SalesStoreId reference WebStoreProductCatalog WebstoreId
Marketing Cloud Account Engagement: Email Activity Mapping
After a data stream is deployed, the Marketing Cloud Account Engagement data bundle maps source objects from Account Engagement
to data model objects (DMOs) in Data Cloud. The Email Activity object includes email engagement data.
DLO to DMO Mapping
These data mappings relate to the Email Activity object used with the Account Engagement connector. You can add to the data mappings,
but don’t change the automatically generated mappings.
DLO Field DLO Field Data Type DMO DMO Field Additional
Details
createdAt dateTime Email Engagement Engagement
Date Time
emailBounceReason text Email Engagement Bounce Only populated
Reason when eventType
is BOUNCE
emailBounceType text Email Engagement Email Only populated
Bounce Type when eventType
is BOUNCE
eventType text Email Engagement Engagement
Channel
Action
externalId text Email Engagement External
Record Id
externalSourceId text Email Engagement External
Source Id
id text Email Engagement Email Primary key
Engagement
Id
537
Model Data in Data Cloud Marketing Cloud Engagement: Campaigns and Journeys
Mappings
DLO Field DLO Field Data Type DMO DMO Field Additional
Details
polymorphicListId text Email Engagement Bulk Email Contains the ID of
Message the list email
record in
Salesforce
prospectEmail text Email Engagement Sendtime
Address
prospectSalesforceId text Email Engagement Contact
Point &
Individual
redirectUrl text Email Engagement Link URL
sendStatus text Email Engagement Email
Recipient
Send Status
Marketing Cloud Engagement: Campaigns and Journeys Mappings
After a data stream is deployed, the Marketing Cloud Engagement starter data bundle automatically maps data from Marketing Cloud
Engagement to data model objects (DMO)s in Data Cloud. The Campaigns and Journeys data includes the following DLOs and associated
data streams: SFMC Campaign, SFMC Email Publication, SFMC Email Template, SFMC Journey, SFMC Journey Activity, SFMC Push Template,
SFMC SMS Template, and SFMC WhatsApp Message Template.
DLO to DMO Mapping
These data streams relate to campaign and journey data associated with the Marketing Cloud Engagement connector and how that
data connects to DMOs.
SFMC Campaign Data Stream
DLO Field DLO Field DMO DMO Field Additional Info
Data Type
Created Date date Campaign Created Date
End Date date Campaign End Date
ID text Campaign Id Primary Key
Primary Key
Modified Date date Campaign Last Modified Date
Name text Campaign Name
Start Date date Campaign Start Date
538
Model Data in Data Cloud Marketing Cloud Engagement: Campaigns and Journeys
Mappings
SFMC Email Publication Data Stream
DLO Field DLO Field DMO DMO Field Additional Info
Data Type
Created Date date Email Publication Created Date
From Email text Email Publication From Address
ID text Email Publication Email Publication Id Primary Key
Primary Key
Modified Date date Email Publication Last Modified Date
Name text Email Publication From Name
SFMC Email Template Data Stream
DLO Field DLO Field DMO DMO Field Additional Info
Data Type
Asset Type text Email Template Engagement Asset Type
Created Date date Email Template Created Date
Email Name text Email Template Name
Email Subject text Email Template Subject
ID text Email Template Email Template Id Primary Key
Primary Key
Modified Date date Email Template Last Modified Date
SFMC Journey Data Stream
DLO Field DLO Field DMO DMO Field Additional Info
Data Type
Created Date date Market Journey Created Date
ID text Market Journey Id Primary Key
Primary Key
Modified Date date Market Journey Last Modified Date
Name text Market Journey Name
VersionID text Market Journey VersionID
539
Model Data in Data Cloud Marketing Cloud Engagement: Campaigns and Journeys
Mappings
SFMC Journey Activity Data Stream
DLO Field DLO Field DMO DMO Field Additional Info
Data Type
Created Date date Market Journey Activity Created Date
ID text Market Journey Activity Market Journey Activity Primary Key
Primary Key Id
Journey ID text Market Journey Activity Market Journey Id
Modified Date date Market Journey Activity Last Modified Date
Name text Market Journey Activity Name
SFMC Push Template Data Stream
DLO Field DLO Field DMO DMO Field Additional Info
Data Type
Asset Type text Device Application Engagement Asset Type
Template
Created Date date Device Application Created Date
Template
ID text Device Application Device Application Primary Key
Primary Key Template Template ID
Modified Date date Device Application Last Modified Date
Template
Name text Device Application Name
Template
SFMC SMS Template Data Stream
DLO Field DLO Field DMO DMO Field Additional Info
Data Type
Asset Type text SMS Template Engagement Asset Type
Created Date date SMS Template Created Date
ID text SMS Template SMS Template ID Primary Key
Primary Key
Modified Date date SMS Template Last Modified Date
540
Model Data in Data Cloud Marketing Cloud Engagement: Contact Mappings
DLO Field DLO Field DMO DMO Field Additional Info
Data Type
Name text SMS Template Name
SFMC WhatsApp Message Template Data Stream
DLO Field DLO Field Data DMO DMO Field Additional Info
Type
AssetTypeID text Message Template Engagement Asset
Type Id
Created Date date Message Template Created Date
ID text Message Template Message Template Primary Key
Id
Modified Date date Message Template Last Modified
Date
Name text Message Template Name
Marketing Cloud Engagement: Contact Mappings
After a data stream is deployed, the Marketing Cloud Engagement starter data bundle automatically maps data from Marketing Cloud
Engagement to data model objects (DMO)s in Data Cloud. Contact data includes the following system-generated DLOS and associated
data streams: SFMC Contact Point App, SFMC Contact Point Email, SFMC Contact Point Phone, SFMC Contact Point WhatsApp, and SFMC
Subscriber.
Attributes relate to individual subscriber data and profile information. The SFMC subscriber stream sources its data from the All Contacts
list in Marketing Cloud and excludes subscribers that aren’t in the active state. The SFMC Contact Point Email stream sources its data
from the All Subscribers list and includes subscribers in all states.
DLO to DMO Mapping
These data mappings relate to contact data associated with the Marketing Cloud Engagement connector and how that data connects
to DMOs.
SFMC Contact Point App Data Stream
DLO Field DLO Field DMO DMO Field Additional
Data Type Info
Application ID text Contact Point App Software Application
Badge Count number Contact Point App Badge Count
Device ID text Contact Point App Device
541
Model Data in Data Cloud Marketing Cloud Engagement: Contact Mappings
DLO Field DLO Field DMO DMO Field Additional
Data Type Info
Device Device ID
Primary Key
Device Name text Device Name
Device Type text Contact Point App Asset Type Id
Id text Contact Point App Contact Point App Id Primary Key
Primary Key Party Identification Party Identification Id Primary Key
OS Name text Device OS Name
OS Version Number text Device OS Version
Party text Party Identification Identification Name
Identification Name
Party text Party Identification Party Identification Type
Identification Type
Registration Id text Party Identification Identification Number
Subscriber Key text Contact Point App Party
Party Identification Party
Time Zone text Contact Point App Best Time to Contact
Timezone
SFMC Contact Point Email Data Stream
DLO Field DLO Field DMO DMO Field Additional
Data Type Info
Email Address text Contact Point Email Email Address
Email Domain text Contact Point Email Email Domain
Is Primary Email number Contact Point Email Primary Flag
Address
Subscriber Key text Contact Point Email Contact Point Email Id Primary Key
Primary Key Party
542
Model Data in Data Cloud Marketing Cloud Engagement: Contact Mappings
SFMC Contact Point Phone Data Stream
DLO Field DLO Field DMO DMO Field Additional
Data Type Info
City text Contact Point Phone City Name
Country Code text Contact Point Phone Country
Id text Contact Point Phone Contact Point Phone Id Primary Key
Primary Key
Is Primary number Contact Point Phone Primary Flag
Is SMS number Contact Point Phone Is SMS Capable
Mobile Number text Contact Point Phone Formatted E164 Phone
Number
Telephone Number
State text Contact Point Phone State Province Text
Subscriber Key text Contact Point Phone Party
Zip Code text Contact Point Phone Postal Code Text
SFMC Contact Point WhatsApp Data Stream
DLO Field DLO Field DMO DMO Field Additional
Data Type Info
Channel text Contact Point OTT Engagement Channel Type
Service
City text Contact Point OTT City
Service
Country Code text Contact Point OTT Country
Service
ID text Contact Point OTT Contact Point OTT Service Primary Key
Primary Key Service
Is Primary text Contact Point OTT Primary Flag
Service
Mobile Number text Contact Point OTT Username
Service
State text Contact Point OTT State Province
Service
543
Model Data in Data Cloud Marketing Cloud Engagement: Engagement Mappings
DLO Field DLO Field DMO DMO Field Additional
Data Type Info
Subscriber Key text Contact Point OTT Party
Service
Zip Code text Contact Point OTT Postal Code
Service
SFMC Subscriber Data Stream
DLO Field DLO Field DMO DMO Field Additional
Data Type Info
Party text Party Identification Party Identification Id Primary Key
Identification ID
Party text Party Identification Identification Name
Identification Name
Party text Party Identification Party Identification Type
Identification Type
Subscriber Key text Identity Individual Id Primary Key
Primary Key Party Identification Identification Number
Party
Marketing Cloud Engagement: Engagement Mappings
After a data stream is deployed, the Marketing Cloud Engagement starter data bundle automatically maps data from Marketing Cloud
Engagement to data model objects (DMO)s in Data Cloud. Engagement data includes the following system-generated DLOS and
associated data streams: SFMC EES Email Snapshot, SFMC EES Push Snapshot, SFMC Einstein Email Scores, SFMC Email Complaint, SFMC
Email Engagement Bounce, SFMC Email Engagement Click, SFMC Email Engagement Open, SFMC Email Engagement Send, SFMC Email
Unsubscribe, SFMC Msg Engagement Event, SFMC Push Engagement Event, SFMC Push Undeliver Event, SFMC WhatsApp Tracking
Event, SFMC WhatsApp MO Event, and SFMC WhatsApp Send Event.
Engagement data includes attributes that relate to customer engagement with outbound marketing.
DLO to DMO Mapping
These data mappings relate to engagement data associated with the Marketing Cloud Engagement connector and how that data
connects to DMOs.
544
Model Data in Data Cloud Marketing Cloud Engagement: Engagement Mappings
SFMC EES Email Snapshot Data Stream
DLO Field DLO Field DMO DMO Field Additional
Data Type Info
Conversion text Einstein Email Email Conversion
Likelihood Engagement Scores Likelihood
Conversion Score number Einstein Email Email Conversion Score
Engagement Scores
Created Date date Einstein Email Created Date
Engagement Scores
Email Click text Einstein Email Email Click Likelihood
Likelihood Engagement Scores
Email Click Score number Einstein Email Email Click Score
Engagement Scores
Email Engagement text Einstein Email Email Engagement Persona
Persona Engagement Scores
Email Open text Einstein Email Email Open Likelihood
Likelihood Engagement Scores
Email Open Score number Einstein Email Email Open Score
Engagement Scores
Email Subscribe text Einstein Email Email Subscribe
Likelihood Engagement Scores Likelihood
Email Subscribe number Einstein Email Email Subscribe Score
Score Engagement Scores
ID text Einstein Email Id Primary Key
Primary Key Engagement Scores
Subscriber Key text Einstein Email Subscriber Key
Engagement Scores
Update Date date Einstein Email Updated Date
Engagement Scores
SFMC EES Push Snapshot Data Stream
DLO Field DLO Field DMO DMO Field Additional
Data Type Info
AppID text Einstein Push Software Application Id
Engagement Scores
545
Model Data in Data Cloud Marketing Cloud Engagement: Engagement Mappings
DLO Field DLO Field DMO DMO Field Additional
Data Type Info
Created Date date Einstein Push Created Date
Engagement Scores
CustomObjectKey text Einstein Push Custom Object Key
Engagement Scores
Direct Open Level text Einstein Push Direct Open Level
Engagement Scores
Direct Open Score number Einstein Push Direct Open Score
Engagement Scores
Engagement Persona text Einstein Push Engagement Persona
Engagement Scores
Engagement Score number Einstein Push Engagement Score
Engagement Scores
Extracted Date date Einstein Push ExtractDate
Engagement Scores
ID text Einstein Push Id Primary Key
Primary Key Engagement Scores
Inferred Open Level text Einstein Push Inferred Open Level
Engagement Scores
Inferred Open Score number Einstein Push Inferred Open Score
Engagement Scores
Predicted Sessions text Einstein Push Predicted Sessions Level
Level Engagement Scores
Predicted Sessions number Einstein Push Predicted Sessions Score
Score Engagement Scores
Predicted Time In number Einstein Push Predicted Time in App
App Engagement Scores
Predicted Time In text Einstein Push Predicted Time in App
App level Engagement Scores level
Subscriber Key text Einstein Push Subscriber Key
Engagement Scores
Updated Date date Einstein Push Updated Date
Engagement Scores
546
Model Data in Data Cloud Marketing Cloud Engagement: Engagement Mappings
SFMC Email Complaint Data Stream
DLO Field DLO Field DMO DMO Field Additional
Data Type Info
Campaign ID text Engagement Topic Campaign
Email Domain text Email Engagement Email Domain Name
Email From Address text Email Engagement Email From Address
Email From Name text Email Engagement Email From Name
Email ID text Email Engagement Engagement Asset
Engagement Channel text Email Engagement Engagement Channel
Engagement Channel Type
Engagement Channel text Email Engagement Engagement Channel Action
Action
Engagement Date date Email Engagement Engagement Date Time
Time
Engagement Topic Created Date Time
Last Modified Date
ID text Email Engagement Email Engagement Id Primary Key
Primary Key Engagement Topic Engagement Topic Id Primary Key
Engagement
Is Test Send number Email Engagement Is Test Send
Journey Activity ID text Email Engagement Market Journey Activity
Last Modified Date date Email Engagement Last Modified Date
Publication ID text Email Engagement Engagement Publication
Subject Line text Email Engagement Subject Line Text
Subscriber Key text Email Engagement Individual
SFMC Email Engagement Bounce Data Stream
DLO Field DLO Field DMO DMO Field Additional
Data Type Info
Campaign ID text Engagement Topic Campaign
Email Domain text Email Engagement Email Domain Name
Email From Address text Email Engagement Email From Address
Email From Name text Email Engagement Email From Name
547
Model Data in Data Cloud Marketing Cloud Engagement: Engagement Mappings
DLO Field DLO Field DMO DMO Field Additional
Data Type Info
Email ID text Email Engagement Engagement Asset
Engagement Channel text Email Engagement Engagement Channel
Engagement Channel Type
Engagement Channel text Email Engagement Engagement Channel Action
Action
Engagement Date date Engagement Date Time
Time
Created Date
Last Modified Date
ID text Email Engagement Email Engagement Id Primary Key
Primary Key Engagement Topic Engagement Topic Id Primary Key
Engagement
Is Test Send number Email Engagement Is Test Send
Journey Activity ID text Email Engagement Market Journey Activity
Last Modified Date date Email Engagement Last Modified Date
Publication ID text Email Engagement Engagement Publication
Subject Line text Email Engagement Subject Line Text
Subscriber Key text Email Engagement Indiviidual
SFMC Email Engagement Click Data Stream
DLO Field DLO Field DMO DMO Field Additional
Data Type Info
Campaign ID text Engagement Topic Campaign
City text Email Engagement City Name
Country Code text Email Engagement Country
Email Domain text Email Engagement Email Domain Name
Email From Address text Email Engagement Email From Address
Email From Name text Email Engagement Email From Name
Email ID text Email Engagement Engagement Asset
Engagement Channel text Email Engagement Engagement Channel
Engagement Channel Type
548
Model Data in Data Cloud Marketing Cloud Engagement: Engagement Mappings
DLO Field DLO Field DMO DMO Field Additional
Data Type Info
Engagement Channel text Email Engagement Engagement Channel Action
Action
Engagement Date date Email Engagement Engagement Date Time
Time
Engagement Topic Created Date
Last Modified Date
ID text Email Engagement Email Engagement Id Primary Key
Primary Key Engagement Topic Engagement Topic Id Primary Key
Engagement
Is Test Send number Email Engagement Is Test Send
Journey Activity ID text Email Engagement Market Journey Activity
Last Modified Date date Email Engagement Last Modified Date
Publication ID text Email Engagement Engagement Publication
State Province Code text Email Engagement State Province Code
Subject Line text Email Engagement Subject Line Text
Subscriber Key text Email Engagement Individual
SFMC Email Engagement Open Data Stream
DLO Field DLO Field DMO DMO Field Additional
Data Type Info
Campaign ID text Engagement Topic Campaign
City text Email Engagement City Name
Country Code text Email Engagement Country
Email Domain text Email Engagement Email Domain Name
Email From Address text Email Engagement Email From Address
Email From Name text Email Engagement Email From Name
Email ID text Email Engagement Engagement Asset
Engagement Channel text Email Engagement Engagement Channel
Engagement Channel Type
Engagement Channel text Email Engagement Engagement Channel Action
Action
549
Model Data in Data Cloud Marketing Cloud Engagement: Engagement Mappings
DLO Field DLO Field DMO DMO Field Additional
Data Type Info
Engagement Date date Email Engagement Engagement Date Time
Time
Engagement Topic Created Date
Last Modified Date
ID text Email Engagement Email Engagement Id Primary Key
Primary Key Engagement Topic Engagement Topic Id Primary Key
Engagement
Is Test Send number Email Engagement Is Test Send
Journey Activity ID text Email Engagement Market Journey Activity
Last Modified Date date Email Engagement Last Modified Date
Publication ID text Email Engagement Engagement Publication
State Province Code text Email Engagement State Province Code
Subject Line text Email Engagement Subject Line Text
Subscriber Key text Email Engagement Individual
SFMC Email Engagement Send Data Stream
DLO Field DLO Field DMO DMO Field Additional
Data Type Info
Campaign ID text Engagement Topic Campaign
Email Domain text Email Engagement Email Domain Name
Email From Address text Email Engagement Email From Address
Email From Name text Email Engagement Email From Name
Email ID text Email Engagement Engagement Asset
Engagement Channel text Email Engagement Engagement Channel
Engagement Channel Type
Engagement Channel text Email Engagement Engagement Channel Action
Action
Engagement Date date Email Engagement Engagement Date Time
Time
Engagement Topic Created Date
Last Modified Date
ID text Email Engagement Email Engagement Id Primary Key
550
Model Data in Data Cloud Marketing Cloud Engagement: Engagement Mappings
DLO Field DLO Field DMO DMO Field Additional
Data Type Info
Primary Key Engagement Topic Engagement Topic Id Primary Key
Engagement
Is Test Send number Email Engagement Is Test Send
Journey Activity ID text Email Engagement Market Journey Activity
Last Modified Date date Email Engagement Last Modified Date
Publication ID text Email Engagement Engagement Publication
Subject Line text Email Engagement Subject Line Text
Subscriber Key text Email Engagement Individual
SFMC Email Unsubscribe Data Stream
DLO Field DLO Field DMO DMO Field Additional
Data Type Info
Campaign ID text Engagement Topic Campaign
Email Domain text Email Engagement Email Domain Name
Email From Address text Email Engagement Email From Address
Email From Name text Email Engagement Email From Name
Email ID text Email Engagement Engagement Asset
Engagement Channel text Email Engagement Engagement Channel
Engagement Channel Type
Engagement Channel text Email Engagement Engagement Channel Action
Action
Engagement Date date Email Engagement Engagement Date Time
Time
Engagement Topic Created Date
Last Modified Date
ID text Email Engagement Email Engagement Id Primary Key
Primary Key Engagement Topic Engagement Topic Id Primary Key
Engagement
Is Test Send number Email Engagement Is Test Send
Journey Activity ID text Email Engagement Market Journey Activity
Last Modified Date date Email Engagement Last Modified Date
551
Model Data in Data Cloud Marketing Cloud Engagement: Engagement Mappings
DLO Field DLO Field DMO DMO Field Additional
Data Type Info
Publication ID text Email Engagement Engagement Publication
Subject Line text Email Engagement Subject Line Text
Subscriber Key text Email Engagement Indiviidual
SFMC Msg Engagement Event Data Stream
DLO Field DLO Field DMO DMO Field Additional
Data Type Info Key
Campaign ID text Engagement Topic Campaign
Country Code text Message Engagement Country
Engagement Channel text Message Engagement Engagement Channel
Engagement Channel Type
Engagement Channel text Message Engagement Engagement Channel Action
Action
Engagement Date date Message Engagement Engagement Date Time
Time
Engagement Topic Created Date
Last Modified Date
ID text Message Engagement Message Engagement Id Primary Key
Primary Key Engagement Topic Engagement Topic Id Primary Key
Engagement
Is Test Send number Message Engagement Is Test Send
Is Valid number Message Engagement Is Valid
Keyword text Message Engagement Keyword Text
Last Modified Date date Message Engagement Last Modified Date
Message ID text Message Engagement Engagement Asset
Subscriber Key text Message Engagement Individual
SFMC Push Engagement Event Data Stream
DLO Field DLO Field DMO DMO Field Additional
Data Type Info
Campaign ID text Engagement Topic Campaign
552
Model Data in Data Cloud Marketing Cloud Engagement: Engagement Mappings
DLO Field DLO Field DMO DMO Field Additional
Data Type Info
Contact Point ID text Device Application Contact Point
Engagement
Engagement Channel text Device Application Engagement Channel
Engagement
Engagement Channel Type
Engagement Channel text Device Application Engagement Channel Action
Action Engagement
Engagement Date date Device Application Engagement Date Time
Time Engagement
Engagement Topic Created Date
Last Modified Date
Geofence Name text Device Application Geofence Name
Engagement
ID text Device Application Device Application Primary Key
Primary Key Engagement Engagement Id
Engagement Topic Engagement Topic Id Primary Key
Engagement
Journey Activity ID text Device Application Market Journey Activity
Engagement
Message ID text Device Application Engagement Asset
Engagement
Subscriber Key text Device Application Individual
Engagement
SFMC Push Undeliver Data Stream
DLO Field DLO Field DMO DMO Field Additional
Data Type Info
Campaign ID text Engagement Topic Engagement Topic Group
Engagement Channel text Device Application Engagement Channel
Engagement
Engagement Channel Type
Engagement Channel text Device Application Engagement Channel Action
Action Engagement
Engagement Date date Device Application Engagement Date Time
Time Engagement
553
Model Data in Data Cloud Marketing Cloud Engagement: Engagement Mappings
DLO Field DLO Field DMO DMO Field Additional
Data Type Info
Engagement Topic Created Date
Last Modified Date
ID text Device Application Device Application Primary Key
Primary Key Engagement Engagement Id
Engagement Topic Engagement Topic Id Primary Key
Engagement
Journey Activity ID text Device Application Market Journey Activity
Engagement
Subscriber Key text Device Application Individual
Engagement
SFMC WhatsApp Tracking Event Data Stream
DLO Field DLO Field Data DMO DMO Field Additional Info
Type
Conversation ID text Message Engagement Session
Engagement Channel text Message Engagement Engagement Channel
Engagement Channel text Message Engagement Engagement Channel Action
Action
Engagement Date date Message Engagement Engagement Date Time
Time
Engagement Topic Created Date
Last Modified Date
ID text Message Engagement Message Engagement Id Primary Key
Primary Key Engagement Topic Engagement Topic Id Primary Key
Engagement
Message ID text Message Engagement Engagement Asset
Reason text Message Engagement Engagement Action Reason
Waba ID text Message Engagement External Source Id
554
Model Data in Data Cloud Marketing Cloud Engagement: Engagement Mappings
SFMC WhatsApp MO Event Data Stream
DLO Field DLO Field DMO DMO Field Additional
Data Type Info
Conversation ID text Message Engagement Session
Engagement Channel text Message Engagement Engagement Channel
Engagement Channel text Message Engagement Engagement Channel Action
Action
Engagement Channel text Message Engagement Engagement Channel Type
Type
Engagement Date dateTime Message Engagement Engagement Date Time
Time
Engagement Topic Created Date
Last Modified Date
Event Direction text Message Engagement Engagement Event
Direction
ID text Message Engagement Message Engagement Id Primary Key
Primary Key Engagement Topic Engagement Topic Id Primary Key
Engagement
Is Test Send text Message Engagement Is Test Send
Is Valid number Message Engagement Is Valid
SubscriberKey text Message Engagement Individual
SFMC WhatsApp Send Event Data Stream
DLO Field DLO Field DMO DMO Field Additional
Data Type Info
Asset Id text Message Engagement Engagement Asset
Country Code text Message Engagement Country
Engagement Channel text Message Engagement Engagement Channel
Engagement Channel text Message Engagement Engagement Channel Action
Action
Engagement Channel text Message Engagement Engagement Channel Type
Type
Engagement Date dateTime Message Engagement Engagement Date Time
Time
Engagement Topic Created Date
555
Model Data in Data Cloud Salesforce CRM: Account Mappings
DLO Field DLO Field DMO DMO Field Additional
Data Type Info
Last Modified Date
Event Direction text Message Engagement Engagement Event
Direction
ID text Message Engagement Message Engagement Id Primary Key
Engagement Topic Engagement Topic Id Primary Key
Engagement
Journey Activity ID text Message Engagement Market Journey Activity
Last Modified Date date Message Engagement Last Modified Date
Subscriber Key text Message Engagement Individiual
Salesforce CRM: Account Mappings
After a data stream is deployed, the Salesforce CRM starter data bundle automatically maps data from Sales Cloud or Service Cloud to
data model objects (DMO)s in Data Cloud. The Sales Cloud and Service Cloud bundles deploy mappings to Contact Point type DMOs.
Identity Resolution uses the DMOs, which link multiple records into a unified customer profile.
Usage and Data Bundles
These mappings are used for various purposes within these bundles.
Bundles:
• Financial Services
• Sales Cloud
• Service Cloud
See the Financial Services Cloud Developer Guide for descriptions of these DSO fields.
DLO to DMO Mapping
These data mappings relate to the Account object included in the Salesforce CRM connector and how that data connects to DMOs.
DLO Field DLO Field API DLO Field Data DMO DMO Field Name Additional
Name Type Details
Account Description__c text Account Account
Description Description
Account Id Id_c text Account Account Id Primary Key
Sales Phone Foreign Key
Bill Contact Foreign Key
Address
556
Model Data in Data Cloud Salesforce CRM: Account Mappings
DLO Field DLO Field API DLO Field Data DMO DMO Field Name Additional
Name Type Details
Contact Point Contact Point Primary Key
Address Address Id
Contact Point Contact Point Primary Key
Phone Phone Id
Account Name Name_c text Account Account Name
Account AccountNumber__c text Account Account Number
Number
Account Phone Phone__c text Contact Point Telephone
Phone Number
Billing City BillingCity__c text Contact Point City Name
Address
Billing BillingCountry__c text Contact Point Country Name
Country Address
Billing BillingLatitude__c number Contact Point Geo Latitude
Latitude Address
Billing BillingLongitude__c number Contact Point Geo Latitude
Longitude Address
Billing BillingPostalCode__c text Contact Point Postal Code
Zip/Postal Address Text
Code
Billing BillingState__c text Contact Point State Province
State/Province Address Name
Billing BillingStreet__c text Contact Point Address Line 1
Street Address
Client FinServ__ClientCategory_c picklist Financial Customer Customer Used with Financial
Category Category Services.
Contact ID text Contact Point Party Foreign Key
Phone
Contact Point Foreign Key
Address
Contact Point Foreign Key
Phone
Created Date CreatedDate__c dateTime Account Created Date
Description text Account Account Used with Financial
Description Services.
557
Model Data in Data Cloud Salesforce CRM: Agent Work Mapping
DLO Field DLO Field API DLO Field Data DMO DMO Field Name Additional
Name Type Details
Household FinServ__HouseHoldPolicies_c picklist Financial Customer Used with Financial
Policies Services.
Id id Account Account Id Used with Financial
Services.
Financial Customer Account
Financial
Customer Id
Investment FinServ__InvestmentExperience_c picklist Financial Customer Investment Used with Financial
Experiene Experience Services.
Level
Last Activity LastActivityDate__c date Account Last Activity
Date
Last Modified LastModifiedDate__c dateTime Account Last Modified
Date Date
Name text Account Account Name Used with Financial
Services
Next FinServ__NextInteraction__c date Account Next Used with Financial
Interaction Interaction Services
Date
Next Review FinServ__NextReview__c date Account Next. Review Used with Financial
Date Services
Parent ParentId__c text Account Parent Account Foreign Key
Account ID
Review FinServ__ReviewFrequency__c picklist Account Review Used with Financial
Frequency Frequency Services
Service Model FinServ__ServiceModel_c picklist Financial Customer Customer Used with Financial
Service Level Services
Type text Account Account Type Foreign Key
Salesforce CRM: Agent Work Mapping
These data mappings are for the AgentWork DLO found in the Services bundle of the Salesforce CRM Connector for Data Cloud.
Usage and Data Bundle
These mappings are used to power Service Intelligence visualizations of contact center performance metrics.
Bundle:
• Service Cloud
558
Model Data in Data Cloud Salesforce CRM: Agent Work Skill Mapping
DLO to DMO Mapping
These data mappings relate to the Agent Work object included in the Salesforce CRM connector and how that data connects to DMOs.
DLO Field DLO Field API Name DLO Field Data DMO DMO Field Additional
Type Name Details
Accept Date AcceptDateTime__c dateTime Agent Work Accept Date
Active Time ActiveTime__c number Agent Work Active Time
After AfterConversationActualTime__c number Agent Work After
Conversation Conversation
Work Actual Work Actual
Time Time
After AcwExtensionCount__c number Agent Work After
Conversation Conversation
Work Work
Extension Extension
Count Count
Agent Work Id__c text Agent Work Agent Work Primary Key
ID ID
Close Date CloseDateTime__c dateTime Agent Work Close Date
Group ID OriginalGroupId__c text Agent Work User Group
Handle Time HandleTime__c number Agent Work Handle Time
Name Name__c text Agent Work Name
Request Date RequestDateTime__c dateTime Agent Work Request
DateTime
Routing Type RoutingType__c text Agent Work Agent Work
Routing Type
Speed To SpeedToAnswer__c number Agent Work Speed To
Answer Answer
Status Status__c text Agent Work Agent Work
Status
User ID PreferredUserId__c text Agent Work Preferred
User
User ID UserId__c text Agent Work User
WorkItem ID WorkItemId__c text Agent Work Related To
Salesforce CRM: Agent Work Skill Mapping
These data mappings are for the AgentWorkSkill DLO found in the Services bundle of the Salesforce CRM Connector for Data Cloud.
559
Model Data in Data Cloud Salesforce CRM: Alert Mappings
Usage and Data Bundle
These mappings are used to power Service Intelligence visualizations of contact center performance metrics.
Bundle:
• Service Cloud
DLO to DMO Mapping
These data mappings relate to the Agent Work Skills object included in the Salesforce CRM connector and how that data connects to
DMOs.
DLO Field Label DLO Field API DLO Field Data DMO DMO Field Name Additional Details
Name Type
Agent Work ID AgentWorkId__c text Agent Work Skill Agent Work
Agent Work Id__c text Agent Work Skill Agent Work Primary Key
Skill ID Skill ID
Name Name__c text Agent Work Skill Name
Skill ID SkillId__c text Agent Work Skill Skill
SkillLevel SkillLevel__c number Agent Work Skill Skill Level
Salesforce CRM: Alert Mappings
These data mappings are for the Alert DLO found in the Financial Services Cloud bundle of the Salesforce CRM Connector for Data Cloud.
Usage and Data Bundle
Bundle:
• Financial Services Cloud
DLO to DMO Mapping
These data mappings relate to the Alert object included in the Salesforce CRM connector and how that data connects to DMOs.
DLO Field DLO API Name DLO Field Data DMO DMO Field Name
Type
Account FinServ__Account__c text Record Alert Account
Active FinServ__Active__c checkbox Record Alert Active
Id id Record Alert Record Alert Id
Message FinServ__Message__c text Record Alert Message
MessageDescription FinServ__MessageDescription__c text Record Alert Descriptio
Name text Record Alert Name
560
Model Data in Data Cloud Salesforce CRM: Benefit Mapping
DLO Field DLO API Name DLO Field Data DMO DMO Field Name
Type
Priority FinServ__Priority__c picklist Record Alert Record Alert
Priority
Severity FinServ__Severity__c picklist Record Alert Record Alert
Severity
Salesforce CRM: Benefit Mapping
These data mappings are for the Benefit DLO found in the Loyalty Management bundle of the Salesforce CRM Connector for Data Cloud.
Benefits are offered to members of a loyalty program. Benefits can be offered to members based on their assigned tier or based on their
engagement.
Data Bundle
• Loyalty Management
DLO to DMO Mapping
These data mappings relate to the Benefit object included in the Salesforce CRM connector and how that data connects to DMOs. Learn
more about the DLOs in the Loyalty Management Developer Guide.
DLO Field DLO Field Data Type DMO DMO Field Name
Benefit ID Date id Loyalty Benefit Benefit Id
Benefit Name string Loyalty Benefit Name
Benefit Type ID Date reference Loyalty Benefit Loyalty Benefit Type
Created Date dateTime Loyalty Benefit Created Date
Last Modified Date dateTime Loyalty Benefit Last Modified Date
Unit of Measure ID reference Loyalty Benefit Loyalty Benefit UOM
Value double Loyalty Benefit Loyalty Benefit Value
Salesforce CRM: Benefit Type Mapping
These data mappings are for the Benefit DLO found in the Loyalty Management bundle of the Salesforce CRM Connector for Data Cloud.
A benefit type is used to categorize benefits that are offered to members of the loyalty program.
Data Bundle
• Loyalty Management
561
Model Data in Data Cloud Salesforce CRM: Business Hours
DLO to DMO Mapping
These data mappings relate to the Benefit Type object included in the Salesforce CRM connector and how that data connects to DMOs.
Learn more about the DLOs in the Loyalty Management Developer Guide.
DLO Field DLO Field Data Type DMO DMO Field Name
Benefit Type ID id Loyalty Benefit Type Benefit Type Id
Benefit Type Name string Loyalty Benefit Type Name
Category picklist Loyalty Benefit Type Loyalty Benefit Category
Created Date dateTime Loyalty Benefit Type Created Date
Last Modified Date dateTime Loyalty Benefit Type Last Modified Date
Loyalty Program ID reference Loyalty Benefit Type Loyalty Program
Salesforce CRM: Business Hours
These data mappings are for the BusinessHours DLO found in the Services bundle of the Salesforce CRM Connector for Data Cloud.
Usage and Data Bundle
These mappings are used to power Service Intelligence visualizations of contact center performance metrics.
Bundle:
• Service Cloud
DLO to DMO Mapping
These data mappings relate to the Business Hours object included in the Salesforce CRM connector and how that data connects to
DMOs.
DLO Field DLO Field API DLO Field Data DMO DMO Field Name Additional Details
Name Type
Active IsActive__c text Operating Hours Is Active
Business Id__c text Operating Hours Operating Primary Key
Hours ID Hours ID
Business Name__c text Operating Hours Name
Hours Name
Default IsDefault__c text Operating Hours Is Default
Business
Hours
Friday End FridayEndTime__c text Operating Hours Friday End
Time
562
Model Data in Data Cloud Salesforce CRM: Card Mappings
DLO Field DLO Field API DLO Field Data DMO DMO Field Name Additional Details
Name Type
Friday Start FridayStartTime__c text Operating Hours Friday Start
Time
Monday End MondayEndTime__c text Operating Hours Monday End
Time
Monday Start MondayStartTime__c text Operating Hours Monday Start
Time
Saturday End SaturdayEndTime__c text Operating Hours Saturday End
Time
Saturday SaturdayStartTime__c text Operating Hours Saturday
Start Start Time
Sunday End SundayEndTime__c text Operating Hours Sunday End
Time
Sunday Start SundayStartTime__c text Operating Hours Sunday Start
Time
Thursday End ThursdayEndTime__c text Operating Hours Thursday End
Time
Thursday ThursdayStartTime__c text Operating Hours Thursday
Start Start Time
TimeZoneSidKey TimeZoneSidKey__c text Operating Hours Time Zone
Tuesday End TuesdayEndTime__c text Operating Hours Tuesday End
Time
Tuesday Start TuesdayStartTime__c text Operating Hours Tuesday Start
Time
Wednesday End WednesdayEndTime__c text Operating Hours Wednesday End
Time
Wednesday WednesdayStartTime__c text Operating Hours Wednesday
Start Start Time
Salesforce CRM: Card Mappings
These data mappings are for the Card DLO found in the Financial Services Cloud bundle of the Salesforce CRM Connector for Data Cloud.
Usage and Data Bundle
Bundle:
• Financial Services Cloud
563
Model Data in Data Cloud Salesforce CRM: Case Mappings
DLO to DMO Mapping
These data mappings relate to the Card object included in the Salesforce CRM connector and how that data connects to DMOs.
DLO Field DLO API Name DLO Field Data DMO DMO Field Name
Type
Active FinServ__Active__c boolean Payment Card
Bin Number FinServ__BinNumber__c double Payment Card
Id id Payment Card
Ownership TYpe FinServ__OwnershipType__c picklist Payment Card
Salesforce CRM: Case Mappings
After a data stream is deployed, the Salesforce CRM starter data bundle automatically maps data from Sales Cloud or Service Cloud to
data model objects (DMO)s in Data Cloud. The Sales Cloud and Service Cloud bundles deploy mappings to Contact Point type DMOs.
Identity Resolution uses the DMOs, which link multiple records into a unified customer profile.
Usage and Data Bundles
These mappings are used for various purposes within these bundles. For Service Cloud, they’re used to power Service Intelligence
visualizations of contact center performance metrics.
Bundles:
• Sales Cloud
• Service Cloud
DLO to DMO Mapping
These data mappings relate to the Case object included in the Salesforce CRM connector and how that data connects to DMOs.
DLO Field DLO Field API DLO Field Data DMO DMO Field Additional Details
Name Type
Account text Case Account Foreign Key
Account ID AccountId__c text Case Account
Case ID Id__c text Case Case Id Primary Key
Case Number CaseNumber__c text Case Case Number
Case Origin Origin__c text Case Case Creation
Channel
Case Reason Reason__c text Case Case Closure
Reason
Case Type Type__c text Case Case Type
564
Model Data in Data Cloud Salesforce CRM: Case Article Mapping
DLO Field DLO Field API DLO Field Data DMO DMO Field Additional Details
Name Type
Closed IsClosed__c text Case Closed
Closed Date ClosedDate__c dateTime Case Closed
DateTime
Closed When IsClosedOnCreate__c text Case Closed when
Created Created
Contact ContactId__c text Case Account
Contact
Created Date CreatedDate__c dateTime Case Created Date
Date/Time dateTime Case Closed Date
Closed Time
Description Description__c text Case Description
Escalated IsEscalated__c text Case Escalated
Internal Comments__c text Case Case Comments
Comments
Last Modified LastModifiedDate__c dateTime Case Last Modified
Date Date
Owner ID OwnerId__c text Case Assigned User
Parent Case ParentId__c text Case Parent Case
ID
Priority Priority__c text Case Case Priority
Status Status__c text Case Case Status
Subject Subject__c text Case Subject
Type text Case Case Type
Salesforce CRM: Case Article Mapping
These data mappings are for the CaseArticle DLO found in the Knowledge bundle of the Salesforce CRM Connector for Data Cloud.
Usage and Data Bundle
Bundle:
• Knowledge: Used with Service Intelligence
DLO to DMO Mapping
These data mappings relate to the CaseArticle object included in the Salesforce CRM connector and how that data connects to DMOs.
565
Model Data in Data Cloud Salesforce CRM: Case History 2 Mapping
DLO Field DLO Field API DLO Field Data DMO DMO Field Additional
Name Type Name Details
Article ID KnowledgeArticleId__c text Linked Knowledge Article Knowledge
Article
Case Article Id__c text Linked Knowledge Article Linked Primary Key
ID Knowledge
Article Id
Case ID CaseId__c text Linked Knowledge Article Linked
Reference
Created By ID CreatedBuId__c text Linked Knowledge Article Created By
Created Date CreatedDate__c date Linked Knowledge Article Created Date
Knowledge KnowledgeArticleVersionId__c text Linked Knowledge Article Knowledge
Article Article
Version ID Version
Linked LinkedReferenceObject__c text Linked Knowledge Article Linked
Reference Reference
Object Object
Salesforce CRM: Case History 2 Mapping
These data mappings are for the CaseHistory2 DLO found in the Services bundle of the Salesforce CRM Connector for Data Cloud.
Usage and Data Bundle
These mappings are used to power Service Intelligence visualizations of contact center performance metrics.
Bundle:
• Service Cloud
DLO to DMO Mapping
These data mappings relate to the Case History 2 object included in the Salesforce CRM connector and how that data connects to DMOs.
DLO Field DLO Field API Name DLO Field Data DMO DMO Field Additional
Type Name Details
Case ID CaseId__c text Case Update Case
Case Id__c text Case Update Case Update Primary Key
History2 ID ID
Last LastModifiedById__c text Case Update Last
Modified By Modified By
ID
566
Model Data in Data Cloud Salesforce CRM: Category Mapping
DLO Field DLO Field API Name DLO Field Data DMO DMO Field Additional
Type Name Details
Last LastModifiedDate__c dateTime Case Update Last
Modified Modified
Date Date
Previous PreviousUpdate__c dateTime Case Update Previous
Update Update Date
Owner ID OwnerId__c text Case Update Related
Owner
Status Status__c text Case Update Status
Salesforce CRM: Category Mapping
These data mappings are for the Category DLO found in the Loyalty Management bundle of the Salesforce CRM Connector for Data
Cloud. A category of products that the company sells.
Data Bundle
• Loyalty Management
DLO to DMO Mapping
These data mappings relate to the Category object included in the Salesforce CRM connector and how that data connects to DMOs.
Learn more about the DLOs in the Loyalty Management Developer Guide.
DLO Field DLO Field Data Type DMO DMO Field Name
Catalog ID reference Product Category Product Catalog
Category ID reference Product Category Parent Category
id Product Category Product Category Id
Created Date dateTime Product Category Created Date
Description textarea Product Category Description
Last Modified Date dateTime Product Category Last Modified Date
Name string Product Category Category Name
Salesforce CRM: Contact Mappings
After a data stream is deployed, the Salesforce CRM starter data bundle automatically maps data from Sales Cloud or Service Cloud to
data model objects (DMO)s in Data Cloud. The Sales Cloud and Service Cloud bundles deploy mappings to Contact Point type DMOs.
Identity Resolution uses the DMOs, which link multiple records into a unified customer profile.
567
Model Data in Data Cloud Salesforce CRM: Contact Mappings
Usage and Data Bundles
These mappings are used for various purposes within these bundles. For Loyalty Management, information about the contact is associated
with an Individual type loyalty program member. For Service Cloud, they’re used to power Service Intelligence visualizations of contact
center performance metrics.
Bundles:
• Financial Services
• Loyalty Management
• Sales Cloud
• Service Cloud
DLO to DMO Mapping
These data mappings relate to the Contact object included in the Salesforce CRM connector and how that data connects to DMOs.
DLO Field DLO Field API Name DLO Field Data DMO DMO Field Name Additional
Type Details
Account Id AccountId__c text Account Contact Account
Annual Income FinServ__AnnualIncome_c currency Individual Yearly Income Used in Financial
Services Cloud.
Assistant AssistantName__c text Account Contact Assistant Name
Name
AsstantPhone AssistantPhone__c text Account Contact Assistant Phone Foreign Key
Birthdate Birthdate__c dateTime Individual Birth Date
Business Phone__c text Contact Point Telephone
Phone Address Number
Contact Point For Business Used with
Phone Use Financial Services
Account Contact Business Phone Used within the
Loyalty
Management
bundle.
Contact ID Id__c text Account Contact Account Contact Primary Key
ID
Business Phone Foreign Key
Contact Email Foreign Key
Individual Foreign Key
Mailing Address Foreign Key
Contact Point Contact Point Primary Key
Address Address ID
568
Model Data in Data Cloud Salesforce CRM: Contact Mappings
DLO Field DLO Field API Name DLO Field Data DMO DMO Field Name Additional
Type Details
Party Foreign Key
Contact Point Contact Point Primary Key
Email Email ID
Party Foreign Key
Contact Point Contact Point Primary Key
Phone Phone ID
Party Foreign Key
Individual Individual ID Primary Key
CountryOfBirth FinServ__CountryOfBirth_c picklist Individual Birth Place Used with
Financial Services
Cloud.
CountryOfResidence FinServ__CountryOfResidence_c string Individual Residence
Country Name
Created Date CreatedDate__c dateTime Account Contact Created Date
Individual Created Date
Current FinServ__CurrentEmployer_c string Individual Current Used in Financial
Employer Employer Name Services Cloud.
Department Department__c text Account Contact Department Name
Email Email__c text Contact Point Email Address
email Account Contact Contact Email Used within the
Loyalty
Management
bundle.
Email Bounced EmailBouncedDate__c dateTime Contact Point Email Latest
Date Email Bounce Date
Time
Email Bounced EmailBouncedReason__c text Contact Point Email Latest
Reason Email Bounce Reason
Text
Email FinServ__EmailVerified_c boolean Contact Point Verified Used with
Verified Email Financial Services
Cloud.
Employed FinServ__EmployedSince_c date Individual Employed Since Used with
Since Date Financial Services
Cloud.
569
Model Data in Data Cloud Salesforce CRM: Contact Mappings
DLO Field DLO Field API Name DLO Field Data DMO DMO Field Name Additional
Type Details
First Name FirstName__c text Individual First Name
Full Name Name__c text Individual Person Name
Gender FinServ__Gender_c picklist Individual Gender Identity Used with
Financial Services
Cloud.
HomePhone phone Contact Point Telephone Used with
Phone Number Financial Services
Cloud.
HomePhoneVerified FinServ__HomePhoneVerified_c boolean Contact Point Verified
Phone
HomeOwnership FinServ__HomeOwnership_c picklist Individual Is Home Owner Used with
Financial Services
Cloud.
Id string Account Contact Business Phone Used in Financial
Services Cloud.
Contact Email
Individual
Account Contact
Id
Mailing Address
id Contact Point Contact Point
Address Address Id
Party
id Contact Point Contact Point
Email Email Id
string Party
string Contact Point Contact Point
Phone Phone Id
Party
id Individual Individual Id
Last Activity LastActivityDate__c dateTime Account Contact Last Activity
Date
Last Modified LastModifiedDate__c dateTime Account Contact Last Modified
Date Date
Individual Last Modified
Date
570
Model Data in Data Cloud Salesforce CRM: Contact Mappings
DLO Field DLO Field API Name DLO Field Data DMO DMO Field Name Additional
Type Details
Last Name LastName__c text Individual Last Name
Mailing address Account Contact Mailing Address Used within the
Address Loyalty
Management
bundle.
Mailing City MailingCity__c text Contact Point City Name
Address
Mailing MailingCountry__c text Contact Point Country Name
Country Address
Mailing MailingLatitude__c number Contact Point Geo Latitude
Latitude Address
Mailing MailingLongitude__c number Contact Point Geo Latitude
Longitude Address
MailingPostalCode text Contact Point Postal Code Used in Financial
Address text Services Cloud.
Mailing MailingState__c text Contact Point State Province
State/Province Address
Mailing MailingStreet__c text Contact Point Address Line 1
Street Address
Mailing MailingPostalCode__c text Contact Point Postal Code
Zip/Postal Address
Code
MaritalStatus FinServ__MaritalStatus__c picklist Individual Marital Status Used with
Financial Services
Cloud.
MobilePhone string Contact Point For Personal
Phone Use
Mother Maiden FinServ__MotherMaidenName_c text Individual Mothers Maiden Used with
Name Name Financial Services
Cloud.
Number Of NumberOfChildren_c double Individual Children Count Used with
Children Financial Services
Cloud.
Number Of NumberOfDependents_c double Individual Dependent Count
Dependents
Occupation FinServ__Occupation_c string Individual Occupation Used with
Financial Services
Cloud.
571
Model Data in Data Cloud Salesforce CRM: Conversation Mapping
DLO Field DLO Field API Name DLO Field Data DMO DMO Field Name Additional
Type Details
Phone text Contact Point Telephone
Phone Number
Photo URL PhotoUrl__c text Individual Photo URL
Preferred FinServ__PreferredName_c String Individual Preferred Name Used with
Name Financial Services
Cloud.
Primary FinServ__PrimaryAddressIsBilling_c boolean Contact Point Is Used for Used in Financial
Address Address Billing Services Cloud.
Billing
Primary FinServ__PrimaryAddressIsMailing_c boolean Contact Point Is Used for Used in Financial
Address Address Mailing Services Cloud.
Mailing
Primary FinServ__PrimaryAddressIsShipping__c boolean Contact Point Is Used for Used in Financial
Address Address Shipping Services Cloud.
Shipping
Primary FinServ__PrimaryCitizenship__c picklist Individual Primary Used in Financial
Citizenship Citizenship Services Cloud.
Country
Primary FinServ__PrimaryLanguage__c picklist Individual Primary Used in Financial
Language Language Services Cloud.
Salutation Salutation__c text Individual Salutation
SecondaryCitizenship FinServ__SecondaryCitizenship__c text Individual Secondary Used in Financial
Citizenship Services Cloud.
Country Id
Title Title__c text Account Contact Title
Wedding FinServ__WeddingAnniversary_c date Individual Wedding Used in Financial
Anniversary Anniversary Services Cloud.
Date
Salesforce CRM: Conversation Mapping
These data mappings are for the Conversation DLO found in the Services bundle of the Salesforce CRM Connector for Data Cloud.
Usage and Data Bundle
These mappings access Digital Engagement channel data for Service Cloud Voice, Messaging for In-App and Web, and enhanced
third-party channels, such as Facebook Messenger, Apple Messages for Business, WhatsApp,and SMS. The data can be used via reports,
dashboards, and APIs for insightful conversation analytics.
Bundle:
572
Model Data in Data Cloud Salesforce CRM: ConversationParticipant Mapping
• Digital Engagement
DLO to DMO Mapping
These data mappings relate to the Conversation object used with the CRM connector. You can add or customize the data mappings.
DLO Field DLO Field API Name DLO Field Data DMO DMO Field additional
Type Name details
Conversation Id__c Text Conversation Conversation Primary Key
ID Id
Conversation ConversationIdentifier__c Text Conversation External
Identifier Record Id
Conversation StartTime__c Text Conversation Start Time
Start Time
Created By CreatedById__c Text Conversation Created By
ID
Created Date CreatedDate__c DateTime Conversation Created Date
Last LastModifiedById__c Text Conversation Last
Modified By Modified By
ID
Last LastModifiedDate__c DateTime Conversation Last
Modified Modified
Date Date
System SystemModstamp__c DateTime Conversation System
Modstamp Modified
Stamp
Conversation EndTime__c DateTime Conversation End Time
End Time
Salesforce CRM: ConversationParticipant Mapping
These data mappings are for the ConversationParticipant DLO found in the Services bundle of the Salesforce CRM Connector for Data
Cloud.
Usage and Data Bundle
These mappings access Digital Engagement channel data for Service Cloud Voice, Messaging for In-App and Web, and enhanced
third-party channels, such as Facebook Messenger, Apple Messages for Business, WhatsApp,and SMS. The data can be used via reports,
dashboards, and APIs for insightful conversation analytics.
Bundle:
• Digital Engagement
573
Model Data in Data Cloud Salesforce CRM: ConversationReason Mapping
DLO to DMO Mapping
These data mappings relate to the Conversation Reason object used with the CRM connector. You can add or customize the data
mappings.
DLO Field DLO Field API Name DLO Field Data DMO DMO Field additional
Type Name details
Conversation ConversationId__c Text ConversationParticipant Conversation
ID
Conversation Id__c Text ConversationParticipant Engagement Primary Key
Participant Channel
ID Participant
Id
Created By CreatedById__c Text ConversationParticipant Created By
ID
Created Date CreatedDate__c DateTime ConversationParticipant Created Date
Joined Time JoinedTime__c DateTime ConversationParticipant Joined
DateTime
Last LastModifiedById__c Text ConversationParticipant Last
Modified By Modified By
ID
Last LastModifiedDate__c DateTime ConversationParticipant Last
Modified Modified
Date Date
Left Time LeftTime__c DateTime ConversationParticipant Left
DateTime
System SystemModstamp__c DateTime ConversationParticipant System
Modstamp Modified
Stamp
Participant ParticipantDisplayName__c Text ConversationParticipant Participant
Display Name Display Name
Salesforce CRM: ConversationReason Mapping
These data mappings are for the ConversationReason DLO found in the Services bundle of the Salesforce CRM Connector for Data Cloud.
Usage and Data Bundle
These mappings are used to power Service Intelligence visualizations of contact center performance metrics.
Bundle:
• Service Cloud
574
Model Data in Data Cloud Salesforce CRM: ConversationReasonExcerpt Mapping
DLO to DMO Mapping
These data mappings relate to the Conversation Reason object used with the CRM connector. You can add or customize the data
mappings.
DLO Field DLO Field API Name DLO Field Data DMO DMO Field Name
Type
Average AverageDurationSeconds__c number Conversation Reason Average
Duration in Duration in
Seconds Seconds
Average Number AverageNumOfTurns__c number Conversation Reason Average Number
of Turns of Turns
Conversation ConversationReasonGroupId__c text Conversation Reason Conversation
Reason Group Reason
ID Category
Conversation Id__c text Conversation Reason Conversation
Reason ID Reason ID
Primary Key
Conversation Status__c text Conversation Reason Conversation
Reason Status Reason Status
Code
Einstein Score EinsteinScore__c number Conversation Reason Einstein Score
Frequency FrequencyPercent__c number Conversation Reason Frequency
Percent Percent
Summary Summary__c text Conversation Reason Summary
Total TotalConversationCount__c text Conversation Reason Total
Conversation Conversation
Count Count
Salesforce CRM: ConversationReasonExcerpt Mapping
These data mappings are for the ConversationReasonExcerpt DLO found in the Services bundle of the Salesforce CRM Connector for
Data Cloud.
Usage and Data Bundle
These mappings are used to power Service Intelligence visualizations of contact center performance metrics.
Bundle:
• Service Cloud
575
Model Data in Data Cloud Salesforce CRM: ConversationReasonGroup Mapping
DLO to DMO Mapping
These data mappings relate to the Conversation Reason Excerpt object used with the CRM connector. You can add or customize the
data mappings.
DLO Field Label DLO Field API Name DLO Field Data Type DMO DMO Field Name
Channel Type ChannelType__c text Conversation Entry Engagement
Transcript Excerpt Channel Type
Conversation DurationInSeconds__c number Conversation Entry Duration In
Duration Seconds Transcript Excerpt Seconds
Conversation Id__c text Conversation Entry Conversation
Research ID Transcript Excerpt Entry Transcript
Primary Key Excerpt ID
Conversation ConversationReasonId__c text Conversation Entry Conversation
Reason ID Transcript Excerpt Reason
Conversation Status__c text Conversation Entry Conversation
Reason Status Transcript Excerpt Intent Status
Conversation TurnCount__c number Conversation Entry Turn Count
Turn Count Transcript Excerpt
Excerpt Text ExcerptTextIndex__c text Conversation Entry Excerpt Text
Index Transcript Excerpt Index
Is Moved IsMoved__c text Conversation Entry Moved
Transcript Excerpt
Language of the Language__c text Conversation Entry Language
Conversation Transcript Excerpt
Excerpt
Relevance Order Order__c text Conversation Entry Excerpt Sequence
Transcript Excerpt Number
Salesforce CRM: ConversationReasonGroup Mapping
These data mappings are for the ConverationReasonGroup DLO found in the Services bundle of the Salesforce CRM Connector for Data
Cloud.
Usage and Data Bundle
These mappings are used to power Service Intelligence visualizations of contact center performance metrics.
Bundle:
• Service Cloud
576
Model Data in Data Cloud Salesforce CRM: ConversationReasonReportDefinition
Mapping
DLO to DMO Mapping
These data mappings relate to the Conversation Reason Group object used with the CRM connector. You can add or customize the data
mappings.
DLO Field DLO Field API Name DLO Field Data DMO DMO Field Name
Type
Average AverageDurationSeconds__c number Conversation Reason Average
Duration in Category Duration in
Seconds Seconds
Average Number AverageNumOfTurns__c number Conversation Reason Average Number
of Turns Category of
Conversation
Turns
Conversation Id__c text Conversation Reason Conversation
Reason Group Category Reason
ID Category ID
Primary Key
Conversation ConvReasonReportDefinitionId__c text Conversation Reason Conversation
Reason Report Category Reason Report
Definition ID Definition
Einstein Score EinsteinScore__c number Conversation Reason Einstein Score
Category
Frequency FrequencyPercent__c number Conversation Reason Frequency
Percent Category Percent
Name Name__c text Conversation Reason Name
Category
Total TotalConversationCount__c number Conversation Reason Total
Conversation Category Conversation
Count Count
Total Number ReasonCount__c number Conversation Reason Reason Count
of Reasons In Category
this Group
Training Date TrainingDate__c dateTime Conversation Reason Training Date
Category
Salesforce CRM: ConversationReasonReportDefinition Mapping
These data mappings are for the ConvReasonReportDefinition DLO used with the Salesforce CRM Connector found in the Services bundle
of the Salesforce CRM Connector for Data Cloud.
577
Model Data in Data Cloud Salesforce CRM: ConvReasonReportSegmentDefinition
Mapping
Usage and Data Bundle
These mappings are used to power Service Intelligence visualizations of contact center performance metrics.
Bundle:
• Service Cloud
DLO to DMO Mapping
These data mappings relate to the Conversation Reason Report Definition object used with the CRM connector. You can add or customize
the data mappings.
DLO Field DLO Field API Name DLO Field Data DMO DMO Field Name
Type
Conversation Id__c text Conversation Reason Conversation
Reason Report Report Definition Reason Report
Definition ID Definition ID
Primary Key
End Date EndDate__c dateTime Conversation Reason EndDate
Report Definition
Label text Conversation Reason Name
Report Definition
Pipeline Run PipelineRunIdentifier__c text Conversation Reason Pipeline Run
Identifier Report Definition Identifier
Refresh RefreshFrequency__c text Conversation Reason Recurring
Frequency Report Definition Event
Frequency UOM
Start Date StartDate__c dateTime Conversation Reason StartDate
Report Definition
Status Status__c text Conversation Reason Conversation
Report Definition Reason Report
Status
Salesforce CRM: ConvReasonReportSegmentDefinition Mapping
These data mappings are for the ConvReasonReportSegmentDefinition DLO found in the Services bundle of the Salesforce CRM Connector
for Data Cloud.
Usage and Data Bundle
These mappings are used to power Service Intelligence visualizations of contact center performance metrics.
Bundle:
• Service Cloud
578
Model Data in Data Cloud Salesforce CRM: Data Category Mapping
DLO to DMO Mapping
These data mappings relate to the Conversation Reason Report Segment Definition object used with the CRM connector. You can add
or customize the data mappings.
DLO Field DLO Field API Name DLO Field Data DMO DMO Field Name
Type
Conversation Reason ConvReasonReportDefinitionId__c Text Conv Reason Report Conversation Reason
Report Definition ID Segment Def Report Definition
Conversation Reason Id__c Primary Key Conv Reason Report Conversation Reason
Report Segment ID Segment Def Rpt Sgmt Def ID
Label MasterLabel__c Text Conv Reason Report Name
Segment Def
Segment Object SegmentObject__c Text Conv Reason Report SegmentObject
Segment Def
Segment Type SegmentType__c Text Conv Reason Report Conversation Reason
Segment Def Report Segment
Type
Target Object TargetObject__c Text Conv Reason Report Target Object
Segment Def
Salesforce CRM: Data Category Mapping
These data mappings are for the DataCategory DLO found in the Knowledge bundle of the Salesforce CRM Connector for Data Cloud.
Usage and Data Bundle
Bundle:
• Knowledge: Used with Service Intelligence
DLO to DMO Mapping
These data mappings relate to the DataCategory object included in the Salesforce CRM connector and how that data connects to DMOs.
DLO Field DLO Field API DLO Field Data DMO DMO Field Additional
Name Type Name Details
Data Category Id__c text Category Category Id Primary Key
ID
Developer Name DeveloperName__c text Category Name
IsKnowledgeCategory IsKnowledgeCategory__c text Category Is Knowledge
Category
Label MasterLabel__c text Category Label
579
Model Data in Data Cloud Salesforce CRM: Email Message Mapping
DLO Field DLO Field API DLO Field Data DMO DMO Field Additional
Name Type Name Details
ParentCategoryId ParentCategoryId__c text Category Parent
Category
Sort Order SortOrder__c text Category Sort Order
Salesforce CRM: Email Message Mapping
These data mappings are for the EmailMessage DLO found in the Services bundle of the Salesforce CRM Connector for Data Cloud.
Usage and Data Bundle
These mappings are used to power Service Intelligence visualizations of contact center performance metrics.
Bundle:
• Service Cloud
DLO to DMO Mapping
These data mappings relate to the Email Message object used with the CRM connector. You can add or customize the data mappings.
DLO Field DLO Field API DLO Field Data DMO DMO Field Additional Details
Name Type
Case ID ParentId__c text Email Message Case
Created By ID CreatedById__c text Email Message Created By
Created Date CreatedDate__c dateTime Email Message Created Date
Email Message Id__c text Email Message Email Message Primary Key
ID ID
Email Message Name__c text Email Message Name
Name
Headers Headers__c text Email Message Email Header
Is Incoming Incoming__c text Email Message Is Incoming
Is Private IsPrivateDraft__c text Email Message Is Private
Draft Draft
Last Modified LastModifiedById__c text Email Message Last Modified
By ID By
Last Modified LastModifiedDate__c dateTime Email Message Last Modified
Date Date
Message Date MessageDate__c dateTime Email Message Message Date
580
Model Data in Data Cloud Salesforce CRM: Data Category Group Mapping
Salesforce CRM: Data Category Group Mapping
These data mappings are for the DataCategoryGroup DLO found in the Knowledge bundle of the Salesforce CRM Connector for Data
Cloud.
Usage and Data Bundle
Bundle:
• Knowledge: Used with Service Intelligence
DLO to DMO Mapping
These data mappings relate to the DataCategoryGroup object included in the Salesforce CRM connector and how that data connects
to DMOs.
DLO Field DLO Field API DLO Field Data DMO DMO Field Additional
Name Type Name Details
Data Category Id__c text Category Category Id Primary Key
Group ID
Developer Name DeveloperName__c text Category Name
IsKnowledgeCategory IsKnowledgeCategory__c text Category Is Knowledge
Category
IsRootCategory IsRootCategory__c text Category Is Root
Category
Label MasterLabel__c text Category Label
Status Status__c text Category Category
Status
Salesforce CRM: Financial Account Mappings
These data mappings are for the FinancialAccount DLO found in Financial Services Cloud bundle of the Salesforce CRM Connector for
Data Cloud.
Usage and Data Bundle
Bundle:
• Financial Services Cloud
DLO to DMO Mapping
These data mappings relate to the FinancialAccount object included in the Salesforce CRM connector and how that data connects to
DMOs.
581
Model Data in Data Cloud Salesforce CRM: Financial Account Mappings
DLO Field DLO API Name DLO Field Data DMO DMO Field Name
Type
Application Date FinServ__ApplicationDate__c date Financial Account Application Date
AYP FinServ__AYP__c percent Investment Account Annual Yield
Percentage
Close Date FinServ__CloseDate__c date Financial Account Close Date
Description FinServ__Description__c text Financial Account Description
Expected Close FinServ__ExpectedCloseDate__c date Loan Account Expected Close Date
Date
Held Away FinServ__HeldAway__c checkbox/boolean Financial Account Held Away
id id Card Account Financial Account
Card Account Id
Deposit Account Financial Account
Deposit Account Id
Financial Account Fee Financial Account
Financial Account
Fee Id
Financial Account Financial Account
Interest Rate
Financial Account
Interest Rate Id
Financial Account Card Account
Deposit Account
Financial Account Id
Insurance Policy
Investment Account
Loan Account
Insurance Policy Financial Account
Insurance Policy Id
Investment Account Financial Account
Investment Account
Id
Loan Account Financial Account
Loan Account Id
582
Model Data in Data Cloud Salesforce CRM: Financial Account Mappings
DLO Field DLO API Name DLO Field Data DMO DMO Field Name
Type
Insurance Policy FinServ__InsurancePolicy__c reference Insurance Policy Insurance Policy
Number
Insured Amount FinServ__InsuredAmount__c currency Insurance Policy Insured Amount
Interest Rate FinServ__InterestRate__c percent Financial Account Interest Rate
Interest Rate Percent
Investment FinServ__InvestmentObjectives__c multi-select picklist Investment Account Investment Objective
Objectives
Lien Holder FinServ__LienHolder__c text Financial Account Lien Holder Name
Loan Amount FinServ__LoanAmount__c currency Loan Account Loan Amount
Loan End Date FinServ__LoanEndDate__c date Loan Account Loan End Date
Loan Term Months FinServ__LoanTermMonths__c number Loan Account Loan Term Months
Managed FinServ__Managed__c checkbox/boolean Financial Account Managed
Model Portfolio FinServ__ModelPortfolio__c picklist Investment Account Model Portfolio Type
Name FinServ__Name text Financial Account Name
Open Date FinServ__OpenDate__c date Financial Account Open Date
Overdraft FinServ__OverdraftAllowed__c boolean/checkbox Deposit Account Over Draft Allowed
Allowed
Overdraft FinServ__OverdraftProtection__c boolean/checkbox Deposit Account Overdraft Protection
Protection
Policy Term FinServ__PolicyTerm__c picklist Insurance Policy Financial Policy
Term
Premium FinServ__Premium__c currency Insurance Policy Premium Amount
Record Type Name FinServ__RecordTypeName__c reference Financial Account Financial Account
Type
Renewal Date FinServ__RenewalDate__c date Insurance Policy Renewal Date
Repayment Period FinServ__RepaymentPeriodMonths__c number Loan Account Repayment Period
Months Months
Routing Number FinServ__RoutingNumber__c text Financial Account Routing Number
Status FinServ__Status__c picklist Financial Account Financial Account
Status
Time Horizon FinServ__TimeHorizon__c picklist Investment Account Investment Time
Horizon
583
Model Data in Data Cloud Salesforce CRM: Financial Account Role Mappings
Salesforce CRM: Financial Account Role Mappings
These data mappings are for the FinancialAccountRole DLO found in Financial Services Cloud bundle of the Salesforce CRM Connector
for Data Cloud.
Usage and Data Bundle
Bundle:
• Financial Services Cloud
DLO to DMO Mapping
These data mappings relate to the FinancialAccountRole object included in the Salesforce CRM connector and how that data connects
to DMOs.
DLO Field DLO API Name DLO Field Data DMO DMO Field Name
Type
Related Contact FinServ__RelatedContact__c reference Financial Account Contact
Party
Related Account FinServ__RelatedAccount__c reference Financial Account Account
Party
Financia Account FinServ__FinancialAccount__c reference Financial Account Financial Account
Party
Role FinServ__Role__c picklist Financial Account Financial Account
Party Role
Id Id Financial Account Financial Account
Party Party Id
Name text Financial Account Name
Party
Active FinServ__Active__c checkbox/boolean Financial Account Active
Party
Salesforce CRM: Financial Goal Mappings
These data mappings are for the FinancialGoal DLO found in Financial Services Cloud bundle of the Salesforce CRM Connector for Data
Cloud.
Usage and Data Bundle
Bundle:
• Financial Services Cloud
584
Model Data in Data Cloud Salesforce CRM: Financial Goal Party Mappings
DLO to DMO Mapping
These data mappings relate to the FinancialGoal object included in the Salesforce CRM connector and how that data connects to DMOs.
DLO Field DLO API Name DLO Field Data DMO DMO Field Name
Type
ActualAmoun currency Financial Goal Actual Value Amount
CompletionDate date Financial Goal Completion Date
Status picklist Financial Goal Financial Goal
Status
Type picklist Financial Goal Financial Goal Type
Id id Financial Goal Financial Goal Id
InitialAmount currency Financial Goal Initial Value Amount
Name text Financial Goal Name
TargetDate date Financial Goal Target Date
TargetAmount currency Financial Goal Target Value Amount
Salesforce CRM: Financial Goal Party Mappings
These data mappings are for the FinancialGoalParty DLO found in the Financial Services Cloud bundle of the Salesforce CRM Connector
for Data Cloud.
Usage and Data Bundle
Bundle:
• Financial Services Cloud
DLO to DMO Mapping
These data mappings relate to the FinancialGoalParty object included in the Salesforce CRM connector and how that data connects to
DMOs.
DLO Field DLO API Name DLO Field Data DMO DMO Field Name
Type
FinancialGoalId reference Financial Goal Party Financial Goal
Id reference Financial Goal Party Financial Goal Party
Id
Name id Financial Goal Party Name
AccountId text Financial Goal Party Party
585
Model Data in Data Cloud Salesforce CRM: Financial Holding Mappings
Salesforce CRM: Financial Holding Mappings
These data mappings are for the FinancialHolding DLO found in Financial Services Cloud bundle of the Salesforce CRM Connector for
Data Cloud.
Usage and Data Bundle
Bundle:
• Financial Services Cloud
DLO to DMO Mapping
These data mappings relate to the FinancialHolding object included in the Salesforce CRM connector and how that data connects to
DMOs.
DLO Field DLO API Name DLO Field Data DMO DMO Field Name
Type
Asset Category FinServ__AssetCategory__c picklist Financial Holding Financial Holding
Class
Asset Category FinServ__AssetCategoryName__c picklist Financial Holding Financial Holding
Name Sub Class
Asset Class FinServ__AssetClass__c picklist Financial Holding Equity Category
Financial FinServ__FinancialAccount__c reference Financial Holding Financial Account
Account
Gain Loss FinServ__GainLoss__c currency Financial Holding Gain Loss Amount
Id id Financial Holding Financial Holding Id
Market Value FinServ__MarketValue__c currency Financial Holding Market Value Amount
Name text Financial Holding Name
Percent Change FinServ__PercentChange__c number Financial Holding Change Percent
Primary Owner FinServ__PrimaryOwner__c text Financial Holding Account
Purchase Price FinServ__PurchasePrice__c currency Financial Holding Purchase Price
Shares FinServ__Shares__c number Financial Holding Holding Count
Source System Id FinServ__SourceSystemId__c external reference Financial Holding Source System
Identifier
Symbol FinServ__Symbol__c reference Financial Holding Financial Security
Salesforce CRM: Group Mapping
These data mappings are for the Group DLO found in the Services bundle of the Salesforce CRM Connector for Data Cloud.
586
Model Data in Data Cloud Salesforce CRM: Group Member Mapping
Usage and Data Bundle
These mappings are used to power Service Intelligence visualizations of contact center performance metrics.
Bundle:
• Service Cloud
DLO to DMO Mapping
These data mappings relate to the Group object used with the CRM connector. You can add or customize the data mappings.
DLO Field DLO Field API DLO Field Data DMO DMO Field Additional Details
Name Type
Developer DeveloperName__c text User Group Name
Name
Group ID Id__c text User Group User Group ID Primary Key
Name Name__c text User Group Alias
Related ID RelatedId__c text User Group User Group
Salesforce CRM: Group Member Mapping
These data mappings are for the GroupMember DLO found in the Services bundle of the Salesforce CRM Connector for Data Cloud.
Usage and Data Bundle
These mappings are used to power Service Intelligence visualizations of contact center performance metrics.
Bundle:
• Service Cloud
DLO to DMO Mapping
These data mappings relate to the Group Member object included in the Salesforce CRM connector and how that data connects to
DMOs.
DLO Field DLO Field API DLO Field Data DMO DMO Field Additional Details
Name Type
Group ID GroupId__c text User Group User Group
Group Member Id__c text User Group User Group Primary Key
ID Relationship
ID
587
Model Data in Data Cloud Salesforce CRM: Journal Subtype Mapping
Salesforce CRM: Journal Subtype Mapping
These data mappings are for the Journal Subtype DLO found in the Loyalty Management bundle of the Salesforce CRM Connector for
Data Cloud. Journal subtypes help categorize the types of member activities for which transaction journals are created.
Data Bundle
• Loyalty Management
DLO to DMO Mapping
These data mappings relate to the Journal Subtype object included in the Salesforce CRM connector and how that data connects to
DMOs. Learn more about the DLOs in the Loyalty Management Developer Guide.
DLO Field DLO Field Data Type DMO DMO Field Name
Created Date dateTime Loyalty Journal Subtype Created Date
Journal Type ID id Loyalty Journal Subtype Loyalty Journal Subtype
Id
Last Modified Date dateTime Loyalty Journal Subtype Last Modified Date
Name string Loyalty Journal Subtype Name
Salesforce CRM: Journal Type Mapping
These data mappings are for the Journal type DLO found in the Loyalty Management bundle of the Salesforce CRM Connector for Data
Cloud. A journal type is used to categorize transaction journals based on the types of members activities for which members can be
rewarded.
Data Bundle
• Loyalty Management
DLO to DMO Mapping
These data mappings relate to the Journal type object included in the Salesforce CRM connector and how that data connects to DMOs.
Learn more about the DLOs in the Loyalty Management Developer Guide.
DLO Field DLO Field Data Type DMO DMO Field Name
Created Date dateTime Loyalty Journal Type Created Date
Journal Type ID id Loyalty Journal Type Loyalty Journal Subtype
Id
Last Modified Date dateTime Loyalty Journal Type Last Modified Date
Name string Loyalty Journal Type Name
588
Model Data in Data Cloud Salesforce CRM: Knowledge Article Mapping
Salesforce CRM: Knowledge Article Mapping
These data mappings are for the Knowledge_ka DLO found in the Knowledge bundle of the Salesforce CRM Connector for Data Cloud.
Usage and Data Bundle
Bundle:
• Knowledge Article: Used with Service Intelligence
`
DLO to DMO Mapping
These data mappings relate to the Knowledge_ka object included in the Salesforce CRM connector and how that data connects to
DMOs.
DLO Field DLO Field API DLO Field Data DMO DMO Field Additional
Name Type Name Details
Article Number ArticleNumber__c text Knowledge Article Article
Number
First FirstPublishedDate__c dateTime Knowledge Article First
Published Date Published
Date Time
Knowledge Id__c text Knowledge Article Knowledge Primary Key
Article ID Article Id
Last Published FirstPublishedDate__c dateTime Knowledge Article Last
Date Published
Date Time
Salesforce CRM: Knowledge Article Engagement Mapping
The data mappings are for KnowledgeArticleView DLO created by the Knowledge Article Views Ingestion API for Data Cloud. The mappings
are for the KnowledgeArticleEngagement DMO
Usage and Data Bundle
Knowledge Article Views Ingestion API:
• Knowledge Engagement: Used with Service Intelligence and Knowledge Enablement
DLO to DMO Mapping
These data mappings relate to the KnowledgeArticleView object included in the Knowledge Article Views Ingestion API and how that
data connects to the KnowledgeArticleEngagement DMO.
589
Model Data in Data Cloud Salesforce CRM: Knowledge Article Version Mapping
DLO Field DLO Field API DLO Field Data DMO DMO Field Additional
Name Type Name Details
ArticleViewContextDescription ArticleViewContextDescription__c text Knowledge Article Article View
Engagement Context
Id Id__c text Knowledge Article Knowledge Primary Key
Engagement Article
Engagement
Id
KnowledgeArticleUserTypeId KnowledgeArticleUserTypeId__c text Knowledge Article Knowledge
Engagement Article User
Type
KnowledgeArticleVersionId KnowledgeArticleVersionId__c text Knowledge Article Knowledge
Engagement Article
Version
SourceReferenceId SourceReferenceId__c text Knowledge Article Source
Engagement Reference
SourceReferenceObject SourceReferenceObject__c text Knowledge Article Source
Engagement Reference
Object
Timestamp Timestamp__c dateTime Knowledge Article Created Date
Engagement
UsedForGrounding UsedForGrounding__c text Knowledge Article Used For
Engagement Grounding
userId userId__c text Knowledge Article User
Engagement
WebsiteId WebsiteId__c text Knowledge Article Website
Engagement
Salesforce CRM: Knowledge Article Version Mapping
These data mappings are for the Knowledge_kav DLO found in the Knowledge bundle of the Salesforce CRM Connector for Data Cloud.
Usage and Data Bundle
Bundle: This bundle is used for Service Intelligence visualizations of knowledge article metrics.
• Knowledge: Used with Service Intelligence
DLO to DMO Mapping
These data mappings relate to the Knowledge_kav object included in the Salesforce CRM connector and how that data connects to
DMOs.
590
Model Data in Data Cloud Salesforce CRM: Knowledge Article Version Mapping
DLO Field DLO Field API DLO Field Data DMO DMO Field Additional
Name Type Name Details
Article Number ArticleNumber__c text Knowledge Article Version Article
Number
Article ArticleMasterLanguage__c text Knowledge Article Version Primary
Primary Language
Language
Created By Id CreatedById__c text Knowledge Article Version Created By
Created Date CreatedDate__c dateTime Knowledge Article Version Created Date
First FirstPublishedDate__c dateTime Knowledge Article Version First
Published Date Published
Date Time
Is Latest IsLastestVersion__c text Knowledge Article Version Is Latest
Version Version
Knowledge KnowledgeArticleId__c text Knowledge Article Version Knowledge
Article ID Article
Knowledge Id__c text Knowledge Article Version Knowledge Primary Key
Article Article
Version ID Version Id
Language Language__c text Knowledge Article Version Language
Last Modified LastModifiedDate__c dateTime Knowledge Article Version Last
Date Modified
Date
Next Review NextReviewDate__c dateTime Knowledge Article Version Next Review
Date DateTime
Publication PublishStatus__c text Knowledge Article Version Knowledge
Status Publication
Status Id
Summary Summary__c text Knowledge Article Version Description
Title Title__c text Knowledge Article Version Name
URL Name UrlName__c text Knowledge Article Version URL
Version Number VersionNumber__c number Knowledge Article Version Version
Number
Visible In IsVisibleInApp__c text Knowledge Article Version Visible In
Internal App Internal App
Visible In IsVisibleInPkb__c text Knowledge Article Version Visible In
Public Public
Knowledge Base
591
Model Data in Data Cloud Salesforce CRM: Knowledge Data Category Selection
Mapping
DLO Field DLO Field API DLO Field Data DMO DMO Field Additional
Name Type Name Details
Knowledge
Base
Visible to IsVisibleInCsp__c text Knowledge Article Version Visible to
Customer Customer
Visible to IsVisibleInPrm__c text Knowledge Article Version Visible to
Partner Partner
Salesforce CRM: Knowledge Data Category Selection Mapping
These data mappings are for the Knowledge_DataCategorySelection DLO found in the Knowledge bundle of the Salesforce CRM
Connector for Data Cloud.
Usage and Data Bundle
Bundle: This bundle is used for Service Intelligence visualizations of knowledge article metrics.
• Knowledge: Used with Service Intelligence
DLO to DMO Mapping
These data mappings relate to the Knowledge_DataCategorySelection object included in the Salesforce CRM connector and how that
data connects to DMOs.
DLO Field DLO Field API DLO Field Data DMO DMO Field Additional
Name Type Name Details
Data Catagory DataCategoryId__c text Knowledge Article Category
ID Category
Entity Data Id__c text Knowledge Article Knowledge Primary Key
Category Category Article
Selection ID Category Id
Knowledge ParentId__c text Knowledge Article Knowledge
Article Category Article
Version ID Version
Salesforce CRM: Linked Article Mapping
These data mappings are for the LinkedArticle DLO found in the Knowledge bundle of the Salesforce CRM Connector for Data Cloud.
Usage and Data Bundle
Bundle: This bundle is used for Service Intelligence visualizations of knowledge article metrics.
592
Model Data in Data Cloud Salesforce CRM: Lead Mappings
• Knowledge: Used with Service Intelligence
DLO to DMO Mapping
These data mappings relate to the LinkedArticle object included in the Salesforce CRM connector and how that data connects to DMOs.
DLO Field DLO Field API DLO Field Data DMO DMO Field Additional
Name Type Name Details
Article ID KnowledgeArticleId__c text Linked Knowledge Article Knowledge
Article
Created By ID CreatedById__c text Linked Knowledge Article Created By
Created Date CreatedDate__c dateTime Linked Knowledge Article Created Date
Knowledge KnowledgeArticleVersionId__c text Linked Knowledge Article Knowledge
Article Article
Version ID Version
Linked Article Id__c text Linked Knowledge Article Knowledge Primary Key
ID Article Id
Linked Article Name__c text Linked Knowledge Article Name
Title
Linked Entity LinkedEntityId__c text Linked Knowledge Article Linked
ID Reference
Linked Object Type__c text Linked Knowledge Article Linked
Type Reference
Object
Salesforce CRM: Lead Mappings
After a data stream is deployed, the Salesforce CRM starter data bundle automatically maps data from Sales Cloud or Service Cloud to
data model objects (DMO)s in Data Cloud. The Sales Cloud and Service Cloud bundles deploy mappings to Contact Point type DMOs.
Identity Resolution uses the DMOs, which link multiple records into a unified customer profile.
Usage and Data Bundles
These mappings are used for various purposes within these bundles.
Bundles:
• Sales Cloud
• Service Cloud
DLO to DMO Mapping
These data mappings relate to the Lead object included in the Salesforce CRM connector and how that data connects to DMOs.
593
Model Data in Data Cloud Salesforce CRM: Lead Mappings
DLO Field DLO Field Data Type DMO Object DMO Field Additional Details
City text Lead City
Contact Point Address City Name
Company text Lead Company Name
Converted boolean Lead Is Converted
Converted text Lead Converted To Foreign Key
Account Id Account
Converted text Lead Converted To Foreign Key
Contact Id AccountContact
Converted Date date Lead Converted Date
Converted text Lead Converted to Foreign Key
Opportunity Id Opportunity
Country text Contact Point Address Country Name
Lead Country Name
Created Date dateTime Individual Created Date
Lead Created Date
Description text Lead Description
Email text Contact Point Email Email Address
Email Bounced dateTime Lead EmailBouncedDate
Date
Contact Point Email Email Latest
Bounce Date Time
Email Bounced text Lead EmailBouncedReason
Reason
Contact Point Email Email Latest
Bounce Reason
Text
First Name text Individual First Name
Full Name text Individual Person Name
Industry text Lead Industry
Last Activity date Lead Last Activity
Date
Last Modified dateTime Lead Last Modified
Date Date
Individual Last Modified
Date
594
Model Data in Data Cloud Salesforce CRM: Lead Mappings
DLO Field DLO Field Data Type DMO Object DMO Field Additional Details
Last Name text Individual Last Name
Lead Id text Lead Lead Id Primary Key
Contact Point Foreign Key
Phone Contact Foreign Key
Point
Contact Point Email Contact Point Primary Key
Email Id
Party Foreign Key
Contact Point Phone Contact Point Primary Key
Phone Id
Party Foreign Key
Individual Individual Id Primary Key
Contact Point Address Contact Point Primary Key
Address Id
Contact Point Address Party Foreign Key
Lead Source text Lead Lead Source Foreign Key
Lead Status text Lead Status Foreign Key
Phone text Contact Point Phone Telephone Number
Photo Url text Lead Photo URL
Individual Photo URL
Rating text Lead Lead Rating Foreign Key
Salutation text Individual Salutation
State/Province text Contact Point Address State Province
Name
Lead State Province
Name
Street text Lead Street Name
Contact Point Address Address Line 1
Website text Lead Website
Zip/Postal Code text Lead Postal Code Foreign Key
Contact Point Address Postal Code Text Foreign Key
595
Model Data in Data Cloud Salesforce CRM: Loyalty Aggregated Point Expiration Ledger
Mapping
Salesforce CRM: Loyalty Aggregated Point Expiration Ledger Mapping
These data mappings are for the Loyalty Aggregated Point Expiration Ledger DLO found in the Loyalty Management bundle of the
Salesforce CRM Connector for Data Cloud. A ledger that contains the details of a member’s fixed-type non-qualifying points that are set
to expire on a particular date.
Data Bundle
• Loyalty Management
DLO to DMO Mapping
These data mappings relate to the Loyalty Aggregated Point Expiration Ledger object included in the Salesforce CRM connector and
how that data connects to DMOs. Learn more about the DLOs in the Loyalty Management Developer Guide.
DLO Field DLO Field Data Type DMO DMO Field Name
Expiration Date date Loyalty Aggregated Point Expiration Date
Expiration Ledger
Expiration Points double Loyalty Aggregated Point Expiration Points Number
Expiration Ledger
Loyalty Aggregated id Loyalty Aggregated Point Loyalty Aggregated Point
Point Expiration Expiration Ledger Expiration Ledger Id
Ledger ID
Currency ID reference Loyalty Aggregated Point Loyalty Program Currency
Expiration Ledger
Loyalty Program reference Loyalty Aggregated Point Loyalty Program Member
Member ID Expiration Ledger
Points Status picklist Loyalty Aggregated Point Points Status
Expiration Ledger
Redeemed Points double Loyalty Aggregated Point Redeemed Points Number
Expiration Ledger
Salesforce CRM: Loyalty Ledger Mapping
These data mappings are for the Loyalty Ledger DLO found in the Loyalty Management bundle of the Salesforce CRM Connector for
Data Cloud. A ledger contains information about credited, debited, or adjusted member activity points by transaction journals.
Data Bundle
• Loyalty Management
596
Model Data in Data Cloud Salesforce CRM: Loyalty Member Currency Mapping
DLO to DMO Mapping
These data mappings relate to the Loyalty Ledge object included in the Salesforce CRM connector and how that data connects to DMOs.
Learn more about the DLOs in the Loyalty Management Developer Guide.
DLO Field DLO Field Data Type DMO DMO Field Name
Activity Date dateTime Loyalty Ledger Activity Date
Created Date dateTime Loyalty Ledger Created Date
Correlation ID string Loyalty Ledger Data Entity Instance
Event Type picklist Loyalty Ledger Financial Transaction
Type
Last Modified Date dateTime Loyalty Ledger Last Modified Date
Points double Loyalty Ledger Loyalty Currency Unit
Quantity
Loyalty Ledger ID id Loyalty Ledger Loyalty Ledger Id
Currency ID reference Loyalty Ledger Loyalty Program Currency
Expiry Date date Loyalty Ledger Loyalty Program Currency
Expiration Date
Loyalty Program reference Loyalty Ledger Loyalty Program Member
Member ID
Transaction Journal reference Loyalty Ledger Loyalty Transaction
ID Journal
Salesforce CRM: Loyalty Member Currency Mapping
These data mappings are for the Loyalty Member Currency DLO found in the Loyalty Management bundle of the Salesforce CRM
Connector for Data Cloud. Information about the qualifying and non-qualifying currency points that are available in members’ point
balances.
Data Bundle
• Loyalty Management
DLO to DMO Mapping
These data mappings relate to the Loyalty Member Currency object included in the Salesforce CRM connector and how that data connects
to DMOs. Learn more about the DLOs in the Loyalty Management Developer Guide.
DLO Field DLO Field Data Type DMO DMO Field Name
Balance Before Reset double Loyalty Member Currency Points Balance Before
Reset
597
Model Data in Data Cloud Salesforce CRM: Loyalty Member Tier Mapping
DLO Field DLO Field Data Type DMO DMO Field Name
Created Date dateTime Loyalty Member Currency Created Date
Total Expirable double Loyalty Member Currency Expirable Points
Points
Loyalty Member id Loyalty Member Currency Loyalty Member Currency
Currency ID Id
Last Accrual dateTime Loyalty Member Currency Last Accrual Processed
Processed Date Date
Last Expiration date Loyalty Member Currency Last Expiration Process
Process Run Date Run Date
Last Modified Date dateTime Loyalty Member Currency Last Modified Date
Last Reset Date date Loyalty Member Currency Last Reset Date
Loyalty Program reference Loyalty Member Currency Loyalty Program Member
Member ID
Currency ID reference Loyalty Member Currency Loyalty Program Currency
Next Reset Date date Loyalty Member Currency Next Reset Date
Points Balance double Loyalty Member Currency Points Balance
Total Points Accrued double Loyalty Member Currency Total Points Accrued
Total Points Expired double Loyalty Member Currency Total Points Expired
Total Points Redeemed double Loyalty Member Currency Total Points Redeemed
Salesforce CRM: Loyalty Member Tier Mapping
These data mappings are for the Loyalty Member Tier DLO found in the Loyalty Management bundle of the Salesforce CRM Connector
for Data Cloud. A tier that is assigned to a member based on their engagement with the loyalty program.
Data Bundle
• Loyalty Management
DLO to DMO Mapping
These data mappings relate to the Loyalty Member Tier object included in the Salesforce CRM connector and how that data connects
to DMOs. Learn more about the DLOs in the Loyalty Management Developer Guide.
DLO Field DLO Field Data Type DMO DMO Field Name
Change Reason Type picklist Loyalty Member Tier Loyalty Member Tier
Change Type
598
Model Data in Data Cloud Salesforce CRM: Loyalty Partner Product Mapping
DLO Field DLO Field Data Type DMO DMO Field Name
Created Date dateTime Loyalty Member Tier Created Date
Effective Date date Loyalty Member Tier Effective Date
Loyalty Member Tier id Loyalty Member Tier Loyalty Member Tier Id
ID
Last Modified Date dateTime Loyalty Member Tier Last Modified Date
Loyalty Program reference Loyalty Member Tier Loyalty Program Member
Member ID
Loyalty Tier ID reference Loyalty Member Tier Loyalty Tier
Reason for Change string Loyalty Member Tier Tier Change Reason
Tier Expiration Date date Loyalty Member Tier Tier Expiration Date
Salesforce CRM: Loyalty Partner Product Mapping
These data mappings are for the Loyalty Partner Product DLO found in the Loyalty Management bundle of the Salesforce CRM Connector
for Data Cloud. This data refers to a product or service offered by a partner of the loyalty program to members of the loyalty program.
Members can accrue or redeem points by purchasing partner products or services.
Data Bundle
• Loyalty Management
DLO to DMO Mapping
These data mappings relate to the Loyalty Partner Product object included in the Salesforce CRM connector and how that data connects
to DMOs. Learn more about the DLOs in the Loyalty Management Developer Guide.
DLO Field DLO Field Data Type DMO DMO Field Name
Created Date dateTime Loyalty Partner Product Created Date
Loyalty Partner id Loyalty Partner Product Loyalty Partner Product
Product ID Id
Last Modified Date dateTime Loyalty Partner Product Last Modified Date
Loyalty Program reference Loyalty Partner Product Loyalty Program Partner
Partner ID
Start Date date Loyalty Partner Product Start Date
End Date date Loyalty Partner Product End Date
599
Model Data in Data Cloud Salesforce CRM: Loyalty Program Mapping
Salesforce CRM: Loyalty Program Mapping
These data mappings are for the Loyalty Program DLO found in the Loyalty Management bundle of the Salesforce CRM Connector for
Data Cloud. This object includes data about a company’s loyalty program.
Data Bundle
• Loyalty Management
DLO to DMO Mapping
These data mappings relate to the Loyalty Program object included in the Salesforce CRM connector and how that data connects to
DMOs. Learn more about the DLOs in the Loyalty Management Developer Guide.
DLO Field DLO Field Data Type DMO DMO Field Name
Created Date dateTime Loyalty Program Created Date
Loyalty Program ID id Loyalty Program Loyalty Program Member Id
Last Modified Date datetime Loyalty Program Last Modified Date
Program Name string Loyalty Program Name
Status picklist Loyalty Program Loyalty Program Status
Salesforce CRM: Loyalty Program Badge Mapping
These data mappings are for the Loyalty Program Badge DLO found in the Loyalty Management bundle of the Salesforce CRM Connector
for Data Cloud. Data refers to a badge assigned to a member as a reward for engaging with the loyalty program.
Data Bundle
• Loyalty Management
DLO to DMO Mapping
These data mappings relate to the Loyalty Program Badge object included in the Salesforce CRM connector and how that data connects
to DMOs. Learn more about the DLOs in the Loyalty Management Developer Guide.
DLO Field DLO Field Data Type DMO DMO Field Name
Status picklist Loyalty Program Badge Badge Status
Validity Type picklist Loyalty Program Badge Badge Validity Type
Description string Loyalty Program Badge Description
Image url Loyalty Program Badge Image URL
Loyalty Program ID reference Loyalty Program Badge Loyalty Program
600
Model Data in Data Cloud Salesforce CRM: Loyalty Program Currency Mapping
DLO Field DLO Field Data Type DMO DMO Field Name
Loyalty Program Badge id Loyalty Program Badge Loyalty Program Badge Id
ID
Name string Loyalty Program Badge Name
Start Date date Loyalty Program Badge Start Date
Validity Duration int Loyalty Program Badge Validity Duration
Validity Duration picklist Loyalty Program Badge Validity Duration UOM
Unit
Validity End Date date Loyalty Program Badge Validity End Date
Salesforce CRM: Loyalty Program Currency Mapping
These data mappings are for the Loyalty Program Currency DLO found in the Loyalty Management bundle of the Salesforce CRM
Connector for Data Cloud. Loyalty program credits points of a specific currency to members when they engage with the loyalty program.
Qualifying currency points help members qualify for tiers of the loyalty program. Members can redeem non-qualifying currency points
credited for their purchases.
Data Bundle
• Loyalty Management
DLO to DMO Mapping
These data mappings relate to the Loyalty Program Currency object included in the Salesforce CRM connector and how that data connects
to DMOs. Learn more about the DLOs in the Loyalty Management Developer Guide.
DLO Field DLO Field Data Type DMO DMO Field Name
Created Date dateTime Loyalty Program Currency Created Date
Currency Type picklist Loyalty Program Currency Currency Type
Expiration Interval picklist Loyalty Program Currency Expiration Period
Unit Frequency Time UOM
Expiry Interval int Loyalty Program Currency Expiration Period
Frequency
Expiry Model picklist Loyalty Program Currency Currency Expiration Model
Extend Expiration picklist Loyalty Program Currency Currency Expiration
Extension Model
Loyalty Program id Loyalty Program Currency Loyalty Program Currency
Currency ID Id
Active boolean Loyalty Program Currency Is Active
601
Model Data in Data Cloud Salesforce CRM: Loyalty Program Engagement Attribute
Mapping
DLO Field DLO Field Data Type DMO DMO Field Name
Primary boolean Loyalty Program Currency Is Primary
Last Modified Date dateTime Loyalty Program Currency Last Modified Date
Loyalty Program ID reference Loyalty Program Currency Loyalty Program
Loyalty Tier Group ID reference Loyalty Program Currency Loyalty Tier Group
Currency Name string Loyalty Program Currency Name
Salesforce CRM: Loyalty Program Engagement Attribute Mapping
These data mappings are for the Loyalty Program Engagement Attribute DLO found in the Loyalty Management bundle of the Salesforce
CRM Connector for Data Cloud. An engagement attribute is used to track a member’s long-term behavior. For example, an attribute can
track a member’s cumulative monthly spend or the number of times the member has logged in to the company’s shopping app.
Data Bundle
• Loyalty Management
DLO to DMO Mapping
These data mappings relate to the Loyalty Program Engagement Attribute object included in the Salesforce CRM connector and how
that data connects to DMOs. Learn more about the DLOs in the Loyalty Management Developer Guide.
DLO Field DLO Field Data Type DMO DMO Field Name
Default Value string Loyalty Program Default Value
Engagement Attribute
Description textarea Loyalty Program Description
Engagement Attribute
End Date date Loyalty Program End Date
Engagement Attribute
Loyalty Program ID reference Loyalty Program Loyalty Program
Engagement Attribute
Loyalty Program id Loyalty Program Loyalty Program
Engagement Attribute Engagement Attribute Engagement Attribute Id
ID
Maximum Reset Count int Loyalty Program Maximum Reset Count Per
Per Period Engagement Attribute Period
Name string Loyalty Program Name
Engagement Attribute
Reset Value On string Loyalty Program Reset Value On
Engagement Attribute
602
Model Data in Data Cloud Salesforce CRM: Loyalty Program Engagement Attribute
Promotion Mapping
DLO Field DLO Field Data Type DMO DMO Field Name
Overwrite Attribute boolean Loyalty Program Should Overwrite
Current Value Engagement Attribute Attribute Current Val
Start Date date Loyalty Program Start Date
Engagement Attribute
Status string Loyalty Program Status
Engagement Attribute
Target Value string Loyalty Program Target Value
Engagement Attribute
Value Reset Frequency picklist Loyalty Program Value Reset Frequency
Engagement Attribute
Salesforce CRM: Loyalty Program Engagement Attribute Promotion Mapping
These data mappings are for the Loyalty Program Engagement Attribute Promotion DLO found in the Loyalty Management bundle of
the Salesforce CRM Connector for Data Cloud. Data refers to an association between a promotion and an engagement attribute. Use
engagement attributes to track the progress of loyalty program members towards achieving promotion targets.
Data Bundle
• Loyalty Management
DLO to DMO Mapping
These data mappings relate to the Loyalty Program Engagement Attribute Promotion object included in the Salesforce CRM connector
and how that data connects to DMOs. Learn more about the DLOs in the Loyalty Management Developer Guide.
DLO Field DLO Field Data Type DMO DMO Field Name
Loyalty Program id Loyalty Program Loyalty Pgm Engmt
Engagement Attribute Engagement Attribute Attribute Promotion Id
Promotion ID Promotion
Loyalty Program reference Loyalty Program Loyalty Program
Engagement Attribute Engagement Attribute Engagement Attribute
ID Promotion
Name string Loyalty Program Name
Engagement Attribute
Promotion
Promotion ID reference Loyalty Program Promotion
Engagement Attribute
Promotion
603
Model Data in Data Cloud Salesforce CRM: Loyalty Program Group Member Relationship
Mapping
Salesforce CRM: Loyalty Program Group Member Relationship Mapping
These data mappings are for the Loyalty Program Group Member Relationship DLO found in the Loyalty Management bundle of the
Salesforce CRM Connector for Data Cloud. This data includes the association between a loyalty program member and their groups, along
with details of a member’s points contribution towards the associated group.
Data Bundle
• Loyalty Management
DLO to DMO Mapping
These data mappings relate to the Loyalty Program Group Member Relationship object included in the Salesforce CRM connector and
how that data connects to DMOs. Learn more about the DLOs in the Loyalty Management Developer Guide.
DLO Field DLO Field Data Type DMO DMO Field Name
Account ID reference Loyalty Program Group Account
Member Relationship
Contact ID reference Loyalty Program Group Account Contact
Member Relationship
Member can redeem boolean Loyalty Program Group Can Member Redeem From
group points Member Relationship Group
Contribution picklist Loyalty Program Group Contribution Calculation
Calculation Type Member Relationship Type
Loyalty Program Group id Loyalty Program Group Loyalty Program Group
Account Member ID Member Relationship Member Relationship Id
Loyalty Program reference Loyalty Program Group Loyalty Program Group
Member ID Member Relationship Member
Member Name string Loyalty Program Group Member Name
Member Relationship
Contribution percent Loyalty Program Group Member Point Contribution
Percentage Member Relationship Percent
Member Role picklist Loyalty Program Group Member Role
Member Relationship
Name string Loyalty Program Group Name
Member Relationship
Loyalty Program reference Loyalty Program Group Related Loyalty Program
Member ID Member Relationship Member
604
Model Data in Data Cloud Salesforce CRM: Loyalty Program Member Mapping
Salesforce CRM: Loyalty Program Member Mapping
These data mappings are for the Loyalty Program Member DLO found in the Loyalty Management bundle of the Salesforce CRM Connector
for Data Cloud. This data includes information about a member of the loyalty program and their individual or corporate membership
details.
Data Bundle
• Loyalty Management
DLO to DMO Mapping
These data mappings relate to the Loyalty Program Member object included in the Salesforce CRM connector and how that data connects
to DMOs. Learn more about the DLOs in the Loyalty Management Developer Guide.
DLO Field DLO Field Data Type DMO DMO Field Name
Account ID reference Loyalty Program Member Account
Associated Corporate reference Loyalty Program Member Related Corporate Program
Membership ID Member
Contact ID reference Loyalty Program Member Party
Contact ID reference Loyalty Program Member Account Contact
Created Date reference Loyalty Program Member Created Date
Enrollment Channel datetime Loyalty Program Member Enrollment Channel
Enrollment Date picklist Loyalty Program Member Enrollment Date
Loyalty Program date Loyalty Program Member
Member ID
Last Activity Date id Loyalty Program Member Last Activity Date
Last Modified Date date Loyalty Program Member Last Modified Date
Loyalty Program ID reference Loyalty Program Member Loyalty Program
Membership End Date date Loyalty Program Member Membership Expiration
Date
Membership Last datetime Loyalty Program Member Last Renewal Date
Renewal Date
Membership Number string Loyalty Program Member Membership Number
Member Status picklist Loyalty Program Member Loyalty Program Member
Status
Member Type picklist Loyalty Program Member Loyalty Member Type
Referred By ID reference Loyalty Program Member Referred by Member
605
Model Data in Data Cloud Salesforce CRM: Loyalty Program Member Attribute Value
Mapping
DLO Field DLO Field Data Type DMO DMO Field Name
Statement Frequency picklist Loyalty Program Member StatementFrequencyTimeUOM
Statement Last datetime Loyalty Program Member Statement Last Generated
Generated Date Date
Salesforce CRM: Loyalty Program Member Attribute Value Mapping
These data mappings are for the Loyalty Program Member Attribute Value DLO found in the Loyalty Management bundle of the Salesforce
CRM Connector for Data Cloud. This data refers to the value achieved by a loyalty program member for an engagement attribute. A
member’s progress towards the target for an engagement attribute is tracked across periods or for individual periods.
Data Bundle
• Loyalty Management
DLO to DMO Mapping
These data mappings relate to the Loyalty Program Member Attribute Value object included in the Salesforce CRM connector and how
that data connects to DMOs. Learn more about the DLOs in the Loyalty Management Developer Guide.
DLO Field DLO Field Data Type DMO DMO Field Name
Cumulative Value double Loyalty Program Member Cumulative Value
Attribute Value
Current Value string Loyalty Program Member Current Value
Attribute Value
End Date date Loyalty Program Member End Date
Attribute Value
LastResetDate date Loyalty Program Member Last Reset Date
Attribute Value
Loyalty Program id Loyalty Program Member Loyalty Pgm Member
Member Attribute Attribute Value Attribute Value Id
Value ID
Loyalty Program reference Loyalty Program Member Loyalty Program
Engagement Attribute Attribute Value Engagement Attribute
ID
Loyalty Program reference Loyalty Program Member Loyalty Program Member
Member ID Attribute Value
Name string Loyalty Program Member Name
Attribute Value
Reset Count int Loyalty Program Member Reset Count
Attribute Value
606
Model Data in Data Cloud Salesforce CRM: Loyalty Program Member Badge Mapping
DLO Field DLO Field Data Type DMO DMO Field Name
Start Date date Loyalty Program Member Start Date
Attribute Value
Salesforce CRM: Loyalty Program Member Badge Mapping
These data mappings are for the Loyalty Program Member Badge DLO found in the Loyalty Management bundle of the Salesforce CRM
Connector for Data Cloud. This data includes information about a badge assigned to a member as a reward for engaging with the loyalty
program.
Data Bundle
• Loyalty Management
DLO to DMO Mapping
These data mappings relate to the Loyalty Program Member Badge object included in the Salesforce CRM connector and how that data
connects to DMOs. Learn more about the DLOs in the Loyalty Management Developer Guide.
DLO Field DLO Field Data Type DMO DMO Field Name
End Date date Loyalty Program Member End Date
Badge
Loyalty Program Badge reference Loyalty Program Member Loyalty Program Badge
ID Badge
Loyalty Program reference Loyalty Program Member Loyalty Program Member
Member ID Badge
Loyalty Program id Loyalty Program Member Loyalty Program Member
Member Badge ID Badge Badge Id
Reason string Loyalty Program Member Reason
Badge
Start Date date Loyalty Program Member Start Date
Badge
Status picklist Loyalty Program Member Status
Badge
Salesforce CRM: Loyalty Program Member Case Mapping
These data mappings are for the Loyalty Program Member Case DLO found in the Loyalty Management bundle of the Salesforce CRM
Connector for Data Cloud. Data refers to an association between a loyalty program member and a case created by the member.
607
Model Data in Data Cloud Salesforce CRM: Loyalty Program Member Promotion
Mapping
Data Bundle
• Loyalty Management
DLO to DMO Mapping
These data mappings relate to the Loyalty Program Member Case object included in the Salesforce CRM connector and how that data
connects to DMOs. Learn more about the DLOs in the Loyalty Management Developer Guide.
DLO Field DLO Field Data Type DMO DMO Field Name
Case ID reference Loyalty Program Member Case
Case
Loyalty Program reference Loyalty Program Member Loyalty Program Member
Member ID Case
Loyalty Program id Loyalty Program Member Loyalty Program Member
Member Case ID Case Case Id
Name string Loyalty Program Member Name
Case
Salesforce CRM: Loyalty Program Member Promotion Mapping
These data mappings are for the Loyalty Program Member Promotion DLO found in the Loyalty Management bundle of the Salesforce
CRM Connector for Data Cloud. Data about a member’s promotion usage. For cumulative type promotions, the member’s progress is
tracked towards achieving the target of the promotion.
Data Bundle
• Loyalty Management
DLO to DMO Mapping
These data mappings relate to the Loyalty Program Member Promotion object included in the Salesforce CRM connector and how that
data connects to DMOs. Learn more about the DLOs in the Loyalty Management Developer Guide.
DLO Field DLO Field Data Type DMO DMO Field Name
Created Date datetime Loyalty Program Member Created Date
Promotion
Cumulative Usage percent Loyalty Program Member Cumulative Usage Complete
Complete Percentage Promotion Percent
Cumulative Usage int Loyalty Program Member Cumulative Usage
Completed Promotion Completed
CumulativeUsageTarget int Loyalty Program Member Cumulative Usage Target
Promotion
608
Model Data in Data Cloud Salesforce CRM: Loyalty Program Partner Mapping
DLO Field DLO Field Data Type DMO DMO Field Name
Loyalty Program id Loyalty Program Member Loyalty Program Member
Member Promotion ID Promotion Promotion Id
Last Modified Date datetime Loyalty Program Member Last Modified Date
Promotion
Loyalty Program reference Loyalty Program Member Loyalty Program Member
Member ID Promotion
Promotion ID reference Loyalty Program Member Promotion
Promotion
Salesforce CRM: Loyalty Program Partner Mapping
These data mappings are for the Loyalty Program Partner DLO found in the Loyalty Management bundle of the Salesforce CRM Connector
for Data Cloud. Loyalty program partners offer their products and services to members of the loyalty program. Partners can choose to
allow members to accrue or redeem points by purchasing partner products. Partners can also run promotions in collaboration with the
loyalty program.
Data Bundle
• Loyalty Management
DLO to DMO Mapping
These data mappings relate to the Loyalty Program Partner object included in the Salesforce CRM connector and how that data connects
to DMOs. Learn more about the DLOs in the Loyalty Management Developer Guide.
DLO Field DLO Field Data Type DMO DMO Field Name
Created Date dateTime Loyalty Program Partner Created Date
Loyalty Program id Loyalty Program Partner Loyalty Program Partner
Partner ID Id
Last Modified Date dateTime Loyalty Program Partner Last Modified Date
Loyalty Program reference Loyalty Program Partner Partner Account
Partner ID
Loyalty Program ID reference Loyalty Program Partner Loyalty Program
Program Partnership picklist Loyalty Program Partner Loyalty Partner Category
Category
Program Partnership date Loyalty Program Partner Partnership End Date
End Date
Program Partnership date Loyalty Program Partner Partnership Start Date
Start Date
609
Model Data in Data Cloud Salesforce CRM: Loyalty Program Partner Promotion Mapping
DLO Field DLO Field Data Type DMO DMO Field Name
Status picklist Loyalty Program Partner Loyalty Partner Status
Type picklist Loyalty Program Partner Loyalty Partner Type
Salesforce CRM: Loyalty Program Partner Promotion Mapping
These data mappings are for the Loyalty Program Partner Promotion DLO found in the Loyalty Management bundle of the Salesforce
CRM Connector for Data Cloud. Data refers to a promotion that a loyalty program runs in collaboration with a loyalty program partner.
Data Bundle
• Loyalty Management
DLO to DMO Mapping
These data mappings relate to the Loyalty Program Partner Promotion object included in the Salesforce CRM connector and how that
data connects to DMOs. Learn more about the DLOs in the Loyalty Management Developer Guide.
DLO Field DLO Field Data Type DMO DMO Field Name
Contribution percent Loyalty Program Partner Contribution Percentage
Percentage Promotion
Loyalty Program reference Loyalty Program Partner Loyalty Program Partner
Partner ID Promotion
Loyalty Program id Loyalty Program Partner Loyalty Program Partner
Partner Promotion ID Promotion Promotion Id
Name string Loyalty Program Partner Name
Promotion
Promotion ID reference Loyalty Program Partner Promotion
Promotion
Salesforce CRM: Loyalty Tier Mapping
These data mappings are for the Loyalty Tier DLO found in the Loyalty Management bundle of the Salesforce CRM Connector for Data
Cloud. Tiers are used to categorize members based on their engagement with the loyalty program. The rewards and benefits offered to
members can differ based on their assigned tier. ...
Data Bundle
• Loyalty Management
610
Model Data in Data Cloud Salesforce CRM: Loyalty Tier Benefit Mapping
DLO to DMO Mapping
These data mappings relate to the Loyalty Tier object included in the Salesforce CRM connector and how that data connects to DMOs.
Learn more about the DLOs in the Loyalty Management Developer Guide.
DLO Field DLO Field Data Type DMO DMO Field Name
Created Date dateTime Loyalty Tier Created Date
Loyalty Tier ID id Loyalty Tier Loyalty Tier Id
Last Modified Date dateTime Loyalty Tier Last Modified Date
Tier Name string Loyalty Tier Name
Tier Group ID reference Loyalty Tier Loyalty Tier Group
Salesforce CRM: Loyalty Tier Benefit Mapping
These data mappings are for the Loyalty Tier Benefit DLO found in the Loyalty Management bundle of the Salesforce CRM Connector
for Data Cloud. A benefit that’s associated with a member’s tier in the loyalty program.
Data Bundle
• Loyalty Management
DLO to DMO Mapping
These data mappings relate to the Loyalty Tier Benefit object included in the Salesforce CRM connector and how that data connects to
DMOs. Learn more about the DLOs in the Loyalty Management Developer Guide.
DLO Field DLO Field Data Type DMO DMO Field Name
Created Date dateTime Loyalty Tier Benefit Created Date
Loyalty Tier Benefit id Loyalty Tier Benefit Loyalty Tier Benefit Id
ID
Last Modified Date dateTime Loyalty Tier Benefit Last Modified Date
Benefit ID reference Loyalty Tier Benefit Loyalty Benefit
Loyalty Tier ID reference Loyalty Tier Benefit Loyalty Tier
Salesforce CRM: Loyalty Tier Group Mapping
These data mappings are for the Loyalty Tier Group DLO found in the Loyalty Management bundle of the Salesforce CRM Connector for
Data Cloud. A tier group consists of a set of tiers that can be assigned to members based on their engagement with the loyalty program.
611
Model Data in Data Cloud Salesforce CRM: Member Benefit Mapping
Data Bundle
• Loyalty Management
DLO to DMO Mapping
These data mappings relate to the Loyalty Tier Group object included in the Salesforce CRM connector and how that data connects to
DMOs. Learn more about the DLOs in the Loyalty Management Developer Guide.
DLO Field DLO Field Data Type DMO DMO Field Name
Created Date dateTime Loyalty Tier Group Created Date
Extend Expiration picklist Loyalty Tier Group Is Extended To End Of
Month
Loyalty Tier Group ID id Loyalty Tier Group Loyalty Tier Group Id
Active boolean Loyalty Tier Group Is Active
Primary boolean Loyalty Tier Group Is Primary
Last Modified Date dateTime Loyalty Tier Group Last Modified Date
Loyalty Program ID reference Loyalty Tier Group Loyalty Program
Qualifying Points date Loyalty Tier Group Qualifying Points Reset
Reset Date Date
Qualifying Points int Loyalty Tier Group Qualifying Points Reset
Reset Frequency Frequency
Qualifying Points picklist Loyalty Tier Group Qualifying Points Reset
Reset Period Period
Tier Period Unit picklist Loyalty Tier Group Tier Period Time UOM
Tier Period Quantity int Loyalty Tier Group Tier Period Quantity
Tier Model picklist Loyalty Tier Group Loyalty Tier Model
Tier Group Name string Loyalty Tier Group Name
Salesforce CRM: Member Benefit Mapping
These data mappings are for the Journal type DLO found in the Loyalty Management bundle of the Salesforce CRM Connector for Data
Cloud. A benefit that has been assigned to a member. Members are assigned benefits based on their tier or based on their engagement
with the loyalty program.
Data Bundle
• Loyalty Management
612
Model Data in Data Cloud Salesforce CRM: Participant Mapping
DLO to DMO Mapping
These data mappings relate to the Journal type object included in the Salesforce CRM connector and how that data connects to DMOs.
Learn more about the DLOs in the Loyalty Management Developer Guide.
DLO Field DLO Field Data Type DMO DMO Field Name
Benefit ID reference MemberBenefit Loyalty Benefit
Created Date dateTime MemberBenefit Created Date
Member Benefit ID id MemberBenefit Member Benefit Id
End Date date MemberBenefit End Date
Last Modified Date dateTime MemberBenefit Last Modified Date
Member ID reference MemberBenefit Loyalty Program Member
Start Date date MemberBenefit Start Date
Status picklist MemberBenefit Member Benefit Status
Salesforce CRM: Participant Mapping
These data mappings are for the Participant DLO found in the Services bundle of the Salesforce CRM Connector for Data Cloud.
Usage and Data Bundle
These mappings access Digital Engagement channel data for Service Cloud Voice, Messaging for In-App and Web, and enhanced
third-party channels, such as Facebook Messenger, Apple Messages for Business, WhatsApp,and SMS. The data can be used via reports,
dashboards, and APIs for insightful conversation analytics.
Bundle:
• Digital Engagement
DLO to DMO Mapping
These data mappings relate to the Participant object used with the CRM connector. You can add or customize the data mappings.
DLO Field DLO Field API Name DLO Field Data DMO DMO Field additional
Type Name details
App Type ParticipantAppType__c Text Participant Participant
Participant Id__c Text Participant Engagement Primary Key
ID Participant
App
Role ParticipantRole__c Text Participant Engagement
Participant
Role
613
Model Data in Data Cloud Salesforce CRM: Person Life Event Mappings
DLO Field DLO Field API Name DLO Field Data DMO DMO Field additional
Type Name details
Subject ParticipantSubject__c Text Participant Subject
Salesforce CRM: Person Life Event Mappings
These data mappings are for the PersonLifeEvent DLO found in Financial Services Cloud bundle of the Salesforce CRM Connector for
Data Cloud.
Usage and Data Bundle
Bundle:
• Financial Services Cloud
DLO to DMO Mapping
These data mappings relate to the PersonLifeEvent object included in the Salesforce CRM connector and how that data connects to
DMOs.
DLO Field DLO API Name DLO Field Data DMO DMO Field Name
Type
ExpirationDate dateTime Person Life Event Event Expiry Date
Id id Person Life Event Person Life Event Id
PrimaryPersonId text Person Life Event Individual
IsExpired boolean Person Life Event IsEventExpired
EventDate dateTime Person Life Event Person Life Event
Date Time
EventType picklist Person Life Event Person Life Event
TYpe
Salesforce CRM: Product Mapping
These data mappings are for the Product DLO found in the Loyalty Management bundle of the Salesforce CRM Connector for Data Cloud.
A product that the company sells.
Data Bundle
• Loyalty Management
614
Model Data in Data Cloud Salesforce CRM: Promotion Mapping
DLO to DMO Mapping
These data mappings relate to the Product object included in the Salesforce CRM connector and how that data connects to DMOs. Learn
more about the DLOs in the Loyalty Management Developer Guide.
DLO Field DLO Field Data Type DMO DMO Field Name
Product Code string Product Product Code
Description textarea Product Description
Product Family picklist Product Product Family
Product ID id Product Product Id
Name string Product Product Name
Product SKU string Product Product SKU
Quantity Unit Of picklist Product Quantity Unit Of Measure
Measure
Salesforce CRM: Promotion Mapping
These data mappings are for the Promotion DLO found in the Loyalty Management bundle of the Salesforce CRM Connector for Data
Cloud. Information about a promotion that’s offered to members of a loyalty program.
Data Bundle
• Loyalty Management
DLO to DMO Mapping
These data mappings relate to the Promotion object included in the Salesforce CRM connector and how that data connects to DMOs.
Learn more about the DLOs in the Loyalty Management Developer Guide.
DLO Field DLO Field Data Type DMO DMO Field Name
Campaign ID reference Promotion Primary Campaign
Created Date dateTime Promotion Created Date
Cumulative Usage int Promotion Cumulative Usage Target
Target Amount
Voucher Definition ID reference Promotion Default Voucher
Definition
End Date date Promotion End Date
Enrollment End Date date Promotion Enrollment End Date
Enrollment Start Date date Promotion Enrollment Start Date
615
Model Data in Data Cloud Salesforce CRM: Promotion Loyalty Partner Product Mapping
DLO Field DLO Field Data Type DMO DMO Field Name
Fulfillment Action picklist Promotion Fulfillment Action
Promotion ID id Promotion Promotion Id
Last Modified Date dateTime Promotion Last Modified Date
Loyalty Promotion picklist Promotion Promotion Type
Type
Enrollment Required boolean Promotion Is Enrollment Required
Name string Promotion Name
Start Date date Promotion Start Date
Loyalty Program ID reference Promotion Loyalty Program
Currency ID reference Promotion Loyalty Program
Status picklist Promotion Promotion Status
Reward Points int Promotion Total Reward Value Amount
Salesforce CRM: Promotion Loyalty Partner Product Mapping
These data mappings are for the Promotion Loyalty Partner Product DLO found in the Loyalty Management bundle of the Salesforce
CRM Connector for Data Cloud. A product that’s eligible for a promotion. Members are provided with the promotion’s reward when
they purchase a product that’s eligible for the promotion.
Data Bundle
• Loyalty Management
DLO to DMO Mapping
These data mappings relate to the Promotion Loyalty Partner Product object included in the Salesforce CRM connector and how that
data connects to DMOs. Learn more about the DLOs in the Loyalty Management Developer Guide.
DLO Field DLO Field Data Type DMO DMO Field Name
Created Date dateTime Promotion Loyalty Partner Created Date
Product
Promotion Loyalty id Promotion Loyalty Partner Promotion Loyalty Partner
Partner Product ID Product Product Id
Last Modified Date dateTime Promotion Loyalty Partner Last Modified Date
Product
Loyalty Partner reference Promotion Loyalty Partner Loyalty Partner Product
Product ID Product
616
Model Data in Data Cloud Salesforce CRM: Promotion Market Segment Mapping
DLO Field DLO Field Data Type DMO DMO Field Name
Promotion ID reference Promotion Loyalty Partner Promotion
Product
Salesforce CRM: Promotion Market Segment Mapping
These data mappings are for the Promotion Market Segment DLO found in the Loyalty Management bundle of the Salesforce CRM
Connector for Data Cloud. Promotions are associated with market segments that the promotions are targeted towards.
Data Bundle
• Loyalty Management
DLO to DMO Mapping
These data mappings relate to the Promotion Market Segment object included in the Salesforce CRM connector and how that data
connects to DMOs. Learn more about the DLOs in the Loyalty Management Developer Guide.
DLO Field DLO Field Data Type DMO DMO Field Name
Market Segment ID reference Promotion Market Segment Market Segment
Promotion ID reference Promotion Market Segment Promotion
Promotion Market id Promotion Market Segment Promotion Market Segment
Segment ID Id
Salesforce CRM: Securities Mappings
These data mappings are for the Securities DLO found in Financial Services Cloud bundle of the Salesforce CRM Connector for Data
Cloud.
Usage and Data Bundle
Bundle:
• Financial Services Cloud
DLO to DMO Mapping
These data mappings relate to the Securities object included in the Salesforce CRM connector and how that data connects to DMOs.
DLO Field DLO API Name DLO Field Data DMO DMO Field Name
Type
Id id Financial Security Security Id
Name text Financial Security Name
617
Model Data in Data Cloud Salesforce CRM: Segment Mapping
DLO Field DLO API Name DLO Field Data DMO DMO Field Name
Type
Price FinServ__Price_c currency Financial Security Price
Salesforce CRM: Segment Mapping
These data mappings are for the Segment DLO found in the Loyalty Management bundle of the Salesforce CRM Connector for Data
Cloud. Segments in Data Cloud are used to determine the target audience for promotions and used to determine the type of rewards
provided to members.
Data Bundle
• Loyalty Management
DLO to DMO Mapping
These data mappings relate to the Segment object included in the Salesforce CRM connector and how that data connects to DMOs.
Learn more about the DLOs in the Loyalty Management Developer Guide.
DLO Field DLO Field Data Type DMO DMO Field Name
Description textarea Market Segment Description
Include Criteria textarea Market Segment Include Criteria
Segment Status Last dateTime Market Segment Last Status Date
Updated
Segment ID id Market Segment Market Segment Id
Publish Status picklist Market Segment Market Segment
Publication Status
Name text Market Segment Name
Salesforce CRM: Service Presence Status Mapping
These data mappings are for the ServicePresenceStatus DLO found in the Services bundle of the Salesforce CRM Connector for Data
Cloud.
Usage and Data Bundle
These mappings are used to power Service Intelligence visualizations of contact center performance metrics.
Bundle:
• Service Cloud
618
Model Data in Data Cloud Salesforce CRM: Skill Mapping
DLO to DMO Mapping
These data mappings relate to the Service Presence object included in the Salesforce CRM connector and how that data connects to
DMOs.
DLO Field DLO Field API DLO Field Data DMO DMO Field Name Additional Details
Name Type
Service Id__c text Service Agent Work Status ID Primary Key
Presence Presence
Status ID Status
Status Name MasterLabel__c text Service Name
Presence
Status
Salesforce CRM: Skill Mapping
These data mappings are for the Skill DLO found in the Services bundle of the Salesforce CRM Connector for Data Cloud.
Usage and Data Bundle
These mappings are used to power Service Intelligence visualizations of contact center performance metrics.
Bundle:
• Service Cloud
DLO to DMO Mapping
These data mappings relate to the Skill object included in the Salesforce CRM connector and how that data connects to DMOs.
DLO Field DLO Field API DLO Field Data DMO DMO Field Name Additional Details
Name Type
Name MasterLabel__c text Skill Name
Skill ID Id__c text Skill Skill ID Primary Key
Salesforce CRM: Survey Mapping
These data mappings are for the Survey DLO found in the Services bundle of the Salesforce CRM Connector for Data Cloud.
Usage and Data Bundle
These mappings are used to power Service Intelligence visualizations of contact center performance metrics.
Bundle:
• Service Cloud
619
Model Data in Data Cloud Salesforce CRM: Survey Invitation Mapping
DLO to DMO Mapping
These data mappings relate to the Survey object used with the CRM connector. You can add or customize the data mappings.
DLO Field DLO Field API DLO Field Data DMO DMO Field Name Additional Details
Name Type
Created Date CreatedDate__c dateTime Survey Created Date
Developer DeveloperName__c text Survey Name
Name
Last Modified LastModifiedDate__c dateTime Survey Last Modified
Date Date
Name Name__c text Survey Description
Namespace NamespacePrefix__c text Survey Name Prefix
Prefix
Survey ID text Survey Survey ID
Survey ActiveVersionId__c text Survey Active Survey
Version ID Version
Type SurveyType__c text Survey Survey Type
Salesforce CRM: Survey Invitation Mapping
These data mappings are for the SurveyInvitation DLO found in the Services bundle of the Salesforce CRM Connector for Data Cloud.
Usage and Data Bundle
These mappings are used to power Service Intelligence visualizations of contact center performance metrics.
Bundle:
• Service Cloud
DLO to DMO Mapping
These data mappings relate to the Survey Invitation object included in the Salesforce CRM connector and how that data connects to
DMOs.
DLO Field DLO Field API Name DLO Field Data DMO DMO Field Additional
Type Name Details
Let Guests OptionsAllowGuestUserResponse__c text Survey Invitation Can Guest
Respond User
Respond
Can See OptionsAllowParticipantAccessTheirRespon__c text Survey Invitation Can
Their Participant
Response
620
Model Data in Data Cloud Salesforce CRM: Survey Page Mapping
DLO Field DLO Field API Name DLO Field Data DMO DMO Field Additional
Type Name Details
Access
Response
Can Respond OptionsCollectAnonymousResponse__c text Survey Invitation Can
Anonymously Participant
Respond
Anonymously
Created CreatedDate__c dateTime Survey Invitation Created
Date Date
Invitation InviteExpiryDateTime__c dateTime Survey Invitation Invitation
Expires On Expires On
Invitation InvitationLink__c text Survey Invitation Invitation
Link Link
Last LastModifiedDate__c dateTime Survey Invitation Last
Modified Modified
Date Date
Name Name__c text Survey Invitation Name
Participant ParticipantId__c text Survey Invitation Participant
ID
Survey ID SurveyId__c text Survey Invitation Survey
Survey Id__c text Survey Invitation Survey Primary Key
Invitation Invitation
ID ID
Response ResponseStatus__c text Survey Invitation Survey
Response
Status
Salesforce CRM: Survey Page Mapping
These data mappings are for the SurveyPage DLO found in the Services bundle of the Salesforce CRM Connector for Data Cloud.
Usage and Data Bundle
These mappings are used to power Service Intelligence visualizations of contact center performance metrics.
Bundle:
• Service Cloud
DLO to DMO Mapping
These data mappings relate to the Survey Page object included in the Salesforce CRM connector and how that data connects to DMOs.
621
Model Data in Data Cloud Salesforce CRM: Survey Question Mapping
DLO Field DLO Field API DLO Field Data DMO DMO Field Name Additional Details
Name Type
Created Date CreatedDate__c dateTime Survey Question Created Date
Section
Developer DeveloperName__c text Survey Question Name
Name Section
Display Order DisplayOrder__c number Survey Question Display Order
Section
Last Modified LastModifiedDate__c dateTime Survey Question Last Modified
Date Section Date
Name Name__c text Survey Question Description
Section
Survey Page Id__c text Survey Question Survey Primary Key
ID Section Question
Section ID
Survey SurveyVersionId__c text Survey Question Survey
Version ID Section Version
Salesforce CRM: Survey Question Mapping
These data mappings are for the SurveyQuestion DLO found in the Services bundle of the Salesforce CRM Connector for Data Cloud.
Usage and Data Bundle
These mappings are used to power Service Intelligence visualizations of contact center performance metrics.
Bundle:
• Service Cloud
DLO to DMO Mapping
These data mappings relate to the Survey Question object included in the Salesforce CRM connector and how that data connects to
DMOs.
DLO Field DLO Field API DLO Field Data DMO DMO Field Name Additional Details
Name Type
Created Date CreatedDate__c dateTime Survey Question Created Date
Display Order QuestionOrder__c number Survey Question Display Order
Is Deprecated IsDeprecated__c text Survey Question Deprecated
Last Modified LastModifiedDate__c dateTime Survey Question Last Modified
Date Date
622
Model Data in Data Cloud Salesforce CRM: Survey Question Response Mapping
DLO Field DLO Field API DLO Field Data DMO DMO Field Name Additional Details
Name Type
Name Name__c text Survey Question Name
Question Name QuestionName__c text Survey Question Description
Question Type QuestionType__c text Survey Question Survey
Question Type
Survey Page SurveyPageId__c text Survey Question Survey
ID Question
Section
Survey Id__c text Survey Question Survey Primary Key
Question ID Question ID
Salesforce CRM: Survey Question Response Mapping
These data mappings are for the SurveyQuestionResponse DLO found in the Services bundle of the Salesforce CRM Connector for Data
Cloud.
Usage and Data Bundle
These mappings are used to power Service Intelligence visualizations of contact center performance metrics.
Bundle:
• Service Cloud
DLO to DMO Mapping
These data mappings relate to the Survey Question Response object included in the Salesforce CRM connector and how that data
connects to DMOs.
DLO Field DLO Field API DLO Field Data DMO DMO Field Name Additional Details
Name Type
Created Date CreatedDate__c dateTime Survey Question Created Date
Response
Data Type Datatype__c text Survey Question Data Type
Response
Date Time DateTimeValue__c dateTime Survey Question Date Time
Value Response Value
Date Value DateValue__c dateTime Survey Question Date Value
Response
Last Modified LastModifiedDate__c dateTime Survey Question Last Modified
Date Response Date
623
Model Data in Data Cloud Salesforce CRM: Survey Response Mapping
DLO Field DLO Field API DLO Field Data DMO DMO Field Name Additional Details
Name Type
Name ResponseShortText__c text Survey Question Name
Response
Number Value NumberValue__c text Survey Question Number Value
Response
Rank Rank__c number Survey Question Rank
Response
Response ResponseValue__c text Survey Question Response
Value Response Value
Survey QuestionId__c text Survey Question Survey
Question ID Response Question
Survey Id__c text Survey Question Survey Primary Key
Question Response Question
Response ID Response
Survey ResponseId__c text Survey Question Survey
Response ID Response Response
True of False TrueOrFalse text Survey Question Boolean Value
Response
Salesforce CRM: Survey Response Mapping
These data mappings are for the SurveyResponse DLO found in the Services bundle of the Salesforce CRM Connector for Data Cloud.
Usage and Data Bundle
These mappings are used to power Service Intelligence visualizations of contact center performance metrics.
Bundle:
• Service Cloud
DLO to DMO Mapping
These data mappings relate to the Survey Response object included in the Salesforce CRM connector and how that data connects to
DMOs.
DLO Field DLO Field API DLO Field Data DMO DMO Field Name Additional Details
Name Type
Created Date CreatedDate__c dateTime Survey Response Created Date
Last Modified LastModifiedDate__c dateTime Survey Response Last Modified
Date Date
624
Model Data in Data Cloud Salesforce CRM: Survey Subject Mapping
DLO Field DLO Field API DLO Field Data DMO DMO Field Name Additional Details
Name Type
Response CompletionDateTime__c dateTime Survey Response Completion
Completion Date
Date and Time
Response Name Name__c text Survey Response Name
Response Status__c text Survey Response Survey
Status Response
Status
Response SubmitterId__c text Survey Response Submitter
Submitter ID
Survey InvitationId__c text Survey Response Survey
Invitation ID Invitation
Survey Id__c text Survey Response Survey Primary Key
Response ID Response ID
Survey SurveyVersionId__c text Survey Response Survey
Version ID Version
Salesforce CRM: Survey Subject Mapping
These data mappings are for the SurveySubject DLO found in the Services bundle of the Salesforce CRM Connector for Data Cloud.
Usage and Data Bundle
These mappings are used to power Service Intelligence visualizations of contact center performance metrics.
Bundle:
• Service Cloud
DLO to DMO Mapping
These data mappings relate to the Survey Subject object included in the Salesforce CRM connector and how that data connects to DMOs.
DLO Field DLO Field API DLO Field Data DMO DMO Field Name Additional Details
Name Type
Created Date CreatedDate__c dateTime Survey Subject Created Date
Last Modified LastModifiedDate__c dateTime Survey Subject Last Modified
Date Date
Name RecordName__c text Survey Subject Name
625
Model Data in Data Cloud Salesforce CRM: Survey Version Mapping
DLO Field DLO Field API DLO Field Data DMO DMO Field Name Additional Details
Name Type
Object Id__c text Survey Subject Survey Primary Key
Relationship Subject ID
ID
Parent ID ParentId__c text Survey Subject Survey Parent
Related ID SubjectEntityType__c text Survey Subject Survey
Subject
Object
Subject ID SubjectId__c text Survey Subject Survey
Subject
Survey ID SurveyId__c text Survey Subject Survey
Salesforce CRM: Survey Version Mapping
These data mappings are for the SurveyVersion DLO found in the Services bundle of the Salesforce CRM Connector for Data Cloud.
Usage and Data Bundle
These mappings are used to power Service Intelligence visualizations of contact center performance metrics.
Bundle:
• Service Cloud
DLO to DMO Mapping
These data mappings relate to the Survey Version object used with the CRM connector. You can add or customize the data mappings.
DLO Field DLO Field API DLO Field Data DMO DMO Field Name Additional Details
Name Type
Created Date CreatedDate__c dateTime Survey Version Created Date
Last Modified LastModifiedDate__c dateTime Survey Version Last Modified
Date Date
Name Name__c text Survey Version Name
Survey ID SurveyId__c text Survey Version Survey
Survey Status SurveyStatus__c text Survey Version Survey Status
Survey Id__c text Survey Version Survey Primary Key
Version ID Version ID
Version VersionNumber__c number Survey Version Version
Number Number
626
Model Data in Data Cloud Salesforce CRM: Topic Mappings
Salesforce CRM: Topic Mappings
These data mappings are for the Topic DLO found in Financial Services Cloud bundle of the Salesforce CRM Connector for Data Cloud.
Usage and Data Bundle
Bundle:
• Financial Services Cloud
DLO to DMO Mapping
These data mappings relate to the Topic object included in the Salesforce CRM connector and how that data connects to DMOs.
DLO Field DLO API Name DLO Field Data DMO DMO Field Name
Type
Description text Interest Tag Definition Description
Id id Interest Tag Definition Interest Tag
Definition Id
Name text Interest Tag Definition Name
Salesforce CRM: Transaction Journal Mapping
These data mappings are for the Transaction Journal DLO found in the Loyalty Management bundle of the Salesforce CRM Connector
for Data Cloud. Transaction journals are used to track member activities, member behavior, and adjustments.
Data Bundle
• Loyalty Management
DLO to DMO Mapping
These data mappings relate to the Transaction Journal object included in the Salesforce CRM connector and how that data connects to
DMOs. Learn more about the DLOs in the Loyalty Management Developer Guide.
DLO Field DLO Field Data Type DMO DMO Field Name
Activity Date dateTime Transaction Journal Activity Date
Booked Fare Class picklist Transaction Journal Booked Fare Class
Booked Room Type picklist Transaction Journal Booked Room Type
Booking Date date Transaction Journal Booking Date
Brand string Transaction Journal Brand
Channel picklist Transaction Journal Sales Channel
627
Model Data in Data Cloud Salesforce CRM: Transaction Journal Mapping
DLO Field DLO Field Data Type DMO DMO Field Name
Created Date dateTime Transaction Journal Created Date
Destination string Transaction Journal Travel Destination Name
Distance double Transaction Journal Travel Distance Number
Establishment string Transaction Journal Establishment Name
External Transaction string Transaction Journal External Record Id
ID
Flight Number string Transaction Journal Flight Number
Transaction Journal id Transaction Journal Loyalty Transaction
Journal Id
Industry picklist Transaction Journal Industry
Invoice Generated date Transaction Journal Invoice Date
Date
Journal Date dateTime Transaction Journal Journal Date
Journal Reason picklist Transaction Journal Reason
Journal SubType ID reference Transaction Journal Loyalty Journal Subtype
Journal Type ID reference Transaction Journal Loyalty Journal Type
Last Modified Date dateTime Transaction Journal Last Modified Date
Loyalty Program ID reference Transaction Journal Loyalty Program
Program Member ID reference Transaction Journal Loyalty Program Member
Order Product ID reference Transaction Journal Sales Order Product
Origin string Transaction Journal Travel Origin Name
Loyalty Program reference Transaction Journal Loyalty Program Partner
Partner ID
Payment Method string Transaction Journal Payment Method Type
Product ID reference Transaction Journal Product
Quantity double Transaction Journal Transaction Quantity
Quantity Unit ID reference Transaction Journal Transaction Quantity UOM
Referred Member ID reference Transaction Journal Loyalty Program Referred
Member
Related Corporate reference Transaction Journal Loyalty Program Corporate
Membership ID Member
628
Model Data in Data Cloud Salesforce CRM: Unit of Measure Mapping
DLO Field DLO Field Data Type DMO DMO Field Name
Related Journal ID reference Transaction Journal Related Loyalty
Transaction Journal
Transaction Amount double Transaction Journal Transaction Amount
Transaction Location string Transaction Journal Location
Traveled Fare Class string Transaction Journal Traveled Fare Class
Salesforce CRM: Unit of Measure Mapping
These data mappings are for the Unit of Measure DLO found in the Loyalty Management bundle of the Salesforce CRM Connector for
Data Cloud. The unit of measure for a product purchased by a loyalty program member.
Data Bundle
• Loyalty Management
DLO to DMO Mapping
These data mappings relate to the Unit of Measure object included in the Salesforce CRM connector and how that data connects to
DMOs. Learn more about the DLOs in the Loyalty Management Developer Guide.
DLO Field DLO Field Data Type DMO DMO Field Name
Name string Unit of Measure Name
Unit Code string Unit of Measure Unit Of Measure Code
Unit of Measure ID id Unit of Measure Unit of Measure Id
Type picklist Unit of Measure Unit Of Measure Type
Salesforce CRM: User Mapping
These data mappings are for the User DLO found in the Services bundle of the Salesforce CRM Connector for Data Cloud.
Usage and Data Bundle
These mappings are used to power Service Intelligence visualizations of contact center performance metrics.
Bundle:
• Service Cloud
DLO to DMO Mapping
These data mappings relate to the Conversation Reason object used with the CRM connector. You can add or customize the data
mappings.
629
Model Data in Data Cloud Salesforce CRM: User Role Mapping
DLO Field DLO Field API DLO Field Data DMO DMO Field Name Additional
Name Type Information
Active IsActive__c text User Is Active
Company Name CompanyName__c text User Company Name
Email Email__c text User Email
First Name FirstName__c text User First Name
Full Name Name__c text User Full Name
Last Name LastName__c text User Last Name
Role ID UserRoleId__c text User User Group
User ID Id__c text User User ID Primary Key
Username Username__c text User Username
Salesforce CRM: User Role Mapping
These data mappings are for the UserRole DLO found in the Services bundle of the Salesforce CRM Connector for Data Cloud.
Usage and Data Bundle
These mappings are used to power Service Intelligence visualizations of contact center performance metrics.
Bundle:
• Service Cloud
DLO to DMO Mapping
These data mappings relate to the User Role object used with the CRM connector. You can add or customize the data mappings.
DLO Field DLO Field API DLO Data Type DMO DMO Field Name Additional Details
Name
Name Name__c text User Group Alias
Last Modified LastModifiedDate__c dateTime User Group Last Modified
Date Date
Developer DeveloperName__c text User Group Name
Name
Parent Role ParentRoleId__c text User Group User Group
ID
Role ID Id__c text User Group User Group ID Primary Key
630
Model Data in Data Cloud Salesforce CRM: User Service Presence Mapping
Salesforce CRM: User Service Presence Mapping
These data mappings are for the UserServicePresence DLO found in the Services bundle of the Salesforce CRM Connector for Data Cloud.
Usage and Data Bundle
These mappings are used to power Service Intelligence visualizations of contact center performance metrics.
Bundle:
• Service Cloud
DLO to DMO Mapping
These data mappings relate to the User Service Presence object used with the CRM connector. You can add or customize the data
mappings.
DLO Field DLO Field API Name DLO Data Type DMO DMO Field Name
At Capacity Description__c number Agent Service Presence At Capacity
Duration Duration
Average Capacity AverageCapacity__c number Agent Service Presence Average Capacity
Configured ConfiguredCapacity__c number Agent Service Presence Configured
Capacity Capacity
Idle Duration IdleDuration__c number Agent Service Presence Idle Duration
Is Away IsAway__c text Agent Service Presence Away
Is Current State IsCurrentState__c text Agent Service Presence Current State
Name Name__c text Agent Service Presence Name
Service Presence ServicePresenceStatusId__c text Agent Service Presence Service Presence
Status ID Status
Status Duration StatusDuration__c number Agent Service Presence Status Duration
Status End Date StatusEndDate__c dateTime Agent Service Presence Status End Date
Status Start StatusStartDate__c dateTime Agent Service Presence Status Start
Date Date
User ID UserId__c text Agent Service Presence User
User Presence ID Id__c number Agent Service Presence Agent Service
Presence ID
Salesforce CRM: Voucher Mapping
These data mappings are for the Voucher DLO found in the Loyalty Management bundle of the Salesforce CRM Connector for Data
Cloud. Data is about a voucher issued to a loyalty program member.
631
Model Data in Data Cloud Salesforce CRM: Voucher Definition Mapping
Data Bundle
• Loyalty Management
DLO to DMO Mapping
These data mappings relate to the Voucher object included in the Salesforce CRM connector and how that data connects to DMOs.
Learn more about the DLOs in the Loyalty Management Developer Guide.
DLO Field DLO Field Data DMO DMO Field Name
Type
Benefit ID reference Voucher Loyalty Benefit
Created Date dateTime Voucher Created Date
Discount Percentage int Voucher Discount Percent
Effective Date date Voucher Effective Date
Expiration Date date Voucher Expiration Date
Face Value currency Voucher Face Value Amount
Voucher ID id Voucher Voucher Id
Last Modified Date dateTime Voucher Last Modified Date
Loyalty Program reference Voucher Loyalty Program Member
Member ID
Voucher Number string Voucher Name
Promotion ID reference Voucher Promotion
Reason string Voucher Notes
Status picklist Voucher Voucher Status
Transaction Journal reference Voucher Loyalty Transaction
ID Journal
Use Date date Voucher Used Date
Voucher Definition ID reference Voucher Voucher Definition
Salesforce CRM: Voucher Definition Mapping
These data mappings are for the Voucher Definition DLO found in the Loyalty Management bundle of the Salesforce CRM Connector
for Data Cloud. A voucher definition is a template that used to issue vouchers to members of a loyalty program.
Data Bundle
• Loyalty Management
632
Model Data in Data Cloud Salesforce CRM: Voucher Definition Mapping
DLO to DMO Mapping
These data mappings relate to the Voucher Definition object included in the Salesforce CRM connector and how that data connects to
DMOs. Learn more about the DLOs in the Loyalty Management Developer Guide.
DLO Field DLO Field Data Type DMO DMO Field Name
Created Date dateTime Voucher Definition Created Date
Discount Percentage int Voucher Definition Discount Percent
Effective Date date Voucher Definition Effective Date
Expiration Date date Voucher Definition Expiration Date
Expiration Period int Voucher Definition Expiration Period
Face Value currency Voucher Definition Face Value Amount
Voucher Definition ID id Voucher Definition Voucher Definition Id
Action boolean Voucher Definition Is Active
Last Modified Date dateTime Voucher Definition Last Modified Date
Loyalty Program ID reference Voucher Definition Loyalty Program
Account ID reference Voucher Definition Partner Account
Expiration Type picklist Voucher Definition Voucher Expiration Type
Expiration Period picklist Voucher Definition Expiration Period UOM
Unit
Type picklist Voucher Definition Voucher Type
633
CHAPTER 5 Extract Data
In this chapter ... Programmatically extract your data from Data Cloud.
• Retrieve Metadata
• Query Data Graph
Data
• Query Customer
Profile Information
with Profile API
• Query Data using
Query API V2
• Query Data using
Query API V1
• Query Services Status
Codes
• Query Unified Record
ID
• Query Calculated
Insights
• CDP Python
Connector
• API Limits for Profile,
Query, and
Calculated Insights
• Webhook Data
Action Targets in
Data Cloud
634
Extract Data Retrieve Metadata
Retrieve Metadata
Data Cloud Metadata API response includes metadata about all entities, including Calculated Insights, Engagement, Profile, and other
entities, and their relationships to other objects. For Data Lake Objects (DLOs) and Data Model Objects (DMOs), the API response also
includes information about key qualifier fields. For each DLO field and DMO field, the API response includes the name of the associated
key qualifier field.
GET /api/v1/metadata
Returns the metadata for Calculated Insights, Engagement, Profile, and other objects.
Syntax
HTTP method
GET
Availability
Data Cloud v1.0, Salesforce API version 51.0 and later
Formats
REST
URI
/api/v1/metadata/
Request Parameters
Field Name Description
entityType Field Type
string
Description
The requested metadata entity type. By default, this parameter includes all of the
available types. Acceptable values: DataLakeObject, DataModelObject, and
CalculatedInsight
entityCategory Field Type
string
Description
The requested metadata entity category. By default, this parameter includes all of
the available categories. It isn’t applicable for Calculated Insight entities. Acceptable
values: Profile, Engagement, and Related
entityName Field Type
string
635
Extract Data Retrieve Metadata
Field Name Description
Description
The name of the requested metadata entity. By default, this parameter includes
all of the available categories and an exhaustive list of entities. Example:
UnifiedIndividual__dlm
Examples
Request
https://{TSE}.360a.salesforce.com/api/v1/metadata/
Response
{
"metadata": [
{
"fields": [
{
"name": "ssot__BirthDate__c",
"displayName": "Birth Date",
"type": "DATE_TIME"
},
{
"name": "ssot__LastName__c",
"displayName": "Last Name",
"type": "STRING"
},
{
"name": "KQ_Id__c",
"displayName": "Key Qualifier Individual Id",
"type": "STRING"
},
{
"name": "ssot__Id__c",
"displayName": "Individual Id",
"type": "STRING",
"keyQualifier": "KQ_Id__c"
},
{
"name": "ssot__DataSourceObjectId__c",
"displayName": "Data Source Object",
"type": "STRING"
},
{
"name": "ssot__YearlyIncome__c",
"displayName": "Yearly Income",
"type": "NUMBER"
},
{
636
Extract Data Retrieve Metadata
"name": "ssot__FirstName__c",
"displayName": "First Name",
"type": "STRING"
}
],
"indexes": [],
"category": "Profile",
"name": "ssot__Individual__dlm",
"displayName": "Individual",
"relationships": [
{
"fromEntity": "ssot__Individual__dlm",
"toEntity": "IndividualIdentityLink__dlm",
"fromEntityAttribute": "ssot__Id__c",
"toEntityAttribute": "SourceRecordId__c",
"cardinality": "ONETOONE"
},
{
"fromEntity": "ssot__ContactPointPhone__dlm",
"toEntity": "ssot__Individual__dlm",
"fromEntityAttribute": "ssot__PartyId__c",
"toEntityAttribute": "ssot__Id__c",
"cardinality": "NTOONE"
}
],
"primaryKeys": [
{
"name": "ssot__Id__c",
"displayName": "Individual Id",
"indexOrder": "1"
}
]
},
{
"fields": [
{
"name": "ssot__DataSourceId__c",
"displayName": "Data Source",
"type": "STRING"
},
{
"name": "ssot__DataSourceObjectId__c",
"displayName": "Data Source Object",
"type": "STRING"
},
{
"name": "KQ_Id__c",
"displayName": "Key Qualifier Party Id",
"type": "STRING"
},
{
"name": "ssot__Id__c",
"displayName": "Party Identification Id",
"type": "STRING",
637
Extract Data Retrieve Metadata
"keyQualifier": "KQ_Id__c"
}
],
"indexes": [],
"category": "Related",
"name": "ssot__PartyIdentification__dlm",
"displayName": "Party Identification",
"relationships": [],
"primaryKeys": [
{
"name": "ssot__Id__c",
"displayName": "Party Identification Id",
"indexOrder": "1"
}
]
},
{
"name": "Avg_Spends__cio",
"displayName": "Avg Spends",
"dimensions": [
{
"name": "Id__c",
"displayName": "Id",
"type": "STRING"
},
{
"name": "FirstName__c",
"displayName": "First Name",
"type": "STRING"
}
],
"measures": [
{
"name": "Avg_Spend__c",
"displayName": "Avg Spend",
"type": "NUMBER",
"rollupable": true
}
],
"relationships": [
{
"fromEntity": "ssot__Individual__dlm",
"toEntity": "Avg_Spends__cio"
}
],
"partitionBy": "Id__c"
}
]
}
638
Extract Data Query Data Graph Data
HTTP Responses
Response Reason
200 OK Callback successfully verified
400 Bad Request Invalid request
500 Server Error Internal error
Query Data Graph Data
To query metadata and data from data graphs, use the Data Graphs APIs.
Important:
• Your orgs must be provisioned with Data Cloud licenses.
• To have full access to objects in Data Cloud, users must be assigned to appropriate roles. See User Roles and Permission Sets
in Data Cloud.
• To authenticate, you must acquire and exchange an access token. For details, seeGetting Started on page 2.
Tip: In example URLs, TSE refers to a tenant-specific endpoint, a unique, system-generated endpoint to each of your orgs.
GET /api/v1/dataGraph/metadata
Request a list of all data graphs and their primary data model object, related objects, and fields.
GET /api/v1/dataGraph/metadata?entityName={dataGraphName}
Request the metadata for a single data graph object. Returned data includes the object's primary data model object, related objects,
and fields.
GET /api/v1/dataGraph/{dataGraphName}/{dataGraphRecordId}
Request data from a specified data graph.
GET /api/v1/dataGraph/{dataGraphName}?lookupKeys=[]
Use secondary lookup keys to request data from a data graph. The lookup keys can be used for one-to-one lookups
SEE ALSO:
Retrieve Metadata
Query Data using Query API V1
GET /api/v1/dataGraph/metadata
Request a list of all data graphs and their primary data model object, related objects, and fields.
Syntax
HTTP method
GET
639
Extract Data GET
/api/v1/dataGraph/metadata?entityName={dataGraphName}
Availability
Data Cloud v1.0, Salesforce v51.0
Formats
REST
URI
/api/v1/dataGraph/metadata
GET /api/v1/dataGraph/metadata?entityName={dataGraphName}
Request the metadata for a single data graph object. Returned data includes the object's primary data model object, related objects,
and fields.
Syntax
HTTP method
GET
Availability
Data Cloud v1.0, Salesforce v51.0
Formats
REST
URI
/api/v1/dataGraph/metadata?entityName={dataGraphName}
Request Parameters
Field Name Field Type Description
entityName string API name of the data graph for which metadata is being requested.
When a data graph is created, the API name is the value set in the
DataGraphApiName field.
Examples
In this example, metadata for the data graph UnifiedIndividual_DG is requested. The response returns metadata values for the primary
data model object, related objects, and each field included in the data graph.
Request
https://{TSE}.360a.salesforce.com/api/v1/dataGraph/metadata?entityName=UnifiedIndividual_DG
Response
640
Extract Data GET
/api/v1/dataGraph/metadata?entityName={dataGraphName}
"metadata": [
{
"developerName": "UnifiedIndividual_DG",
"description": "",
"dataspaceName": "default",
"primaryObjectName": "UnifiedssotIndividualIr1__dlm",
"valuesDmoName": "Individual_DG_VALUE__dlm",
"idDmoName": "Individual_DG_ID__dlm",
"version": "1",
"primaryObjectType": "DMO",
"status": "READY",
"object": {
"developerName": "UnifiedssotIndividualIr1__dlm",
"type": "DMO",
"memberDmoName": "ssotIndividualIr1_FRAGMENT15__dlm",
"fields": [
{
"developerName": "ssot__Id__c",
"lookupCol": "false",
"length": "1",
"dataType": "STRING",
"keyCol": "true"
}
],
"relatedObjects": [
{
"developerName": "UnifiedLinkssotIndividualIr1__dlm",
"type": "DMO",
"memberDmoName": "LinkssotIndividual_FRAGMENT7__dlm",
"fields": [
{
"developerName": "SourceRecordId__c",
"lookupCol": "false",
"length": "1",
"dataType": "STRING",
"keyCol": "true"
},
{
"developerName": "UnifiedRecordId__c",
"lookupCol": "false",
"length": "1",
"dataType": "STRING",
"keyCol": "false"
}
],
"paths": [
{
"fieldName": "UnifiedRecordId__c",
"parentFieldName": "ssot__Id__c",
"cardinality": "NTOONE"
}
],
"relatedObjects": [
{
641
Extract Data GET
/api/v1/dataGraph/metadata?entityName={dataGraphName}
"developerName": "ssot__Individual__dlm",
"type": "DMO",
"memberDmoName": "Individual_FRAGMENT32__dlm",
"fields": [
{
"developerName": "ssot__FirstName__c",
"lookupCol": "false",
"length": "1",
"dataType": "STRING",
"keyCol": "false"
},
{
"developerName": "ssot__Id__c",
"lookupCol": "false",
"length": "1",
"dataType": "STRING",
"keyCol": "true"
},
{
"developerName": "ssot__LastName__c",
"lookupCol": "false",
"length": "1",
"dataType": "STRING",
"keyCol": "false"
}
],
"paths": [
{
"fieldName": "UnifiedRecordId__c",
"parentFieldName": "ssot__Id__c",
"cardinality": "NTOONE"
},
{
"fieldName": "ssot__Id__c",
"parentFieldName": "SourceRecordId__c",
"cardinality": "ONETOONE"
}
],
"relatedObjects": [
{
"developerName": "ssot__SalesOrder__dlm",
"type": "DMO",
"memberDmoName": "SalesOrder_FRAGMENT16__dlm",
"fields": [
{
"developerName": "ssot__PurchaseOrderDate__c",
"lookupCol": "false",
"length": "1",
"dataType": "DATE_TIME",
"keyCol": "false"
},
{
"developerName": "ssot__Id__c",
"lookupCol": "false",
642
Extract Data GET
/api/v1/dataGraph/{dataGraphName}/{dataGraphRecordId}
"length": "1",
"dataType": "STRING",
"keyCol": "true"
},
{
"developerName": "ssot__SoldToCustomerId__c",
"lookupCol": "false",
"length": "1",
"dataType": "STRING",
"keyCol": "false"
},
{
"developerName": "ssot__TotalProductAmount__c",
"lookupCol": "false",
"length": "1",
"dataType": "NUMBER",
"keyCol": "false"
}
],
"paths": [
{
"fieldName": "UnifiedRecordId__c",
"parentFieldName": "ssot__Id__c",
"cardinality": "NTOONE"
},
{
"fieldName": "ssot__Id__c",
"parentFieldName": "SourceRecordId__c",
"cardinality": "ONETOONE"
},
{
"fieldName": "ssot__SoldToCustomerId__c",
"parentFieldName": "ssot__Id__c",
"cardinality": "NTOONE"
}
]
}
]
}
]
}
]
}
}
]
}
GET /api/v1/dataGraph/{dataGraphName}/{dataGraphRecordId}
Request data from a specified data graph.
643
Extract Data GET /api/v1/dataGraph/{dataGraphName}?lookupKeys=[]
Syntax
HTTP method
GET
Availability
Data Cloud v1.0, Salesforce v51.0
Formats
REST
URI
/api/v1/dataGraph/{dataGraphName}/{dataGraphRecordId}
Request Parameters
Field Name Field Type Description
dataGraphName string The data graph's API name.
dataGraphRecordId int The value of the primary key on the data graph record. The value of this
field is the same as the value of the primary key for the data graph’s
primary data model object.
Example
This example shows a request for the data graph individual_eng_dg, with record ID 100005. The response includes specific data values
for the primary DMO and related fields specified in the data graph.
Request
https://{TSE}.360a.salesforce.com/api/v1/dataGraph/individual_eng_dg/100005
Response
{
"data":[
{
"
j
s
o
n
_b
l
o
b
_c
"
:
"
{\
"
so
t
_I
d
_c
\
"
:
\
"1
005
\
"
,
\
"U
n
i
f
ie
d
L
i
n
kso
t
I
n
d
iv
i
d
u
al
I
r
1
_d
l
m
\
":
[
{
\
"
So
u
r
c
eR
e
c
o
r
dI
d
_c
\
"
:
\
"1
0001
\
"
,
\
"U
n
i
f
ie
d
R
e
c
or
d
I
d
_c
\
"
:
\"
1
005
\
"
,
\
"so
t
_I
n
d
i
v
id
u
a
l
_d
l
m
\
":
[
{
\
"
so
t
_F
i
r
s
t
Na
m
e
_c
\
"
:
\
"J
e
a
n
\"
,
\
"
so
t
_I
d
_c
\
"
:
\
"1
0001
\
"
,
\
"so
t
_L
a
s
t
N
am
e
_c
\
"
:
\
"J
o
h
n
so
n
\
"
,
\"
so
t
_S
a
l
e
s
Or
d
e
r
_d
l
m
\
":
[
{
\
"
so
t
_P
u
r
c
h
as
e
O
r
de
r
D
a
t
e_c
\
"
:
\
"2
0
2
3
-0
7
-
2
6
T0
7
:
3
7:
5
7
.
9
27
Z
\
"
,\
"
so
t
_I
d
_c
\
"
:
\
"1
002
\
"
,
\
"so
t
_S
o
l
d
T
oC
u
s
t
om
e
r
I
d
_c
\
"
:\
"
1
0001
\
"
,
\
"so
t
_T
o
t
a
l
Pr
o
d
u
ct
A
m
o
u
nt
_c
\
"
:
57
.
000000000}
,
{
\
"
so
t
_P
u
r
c
h
as
e
O
r
de
r
D
a
t
e_c
\
"
:
\
"2
0
2
3
-0
7
-
2
6
T1
9
:
5
2:
2
6
.
5
25
Z
\
"
,\
"
so
t
_I
d
_c
\
"
:
\
"1
001
\
"
,
\
"so
t
_S
o
l
d
T
oC
u
s
t
om
e
r
I
d
_c
\
"
:\
"
1
0001
\
"
,
\
"so
t
_T
o
t
a
l
Pr
o
d
u
ct
A
m
o
u
nt
_c
\
"
:
1
92
.
000000000}
,
{
\
"
so
t
_P
u
r
c
h
as
e
O
r
de
r
D
a
t
e_c
\
"
:
\
"2
0
2
3
-0
7
-
0
6
T2
0
:
3
0:
1
8
.
2
5Z
\
"
,\
"
so
t
_I
d
_c
\
"
:
\
"1
005
\
"
,
\
"so
t
_S
o
l
d
T
oC
u
s
t
om
e
r
I
d
_c
\
"
:\
"
1
0001
\
"
,
\
"so
t
_T
o
t
a
l
Pr
o
d
u
ct
A
m
o
u
nt
_c
\
"
:
5
90
.
000000000}
]
}
]
}
]}
"
,
}
],
"done":true
}
GET /api/v1/dataGraph/{dataGraphName}?lookupKeys=[]
Use secondary lookup keys to request data from a data graph. The lookup keys can be used for one-to-one lookups
644
Extract Data Query Customer Profile Information with Profile API
Syntax
HTTP method
GET
Availability
Data Cloud v1.0, Salesforce v51.0
Formats
REST
URI
/api/v1/dataGraph/{dataGraphName}/{dataGraphRecordId}
Request Parameters
Field Name Field Type Description
dataGraphName string The data graph's API name.
lookupKeys string[] The API name of the related object included in the data graph and a
field name and field ID of that related object, limited to the individual
ID field on a specific related data model object.
Query Customer Profile Information with Profile API
Data Cloud Profile API calls are used to look up and search customer profile information. These API calls can be included in your external
web or mobile apps to look up customer profile information.
Using Data Cloud Profile API calls, you can build the complete Data Cloud pages by retrieving the Profile info along with computed
engagement insights.
The calls only support the data model objects in the profile category, such as Individual, Contact Point Email, Unified Individual, and
Contact Point Address. They also support retrieving the computed attributes related to the Individual field. For example, the computed
value of the total sales quantity in the last 6 months for a customer profile.
These calls do NOT support the engagement category data model objects like Sales Order.
Data Cloud Profile API calls follow the REST standard specification.
Note: Unified profile objects that are filtered on the index column have accelerated response rates. Other Profile category objects
can’t guarantee a faster response.
Key Properties
• You must explicitly specify the fields you want to retrieve, or only the data from the first 10 alphabetically sorted fields or attributes
of the entity will be included in your response. This restriction of 10 fields doesn’t apply when you explicitly mention the field names.
• You can retrieve a maximum of 50 fields.
• Only the AND logical operator and equality comparator operator are supported.
• There are no limits on the number of filters you can have in your query.
• The default return limit is 49,999 rows. A max limit of 49,999 is allowed.
645
Extract Data Query Customer Profile Information with Profile API
• For date and time fields, use the format:
Date/DateTime BirthDate__c=1990-07-12 00:00:00
Call Reference
GET /api/v1/profile/metadata
GET /api/v1/profile/metadata/{dataModelName}
GET /api/v1/profile/{dataModelName}
GET /api/v1/profile/{dataModelName}/{Id}
GET /api/v1/profile/{dataModelName}/{Id}/{childDataModelName}
GET /api/v1/profile/{dataModelName}/{Id}/calculated-insights/{ci-name}
Connected App Setup
Important: Your orgs must be provisioned with Data Cloud licenses and the users must be assigned to appropriate roles for
having full access to objects in the Data Cloud. Refer to User Roles and Permission Sets in Data Cloud before setting up the Connected
App.
Set Up a Connected App to discover new insights about your customers.
Acquire and Exchange Your Access Token for Data Cloud
Refer to Getting Started page to acquire the token.
Troubleshooting
If you receive the User hasn't approved this consumer yet error message, double-check the following configuration
parameters:
• Make sure you have Users may self-authorize in the connected app configuration.
• Make sure you select refresh_token scope and AT LEAST one other scope apart from this (not counting custom scopes).
• In the self-authorization URL, set the scope parameter value as api refresh_token cdpquery cdpprofile.
• The first time you call the self-authorization URL, you must respond to a consent page asking for permission for each of the scopes
you requested in the URL.
GET /api/v1/profile/metadata
Returns the list of data model objects, their fields, and category.
GET /api/v1/profile/metadata/{dataModelName}
Returns the metadata for the data model object. Metadata includes the list of fields, data types, and indexes available for lookup.
GET /api/v1/profile/{dataModelName}
Returns data model objects based on search filters. Use this API call to retrieve the object records after applying the selected filters.
646
Extract Data GET /api/v1/profile/metadata
GET /api/v1/profile/{dataModelName}/{Id}
Returns data model objects based on search indexes and filters. Use this API call to retrieve the object record based on the primary
key or secondary keys. Returns an empty list when records aren’t found.
GET /api/v1/profile/{dataModelName}/{Id}/{childDataModelName}
Returns data model objects and child objects based on indexes and search filters.
GET /api/v1/profile/{dataModelName}/{Id}/calculated-insights/{ci-name}
Returns data model objects and a computed view based on indexes and search filters.
SEE ALSO:
API Limits for Profile, Query, and Calculated Insights
GET /api/v1/profile/metadata
Returns the list of data model objects, their fields, and category.
Syntax
HTTP method
GET
Availability
Data Cloud v1.0, Salesforce v51.0
Formats
REST
URI
/api/v1/profile/metadata
Request Parameters
None.
Examples
Request
https://{TSE}.360a.salesforce.com/api/v1/profile/metadata
Response
{
"metadata": [
{
"indexes": [
{
"fields": [
{
647
Extract Data GET /api/v1/profile/metadata
"name": "FirstName__c",
"type": "STRING"
}
]
}
],
"name": "Individual__dlm",
"category": "Profile",
"displayName" : "Individual",
"fields": [
{
"name": "BirthDate__c",
"displayName": "Birth Date",
"type": "DATE"
},
{
"name": "FirstName__c",
"displayName" : "First Name",
"type": "STRING"
}
],
"relationships" : [
{
"fromEntity" : "ContactPointEmail__dlm",
"toEntity" : "Individual__dlm",
"fromEntityAttribute" : "PartyId__c",
"toEntityAttribute" : "Id__c",
"cardinality" : "NTOONE"
}
],
"primaryKeys" : [
{
"name" : "Id__c",
"displayName" : "Individual Id",
"indexOrder" : "1"
}
]
}
]
}
HTTP Responses
Response Reason
200 OK Callback successfully verified.
400 Bad Request Invalid request.
403 Forbidden Failed to pass authorization.
404 Not Found Incorrect callback ID, verification key, or both.
422 Unprocessable Entity Attribute name used in fields/filter parameter doesn’t exist.
648
Extract Data GET /api/v1/profile/metadata/{dataModelName}
Response Reason
500 Server Error Internal error.
GET /api/v1/profile/metadata/{dataModelName}
Returns the metadata for the data model object. Metadata includes the list of fields, data types, and indexes available for lookup.
Syntax
HTTP method
GET
Availability
Data Cloud v1.0, Salesforce v51.0
Formats
REST
URI
/api/v1/profile/metadata/{dataModelName}
Request Parameters
Field Name Field Type Description
dataModelName string Required. Data model object API name. Example: UnifiedIndividual__dlm
Examples
Request
https://{TSE}.360a.salesforce.com/api/v1/profile/metadata/{dataModelName}
Response
{
"metadata": [
{
"indexes": [
{
"fields": [
{
"name": "FirstName__c",
"type": "STRING"
}
]
}
],
649
Extract Data GET /api/v1/profile/metadata/{dataModelName}
"name": "Individual__dlm",
"category": "Profile",
"displayName" : "Individual",
"fields": [
{
"name": "BirthDate__c",
"displayName": "Birth Date",
"type": "DATE"
},
{
"name": "FirstName__c",
"displayName" : "First Name",
"type": "STRING"
}
],
"relationships" : [
{
"fromEntity" : "ContactPointEmail__dlm",
"toEntity" : "Individual__dlm",
"fromEntityAttribute" : "PartyId__c",
"toEntityAttribute" : "Id__c",
"cardinality" : "NTOONE"
}
],
"primaryKeys" : [
{
"name" : "Id__c",
"displayName" : "Individual Id",
"indexOrder" : "1"
}
]
}
]
}
HTTP Responses
Response Reason
200 OK Callback successfully verified
400 Bad Request Invalid request
403 Forbidden Failed to pass authorization.
404 Not Found Incorrect callback ID, verification key, or both.
422 Unprocessable Entity Attribute name used in fields/filter parameter doesn’t exist.
500 Server Error Internal error
650
Extract Data GET /api/v1/profile/{dataModelName}
GET /api/v1/profile/{dataModelName}
Returns data model objects based on search filters. Use this API call to retrieve the object records after applying the selected filters.
Syntax
HTTP method
GET
Availability
Data Cloud v1.0, Salesforce v51.0
Formats
REST
URI
/api/v1/profile/{dataModelName}
Request Parameters
Field Name Field Type Description
dataModelName string Required. Data model object API name. Example: UnifiedIndividual__dlm
fields string Distinct comma-separated name of fields that you want to include in
the result. Example: Id__c,FirstName__c,GenderId__c,Occupation__c
If this parameter isn't specified, up to 10 arbitrary fields are returned.
filters string Required. A set of comma-separated equality expressions, within square
brackets. Example: [FirstName__c=DON]
limit int The numbers of records to be returned. Example: 10
offset int Number of rows to skip before starting to return. Example: 100
This field is available in API version 52.0 and later.
orderby string Comma-separated values to sort the result-set in ascending or
descending order. Example: GenderId__c ASC, Occupation__c DESC
This field is available in API version 52.0 and later.
Examples
Request
https://{TSE}.360a.salesforce.com/api/v1/profile/{dataModelName}
Response
651
Extract Data GET /api/v1/profile/{dataModelName}/{Id}
"data": [
{
"GenderId__c": "F",
"Id__c": "05d01a06-0c61-3990-808d-2aa602dd3e7f",
"Occupation__c": "Staffing",
"FirstName__c": "Don"
},
{
"GenderId__c": "M",
"Id__c": "11bcc846-1a80-3293-8cc4-3449835d8d4c",
"Occupation__c": "Operational",
"FirstName__c": "Don"
},
{
"GenderId__c": "M",
"Id__c": "18213566-df86-34a8-97aa-2cb75b70ae3b",
"Occupation__c": "Organizational",
"FirstName__c": "Don"
}
],
"done": false
}
HTTP Responses
Response Reason
200 OK Callback successfully verified
400 Bad Request Invalid request
403 Forbidden Failed to pass authorization.
404 Not Found Incorrect callback ID, verification key, or both.
422 Unprocessable Entity Attribute name used in fields/filter parameter doesn’t exist.
500 Server Error Internal error
GET /api/v1/profile/{dataModelName}/{Id}
Returns data model objects based on search indexes and filters. Use this API call to retrieve the object record based on the primary key
or secondary keys. Returns an empty list when records aren’t found.
Syntax
HTTP method
GET
Availability
Data Cloud v1.0, Salesforce v51.0
652
Extract Data GET /api/v1/profile/{dataModelName}/{Id}
Formats
REST
URI
/api/v1/profile/{dataModelName}/{Id}
Request Parameters
Field Name Description
dataModelName Field Type
string
Description
Required.
Data model object API name. Example: UnifiedIndividual__dlm
fields Field Type
string
Description
Optional. Distinct comma-separated name of fields that you want to include in
the result. Not specifying this parameter returns an arbitrary set of fields. Example:
Id__c,FirstName__c,GenderId__c,Occupation__c
filters Field Type
string
Field Type
string
Description
A set of comma-separated equality expressions within square brackets. Example:
[FirstName__c=DON]
Id Field Type
string
Description
Required.
The value of the primary/secondary key field. Defaults to primary key when not
specified. Example: John
limit Field Type
int
Description
The numbers of records to be returned. Example: 10
653
Extract Data GET /api/v1/profile/{dataModelName}/{Id}
Field Name Description
offset Field Type
int
Description
The number of rows to skip before starting to return. Example: 100
This field is available in API version 52.0 and later.
orderby Type
string
Description
A list of comma-separated values to sort the results in ascending or descending
order. Example: GenderId__c ASC, Occupation__c DESC
This field is available in API version 52.0 and later.
searchKey Field Type
string
Description
The name of the key field, if a field other than the primary key is used. Example:
FirstName__c
Examples
Request
https://{TSE}.360a.salesforce.com/api/v1/profile/{dataModelName}/{Id}
Response
{
"data": [
{
"GenderId__c": "F",
"Id__c": "05d01a06-0c61-3990-808d-2aa602dd3e7f",
"Occupation__c": "Staffing",
"FirstName__c": "Don"
},
{
"GenderId__c": "M",
"Id__c": "11bcc846-1a80-3293-8cc4-3449835d8d4c",
"Occupation__c": "Operational",
"FirstName__c": "Don"
},
{
"GenderId__c": "M",
"Id__c": "18213566-df86-34a8-97aa-2cb75b70ae3b",
654
Extract Data GET
/api/v1/profile/{dataModelName}/{Id}/{childDataModelName}
"Occupation__c": "Organizational",
"FirstName__c": "Don"
}
],
"done": false
}
HTTP Responses
Response Reason
200 OK The callback successfully verified.
400 Bad Request Invalid request.
403 Forbidden Failed to pass authorization.
404 Not Found Incorrect callback ID, verification key, or both.
422 Unprocessable Entity The attribute name used in the fields or filters parameter doesn’t exist.
500 Server Error Internal error.
GET /api/v1/profile/{dataModelName}/{Id}/{childDataModelName}
Returns data model objects and child objects based on indexes and search filters.
Syntax
HTTP method
GET
Availability
Data Cloud v1.0, Salesforce v51.0
Formats
REST
URI
/api/v1/profile/{dataModelName}/{Id}/{childDataModelName}
Request Parameters
Field Name Field Type Description
childDataModelName string Required. Child data model object API name. Example:
UnifiedContactPointEmail__dlm
dataModelName string Required. Data model object API name. Example: UnifiedIndividual__dlm
655
Extract Data GET
/api/v1/profile/{dataModelName}/{Id}/{childDataModelName}
Field Name Field Type Description
fields string Comma-separated name of the fields to be part of result from the child
entity. Not specifying gives the first 10 alphabetically sorted fields.
Example: Id__c, EmailAddress__c
filters string Filters are applied only on the parent object. Example:
[FirstName__c=Mary]
id string Required. The value of an indexed column.
limit int The numbers of items to return. Example: 10
offset int Number of rows to skip before starting to return. Example: 100
This field is available in API version 52.0 and later.
orderby string Comma-separated values to sort the result-set in ascending or
descending order. Example: GenderId__c ASC, Occupation__c DESC
This field is available in API version 52.0 and later.
searchKey string Index name if object's ID is different from primary key. Example:
FirstName__c
Examples
Request
https://{TSE}.360a.salesforce.com/api/v1/profile/{dataModelName}/{Id}/{childDataModelName}
Response
{
"data": [
{
"GenderId__c": "F",
"Id__c": "05d01a06-0c61-3990-808d-2aa602dd3e7f",
"Occupation__c": "Staffing",
"FirstName__c": "Don"
},
{
"GenderId__c": "M",
"Id__c": "11bcc846-1a80-3293-8cc4-3449835d8d4c",
"Occupation__c": "Operational",
"FirstName__c": "Don"
},
{
"GenderId__c": "M",
"Id__c": "18213566-df86-34a8-97aa-2cb75b70ae3b",
656
Extract Data GET
/api/v1/profile/{dataModelName}/{Id}/calculated-insights/{ci-name}
"Occupation__c": "Organizational",
"FirstName__c": "Don"
}
],
"done": false
}
HTTP Responses
Response Reason
200 OK Callback successfully verified
400 Bad Request Invalid request
403 Forbidden Failed to pass authorization.
404 Not Found Incorrect callback ID, verification key, or both.
422 Unprocessable Entity Attribute name used in fields/filter parameter doesn’t exist.
500 Server Error Internal error
GET /api/v1/profile/{dataModelName}/{Id}/calculated-insights/{ci-name}
Returns data model objects and a computed view based on indexes and search filters.
Syntax
HTTP method
GET
Availability
Data Cloud v1.0, Salesforce v51.0
Formats
REST
URI
/api/v1/profile/{dataModelName}/{Id}/calculated-insights/{ci-name}
Request Parameters
Field Name Description
ci_name Field Type
string
Description
Required.
The Calculated Insight name. Example: IndividualChildrenCount__cio
657
Extract Data GET
/api/v1/profile/{dataModelName}/{Id}/calculated-insights/{ci-name}
Field Name Description
dataModelName Field Type
string
Description
Required.
Data model object API name. Example: UnifiedIndividual__dlm
dimensions Field Type
string
Description
Comma-separated name of the dimensions to be part of the result from the
computed view. By default includes all the dimensions. Example: Id__c
filters Field Type
string
Description
Filters are applied only on the parent object. Example: [FirstName__c=Angel]
id Field Type
string
Description
Required.
The value of an indexed column. Example:
003726a3-061d-33e7-a5a5-96ecae866a61
limit Field Type
int
Description
The number of items to return. Example: 10
measures Field Type
string
Description
Comma-separated name of the measures to be part of the result from the
computed view. By default includes all the measures. Example: TotalSales__c
offset Field Type
int
Description
Number of rows to skip before starting to return. Example: 100
This field is available in API version 52.0 and later.
658
Extract Data GET
/api/v1/profile/{dataModelName}/{Id}/calculated-insights/{ci-name}
Field Name Description
orderby Field Type
string
Description
Comma-separated values to sort the result-set in ascending or descending order.
Example: GenderId__c ASC, Occupation__c DESC
This field is available in API version 52.0 and later.
searchKey Field Type
string
Description
Index name if the object’s ID is different from the primary key. Example:
FirstName__c
timeGranularity Field Type
string
Description
With this parameter, you can roll up the measures to various time ranges. Possible
values: HOUR, DAY, MONTH, QUARTER, YEAR
This field is available in API version 53.0 and later.
Examples
Request
https://{TSE}.360a.salesforce.com/api/v1/profile/{dataModelName}/{Id}/calculated-insights/{ci-name}
Response
{
"data": [
{
"GenderId__c": "F",
"Id__c": "05d01a06-0c61-3990-808d-2aa602dd3e7f",
"Occupation__c": "Staffing",
"FirstName__c": "Don"
},
{
"GenderId__c": "M",
"Id__c": "11bcc846-1a80-3293-8cc4-3449835d8d4c",
"Occupation__c": "Operational",
"FirstName__c": "Don"
},
659
Extract Data Query Data using Query API V2
{
"GenderId__c": "M",
"Id__c": "18213566-df86-34a8-97aa-2cb75b70ae3b",
"Occupation__c": "Organizational",
"FirstName__c": "Don"
}
],
"done": false
}
HTTP Responses
Response Reason
200 OK Callback successfully verified.
400 Bad Request Invalid request.
403 Forbidden Failed to pass authorization.
404 Not Found Incorrect callback ID, verification key, or both.
422 Unprocessable Entity Attribute name used in fields/filter parameter doesn’t exist.
500 Server Error Internal error.
Query Data using Query API V2
Query API V2 supports SQL query in ANSI standard. The results return as an array of records. The expected input when calling this API is
free form SQL. The input objects include data stream, profile and engagement data model objects, and unified data model objects. You
can use Query API V2 to support a variety of use cases, which includes large volume data reads, external application integration, or
interactive on demand querying on the data lake.
Note: We recommend using Query API V1 for smaller extract queries. You can also use the API when you want to fetch a limited
set of data by specifying offsets and limits.
Key Properties
• Cursor pagination is supported.
• GET and POST API calls are supported.
• The POST endpoint is used to make the first request. The POST endpoint returns data along with batchId for next batch using cursor
pagination.
• The GET endpoint is used for subsequent requests for the same query.
• The GET endpoint requires a batchId as a parameter.
• Pagination is forward cursor only, which means the same batchId couldn’t be used more than one time.
• As subsequent GET calls need nextBatchId value from last call, hence the query execution is done serially.
• There’s no explicit limit on the number of nested subqueries.
• There’s no explicit limit on the number of joins.
660
Extract Data Query Data using Query API V2
• There’s no explicit limit on the number of filters.
• There’s no explicit limit on the number of column projections.
• There’s no explicit limit on the data types.
• In the response a done boolean flag is exposed. If the flag is set to true, then there are no more records to be queried. If the flag
is set to false, then the next page can be retrieved using the next batchId.
• You must fetch the complete result set generated by the query within one hour.
• The time interval between two batch calls must not exceed three minutes.
• When using aggregate functions, the results computed are of number types instead of string types.
Note: The response contains a queryId. The ID remains the same irrespective of POST and GET calls.
Connected App Setup
Important: Your orgs must be provisioned with Data Cloud licenses and the users must be assigned to appropriate roles for
having full access to objects in the Data Cloud. Refer to User Roles and Permission Sets in Data Cloud before setting up the Connected
App.
Set Up a Connected App to discover new insights about your customers.
Acquire and Exchange Your Access Token for Data Cloud
Refer to Getting Started page to acquire the token.
Key Qualifiers
We recommend that you include key qualifier fields in all table joins for queries submitted through the Query API V2. Make sure to use
the COALESCE() function to get a null-safe join. When key qualifiers aren’t configured on data lake object fields, the value for the key
qualifier field is null. In such cases, use the COALESCE() function to achieve desired results. This sample query covers the usage of
COALESCE() function.
SELECT * FROM ssot__ContactPointEmail__dlm email
LEFT JOIN ssot__Individual__dlm individual
ON email.ssot__PartyId__c = individual.ssot__Id__c
AND
COALESCE(email.KQ_PartyId__c, '') = COALESCE(individual.KQ_Id__c, '')
limit 10
Call Reference
POST /api/v2/query
Use the POST endpoint of Query API V2 to make the first request with the SQL query. The POST endpoint returns data along with
batchId for the next batch.
661
Extract Data POST /api/v2/query
GET /api/v2/query/{nextBatchId}
Returns the next batch of data from the initial POST request.
SEE ALSO:
API Limits for Profile, Query, and Calculated Insights
POST /api/v2/query
Use the POST endpoint of Query API V2 to make the first request with the SQL query. The POST endpoint returns data along with
batchId for the next batch.
Syntax
HTTP method
POST
Availability
Data Cloud v2.0, Salesforce 54.0
Formats
REST
URI
/api/v2/query
Examples
Request Header
Authorization: Bearer {{cdpAuthToken}}
Request
{
"sql" : "select * from Orders__dll"
}
Response
Note: The placeInOrder parameter indicates the position of the column in each data row. For example, in the following
response InternalOrganization__c is the second column in a data row. Similarly quantity__c is the third
column. For information on the typeCodes, refer to SQL data type codes.
{
"data": [
[
"s3://dev1-uswest2-cdp001-test-data/sbothra/Orders.csv",
"aws",
null,
null,
"Office Supplies",
"0019-01-03",
null,
662
Extract Data POST /api/v2/query
"Philadelphia",
"United States",
"MB-18085",
"Mick Brown",
"0.200000000000000000",
"570907236",
"0019-01-05 00:00:00.000 UTC",
"0019-01-05",
"CA-NEW-2014-141817",
"19143.000000000000000000",
"OFF-AR-10003478",
"Avery Hi-Liter EverBold Pen Style Fluorescent Highlighters 4/Pack",
"4.884000000000000000",
"3.000000000000000000",
"East",
"1760",
"19.536000000000000000",
"Consumer",
"0019-01-12 00:00:00.000 UTC",
"0019-01-12",
"Standard Class",
"Pennsylvania",
"Art"
],
[
"s3://dev1-uswest2-cdp001-test-data/sbothra/Orders.csv",
"aws",
null,
null,
"Furniture",
"0021-01-06",
null,
"Seattle",
"United States",
"RS-19420",
"Ricardo Sperren",
"0.000000000000000000",
"307077322",
"0021-01-08 00:00:00.000 UTC",
"0021-01-08",
"CA-NEW-2017-115154",
"98115.000000000000000000",
"FUR-TA-10001950",
"Balt Solid Wood Round Tables",
"80.368200000000000000",
"2.000000000000000000",
"West",
"2290",
"892.980000000000000000",
"Corporate",
"0021-01-11 00:00:00.000 UTC",
"0021-01-11",
"First Class",
"Washington",
663
Extract Data POST /api/v2/query
"Tables"
]
],
"startTime": "2024-05-08T13:30:31.241168Z",
"endTime": "2024-05-08T13:30:35.571609Z",
"rowCount": 2,
"queryId": "20240508_133031_00088_p25a7",
"nextBatchId": "09151b49-54ed-4948-8139-1f4c7c3a9581",
"done": false,
"metadata": {
"state__c": {
"type": "VARCHAR",
"placeInOrder": 28,
"typeCode": 12
},
"sales__c": {
"type": "DECIMAL",
"placeInOrder": 23,
"typeCode": 3
},
"productid__c": {
"type": "VARCHAR",
"placeInOrder": 17,
"typeCode": 12
},
"segment__c": {
"type": "VARCHAR",
"placeInOrder": 24,
"typeCode": 12
},
"individualid__c": {
"type": "VARCHAR",
"placeInOrder": 12,
"typeCode": 12
},
"shipdate1__c": {
"type": "TIMESTAMP WITH TIME ZONE",
"placeInOrder": 25,
"typeCode": 2014
},
"shipmode__c": {
"type": "VARCHAR",
"placeInOrder": 27,
"typeCode": 12
},
"rowid__c": {
"type": "VARCHAR",
"placeInOrder": 22,
"typeCode": 12
},
"InternalOrganization__c": {
"type": "VARCHAR",
"placeInOrder": 2,
"typeCode": 12
664
Extract Data POST /api/v2/query
},
"orderdate1__c": {
"type": "TIMESTAMP WITH TIME ZONE",
"placeInOrder": 13,
"typeCode": 2014
},
"customername__c": {
"type": "VARCHAR",
"placeInOrder": 10,
"typeCode": 12
},
"quantity__c": {
"type": "DECIMAL",
"placeInOrder": 20,
"typeCode": 3
},
"DataSource__c": {
"type": "VARCHAR",
"placeInOrder": 1,
"typeCode": 12
},
"orderdate__c": {
"type": "DATE",
"placeInOrder": 14,
"typeCode": 91
},
"cdp_sys_PartitionDate__c": {
"type": "DATE",
"placeInOrder": 5,
"typeCode": 91
},
"orderid__c": {
"type": "VARCHAR",
"placeInOrder": 15,
"typeCode": 12
},
"region__c": {
"type": "VARCHAR",
"placeInOrder": 21,
"typeCode": 12
},
"KQ_orderid__c": {
"type": "VARCHAR",
"placeInOrder": 3,
"typeCode": 12
},
"discount__c": {
"type": "DECIMAL",
"placeInOrder": 11,
"typeCode": 3
},
"postalcode__c": {
"type": "DECIMAL",
"placeInOrder": 16,
665
Extract Data POST /api/v2/query
"typeCode": 3
},
"city__c": {
"type": "VARCHAR",
"placeInOrder": 7,
"typeCode": 12
},
"profit__c": {
"type": "DECIMAL",
"placeInOrder": 19,
"typeCode": 3
},
"customerid__c": {
"type": "VARCHAR",
"placeInOrder": 9,
"typeCode": 12
},
"category__c": {
"type": "VARCHAR",
"placeInOrder": 4,
"typeCode": 12
},
"sub_category__c": {
"type": "VARCHAR",
"placeInOrder": 29,
"typeCode": 12
},
"cdp_sys_SourceVersion__c": {
"type": "VARCHAR",
"placeInOrder": 6,
"typeCode": 12
},
"country__c": {
"type": "VARCHAR",
"placeInOrder": 8,
"typeCode": 12
},
"shipdate__c": {
"type": "DATE",
"placeInOrder": 26,
"typeCode": 91
},
"productname__c": {
"type": "VARCHAR",
"placeInOrder": 18,
"typeCode": 12
},
"DataSourceObject__c": {
"type": "VARCHAR",
"placeInOrder": 0,
"typeCode": 12
}
}
}
666
Extract Data GET /api/v2/query/{nextBatchId}
HTTP Responses
Query Services Status Codes
GET /api/v2/query/{nextBatchId}
Returns the next batch of data from the initial POST request.
Syntax
HTTP method
GET
Availability
Data Cloud v2.0, Salesforce 54.0
Formats
REST
URI
/api/v2/query/{nextBatchId}
Examples
Request Header
Authorization: Bearer {{cdpAuthToken}}
Response
Note: The placeInOrder parameter indicates the position of the column in each data row. For example, in the following
response InternalOrganization__c is the second column in a data row. Similarly quantity__c is the third
column. For information on the typeCodes, refer to SQL data type codes.
{
"data": [
[
"1103658353",
"123",
"2020-09-28T00:00:00.000+00:00",
], [], [] ...
]
], "startTime": "2024-05-08T13:30:31.241168Z",
"endTime": "2024-05-08T13:30:35.571609Z",
"rowCount": 2,
"queryId": "20240508_133031_00088_p25a7",
"nextBatchId": "09151b49-54ed-4948-8139-1f4c7c3a9581",
"done": false,
"metadata": {
"state__c": {
"type": "VARCHAR",
"placeInOrder": 28,
667
Extract Data GET /api/v2/query/{nextBatchId}
"typeCode": 12
},
"sales__c": {
"type": "DECIMAL",
"placeInOrder": 23,
"typeCode": 3
},
"productid__c": {
"type": "VARCHAR",
"placeInOrder": 17,
"typeCode": 12
},
"segment__c": {
"type": "VARCHAR",
"placeInOrder": 24,
"typeCode": 12
},
"individualid__c": {
"type": "VARCHAR",
"placeInOrder": 12,
"typeCode": 12
},
"shipdate1__c": {
"type": "TIMESTAMP WITH TIME ZONE",
"placeInOrder": 25,
"typeCode": 2014
},
"shipmode__c": {
"type": "VARCHAR",
"placeInOrder": 27,
"typeCode": 12
},
"rowid__c": {
"type": "VARCHAR",
"placeInOrder": 22,
"typeCode": 12
},
"InternalOrganization__c": {
"type": "VARCHAR",
"placeInOrder": 2,
"typeCode": 12
},
"orderdate1__c": {
"type": "TIMESTAMP WITH TIME ZONE",
"placeInOrder": 13,
"typeCode": 2014
},
"customername__c": {
"type": "VARCHAR",
"placeInOrder": 10,
"typeCode": 12
},
"quantity__c": {
"type": "DECIMAL",
668
Extract Data GET /api/v2/query/{nextBatchId}
"placeInOrder": 20,
"typeCode": 3
},
"DataSource__c": {
"type": "VARCHAR",
"placeInOrder": 1,
"typeCode": 12
},
"orderdate__c": {
"type": "DATE",
"placeInOrder": 14,
"typeCode": 91
},
"cdp_sys_PartitionDate__c": {
"type": "DATE",
"placeInOrder": 5,
"typeCode": 91
},
"orderid__c": {
"type": "VARCHAR",
"placeInOrder": 15,
"typeCode": 12
},
"region__c": {
"type": "VARCHAR",
"placeInOrder": 21,
"typeCode": 12
},
"KQ_orderid__c": {
"type": "VARCHAR",
"placeInOrder": 3,
"typeCode": 12
},
"discount__c": {
"type": "DECIMAL",
"placeInOrder": 11,
"typeCode": 3
},
"postalcode__c": {
"type": "DECIMAL",
"placeInOrder": 16,
"typeCode": 3
},
"city__c": {
"type": "VARCHAR",
"placeInOrder": 7,
"typeCode": 12
},
"profit__c": {
"type": "DECIMAL",
"placeInOrder": 19,
"typeCode": 3
},
"customerid__c": {
669
Extract Data GET /api/v2/query/{nextBatchId}
"type": "VARCHAR",
"placeInOrder": 9,
"typeCode": 12
},
"category__c": {
"type": "VARCHAR",
"placeInOrder": 4,
"typeCode": 12
},
"sub_category__c": {
"type": "VARCHAR",
"placeInOrder": 29,
"typeCode": 12
},
"cdp_sys_SourceVersion__c": {
"type": "VARCHAR",
"placeInOrder": 6,
"typeCode": 12
},
"country__c": {
"type": "VARCHAR",
"placeInOrder": 8,
"typeCode": 12
},
"shipdate__c": {
"type": "DATE",
"placeInOrder": 26,
"typeCode": 91
},
"productname__c": {
"type": "VARCHAR",
"placeInOrder": 18,
"typeCode": 12
},
"DataSourceObject__c": {
"type": "VARCHAR",
"placeInOrder": 0,
"typeCode": 12
}
}
}
HTTP Responses
Query Services Status Codes
670
Extract Data Query Data using Query API V1
Query Data using Query API V1
The Query API V1 supports SQL query in ANSI standard. The SQL can be a free form SQL with objects that include data streams, profile
or engagement data model objects, and unified data model objects. The Query API V1 supports only synchronous calls. You can use the
API to support a variety of use cases that include data extraction, external application integration or interactive querying on the data
lake. If you don't want to fetch the entire data like in case of browser-based clients then you can make a call to the API with limit
and offset.
Note: A newer version of the Query API is available. We recommend using Query V2 API on page 660 to take advantage of GET
calls in addition to POST calls, subsequent requests, and larger response sizes.
Key Properties
• The call return limit defaults to the max limit of 49,999 rows returned. Use a done flag to check whether more records exist.
• There’s no explicit limit to the SQL call length.
• There’s no explicit limit for the number of nested subqueries.
• There’s no explicit limit for the number of joins.
• There’s no explicit limit for the number of filters.
• There’s no explicit limit for the number of column projections.
• There’s no explicit limit for any specific data type, such as VARCHAR, DECIMAL, or TIMESTAMP.
• Pagination supported via limit, offset, and orderby parameters.
– When done is flagged as true in the response, then there are no more records to query. When the response is false, call
orderby with offset param to retrieve the next set of numbers.
Connected App Setup
Important: Your orgs must be provisioned with Data Cloud licenses and the users must be assigned to appropriate roles for
having full access to objects in the Data Cloud. Refer to User Roles and Permission Sets in Data Cloud before setting up the Connected
App.
Set Up a Connected App to discover new insights about your customers.
Acquire and Exchange Your Access Token for Data Cloud
Refer to Getting Started page to acquire the token.
Key Qualifiers
We recommend that you include key qualifier fields in all table joins for queries submitted through the Query API V2. Make sure to use
the COALESCE() function to get a null-safe join. When key qualifiers aren’t configured on data lake object fields, the value for the key
qualifier field is null. In such cases, use the COALESCE() function to achieve the desired results. This sample query covers the usage of
COALESCE() function.
SELECT * FROM ssot__ContactPointEmail__dlm email
LEFT JOIN ssot__Individual__dlm individual
ON email.ssot__PartyId__c = individual.ssot__Id__c
671
Extract Data POST /api/v1/query
AND
COALESCE(email.KQ_PartyId__c, '') = COALESCE(individual.KQ_Id__c, '')
limit 10
Call Reference
POST /api/v1/query
Use Query API V1 to query Data Cloud data lake across data model, data lake, unified, and linked objects.
SEE ALSO:
API Limits for Profile, Query, and Calculated Insights
POST /api/v1/query
Use Query API V1 to query Data Cloud data lake across data model, data lake, unified, and linked objects.
Syntax
HTTP method
POST
Availability
Data Cloud v1.0, Salesforce v51.0
Formats
REST
URI
/api/v1/query
Request Parameters
Field Name Description
limit Field Type
int
Description
The numbers of records to be returned. Example: 10
offset Field Type
int
Description
Number of rows to skip before starting to return. Example: 100
orderby Field Type
string
672
Extract Data POST /api/v1/query
Field Name Description
Description
Comma-separated values to sort the results in ascending or descending order.
Example: GenderId__c ASC, Occupation__c DESC
Examples
Request Header
Authorization: Bearer {{cdpAuthToken}}
Request
{
"sql": "select BirthDate__c, DataSourceId__c, DataSourceObjectId__c,
ExternalRecordId__c, FirstName__c, GenderId__c, Id__c, InternalOrganizationId__c,
LastName__c from Individual__dlm where Id__c='100470169'”
}
Response
{
"data": [
{
"Id__c": "100470169",
"GenderId__c": "M",
"FirstName__c": "Joshua",
"LastName__c": "Carrier",
"BirthDate__c": "2022-07-12T06:41:47.865044Z",
"ExternalRecordId__c": "003f200002a3227163",
"DataSourceId__c": "SubscribedUsers",
"InternalOrganizationId__c": "",
"DataSourceObjectId__c": "Subscribers_for_CDP"
}
],
"startTime": "2020-12-19T06:50:05.251Z",
"endTime": "2020-12-19T06:50:05.251Z",
"rowCount": 1,
"queryId": "3442db1a-ecef-42b3-b0d8-971ee459efa4",
"done": true,
"metadata":
{
"BirthDate__c":
{
"type": "TIMESTAMP WITH TIME ZONE",
"placeInOrder": 3,
"typeCode": 93
},
"LastName__c":
673
Extract Data POST /api/v1/query
{
"type": "VARCHAR",
"placeInOrder": 2,
"typeCode": 12
},
"FirstName__c":
{
"type": "VARCHAR",
"placeInOrder": 1,
"typeCode": 12
},
"InternalOrganizationId__c":
{
"type": "VARCHAR",
"placeInOrder": 5,
"typeCode": 12
},
"Id__c":
{
"type": "VARCHAR",
"placeInOrder": 0,
"typeCode": 12
},
"DataSourceObjectId__c":
{
"type": "VARCHAR",
"placeInOrder": 6,
"typeCode": 12
},
"DataSourceId__c":
{
"type": "VARCHAR",
"placeInOrder": 4,
"typeCode": 12
},
"GenderId__c":
{
"type": "VARCHAR",
"placeInOrder": 7,
"typeCode": 12
},
"ExternalRecordId__c":
{
"type": "VARCHAR",
"placeInOrder": 8,
"typeCode": 12
}
}
}
HTTP Responses
Query Services Status Codes
674
Extract Data Query Services Status Codes
Query Services Status Codes
Status codes for Query API V1 and Query API V2.
HTTP Responses
Response Reason
200 OK Callback successfully verified
400 Bad Request Invalid request
403 Forbidden Failed to pass authorization.
404 Not Found Incorrect callback ID, verification key, or both.
422 Unprocessable Entity Attribute name used in fields/filter parameter doesn’t exist.
429 Too Many Requests Indicates too many requests in a given amount of time. Query API V1 and Query API V2
support up to 15 concurrent requests.
500 Server Error Internal error
Query Unified Record ID
Use the Universal ID Lookup API to retrieve all individual records associated with a unified record. You can query on an Individual ID from
one source and get all the Individual IDs for that individual from other data sources.
GET /api/v1/universalIdLookup/{entity_name}/{DataSourceId__c}/{DataSourceObjectId__c}/{SourceRecordId__c}
Retrieve all the Individual records of an individual from all the data sources. For example, if a runner’s profile information comes from
three data sources retail sales, loyalty program, and mobile identity. A unified individual record for the runner gets created and all
the individual records are assigned the same unified record id.
GET
/api/v1/universalIdLookup/{entity_name}/{DataSourceId__c}/{DataSourceObjectId__c}/{SourceRecordId__c}
Retrieve all the Individual records of an individual from all the data sources. For example, if a runner’s profile information comes from
three data sources retail sales, loyalty program, and mobile identity. A unified individual record for the runner gets created and all the
individual records are assigned the same unified record id.
Syntax
HTTP method
GET
Availability
Data Cloud v1.0, Salesforce API version 54.0 and later
675
Extract Data GET
/api/v1/universalIdLookup/{entity_name}/{DataSourceId__c}/{DataSourceObjectId__c}/{SourceRecordId__c}
Formats
REST
URI
/api/v1/universalIdLookup/{entity_name}/{DataSourceId__c}/{DataSourceObjectId__c}/{SourceRecordId__c}
Request Parameters
Use the entity_name, DataSourceId__c, DataSourceObjectId__c, and SourceRecordId__c and retrieve the individual records.
Note: SourceRecordId__c maps to Individual ID of Individual data model object. For more information, see Individual.
Field Name Field Type Description
DataSourceId__c string Required. The data source ID.
DataSourceObjectId__c string Required. The data source object ID.
entity_name string Required. The name of the bridge table entity.
SourceRecordId__c string Required. The primary key of the data source record.
Examples
Request
https://{TSE}.360a.salesforce.com/api/v1/universalIdLookup/IndividualIdentityLink__dlm/SFMC1487860/SFMC1487860_EmailProfile/100060522
Response
{
"data": [
{
"SourceRecordId__c": "100060522",
"UnifiedRecordId__c": "c7ac3830-77c0-3d3d-851ccee3e8d9c2c6",
"ssot__DataSourceObjectId__c": "SFMC1487860_EmailProfile",
"ssot__DataSourceId__c": "SFMC1487860",
},
{
"SourceRecordId__c": "138408",
"UnifiedRecordId__c": "c7ac3830-77c0-3d3d-851ccee3e8d9c2c6",
"ssot__DataSourceObjectId__c": "Mobile_AllSubscribers",
"ssot__DataSourceId__c": "MobileSDK",
},
{
"SourceRecordId__c": "0043V00001ENHZ",
"UnifiedRecordId__c": "c7ac3830-77c0-3d3d-851ccee3e8d9c2c6",
"ssot__DataSourceObjectId__c": "Salesforce_0043V00001ENHZ",
"ssot__DataSourceId__c": "Contact",
}
]
}
676
Extract Data Query Calculated Insights
Query Calculated Insights
The Calculated Insights API calls only support data collection from the Data Cloud Calculated Insights object. You can use this API to
query Calculated Insights with selected SQL dimensions and measures with optional filters.
For details on how to use Calculated Insights calls from within Data Cloud, see the Calculated Insights online Help topics.
This API library follows the standard REST specification.
Key Properties
• The call return limit defaults to the max limit of 4,999 rows returned.
• Pagination support via limit, offset, and order by parameters.
Call Reference
GET /api/v1/insight/metadata/(ci-name)
GET /api/v1/insight/calculated-insights/(ci-name)
GET /api/v1/insight/metadata
The metadata includes the dimension and measure that are part of the calculated insight.
GET /api/v1/insight/metadata/(ci-name)
The metadata includes the dimension and measure that are part of the calculated insight.
GET /api/v1/insight/calculated-insights/(ci-name)
Use this API to query your Calculated Insights. Users can filter by selecting different dimensions, measures, and filters.
SEE ALSO:
API Limits for Profile, Query, and Calculated Insights
GET /api/v1/insight/metadata
The metadata includes the dimension and measure that are part of the calculated insight.
Syntax
HTTP method
GET
Availability
Data Cloud v1.0, Salesforce v51.0
Formats
REST
URI
/api/v1/insight/metadata
677
Extract Data GET /api/v1/insight/metadata
Examples
Request
https://{TSE}.360a.salesforce.com/api/v1/insight/metadata
Response
{
"metadata": [
{
"name": "runner_ci__cio",
"displayName": "runner ci",
"dimensions": [
{
"name": "runner_id__c",
"displayName": "runner id",
"type": "NUMBER"
}
],
"measures": [
{
"name": "total_exercises__c",
"displayName": "total exercises",
"type": "NUMBER",
"rollupable": true
},
{
"name": "total_km__c",
"displayName": "total km",
"type": "NUMBER",
"rollupable": true
}
],
"relationships": [
{
"fromEntity": "runner__dlm",
"toEntity": "runner_ci__cio"
},
{
"fromEntity": "Exercises__dlm",
"toEntity": "runner_ci__cio"
}
],
"partitionBy": "runner_id__c"
},
{
"name": "Avg_Spends__cio",
"displayName": "Avg Spends",
"dimensions": [
{
"name": "Id__c",
678
Extract Data GET /api/v1/insight/metadata/(ci-name)
"displayName": "Id",
"type": "STRING"
},
{
"name": "FirstName__c",
"displayName": "First Name",
"type": "STRING"
}
],
"measures": [
{
"name": "Avg_Spend__c",
"displayName": "Avg Spend",
"type": "NUMBER",
"rollupable": true
}
],
"relationships": [
{
"fromEntity": "ssot__Individual__dlm",
"toEntity": "Avg_Spends__cio"
}
],
"partitionBy": "Id__c"
}
]
}
HTTP Responses
Response Reason
200 OK Callback successfully verified
400 Bad Request Invalid request
500 Server Error Internal error
GET /api/v1/insight/metadata/(ci-name)
The metadata includes the dimension and measure that are part of the calculated insight.
Syntax
HTTP method
GET
Availability
Data Cloud v1.0, Salesforce v51.0
Formats
REST
679
Extract Data GET /api/v1/insight/metadata/(ci-name)
URI
/api/v1/insight/metadata/(ci-name)
Request Parameters
Field Name Field Type Description
ci_name string Required. The calculated insight name. Example:
IndividualChildrenCount__cio
Examples
Request
https://{TSE}.360a.salesforce.com/api/v1/insight/metadata/{ci-name}
Response
{
"metadata": [
{
"name": "Avg_Spends__cio",
"displayName": "Avg Spends",
"dimensions": [
{
"name": "Id__c",
"displayName": "Id",
"type": "STRING"
},
{
"name": "FirstName__c",
"displayName": "First Name",
"type": "STRING"
}
],
"measures": [
{
"name": "Avg_Spend__c",
"displayName": "Avg Spend",
"type": "NUMBER",
"rollupable": true
}
],
"relationships": [
{
"fromEntity": "ssot__Individual__dlm",
"toEntity": "Avg_Spends__cio"
}
],
680
Extract Data GET /api/v1/insight/calculated-insights/(ci-name)
"partitionBy": "Id__c"
}
]
}
HTTP Responses
Response Reason
200 OK Callback successfully verified
400 Bad Request Invalid request
403 Forbidden Failed to pass authorization.
404 Not Found Incorrect callback ID, verification key, or both.
422 Unprocessable Entity Attribute name used in fields/filter parameter doesn’t exist.
500 Server Error Internal error
GET /api/v1/insight/calculated-insights/(ci-name)
Use this API to query your Calculated Insights. Users can filter by selecting different dimensions, measures, and filters.
Syntax
HTTP method
GET
Availability
Data Cloud v1.0, Salesforce v51.0
Formats
REST
URI
/api/v1/insight/calculated-insight/(ci-name)
Request Parameters
Field Name Description
ci_name Field Type
string
Description
Required.
The Calculated Insight name.
681
Extract Data GET /api/v1/insight/calculated-insights/(ci-name)
Field Name Description
dimensions Field Type
string
Description
Comma-separated list of dimensions to be projected. By default, this parameter
includes all of the available dimensions. Example: GenderId__c
measures Field Type
string
Description
Comma-separated list of measures to be projected. By default, this parameter
includes all of the available measures. Example: TotalSales__c
limit Field Type
int
Description
The number of items to return. By default, the maximum number, 4,999 items are
returned. Example: 1,000
offset Field Type
int
Description
Number of rows to skip before starting to return. Example: 100
filters Field Type
string
Description
This parameter is added to a select query to select results of only a specific type.
Example: [GenderId__c=Male,FirstName__c=Angel]
orderby Field Type
string
Description
Comma-separated values to sort the result-set in ascending or descending order.
Example: GenderId__c ASC, Occupation__c DESC
timeGranularity Field Type
string
Description
With this parameter you can roll up the measures to various time ranges. Possible
values: HOUR, DAY, MONTH, QUARTER, YEAR
This field is available in API version 53.0 and later.
682
Extract Data CDP Python Connector
Examples
Request
https://{TSE}.360a.salesforce.com/api/v1/insights/calculated-insights/{ci-name}
Response
{
"data": [
{
"Id__c": "05d01a06-0c61-3990-808d-2aa602dd3e7f",
"FirstName__c": "Don",
"Avg_Spend__c": 1335.15
},
{
"Id__c": "11bcc846-1a80-3293-8cc4-3449835d8d4c",
"FirstName__c": "Wensei",
"Avg_Spend__c": 942.67
},
{
"Id__c": "18213566-df86-34a8-97aa-2cb75b70ae3b",
"FirstName__c": "Ryan",
"Avg_Spend__c": 2886.50
}
],
done: true
}
HTTP Responses
Response Reason
200 OK Callback successfully verified.
400 Bad Request Invalid request.
403 Forbidden Failed to pass authorization.
404 Not Found Incorrect callback ID, verification key, or both.
422 Unprocessable Entity The attribute name used in fields or filter parameters doesn’t exist.
500 Server Error Internal error.
CDP Python Connector
Unlock and extend the value of Data Cloud data with the CDP Python Connector. The connector uses the Query API and extracts data
from Data Cloud into Python. It lets you fetch data in Pandas DataFrames. With the data in your environment, you can create visual data
models, perform powerful analytical operations, or build powerful machine learning and AI models as well.
683
Extract Data CDP Python Connector
Prerequisites
Complete the prerequisites to configure the CDP Python Connector:
• Install the CDP Python Connector from PyPI (Python Package Index) repository.
pip install salesforce-cdp-connector
Note: Upon successful installation, you’ll see the following message Successfully Installed
salesforce-cdp-connector-<version>.
• Authenticate the CDP Python Connector. You can authenticate the connector using two ways:
– Authenticate with username and password
1. Create your connected app, and complete its basic information.
2. Select Enable OAuth Settings.
3. Enter the callback URL (endpoint) that Salesforce calls back to your application during OAuth.
4. Select the OAuth scopes to apply to the connected app. OAuth scopes define permissions for the connected app, which are
granted as tokens after the app is authorized. The OAuth token name is in parentheses.
5. Click Save for the changes to take effect.
6. Click Continue to get to Manage Connected Apps.
7. Copy the consumer key and consumer secret. They’re used during the creation of the Connection Object.
– Authenticate using OAuth endpoint
1. Create your connected app, and complete its basic information.
2. Select Enable OAuth Settings.
3. Enter the callback URL (endpoint) that Salesforce calls back to your application during OAuth.
4. Select the OAuth scopes to apply to the connected app. OAuth scopes define permissions for the connected app, which are
granted as tokens after the app is authorized. The OAuth token name is in parentheses.
5. Click Save for the changes to take effect.
6. Click Continue to get to Manage Connected Apps.
7. Copy the consumer key and consumer secret. They’re used during the creation of the Connection Object.
8. Construct the URL -
<YOUR_ORG_URL>/services/oauth2/authorize?response_type=code&client_id=<YOUR_CONSUMER_KEY>&scope=api
refresh_token cdp_profile_api cdp_query_api&redirect_uri=<YOUR_CALLBACK_URL> .
Note: <YOUR_ORG_URL> is the fully qualified instance URL.
9. Paste the URL in a browser and it will redirect you to the callback url. The redirected url is of the form<callback
url>?code=<CODE>. . Extract the CODE from the address bar.
10. Make a post call to
<YOUR_ORG_URL>/services/oauth2/token?code=<CODE>&grant_type=authorization_code&client_id=<clientId>&client_secret=<clientSecret>&redirect_uri=<callback_uri>
.The response to the post call is a json with access_token and refresh_token.
684
Extract Data CDP Python Connector
Use CDP Python Connector
The CDP Python Connector setup requires you to:
• Create a Connection Object
• Create a Cursor Object and query Data Cloud
• Fetch the Data Cloud data
Create a Connection Object
You can create a connection object in two ways:
• With username and password Use the parameters described here and instantiate a Connection Object with username and
password.
Parameters Description
login_url Salesforce org url
user_name Salesforce org Username
password Salesforce org password
client_id consumer key generated by Connected App
client_secret consumer secret generated by the Connected App
from salesforcecdpconnector.connection import SalesforceCDPConnection
conn = SalesforceCDPConnection(
'login_url',
'user_name',
'password',
'client_id',
'client_secret'
)
• With OAuth endpoint Use the parameters described here and instantiate a connection object with OAuth endpoint.
Parameters Description
login_url Salesforce org url
client_id Salesforce org Username
client_secret Salesforce org password
core_token access_token received in step-9 of Authenticate using OAuth endpoint section.
refresh_token refresh_token received in step-9 of Authenticate using OAuth endpoint section.
from salesforcecdpconnector.connection import SalesforceCDPConnection
conn = SalesforceCDPConnection(login_url,
685
Extract Data API Limits for Profile, Query, and Calculated Insights
client_id='<client_id>',
client_secret='<client_secret>',
core_token='<core token>'
refresh_token='<refresh_token>'
)
Create a Cursor Object and query Data Cloud
Create a cursor object to execute queries. When a query is executed, the cursor passes on that query to the Data Cloud to fetch the
results.
cur = conn.cursor()
cur.execute('<query>')
Fetch Data Cloud data
You can fetch the data in three possible ways:
• One row at a time: Use the fetchone() method to retrieve one row of result at a time.
results = cur.fetchone()
• Get all the rows:Use the fetchall() method to retrieve all the query results in one call.
results = cur.fetchall()
• Get results in a dataframe: You can retrieve the results into a Pandas DataFrame using the get_pandas_dataframe()
method.
dataframe = conn.get_pandas_dataframe('<query>')
API Limits for Profile, Query, and Calculated Insights
There are three distinct classes of APIs used to extract data from Data Cloud (formerly Customer Data Platform): Profile, Query, and
Calculated Insights.
Profile, Query, and Calculated Insights API limits for Data Cloud (formerly Customer Data Platform) orgs are based on the org’s Data Cloud
edition, not its Salesforce edition, except when running Data Cloud on a Developer org.
These limits don't apply to new Data Cloud orgs.
Data Cloud Editions Profile API Queries Per Day Query API and Insights API Query API and Insights API
Per Day Concurrent Inbound
Requests
Data Cloud (formerly Customer 10,000 1,000 15
Data Platform) Corporate Edition
Data Cloud (Customer Data 50,000 1,000 15
Platform) Enterprise and
Enterprise Editions Plus
Any edition, when running on a 1,000 100 15
Salesforce Developer org
686
Extract Data Webhook Data Action Targets in Data Cloud
Note: To understand what other limits impact your org, review Data Cloud Limits and Guidelines.
Webhook Data Action Targets in Data Cloud
Send a Data Cloud data action event to a webhook target and protect the message integrity with a Salesforce-generated secret key. A
webhook is a type of HTTP request that’s triggered by an event in a source system and sent to a destination system with a payload. A
webhook is event-driven rather than request-driven. Webhooks are sent automatically when an event is triggered in the source system.
The secret key based signature validates the payload requests sent from Salesforce.
A webhook transports HTTP payload with events in the format of DataObjectDataChgEvent.
{
"creationDateTime": "DateTime: Payload creation time at the service calling webhook",
"count": "Number: Count of events in this payload",
"schemas": [ { "schemaId": "Action Name of schema", schema : "Schema of Event Payload in
Action" } ], //Array of Schemas for different event payload
"events": [Array of DataObjectDataChgEvent Events],
}
Generate a Secret Key for Signature Validation
To protect a webhook system from malicious attacks, generate a secret key for validation. If you don’t generate a secret key, targets
don’t receive a payload, and calls are marked with Signing Key Not Found. In Data Cloud, data actions use the HMACSHA256 signature
algorithm.
Regenerate a Secret Key
We recommend regenerating the secret key used in your webhook system at least every 12 months. After you regenerate a secret
key, it takes up to 15 minutes to be effective. Until the new key is configured for use, validations at the webhook target fail.
Payload Signature
Payload-based signature validates the payload requests sent to your webhook system from Salesforce.
Validating the Signature
To validate the signature, you can use this sample Java code or something similar. This code includes the payload, signature received,
and secret key.
SEE ALSO:
Salesforce Developers Blog: Unleashing the Power of Data Actions Using a Webhook as a Target
Generate a Secret Key for Signature Validation
To protect a webhook system from malicious attacks, generate a secret key for validation. If you don’t generate a secret key, targets don’t
receive a payload, and calls are marked with Signing Key Not Found. In Data Cloud, data actions use the HMACSHA256 signature algorithm.
1. In Data Cloud, on the Data Actions Target tab, click New.
2. Enter the action target name.
The Action Target API Name field is auto-filled.
3. Select Webhook.
4. Enter the URL where you want to publish the webhook events, and click Save.
687
Extract Data Regenerate a Secret Key
5. Generate the secret key.
6. Copy the secret key to your webhook system to validate and protect the integrity of the payload requests sent from Salesforce.
Regenerate a Secret Key
We recommend regenerating the secret key used in your webhook system at least every 12 months. After you regenerate a secret key,
it takes up to 15 minutes to be effective. Until the new key is configured for use, validations at the webhook target fail.
1. In Data Cloud, navigate to the Data Actions Target tab.
2. Open your webhook-based data action target.
3. Regenerate the secret key.
4. Copy the secret key to your webhook system to validate the signature provided with payload.
Payload Signature
Payload-based signature validates the payload requests sent to your webhook system from Salesforce.
You can find the payload signature in the header of the HTTP payload received in your webhook system. For example, x-signature:
uruO+yjX8KKjl72GkQbLXuoMyAilC5losEnY1Liiu30=
Validating the Signature
To validate the signature, you can use this sample Java code or something similar. This code includes the payload, signature received,
and secret key.
You can have analogous code in your respective programming language.
public static final String SIGNING_KEY_ALGO = "HMACSHA256";
public static boolean isSignatureValid(String payload, String receivedSignature, String
signingKey) throws NoSuchAlgorithmException, InvalidKeyException,
UnsupportedEncodingException {
Mac mac = Mac.getInstance(SIGNING_KEY_ALGO);
SecretKeySpec secretKeySpec =
new SecretKeySpec(
signingKey.getBytes(StandardCharsets.UTF_8), SIGNING_KEY_ALGO);
mac.init(secretKeySpec);
String signature =
org.apache.commons.codec.binary.Base64.encodeBase64String(mac.doFinal(payload.getBytes(StandardCharsets.UTF_8)));
if(signature.equals(receivedSignature))
{
return true;
}
return false;
}
import hmac
import hashlib
import base64
688
Extract Data Validating the Signature
def is_signature_valid(payload, received_signature, signing_key):
mac = hmac.new(signing_key.encode('latin-1'), digestmod=hashlib.sha256)
mac.update(payload.encode('latin-1'))
signature = base64.b64encode(mac.digest()).decode('utf-8')
return signature == received_signature
689
You might also like
- TMF640-Service Activation and Configuration-V5.0.0No ratings yetTMF640-Service Activation and Configuration-V5.0.070 pages
- Fritzing for Inventors: Take Your Electronics Project from Prototype to ProductFrom EverandFritzing for Inventors: Take Your Electronics Project from Prototype to ProductNo ratings yet
- Securing ChatGPT: Best Practices for Protecting Sensitive Data in AI Language ModelsFrom EverandSecuring ChatGPT: Best Practices for Protecting Sensitive Data in AI Language ModelsNo ratings yet
- Cybersecurity for Executives: A Guide to Protecting Your BusinessFrom EverandCybersecurity for Executives: A Guide to Protecting Your BusinessNo ratings yet
- Austin and Boxerman's Information Systems for Healthcare Management, Seventh EditionFrom EverandAustin and Boxerman's Information Systems for Healthcare Management, Seventh EditionNo ratings yet
- Programming the Photon: Getting Started with the Internet of ThingsFrom EverandProgramming the Photon: Getting Started with the Internet of Things5/5 (1)
- Programming the Intel Galileo: Getting Started with the Arduino -Compatible Development BoardFrom EverandProgramming the Intel Galileo: Getting Started with the Arduino -Compatible Development Board5/5 (1)
- The Ultimate Small Business Marketing Toolkit: All the Tips, Forms, and Strategies You'll Ever Need!From EverandThe Ultimate Small Business Marketing Toolkit: All the Tips, Forms, and Strategies You'll Ever Need!3/5 (1)
- Smart Card Applications: Design models for using and programming smart cardsFrom EverandSmart Card Applications: Design models for using and programming smart cardsNo ratings yet
- Business Object Modeling (BOM) workbook: A pattern-based approach to creating, managing and using an enterprise data modelFrom EverandBusiness Object Modeling (BOM) workbook: A pattern-based approach to creating, managing and using an enterprise data modelNo ratings yet
- Benefits of semantic data models. A study in the European goods transport industryFrom EverandBenefits of semantic data models. A study in the European goods transport industryNo ratings yet
- Catastrophe Risk Financing in Developing Countries: Principles for Public InterventionFrom EverandCatastrophe Risk Financing in Developing Countries: Principles for Public InterventionNo ratings yet
- Programming Arduino: Getting Started with Sketches, Third EditionFrom EverandProgramming Arduino: Getting Started with Sketches, Third EditionNo ratings yet
- Financial Services Cloud Administrator GuideNo ratings yetFinancial Services Cloud Administrator Guide580 pages
- Programming Arduino Next Steps: Going Further with Sketches, Second EditionFrom EverandProgramming Arduino Next Steps: Going Further with Sketches, Second Edition3/5 (3)
- CNC Machining Handbook: Building, Programming, and ImplementationFrom EverandCNC Machining Handbook: Building, Programming, and ImplementationNo ratings yet
- Some Small Countries Do It Better: Rapid Growth and Its Causes in Singapore, Finland, and IrelandFrom EverandSome Small Countries Do It Better: Rapid Growth and Its Causes in Singapore, Finland, and IrelandNo ratings yet
- Arduino + Android Projects for the Evil Genius: Control Arduino with Your Smartphone or TabletFrom EverandArduino + Android Projects for the Evil Genius: Control Arduino with Your Smartphone or Tablet4.5/5 (2)
- Document Information Extraction: Public 2024-05-13No ratings yetDocument Information Extraction: Public 2024-05-13302 pages
- Artificial Intelligence To Enhance Energy Management and Distribution in Smart Grid Communication NetworksNo ratings yetArtificial Intelligence To Enhance Energy Management and Distribution in Smart Grid Communication Networks13 pages
- Mercedes-Amg Petronas Formula One Team: Case StudyNo ratings yetMercedes-Amg Petronas Formula One Team: Case Study8 pages
- PDF A Short History of the Middle Ages 5th Edition Barbara H. Rosenwein downloadNo ratings yetPDF A Short History of the Middle Ages 5th Edition Barbara H. Rosenwein download40 pages
