Procedures

Automation procedures in the Salesforce book.

The following documentation is for Salesforce v2.0.3 (BDK).

Ensure that you have installed or connected the Salesforce book and created a new playground before using these automation procedures.

to create a report in salesforce

Creates a report in Salesforce.

Input Concepts

Concept	Description	Type	Required	Default Value
report	A CreateSalesforceReportBody to create a Report with in Salesforce	salesforce create report body	Yes	(no default)

Output Concepts

Concept	Description	Type
answer	The id of the created report	text

Examples

Create a basic Salesforce Report

create a json
use the above as the type json
set the type json's "type" to "Opportunity"
set the type json's "label" to "Opportunity"
create a json
use the above as the metadata json
set the metadata json's "name" to "Example Report from BDK"
set the metadata json's "description" to "A report from BDK"
set the metadata json's "report_type" to the type json
create a json
use the above as the request json
set the request json's "report_metadata" to the metadata json
create the request json in salesforce

Create a Report with a filter

create a json
use the above as the type json
set the type json's "type" to "Opportunity"
set the type json's "label" to "Opportunity"
create a json
use the above as the filter
set the filter's "target" to "20000"
set the filter's "column" to "AMOUNT"
set the filter's "operator" to "greaterThan"
set the filter's "is_run_page_editable" to True
set the filter's "filter_type" to "fieldValue"
use the above filters as the filters
create a json
use the above as the metadata json
set the metadata json's "name" to "Example Report from BDK"
set the metadata json's "description" to "A report from BDK"
set the metadata json's "report_type" to the type json
set the metadata json's "report_filters" to the filters
create a json
use the above as the request json
set the request json's "report_metadata" to the metadata json
create the request json in salesforce

to export a report as a excel

Exports a report as an Excel file.

Input Concepts

Concept	Description	Type	Required	Default Value
report	A SalesforceReport to export as an Excel file	salesforce report	Yes	(no default)

Output Concepts

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

Examples

retrieve reports from salesforce whose Name is "BOF Report"
use the first report as the record
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	Default Value
report	A SalesforceReport to export as a Pyarrow Table	salesforce report	Yes	(no default)

Output Concepts

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

Examples

retrieve reports from salesforce whose Name is "BOF Report"
use the first report as the record
export the report as a table

to retrieve some (reports) from salesforce

FILTER - CAPABLE

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	Default Value
receivers	The receivers of the email.	text	Yes	(no default)
subject	The subject of the email.	text	Yes	(no default)
body	The body of the email.	text	No	(no default)

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"