Search External GraphQL Objects in Salesforce Connect



Use CData Connect Cloud to securely provide OData feeds of GraphQL data to smart devices and cloud-based applications. Use the CData Connect and Salesforce Connect to create GraphQL Data objects that you can access from apps and the dashboard.

CData Connect Cloud, enables you to access GraphQL data from cloud-based applications like the Salesforce console and mobile applications like the Salesforce Mobile App. In this article, you will use CData Connect Cloud and Salesforce Connect to access external GraphQL objects alongside standard Salesforce objects.

Connect to GraphQL from Salesforce

To work with live GraphQL data in Salesforce Connect, we need to connect to GraphQL from Connect Cloud, provide user access to the connection, and create OData endpoints for the GraphQL data.

(Optional) Add a New Connect Cloud User

As needed, create Users to connect to GraphQL through Connect Cloud.

  1. Navigate to the Users page and click Invite Users
  2. Enter the new user's email address and click Send to invite the user
  3. You can review and edit users from the Users page

Add a Personal Access Token

If you are connecting from a service, application, platform, or framework that does not support OAuth authentication, you can create a Personal Access Token (PAT) to use for authentication. Best practices would dictate that you create a separate PAT for each service, to maintain granularity of access.

  1. Click on your username at the top right of the Connect Cloud app and click User Profile.
  2. On the User Profile page, scroll down to the Personal Access Tokens section and click Create PAT.
  3. Give your PAT a name and click Create.
  4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

Connect to GraphQL from Connect Cloud

CData Connect Cloud uses a straightforward, point-and-click interface to connect to data sources.

  1. Log into Connect Cloud, click Connections and click Add Connection
  2. Select "GraphQL" from the Add Connection panel
  3. Enter the necessary authentication properties to connect to GraphQL.

    You must specify the URL of the GraphQL service. The driver supports two types of authentication:

    • Basic: Set AuthScheme to Basic. You must specify the User and Password of the GraphQL service.
    • OAuth 1.0 & 2.0: Take a look at the OAuth section in the Help documentation for detailed instructions.
  4. Click Create & Test
  5. Navigate to the Permissions tab in the Add GraphQL Connection page and update the User-based permissions.

Configure GraphQL Endpoints for Salesforce Connect

After connecting to GraphQL, create a workspace and virtual dataset for your desired table(s).

  1. Navigate to the Virtual Datasets page and click Add to create a new Workspace (or select an existing workspace).
  2. Click Add to add new assets to the Workspace.
  3. Select the GraphQL connection (e.g. GraphQL1) and click Next.
  4. Select the table(s) you wish to work with and click Confirm.
  5. Make note of the OData Service URL for your workspace, e.g. https://cloud.cdata.com/api/odata/{workspace_name}

With the connection and Workspace configured, you are ready to connect to GraphQL data from Salesforce Connect.

Connect to GraphQL Data as an External Data Sources

Follow the steps below to connect to the feed produced by Connect Cloud.

  1. Log into Salesforce and click Setup -> Integrations -> External Data Sources.
  2. Click Now External Data Sources.
  3. Enter values for the following properties:
    • External Data Sources: Enter a label to be used in list views and reports.
    • Name: Enter a unique identifier.
    • Type: Select the option "Salesforce Connect: OData 4.0".
    • URL: Enter the URL to the OData endpoint of Connect Cloud: https://cloud.cdata.com/api/odata/{workspace_name}
  4. Select JSON in the Format menu.
  5. In the Authentication section, set the following properties:
    • Identity Type: If all members of your organization will use the same credentials to access Connect Cloud, select "Named Principal". If the members of your organization will connect with their own credentials, select "Per User".
    • Authentication Protocol: Select Password Authentication to use basic authentication.
    • Certificate: Enter or browse to the certificate to be used to encrypt and authenticate communications from Salesforce to your server.
    • Username: Enter a CData Connect Cloud username (e.g. [email protected].
    • Password: Enter the user's PAT.

Synchronize GraphQL Objects

After you have created the external data source, follow the steps below to create GraphQL external objects that reflect any changes in the data source. You will synchronize the definitions for the GraphQL external objects with the definitions for GraphQL tables.

  1. Click the link for the external data source you created.
  2. Click Validate and Scan.
  3. Select the GraphQL tables you want to work with as external objects.

Access GraphQL Data as Salesforce Objects

After adding GraphQL data as an external data source and syncing GraphQL tables as external objects, you can use the external GraphQL objects just as you would standard Salesforce objects.

  • Create a new tab with a filter list view:

  • Create reports of external objects:

Simplified Access to GraphQL Data from Cloud Applications

At this point, you have a direct, cloud-to-cloud connection to live GraphQL data from Salesforce. For more information on gaining simplified access to data from more than 100 SaaS, Big Data, and NoSQL sources in cloud applications like Salesforce, refer to our Connect Cloud page.

Ready to get started?

Learn more about CData Connect Cloud or sign up for free trial access:

Free Trial