Salesforce SObject Types for Ballerina Salesforce Connector

Salesforce is a leading customer relationship management (CRM) platform that helps businesses manage and streamline their sales, service, and marketing operations. The Ballerina Salesforce Connector is a project designed to enhance integration capabilities with Salesforce by providing a seamless connection for Ballerina. Notably, this Ballerina project incorporates record type definitions for the base types of Salesforce objects, offering a comprehensive and adaptable solution for developers working on Salesforce integration projects.

Setup Guide

To customize this project for your Salesforce account and include your custom SObjects, follow the steps below:

Step 1: Login to Your Salesforce Developer Account

Begin by logging into your Salesforce Developer Account.

Step 2: Generate Open API Specification for Your SObjects

Step 2.1: Initiate OpenAPI Document Generation

Use the following command to send a POST request to start the OpenAPI document generation process.

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
https://MyDomainName.my.salesforce.com/services/data/vXX.X/async/specifications/oas3 \
-d '{"resources": ["*"]}'

Replace YOUR_ACCESS_TOKEN and MyDomainName with your actual access token and Salesforce domain. If successful, you'll receive a response with a URI. Extract the locator ID from the URI.

Step 2.2: Retrieve the OpenAPI Document

Send a GET request to fetch the generated OpenAPI document using the following command.

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
https://MyDomainName.my.salesforce.com/services/data/vXX.X/async/specifications/oas3/LOCATOR_ID -o oas.json

Replace YOUR_ACCESS_TOKEN, MyDomainName, and LOCATOR_ID with your actual values.

Step 3: Configure Cluster Settings

To prevent Out-of-Memory (OOM) issues, execute the following command:

export JAVA_OPTS="$JAVA_OPTS -DmaxYamlCodePoints=99999999"

Generate the Ballerina project for the OpenAPI spec using the Ballerina Open API tool with the following commands.

1. Create a new Ballerina project, naming the project as desired (e.g., custom_types, salesforce_types, etc.).

bal new custom_types

2. Customize the package details by editing the Ballerina.toml file. For instance, you can modify the [package] section as follows:

[package]
org = "example"
name = "salesforce.types"
version = "0.1.0"

Feel free to replace "salesforce.types" with one of the suitable desired names like "custom.types" or "integration.types," or come up with your own unique package name.

4. Move the OpenAPI spec into the newly created project directory and execute the following command:

bal openapi -i oas.json --mode client --client-methods resource

This will generate the Ballerina project structure, record types that correspond to the SObject definitions, and client methods based on the provided OpenAPI specification.

Step 4: Edit the Generated Client and Push it to Local Repository

Step 4.1 Delete the utils.bal and clients.bal files.

Step 4.2 Use the following commands to build, pack, and push the package:

bal pack

bal push --repository=local

By following these steps, you can set up and customize the Ballerina Salesforce Connector for your Salesforce account with ease.

Quickstart

To use the salesforce.types module in your Ballerina application, modify the .bal file as follows:

Step 1: Import the package

Import ballerinax/salesforce.types module.

import ballerinax/salesforce;
import ballerinax/salesforce.types;

Step 2: Instantiate a new client

Obtain the tokens using the following the ballerinax/salesforce connector set up guide. Create a salesforce:ConnectionConfig with the obtained OAuth2 tokens and initialize the connector with it.

salesforce:ConnectionConfig config = {
    baseUrl: baseUrl,
    auth: {
        clientId: clientId,
        clientSecret: clientSecret,
        refreshToken: refreshToken,
        refreshUrl: refreshUrl
    }
};

salesforce:Client salesforce = new(config);

Step 3: Invoke the connector operation

Now you can utilize the available operations. Note that they are in the form of remote operations. Following is an example on how to create a record using the connector.

salesforce:Client salesforce = check new (config);
stypes:AccountSObject response = {
   Name: "IT World",
   BillingCity: "New York"
};

salesforce:CreationResponse response = check salesforce->create("Account", response);

Use following command to compile and run the Ballerina program.

bal run

Issues and projects

The Issues and Projects tabs are disabled for this repository as this is part of the Ballerina library. To report bugs, request new features, start new discussions, view project boards, etc., visit the Ballerina library parent repository.

This repository only contains the source code for the package.

Build from the source

Prerequisites

1. Download and install Java SE Development Kit (JDK) version 17. You can download it from either of the following sources:

   • Oracle JDK
   • OpenJDK

   Note: After installation, remember to set the JAVA_HOME environment variable to the directory where JDK was installed.

2. Download and install Ballerina Swan Lake.

3. Download and install Docker.

   Note: Ensure that the Docker daemon is running before executing any tests.

Build options

Execute the commands below to build from the source.

1. To build the package:

   ./gradlew clean build

2. Publish the generated artifacts to the local Ballerina Central repository:

   ./gradlew clean build -PpublishToLocalCentral=true

3. Publish the generated artifacts to the Ballerina Central repository:

   ./gradlew clean build -PpublishToCentral=true

Contribute to Ballerina

As an open-source project, Ballerina welcomes contributions from the community.

For more information, go to the contribution guidelines.

Code of conduct

All the contributors are encouraged to read the Ballerina Code of Conduct.

Useful links

• For more information go to the salesforce.types package.
• For example demonstrations of the usage, go to Ballerina By Examples.
• Chat live with us via our Discord server.
• Post all technical questions on Stack Overflow with the #ballerina tag.