Accelerator Salesforce Global Party System API - Implementation Template
home
This API implementation template is a shared component of MuleSoft Accelerators, which accelerate the implementation of essential integration use cases.
The solution includes pre-built APIs, connectors, and integration templates that help unlock business-critical data from external systems and guide you in adopting best practices synthesized from thousands of customer implementations. Use these assets as is or extend them to meet your company’s unique needs.
Summary
This integration template implements the Accelerator Global Party System API specification. This is a System API for a Global Data Service to manage parties and party roles. A scaled down version of Global Data has been implemented using Salesforce as the back-end system. This API follows the Cloud Information Model (CIM).
This API has endpoints to search Parties (e.g., Individuals), associate ContactPoints to a Party and associate external IDs of other Systems to a Party. A party can be of type Individual or Organization or Households. The only types of ContactPoints that can be associated at this time are ContactPointEmail, ContactPointAddress and ContactPointPhone there can also only be a single instance of each type.
Getting started
|
The Accelerators setup guide provides general information on getting started with the accelerator components. This includes instructions on setting up your local workstation for configuring and deploying the applications. |
Once your workstation has been set up, proceed with the Getting started instructions for this asset.
Contact Point Mappings
The following table lists the conditions used to assign ContactPoints in Salesforce:
| CIM PartyRoleType - PartyType | Salesforce Object - Record Type | Condition | Action in Salesforce | Comments |
|---|---|---|---|---|
| Customer - Individual | Account - PersonAccounts | ContactPointAddress with isUsedForBilling set as false and isUsedForShipping set as false | Assign Address as PersonMailingAddress | If multiple addresses match this condition, the one with primaryFlag set to true is used; if none set the first one will be used |
| Customer - Individual | Account - PersonAccounts | ContactPointAddress with isUsedForBilling set as true | Assign Address as BillingAddress | |
| Customer - Individual | Account - PersonAccounts | ContactPointAddress with isUsedForShipping set as true | Assign Address as ShippingAddress | |
| Customer - Individual | Account - PersonAccounts | ContactPointPhone with isSMSCapable set as false | Assign Phone Number as Phone | If multiple phones match this condition, the one with primaryFlag set to true is used; if none set the first one will be used. |
| Customer - Individual | Account - PersonAccounts | ContactPointPhone with isSMSCapable set as true | Assign Phone Number as PersonMobilePhone | |
| Customer - Organization | Account - Account | ContactPointAddress with isUsedForBilling set as true | Assign Address as BillingAddress | If multiple addresses match this condition, the one with primaryFlag set to true is used; if none set the first one will be used |
| Customer - Organization | Account - Account | ContactPointAddress with isUsedForBilling set as true | Assign Address as BillingAddress | If multiple addresses match this condition, the one with primaryFlag set to true is used; if none set the first one will be used |
| Customer - Organization | Account - Account | ContactPointAddress with isUsedFoShipping set as true | Assign Address as ShippingAddress | |
| Customer - Organization | Account - Account | ContactPointPhone with isFaxCapable set as false | Assign Phone Number as Phone | If multiple phones match this condition, the one with primaryFlag set to true is used; if none set the first one will be used |
| Customer - Organization | Account - Account | ContactPointPhone with isFaxCapable set as true | Assign Phone Number as Fax |
*The default value for all flags is false.
Additional resources
- The Prerequisites tab provides detailed information about configuring dependencies this application has on external systems or services.
- The Deployment tab provides instructions on running the application locally from Studio or deploying to CloudHub.
- The Data mappings tab describes how the request and response data structures are mapped between the API interface and the Salesforce.