Help Desk

Submit a ticket My Tickets
Welcome
Login

Salesforce Command Reference

This BizApp provides functionality to interact with the data inside Salesforce, including loading, extracting and deleting data via SOQL and bulk operations. There are also functions for creating and managing Salesforce object and updating and creating records.

Connections

Salesforce Basic Auth

Basic authentication with username, password, and security token

Inputs

Input Type Detail Notes
User Name TextField Salesforce user name
Password TextField Salesforce password
Security Token TextField Salesforce security token. To obtain a security token, go to Settings -> My Personal Information -> Reset security token to have Salesforce email you a security token.
Instance TextField Salesforce instance - the characters before salesforce.com in your Salesforce URL (i.e. na73). NOTE: Do not use this field if your organization uses a custom domain
Custom Domain TextField Salesforce custom domain - if your Salesforce instance uses a custom domain, enter it here INSTEAD of using the Instance field. NOTE: This value will usually end with .my.salesforce.com. It can be found under Company Settings -> My Domain

Commands

Bulk Delete

Deletes a large volume of records

Inputs

Input Type Detail Notes
Concurrency mode DropdownField Concurrency mode: Defaults to process in parallel, but can be set to serial if records must be processed sequentially. Very large jobs can fail in parallel mode due to the volume of database connections; in those cases, use serial mode. Serial mode, however, can result in much longer processing times.
SObject Name TextField Type of SObject on which the operation is being performed
Input file FileField File containing relevant records
File format DropdownField Format of the input file. Accepts CSV, JSON, and XML
Batch size NumberField Number of records to be processed per batch. It is recommended you use the default setting, but it can be increased or decreased accordingly.
Wait for completion BooleanField Leaving this checked will ensure OneCloud waits for the operation to complete, since it is executed asynchronously in Salesforce. It is recommend you leave this option checked if your subsequent commands depend on the result of the operation.

Outputs

Output Output Type Notes
Bulk delete error log File

Exit Codes

Code Type Detail
0 Success Indicates that the request was made successfully
1 Error General failure

Bulk Insert

Insert a large volume of records

Inputs

Input Type Detail Notes
Concurrency mode DropdownField Concurrency mode: Defaults to process in parallel, but can be set to serial if records must be processed sequentially. Very large jobs can fail in parallel mode due to the volume of database connections; in those cases, use serial mode. Serial mode, however, can result in much longer processing times.
SObject Name TextField Type of SObject on which the operation is being performed
Input file FileField File containing relevant records
File format DropdownField Format of the input file. Accepts CSV, JSON, and XML
Batch size NumberField Number of records to be processed per batch. It is recommended you use the default setting, but it can be increased or decreased accordingly.
Wait for completion BooleanField Leaving this checked will ensure OneCloud waits for the operation to complete, since it is executed asynchronously in Salesforce. It is recommend you leave this option checked if your subsequent commands depend on the result of the operation.

Outputs

Output Output Type Notes
Bulk insert error log File

Exit Codes

Code Type Detail
0 Success Indicates that the request was made successfully
1 Error General failure

Bulk Query

Queries for a large volume of records.

Inputs

Input Type Detail Notes
Concurrency mode DropdownField Concurrency mode: Defaults to process in parallel, but can be set to serial if records must be processed sequentially. Very large jobs can fail in parallel mode due to the volume of database connections; in those cases, use serial mode. Serial mode, however, can result in much longer processing times.
SObject Name TextField Type of SObject on which the operation is being performed
SOQL Query TextField SOQL Query to execute

Outputs

Output Output Type Notes
Bulk query results CSV File

Exit Codes

Code Type Detail
0 Success Indicates that the request was made successfully
1 Error General failure

Bulk Update

Updates a large volume of records

Inputs

Input Type Detail Notes
Concurrency mode DropdownField Concurrency mode: Defaults to process in parallel, but can be set to serial if records must be processed sequentially. Very large jobs can fail in parallel mode due to the volume of database connections; in those cases, use serial mode. Serial mode, however, can result in much longer processing times.
SObject Name TextField Type of SObject on which the operation is being performed
Input file FileField File containing relevant records
File format DropdownField Format of the input file. Accepts CSV, JSON, and XML
Batch size NumberField Number of records to be processed per batch. It is recommended you use the default setting, but it can be increased or decreased accordingly.
Wait for completion BooleanField Leaving this checked will ensure OneCloud waits for the operation to complete, since it is executed asynchronously in Salesforce. It is recommend you leave this option checked if your subsequent commands depend on the result of the operation.

Outputs

Output Output Type Notes
Bulk update error log File

Exit Codes

Code Type Detail
0 Success Indicates that the request was made successfully
1 Error General failure

Bulk Upsert

Performs an upsert on a large volume of records, either updating existing records or creating new ones based on the external ID field

Inputs

