deploySalesforce
Deploys a Salesforce artifact to a Salesforce Organization or sandbox.
Supports Full or Partial Deploy projects.
In Full Deployment mode, it supports:
- Deploying a Salesforce zip file from the
FD_ARTIFACTS_DIR.
In Partial Deployment mode, it supports:
- Deploying a FlexDeploy Salesforce zip file from the
FD_ARTIFACTS_DIR
. This file must have been created by the BuildSalesforce operation, in a partial deploy project. - In this mode, see the Supported SalesForce Object Types list for information on what types of objects are supported.
Environment/Instance Properties
Property Name | Property Code | Required | Description |
---|---|---|---|
Salesforce Account Code |
| Yes | Salesforce Account with all the required properties like User, Password, Client Id, etc. |
Sandbox name | FDSF_SANDBOX | No | The name of a sandbox to access, or leave blank to access the production organization. The sandbox is automatically appended to the user name if forgotten. |
Salesforce HTTPS protocol | FDSF_HTTPS_PROTOCOL | No | The HTTPS protocol to use to secure the connection. Defaults to TLSv1.2. |
Salesforce API Version | FDSF_API_VERSION | No | The Salesforce API version to target. This Default will likely change with each FlexDeploy server and Saleforce plugin release in the future. The maximum supported version of Salesforce API that is supported is linked to the version of FlexDeploy currently running. |
Salesforce Cli Path | FDSF_CLI_PATH | No | The Salesforce CLI Path. (Eg: C:\Program Files\Salesforce CLI\bin) |
Rollback On Error | FDSF_ROLLBACK_ON_ERROR | No | Indicates whether any failure causes a complete rollback (true) or not (false) |
Cloud Account Properties
Property Name | Property Code | Required | Description |
---|---|---|---|
Salesforce User Email | FDSF_USER | Yes | Authentication User Email. |
Salesforce Password | FDSF_PASSWORD | No | The Salesforce password for Salesforce User. If you are using a security token, paste the 25-digit token value to the end of your password. If you don't know the security token, see http://salesforce.stackexchange.com/questions/95259/where-is-reset-security-token-option-in-salesforce |
JWT Key File | FDSF_SERVER_KEY_FILE | No | Path to a file containing the private key |
Client Id | FDSF_CLIENT_ID | No | OAuth client ID (sometimes called the consumer key) |
Development Org Type | FDSF_ORG_TYPE | No | Enter Org type for Development Environment. Eg: Sandbox or DevHub or Developer |
Salesforce URL | FDSF_URL | No | The login URL of the instance the org lives on |
Project Properties
Property Name | Property Code | Required | Description |
---|---|---|---|
Inputs
Input Name | Input Code | Required | Description |
---|---|---|---|
Check Only | FDSF_CHECK_ONLY | No | Check to only validate the deployment. Uncheck to complete the deployment normally. |
Outputs
Output Name | Required | Description |
---|---|---|
| No | Outputs the deployment id so that it can be used in other operations or to look up the status of the deployment in the Salesforce UI. |
Artifacts
This operation consumes artifacts from the artifacts repository.
Endpoint Selection
This operation will select all available endpoints associated to the environment/instance.
Endpoint Execution
This operation will execute on any one of the selected endpoints and will be random in the determination of which one.
- style