Add Product Into Opportunity

Arguments

  • product_name: str
  • quantity: int
  • opportunity_id: str = None
  • pricebook_name: str = None
  • custom_total_price: float = None

Add Salesforce Product into Opportunity.

param product_name:
 type of the product in the Pricelist
param quantity:number of products to add
param opportunity_id:
 identifier of Opportunity, default None
param pricebook_name:
 name of the pricelist, default None
param custom_total_price:
 price that overrides quantity and product price, default None
return:True is operation is successful or False

Auth With Token

Arguments

  • username: str
  • password: str
  • api_token: str

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

param username:Salesforce API username
param password:Salesforce API password
param api_token:
 Salesforce API security token

Create New Opportunity

Arguments

  • close_date: str
  • opportunity_name: str
  • stage_name: str = Closed Won
  • account_name: str = None

Create Salesforce Opportunity object.

param close_date:
 closing date for the Opportunity, format 'YYYY-MM-DD'
param opportunity_name:
 as string
param stage_name:
 needs to be one of the defined stages, defaults to "Closed Won"
param account_name:
 by default uses previously set account, defaults to None
return:created opportunity or False

Create Salesforce Object

Arguments

  • object_type: str
  • object_data: typing.Any

Create Salesforce object by type and data.

param object_type:
 Salesforce object type
param object_data:
 Salesforce object data
raises SalesforceDataNotAnDictionary:
 when object_data is not dictionary
return:resulting object as dictionary

Delete Salesforce Object

Arguments

  • object_type: str
  • object_id: str

Delete Salesfoce object by type and id.

param object_type:
 Salesforce object type
param object_id:
 Salesforce object id
return:True if successful

Describe Salesforce Object

Arguments

  • object_type: str

Get Salesfoce object description by type.

param object_type:
 Salesforce object type
return:object description as dictionary

Execute Dataloader Insert

Arguments

  • input_object: typing.Any
  • mapping_object: typing.Any
  • object_type: str

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.

param input_object:
 filepath or list of dictionaries
param mapping_object:
 filepath or dictionary
param object_type:
 Salesforce object type
return:True if operation is successful

Get Dataloader Error Table

Arguments

Return Dataloader error entries as RPA.Table

Get Dataloader Success Table

Arguments

Return Dataloader success entries as RPA.Table

Get Opportunity Id

Arguments

  • opportunity_name: str

Get ID of an Opportunity linked to set account.

param opportunity_name:
 opportunity to query
return:Id of the opportunity or False

Get Pricebook Entries

Arguments

Get all pricebook entries.

return:query result

Get Pricebook Id

Arguments

  • pricebook_name: str

Get ID of a pricelist.

Returns False if unique Id is not found.

param pricebook_name:
 pricelist to query
return:Id of the pricelist or False

Get Products In Pricelist

Arguments

  • pricebook_name: str

Get all products in a pricelist.

param pricebook_name:
 pricelist to query
return:products in dictionary

Get Salesforce Object By Id

Arguments

  • object_type: str
  • object_id: str

Get Salesforce object by id and type.

param object_type:
 Salesforce object type
param object_id:
 Salesforce object id
return:dictionary of object attributes

Get Salesforce Object Metadata

Arguments

  • object_type: str

Get Salesfoce object metadata by type.

param object_type:
 Salesforce object type
return:object metadata as dictionary

Read Dictionary From File

Arguments

  • mapping_file: str

Read dictionary from file.

param mapping_file:
 path to the file
return:file content as dictionary

Salesforce Query

Arguments

  • sql_string: str

Perform SQL query.

param sql_string:
 SQL clause to perform
return:result of the SQL query

Salesforce Query Result As Table

Arguments

  • sql_string: str

Perform SQL query and return result as RPA.Table.

param sql_string:
 SQL clause to perform
return:result of the SQL query as Table

Set Account

Arguments

  • account_name: str =
  • account_id: str =

Set account name and id by giving either parameter.

Can be used together with keywords:
  • get_opportunity_id
  • create_new_opportunity
param account_name:
 string, defaults to ""
param account_id:
 string, defaults to ""
return:True if account was found from Salesforce, else False

Set Pricebook

Arguments

  • pricebook_name: str

Sets Pricebook to be used in Salesforce operations.

param pricebook_name:
 pricelist to use

Update Salesforce Object

Arguments

  • object_type: str
  • object_id: str
  • object_data: typing.Any

Update Salesfoce object by type, id and data.

param object_type:
 Salesforce object type
param object_id:
 Salesforce object id
param object_data:
 Salesforce object data
raises SalesforceDataNotAnDictionary:
 when object_data is not dictionary
return:True if successful

Upsert Salesforce Object

Arguments

  • object_type: str
  • object_id: str
  • object_data: typing.Any

Upsert Salesfoce object by type, id and data.

param object_type:
 Salesforce object type
param object_id:
 Salesforce object id
param object_data:
 Salesforce object data
raises SalesforceDataNotAnDictionary:
 when object_data is not dictionary
return:True if successful