Python API¶

Salesforce¶

class RPA.Salesforce.Salesforce(sandbox: bool = False)¶

Bases: object

Salesforce is a library for accessing Salesforce using REST API. The library extends simple-salesforce library.

More information available at Salesforce REST API Developer Guide.

Dataloader

The keyword execute_dataloader_import can be used to mimic Salesforce Dataloader import behaviour.

input_object can be given in different formats. Below is an example where input is in RPA.Table format in method a and list format in method b.

*** Settings ***
Library     RPA.Salesforce
Library     RPA.Database
Task Setup  Authorize Salesforce

*** Tasks ***
# Method a
${orders}=        Database Query Result As Table
...               SELECT * FROM incoming_orders
${status}=        Execute Dataloader Insert
...               ${orders}  ${mapping_dict}  Tilaus__c
# Method b
${status}=        Execute Dataloader Insert
...               ${WORKDIR}${/}orders.json  ${mapping_dict}  Tilaus__c

Example file orders.json

[
    {
        "asiakas": "0015I000002jBLIQA2"
    },
    {
        "asiakas": "0015I000002jBLDQA2"
    },
]

mapping_object describes how the input data fields are mapped into Salesforce object attributes. In the example, the mapping defines that asiakas attribute in the input object is mapped into Tilaaja__c attribute of Tilaus__c custom Salesforce object.

{
    "Tilaus__c": {
        "asiakas": "Tilaaja__c"
    },
}

Object type could be, for example, Tilaus__c.

Salesforce object operations

Following operations can be used to manage Salesforce objects:

Get Salesforce Object By Id
Create Salesforce Object
Update Salesforce Object
Upsert Salesforce Object
Delete Salesforce Object
Get Salesforce Object Metadata
Describe Salesforce Object

Examples

Robot Framework

*** Settings ***
Library     RPA.Salesforce
Task Setup  Authorize Salesforce

*** Variables ***
${ACCOUNT_NOKIA}    0015I000002jBLDQA2

*** Tasks ***
Change account details in Salesforce
    &{account}=      Get Salesforce Object By Id   Account  ${ACCOUNT_NOKIA}
    &{update_obj}=   Create Dictionary   Name=Nokia Ltd  BillingStreet=Nokia bulevard 1
    ${result}=       Update Salesforce Object  Account  ${ACCOUNT_NOKIA}  ${update_obj}

*** Keywords ***
Authorize Salesforce
    ${secrets}=     Get Secret   salesforce
    Auth With Token
    ...        username=${secrets}[USERNAME]
    ...        password=${secrets}[PASSWORD]
    ...        api_token=${secrets}[API_TOKEN]

Python

import pprint
from RPA.Salesforce import Salesforce
from RPA.Robocorp.Vault import FileSecrets

pp = pprint.PrettyPrinter(indent=4)
filesecrets = FileSecrets("secrets.json")
secrets = filesecrets.get_secret("salesforce")

sf = Salesforce()
sf.auth_with_token(
    username=secrets["USERNAME"],
    password=secrets["PASSWORD"],
    api_token=secrets["API_TOKEN"],
)
nokia_account_id = "0015I000002jBLDQA2"
account = sf.get_salesforce_object_by_id("Account", nokia_account_id)
pp.pprint(account)
billing_information = {
    "BillingStreet": "Nokia Bulevard 1",
    "BillingCity": "Espoo",
    "BillingPostalCode": "01210",
    "BillingCountry": "Finland",
}
result = sf.update_salesforce_object("Account", nokia_account_id, billing_information)
print(f"Update result: {result}")

ROBOT_LIBRARY_DOC_FORMAT = 'REST'¶

ROBOT_LIBRARY_SCOPE = 'GLOBAL'¶

account = {'Id': None, 'Name': None}¶

add_product_into_opportunity(product_name: str, quantity: int, opportunity_id: str = None, pricebook_name: str = None, custom_total_price: float = None) → bool¶

Add Salesforce Product into Opportunity.

Parameters

product_name – type of the product in the Pricelist
quantity – number of products to add
opportunity_id – identifier of Opportunity, default None
pricebook_name – name of the pricelist, default None
custom_total_price – price that overrides quantity and product price, default None

Returns

True is operation is successful or False

auth_with_token(username: str, password: str, api_token: str) → None¶

Authorize to Salesforce with security token, username and password creating instance.

Parameters

username – Salesforce API username
password – Salesforce API password
api_token – Salesforce API security token

create_new_opportunity(close_date: str, opportunity_name: str, stage_name: str = 'Closed Won', account_name: str = None) → Any¶

Create Salesforce Opportunity object.

Parameters

close_date – closing date for the Opportunity, format ‘YYYY-MM-DD’
opportunity_name – as string
stage_name – needs to be one of the defined stages, defaults to “Closed Won”
account_name – by default uses previously set account, defaults to None

