Add Product Into Opportunity
Add Salesforce Product into Opportunity.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
product_name | str | null | type of the product in the Pricelist |
quantity | int | null | number of products to add |
opportunity_id | str, None | None | identifier of Opportunity, default None |
pricebook_name | str, None | None | name of the pricelist, default None |
custom_total_price | float, None | None | price that overrides quantity and product price, default None |
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
Authorize to Salesforce with security token, username and password creating instance.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
username | str | null | Salesforce API username |
password | str | null | Salesforce API password |
api_token | str | null | Salesforce API security token |
param username: | Salesforce API username |
---|---|
param password: | Salesforce API password |
param api_token: | |
Salesforce API security token |
Create New Opportunity
Create Salesforce Opportunity object.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
close_date | str | null | closing date for the Opportunity, format 'YYYY-MM-DD' |
opportunity_name | str | null | as string |
stage_name | str | Closed Won | needs to be one of the defined stages, defaults to "Closed Won" |
account_name | str, None | None | by default uses previously set account, defaults to None |
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
Create Salesforce object by type and data.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
object_type | str | null | Salesforce object type |
object_data | Any | null | Salesforce object 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
Delete Salesfoce object by type and id.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
object_type | str | null | Salesforce object type |
object_id | str | null | Salesforce object id |
param object_type: | |
---|---|
Salesforce object type | |
param object_id: | |
Salesforce object id | |
return: | True if successful |
Describe Salesforce Object
Get Salesfoce object description by type.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
object_type | str | null | Salesforce object type |
param object_type: | |
---|---|
Salesforce object type | |
return: | object description as dictionary |
Execute Dataloader Insert
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.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
input_object | Any | null | filepath or list of dictionaries |
mapping_object | Any | null | filepath or dictionary |
object_type | str | null | Salesforce object 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
Return Dataloader error entries as RPA.Table
Get Dataloader Success Table
Return Dataloader success entries as RPA.Table
Get Domain
Used to determine the current domain that has been set
returns: | string of the currently set domain |
---|
Get Opportunity Id
Get ID of an Opportunity linked to set account.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
opportunity_name | str | null | opportunity to query |
param opportunity_name: | |
---|---|
opportunity to query | |
return: | Id of the opportunity or False |
Get Pricebook Entries
Get all pricebook entries.
return: | query result |
---|
Get Pricebook Id
Get ID of a pricelist.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
pricebook_name | str | null | pricelist to query |
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
Get all products in a pricelist.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
pricebook_name | str | null | pricelist to query |
param pricebook_name: | |
---|---|
pricelist to query | |
return: | products in dictionary |
Get Salesforce Object By Id
Get Salesforce object by id and type.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
object_type | str | null | Salesforce object type |
object_id | str | null | Salesforce object id |
param object_type: | |
---|---|
Salesforce object type | |
param object_id: | |
Salesforce object id | |
return: | dictionary of object attributes |
Get Salesforce Object Metadata
Get Salesfoce object metadata by type.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
object_type | str | null | Salesforce object type |
param object_type: | |
---|---|
Salesforce object type | |
return: | object metadata as dictionary |
Read Dictionary From File
Read dictionary from file.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
mapping_file | str | null | path to the file |
param mapping_file: | |
---|---|
path to the file | |
return: | file content as dictionary |
Salesforce Query
Perform SQL query and return result as dict or Table.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
sql_string | str | null | SQL clause to perform. |
as_table | bool | False | Set to True if the result should be of RPA.Tables.Table type. (dictionary is returned by default) |
param sql_string: | |
---|---|
SQL clause to perform. | |
param as_table: | Set to True if the result should be of RPA.Tables.Table type. (dictionary is returned by default) |
returns: | Result of the SQL query. |
Salesforce Query Result As Table
Shorthand for Salesforce Query ${sql_string} as_table=${True}.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
sql_string | str | null | SQL clause to perform. |
param sql_string: | |
---|---|
SQL clause to perform. | |
returns: | Result of the SQL query as RPA.Tables.Table. |
Set Account
Set account name and id by giving either parameter.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
account_name | str | string, defaults to "" | |
account_id | str | string, defaults to "" |
- 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 Domain
Used to set the domain the Auth With Token keyword will use. To set the domain to 'test' or if using a sandbox environment use "sandbox" as the domain. If you have a Salsesforce My domain you may also input that name. If the domain argument is not used the default domain is "login".
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
domain | str | login | "sandbox" or the name of the Salesforce My domain; if no argument provided defaults to "login" |
param domain: | "sandbox" or the name of the Salesforce My domain; if no argument provided defaults to "login" |
---|
Set Pricebook
Sets Pricebook to be used in Salesforce operations.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
pricebook_name | str | null | pricelist to use |
param pricebook_name: | |
---|---|
pricelist to use |
Update Salesforce Object
Update Salesfoce object by type, id and data.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
object_type | str | null | Salesforce object type |
object_id | str | null | Salesforce object id |
object_data | Any | null | Salesforce object 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
Upsert Salesfoce object by type, id and data.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
object_type | str | null | Salesforce object type |
object_id | str | null | Salesforce object id |
object_data | Any | null | Salesforce object 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 |