ProstDev ProstDev
Tutorials Feb 7, 2024 · 6 min read

Part 1: Data Cloud + MuleSoft integration - Connected App, Ingestion API & Data Stream settings in Salesforce

In this first part, we'll just go through the Salesforce/Data Cloud settings that we need to set up before even calling Data Cloud through the Mule app.

By Alex Martinez
Thumbnail: Part 1: Data Cloud + MuleSoft integration - Connected App, Ingestion API & Data Stream settings in Salesforce Read & copy the full video transcript

A little bird told me that deleting records in Data Cloud is actually not that easy to do. So, I did my research and came up with a Mule application for you all to reuse to (hopefully) make your lives easier when dealing with Data Cloud!

In this first part, we’ll go through the Salesforce/Data Cloud settings that we need to set up before even calling Data Cloud through the Mule app.

I want to thank Mohammad Arsha for creating this useful article that got me started on the Data Cloud/Salesforce configuration. Keep creating content!

Prerequisites

  • Salesforce Account with Data Cloud - You should have a Salesforce account where you will be able to access Data Cloud. For more info, see Salesforce Data Cloud.

Connected App settings

The first thing we’re going to do is to create a Connected App in Salesforce to authenticate to Data Cloud. To do this, first enter the Setup from the top-right of the screen.

Salesforce gear menu showing the Setup option for the current app

Search for App Manager using the Quick Find input from the left and click on New Connected App on the top-right of the screen.

Salesforce App Manager with the New Connected App button highlighted

Fill in the following fields and click Save and Continue once you’re done.

FieldValue
Connected App NameMuleSoft Integration Connected App
API NameMuleSoft_Integration_Connected_App
Contact Emailyour email
Enable OAuth Settings
Callback URLhttps://login.salesforce.com/services/oauth2/callback
Selected OAuth Scopes- Access Interaction API resources (cdp_api)
- Access all Data Cloud API resources (cdp_api)
- Manage Data Cloud Calculated Insight data (cdp_calculated_insight_api)
- Manage Data Cloud Identity Resolution (cdp_identityresolution_api)
- Manage Data Cloud Ingestion API data (cdp_ingest_api)
- Manage Data Cloud profile data (cdp_profile_api)
- Manage user data via Web browsers (web)
- Perform ANSI SQL queries on Data Cloud data (cdp_query_api)
- Perform segmentation on Data Cloud data (cdp_segment_api)
Enable Client Credentials Flow

In the created Connected App detail page, click on Manage Consumer Details

Connected App API section with the Manage Consumer Details button

Enter the code sent to your email and click on Verify. Once inside the Consumer Details page, click on Generate and copy the newly generated Staged Consumer Key and Staged Consumer Secret. You will use these credentials for your Mule integration. After that, click on Apply and Apply again. Your staged consumer details should be now your main consumer details.

Connected App Consumer Details page with masked Consumer Key and Secret and Copy buttons

Important

These credentials will be used as cdp.consumer.key and cdp.consumer.secret in your Mule application’s settings in Anypoint Platform (the properties in Runtime Manager).

You can close this window after you’ve copied the credentials.

OAuth settings

Still inside the Setup page, search for OAuth and OpenID Connect Settings in the Quick Find input box and click on it. Make sure the Allow OAuth Username-Password Flows option is On.

OAuth and OpenID Connect Settings with Allow OAuth Username-Password Flows toggled On

Ingestion API settings

If you already have an Ingestion API with a YAML schema, just take note of the name of the Ingestion API you created. Otherwise, follow the next steps to create one.

Still inside the Setup page, search for Ingestion API in the Quick Find input box and click on it. Click on New.

Data Cloud Ingestion API setup page with the New button to create a connector

Add a Connector Name like MuleSoft Ingestion API and click on Save.

MuleSoft Ingestion API connector details showing Source API Name MuleSoft_Ingestion_API

Important

Take note of the Source API Name. This name will be used as the sourceApiName query parameter to call the Mule application. In this case, the correct value would be MuleSoft_Ingestion_API.

If you already have a YAML schema, upload it here and take note of the name of the object(s). If not, upload the following example schema (the names of the objects are runner_profiles and exercises).

openapi: 3.0.3
components:
  schemas:
    runner_profiles:
      type: object
      properties:
        maid:
          type: number
        first_name:
          type: string
        last_name:
          type: string
        email:
          type: string
        gender:
          type: string
        city:
          type: string
        state:
          type: string
        created:
          type: string
          format: date
    exercises:
      type: object
      properties:
        runid:
          type: number
        datetime:
          type: string
          format: date-time
        km_run:
          type: number
        calories_burned:
          type: number
        duration_minutes:
          type: number
        maid:
          type: number
        type:
          type: string

