Subscribe

UiPath Activities

The UiPath Activities Guide

Salesforce Application Scope

UiPath.Salesforce.Activities.SalesforceApplicationScope

Establishes a connection to a specified Salesforce Org and provides a scope for all subsequent activities. The Configure button in the body of the activity opens a connection wizard that helps you establish your connection to your Salesforce Org.

📘

Note

The Consumer Key and Consumer Secret identify the Salesforce Connected App. These can be obtained from your Salesforce administrator.

Once all of the connection details are inserted into their respective fields, the Test Connection button becomes available.

Clicking Test Connections verifies the validity of the credentials you have entered and informs you of the result. This connection is used only for design time, as once the connection is verified, you can start configuring all child activities in their respective wizards.

📘

Important!

Configuring the fields in the wizard does not fill in the property fields of the Salesforce Application Scope. The wizard establishes a connection to Salesforce that is used strictly for design time, enabling you to configure the Salesforce activities contained in this scope activity.

Properties

📘

Important!

The New Connection and Use Existing Connection property sections are mutually exclusive. Configuring either section disables the other one. It is mandatory to configure one of them for the activity to connect to Salesforce at runtime.

Common

  • DisplayName - The display name of the activity.

Misc

  • Private - If selected, the values of variables and arguments are no longer logged at Verbose level.

New Connection

  • ConsumerKey - The consumer key of your Salesforce Connected App. This field supports only strings and String variables.
  • ConsumerSecret - The consumer Secret of your Salesforce Connected App, stored in a SecureString variable. This field supports only SecureString variables.
  • Password - The password of the user you want to log in with, stored in a SecureString variable. This field supports only SecureString variables.
  • SecurityToken - The security token of the user whose credentials are used to log into Salesforce, stored in a SecureString variable. This field supports only SecureString variables. This property is optional, depending on the settings of your Salesforce Org.
  • Server - The server instance you want to connect to. The three supported values for this field are Live (https://login.salesforce.com), Test (https://test.salesforce.com), and Custom. This field supports only strings and String variables.
  • CustomServer - The custom Salesforce instance to connect to when Server is set to Custom. Used when logging in via the standard domain https://login.salesforce.com or https://test.salesforce.com is restricted. Example: https://mycompany.my.salesforce.com/
  • Username - The username you want to use to log into Salesforce. This field supports only strings and String variables.

Proxy Settings

  • ProxyAddress - The address of the proxy server. If the protocol is not specified in the address, it automatically defaults to http. This field supports only strings and String variables.
  • ProxyPort - The port of the proxy server. This field supports only strings and String variables.
  • ProxyUser - The username to submit to the proxy server for authentication. This field is optional. This field supports only strings and String variables.
  • ProxyUserPassword - The password of the proxy user. This field is optional. This field supports only SecureStrings and SecureString variables.

📘

Important!

The ConsumerSecret and SecurityToken are encrypted by using the Microsoft .NET Data Protection API (DPAPI) and stored in the workflow file itself. These can be decrypted only by opening the workflow on the same user account and on the same machine. If the workflow is opened by another user or on another machine, an error message appears, and the two properties must be reconfigured.

Options

  • ReportApiErrorAsException - When selected, API error responses are reported in Salesforce Exception by all child activities that use this application scope. When cleared, the child activity populates the API error message in the SalesforceStatus output property and workflow execution continues. Check the SalesforceStatus property to confirm successful execution.

Output

  • SalesforceConnection - The details of the connection to Salesforce, stored in an IConnectionService object. This object can be passed to subsequent Salesforce Application Scope activities in the ExistingSalesforceConnection property to easily reuse the same connection. This field supports only IConnectionService objects.

📘

Note:

An IConnectionService object is reusable only in scope activities that are contained inside the parent scope it is generated in.

Use Existing Connection

  • ExistingSalesforceConnection - An already established connection to Salesforce, stored in an IConnectionService object, which you want to reuse for this scope activity. The IConnectionService object can be obtained from the SalesforceConnection property of a parent Salesforce Application Scope activity. This field supports only IConnectionService objects.

Updated 7 months ago


Salesforce Application Scope


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.