Input Type Detail Notes
Concurrency mode DropdownField Concurrency mode: Defaults to process in parallel, but can be set to serial if records must be processed sequentially. Very large jobs can fail in parallel mode due to the volume of database connections; in those cases, use serial mode. Serial mode, however, can result in much longer processing times.
SObject Name TextField Type of SObject on which the operation is being performed
Input file FileField File containing relevant records
File format DropdownField Format of the input file. Accepts CSV, JSON, and XML
Batch size NumberField Number of records to be processed per batch. It is recommended you use the default setting, but it can be increased or decreased accordingly.
Wait for completion BooleanField Leaving this checked will ensure OneCloud waits for the operation to complete, since it is executed asynchronously in Salesforce. It is recommend you leave this option checked if your subsequent commands depend on the result of the operation.
External ID TextField Upserting records requires an external ID field on the object involved in the job. This field is used to identify whether the record exists already or if it needs to be created.

Outputs

Output Output Type Notes
Bulk upsert error log File

Exit Codes

Code Type Detail
0 Success Indicates that the request was made successfully
1 Error General failure

Create Record

Creates a new record in Salesforce

Inputs

Input Type Detail Notes
Name TextField Name of SObject under which record will be created
Fields ArrayField Record fields to update. Fields must be provided in the format of FIELD_NAME:VALUE

Outputs

Output Output Type Notes
New record ID String

Exit Codes

Code Type Detail
0 Success Indicates that the request was made successfully
1 Error General failure

Delete Record

Deletes a record in Salesforce given an ID

Inputs

Input Type Detail Notes
ID TextField ID of the record to be updated. If ID is not known, can provide an external ID in the format EXTERNAL_ID_NAME:VALUE (i.e. Name:John)
Name TextField Name of SObject under which this record will be deleted

Outputs

None

Exit Codes

Code Type Detail
0 Success Indicates that the request was made successfully
1 Error General failure

Download Report

Downloads a custom report as a CSV

Inputs

Input Type Detail Notes
Report Name TextField DEPRECATED: Avoid using the report name when possible. Report Name will only work if the report has been recently viewed by the user in the connection. Name of the custom report to be downloaded
Report ID TextField The ID of the report

Outputs

Output Output Type Notes
Custom Report CSV File

Exit Codes

Code Type Detail
0 Success Indicates that the request was made successfully
1 Error General failure

Get Record

Retrieves a record from Salesforce given an ID

Inputs

Input Type Detail Notes
ID TextField ID of the record to be fetched
Name TextField Name of the SObject from which this record will be fetched
Fields ArrayField Optional: Record's fields to include

Outputs

Output Output Type Notes
Get record JSON Json

Exit Codes

Code Type Detail
0 Success Indicates that the request was made successfully
1 Error General failure

List Logins

Displays a list of logins to the Salesforce environment

Inputs

None

Outputs

Output Output Type Notes
List logins CSV File

Exit Codes

Code Type Detail
0 Success Indicates that the request was made successfully
1 Error General failure

List Objects

Retrieves a list of SObjects from Salesforce

Inputs

None

Outputs

Output Output Type Notes
List objects CSV File

Exit Codes

Code Type Detail
0 Success Indicates that the request was made successfully
1 Error General failure

List Reports

Retrieves a list of reports from Salesforce

Inputs

None

Outputs

Output Output Type Notes
List reports CSV File

Exit Codes

Code Type Detail
0 Success Indicates that the request was made successfully
1 Error General failure

SOQL Query

Execute a SOQL query and generates a CSV file

Inputs

Input Type Detail Notes
Query TextField SOQL Query to be executed
Query command DropdownField Determines if you are executing a Query or QueryAll, which includes deleted records

Outputs

Output Output Type Notes
SOQL Query Output File

Exit Codes

Code Type Detail
0 Success Indicates that the request was made successfully
1 Error General failure

SObject - Create

Creates a new SObject in Salesforce

Inputs

Input Type Detail Notes
Name TextField Name of the new SObject. Note that "__c" will be added to the end automatically by Salesforce to denote that this is a custom object.
Fields ArrayField Record fields to be created. Fields must be provided in the format of FIELD_NAME:TYPE. TYPE must correspond to a Salesforce field type

Outputs

None

Exit Codes

Code Type Detail
0 Success Indicates that the request was made successfully
1 Error General failure

SObject - Delete

Deletes SObjects

Inputs

Input Type Detail Notes
Names ArrayField Names of SObjects to delete

Outputs

None

Exit Codes

Code Type Detail
0 Success Indicates that the request was made successfully
1 Error General failure

Update Record

Updates a record in Salesforce given an ID and field values

Inputs

Input Type Detail Notes
ID TextField ID of the record to be updated
Name TextField Name of the SObject under which the record will be updated
Fields ArrayField Record fields to update. Fields must be provided in the format of FIELD_NAME:VALUE

Outputs

None

Exit Codes

Code Type Detail
0 Success Indicates that the request was made successfully
1 Error General failure
B
Brian is the author of this solution article.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.