Ingestion API schema listing the exercises and runner_profiles objects, connector In Use

Click on Save.

Important

Whichever object you wish to insert/delete records to, will be used as the objectName query parameter to call the Mule application. In this case, the correct value(s) would be runner_profiles or exercises.

Data Stream settings

Exit the Setup page or go back to the main page after logging in to Salesforce. Click on the apps button at the top-left of the screen and search for Data Cloud. Click on the app.

Salesforce App Launcher searching for and showing the Data Cloud app

Select the Data Streams tab from the top. Click New.

Data Cloud Data Streams tab with the New button to create a data stream

Select Ingestion API and click Next.

New Data Stream source picker with the Ingestion API tile selected

Select your MuleSoft Ingestion API from the dropdown. Select all the objects and click on Next.

  • In the exercises configuration, select Category Profile and Primary Key maid
  • In the runner_profiles configuration, select Category Profile and Primary Key maid

Click Next. Select the default Data Space and click Deploy.

Two deployed data streams: MuleSoft Ingestion API-runner_profiles and -exercises

If you used the example YAML schema, you should have ended up with something like the following.

runner_profiles data stream fields table with maid set as the Primary Key

Note

In this Data Stream, we selected maid as the Primary Key. This is the field we’re going to need per record to delete them using the Mule app.

Conclusion

After finishing this configuration in Salesforce/Data Cloud, you should now have the following data that you will use later when calling the integration.

FieldValue
salesforce.usernameThe username you used to log in to Salesforce at login.salesforce.com
salesforce.passwordThe password you used to log in to Salesforce at login.salesforce.com
cdp.consumer.keyThe Consumer Key you generated from the Connected App
cdp.consumer.secretThe Consumer Key you generated from the Connected App
sourceApiNameThe Source API Name from the Ingestion API (MuleSoft_Ingestion_API)
objectNameThe objects created from the YAML schema in the Ingestion API (runner_profiles or exercises)
Object ID / Primary KeyThe field selected as Primary Key from the Data Stream settings (maid)

Subscribe to receive notifications as soon as new content is published ✨

💬 Prost! 🍻

FAQs

Frequently asked questions about this post.

  • What does Part 1 of this Data Cloud + MuleSoft integration cover?

    This first part only goes through the Salesforce and Data Cloud settings you need to set up before even calling Data Cloud through the Mule app, namely the Connected App, OAuth, Ingestion API, and Data Stream settings.

  • Why do I need to create a Connected App in Salesforce?

    You create a Connected App in Salesforce to authenticate to Data Cloud, enabling OAuth settings and the Client Credentials Flow, then generating a Consumer Key and Consumer Secret that your Mule integration will use.

  • How are the generated Consumer Key and Consumer Secret used in the Mule app?

    The Staged Consumer Key and Staged Consumer Secret you generate and apply from the Connected App's Manage Consumer Details become your main consumer details, and they are used as cdp.consumer.key and cdp.consumer.secret in your Mule application's settings in Anypoint Platform (the properties in Runtime Manager).

  • What do sourceApiName and objectName map to when calling the Mule application?

    sourceApiName is the Source API Name from the Ingestion API, which in this example is MuleSoft_Ingestion_API, and objectName is whichever object you wish to insert or delete records to, which in the example schema is either runner_profiles or exercises.

  • Why is the maid field selected as the Primary Key in the Data Stream?

    In the Data Stream, maid is selected as the Primary Key because it is the field needed per record to delete records using the Mule app.

  • Do I have to use the example YAML schema for the Ingestion API?

    No, if you already have an Ingestion API with a YAML schema you just take note of its name and object names, otherwise you can upload the provided example schema whose objects are runner_profiles and exercises.

More from this series

Data Cloud + MuleSoft Integration· Part 1 of 5
  1. 1.Part 1: Data Cloud + MuleSoft integration - Connected App, Ingestion API & Data Stream settings in Salesforce
  2. 2.Part 2: Data Cloud + MuleSoft integration - Deploy your own Mule app on Anypoint Platform (CloudHub)
  3. 3.Part 3: Data Cloud + MuleSoft integration - Call your integration with Postman
  4. 4.Part 4: Data Cloud + MuleSoft integration - Secure your API with basic authentication in API Manager
  5. 5.Part 5: Data Cloud + MuleSoft integration - Insert data with the BULK operations
Search

Loading search…