Salesforce

A BDK Book containing automation procedures for integrating with Salesforce.

Make sure to learn the Salesforce Book (BDK) in your agent before using these automation procedures.

Overview

The Salesforce Book (BDK) provides a set of procedures to interact with a Salesforce instance. It allows users to connect and perform operations such as create, update, and delete Salesforce Objects.

Connectivity

This Book supports the connectivity methods described in this section. In here, you will find information about what information is required in order to employ each method.

Connect using Consumer Key, Consumer Secret and Domain

Connects to a Salesforce instance using the consumer key and consumer secret, following the

Label	Description	Type
Consumer Key	The consumer key for authentication.	sensitive
Consumer Secret	The consumer secret for authentication.	sensitive
Domain	The domain of the Salesforce instance.	text

Connect using Username, Password and Security Token

Connects to a Salesforce instance using username, password and security token.

Label	Description	Type
Username	The username for authentication.	text
Password	The password for authentication.	sensitive
Security Token	The security token for authentication.	sensitive

Procedures

to create a report in Salesforce

---

Creates a report in Salesforce.

Input Concepts

Concept	Description	Type	Required
report	A CreateSalesforceReportBody to create a Report with in Salesforce	salesforce create report body	Yes

Output Concepts

Concept	Description	Type
answer	The id of the created report	text

to export a report as a excel

---

Exports a report as an Excel file.

Input Concepts

Concept	Description	Type	Required
report	A SalesforceReport to export as an Excel file	salesforce report	Yes

Output Concepts

Concept	Description	Type
answer	The Excel file as an IO object.	file

Examples

export the record as an excel

to export a report as a table

---

Exports a report as a Pyarrow Table.

Input Concepts

Concept	Description	Type	Required
report	A SalesforceReport to export as a Pyarrow Table	salesforce report	Yes

Output Concepts

Concept	Description	Type
answer	The report represented as a Pyarrow Table.	table

Examples

export the report as a table

to retrieve some (reports) from salesforce

---

Retrieves reports from Salesforce.

Output Concepts

Concept	Description	Type
reports	The reports retrieved from Salesforce.	salesforce report

Examples

Retrieve reports from Salesforce

retrieve reports from salesforce

Retrieve reports from Salesforce, filtering by name

retrieve reports from salesforce whose Name is "BOF Report"

to send an email in salesforce

Sends an email in Salesforce.

Input Concepts

Concept	Description	Type	Required
receivers	The receivers of the email.	text	Yes
subject	The subject of the email.	text	Yes
body	The body of the email.	text	No

Examples

Send an email in Salesforce

send an email in salesforce
    the receivers are "[email protected]","[email protected]"
    the subject is "Test Subject"
    the body is "Test Body"

Concepts

Salesforce create report body

The information sent to Salesforce to create a report.

Field Name	Description
report_metadata	The metadata of the report.

---

Salesforce report

A Salesforce report, modeled as the Salesforce Object (SObject) and defined as a set of data that meets specific criteria.

Field Name	Description	Type
id	The ID of the report.	text
owner_id	The ID of the owner of the report.	text
name	The name of the report.	text
developer_name	The unique name of the object in the API.	text
description	The description of the report. Limit: 255 characters.	optional[text]
folder_name	The name of the folder that contains the report.	optional[text]
namespace_prefix	The namespace prefix of the report.	optional[text]
format	Indicates the format of the report. Can have one of these values: Tabular, Summary, Matrix, or Joined.	text
is_deleted	Indicates whether the report is deleted.	boolean
created_date	The date and time when the report was created.	optional[datetime]
created_by_id	The ID of the user who created the report.	optional[text]
last_modified_date	The date and time when the report was last modified.	optional[datetime]
last_modified_by_id	The ID of the user who last modified the report.	optional[text]
last_referenced_date	The date and time when the report was last referenced.	optional[datetime]
last_run_date	The date and time when the report was last run.	optional[datetime]
last_viewed_date	The date and time when the report was last viewed.	optional[datetime]