Returns

created opportunity or False

create_salesforce_object(object_type: str, object_data: Any) → dict¶

Create Salesforce object by type and data.

Parameters

object_type – Salesforce object type
object_data – Salesforce object data

Raises

SalesforceDataNotAnDictionary – when object_data is not dictionary

Returns

resulting object as dictionary

delete_salesforce_object(object_type: str, object_id: str) → bool¶

Delete Salesfoce object by type and id.

Parameters

object_type – Salesforce object type
object_id – Salesforce object id

Returns

True if successful

describe_salesforce_object(object_type: str) → dict¶

Get Salesfoce object description by type.

Parameters: object_type – Salesforce object type
Returns: object description as dictionary

execute_dataloader_insert(input_object: Any, mapping_object: Any, object_type: str) → bool¶

Keyword mimics Salesforce Dataloader ‘insert’ behaviour by taking in a input_object`representing dictionary of data to input into Salesforce, a `mapping_object representing dictionary mapping the input keys into Salesforce keys, an object_type representing Salesforce object which Datahandler will handle with operation type.

Stores operation successes into Salesforce.dataloader_success array. Stores operation errors into Salesforce.dataloader_errors.

These can be retrieved with keywords get_dataloader_success_table and get_dataloader_error_table which return corresponding data as RPA.Table.

Parameters

input_object – filepath or list of dictionaries
mapping_object – filepath or dictionary
object_type – Salesforce object type

Returns

True if operation is successful

get_dataloader_error_table() → RPA.Tables.Table¶: Return Dataloader error entries as RPA.Table

get_dataloader_success_table() → RPA.Tables.Table¶: Return Dataloader success entries as RPA.Table

get_opportunity_id(opportunity_name: str) → Any¶

Get ID of an Opportunity linked to set account.

Parameters: opportunity_name – opportunity to query
Returns: Id of the opportunity or False

get_pricebook_entries() → dict¶

Get all pricebook entries.

Returns: query result

get_pricebook_id(pricebook_name: str) → Any¶

Get ID of a pricelist.

Returns False if unique Id is not found.

Parameters: pricebook_name – pricelist to query
Returns: Id of the pricelist or False

get_products_in_pricelist(pricebook_name: str) → dict¶

Get all products in a pricelist.

Parameters: pricebook_name – pricelist to query
Returns: products in dictionary

get_salesforce_object_by_id(object_type: str, object_id: str) → dict¶

Get Salesforce object by id and type.

Parameters

object_type – Salesforce object type
object_id – Salesforce object id

Returns

dictionary of object attributes

get_salesforce_object_metadata(object_type: str) → dict¶

Get Salesfoce object metadata by type.

Parameters: object_type – Salesforce object type
Returns: object metadata as dictionary

property instance¶

read_dictionary_from_file(mapping_file: str) → dict¶

Read dictionary from file.

Parameters: mapping_file – path to the file
Returns: file content as dictionary

salesforce_query(sql_string: str, as_table: bool = False) → dict¶

Perform SQL query.

Parameters

sql_string – SQL clause to perform
as_table – set to True if result should be RPA.Tables.Table

Returns

result of the SQL query

salesforce_query_result_as_table(sql_string: str) → RPA.Tables.Table¶

Perform SQL query and return result as RPA.Table.

Parameters: sql_string – SQL clause to perform
Returns: result of the SQL query as Table

property session_id¶

set_account(account_name: str = '', account_id: str = '') → bool¶

Set account name and id by giving either parameter.

Can be used together with keywords:

get_opportunity_id
create_new_opportunity

Parameters

account_name – string, defaults to “”
account_id – string, defaults to “”

Returns

True if account was found from Salesforce, else False

set_pricebook(pricebook_name: str) → None¶

Sets Pricebook to be used in Salesforce operations.

Parameters: pricebook_name – pricelist to use

update_salesforce_object(object_type: str, object_id: str, object_data: Any) → bool¶

Update Salesfoce object by type, id and data.

Parameters

object_type – Salesforce object type
object_id – Salesforce object id
object_data – Salesforce object data

Raises

SalesforceDataNotAnDictionary – when object_data is not dictionary

Returns

True if successful

upsert_salesforce_object(object_type: str, object_id: str, object_data: Any) → bool¶

Upsert Salesfoce object by type, id and data.

Parameters

object_type – Salesforce object type
object_id – Salesforce object id
object_data – Salesforce object data

Raises

SalesforceDataNotAnDictionary – when object_data is not dictionary

Returns

True if successful

exception RPA.Salesforce.SalesforceAuthenticationError¶

Bases: Exception

Error when authenticated Salesforce instance does not exist.

args¶

with_traceback()¶: Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception RPA.Salesforce.SalesforceDataNotAnDictionary¶

Bases: Exception

Error when parameter is not dictionary as expected.

args¶

with_traceback()¶: Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.