deploySalesforceSFDX

Deploys a Salesforce artifact to a Salesforce Organization or sandbox using the Salesforce CLI. This plugin operation requires sfdx to be installed on the endpoint where the project will be executed.

Supports both Full and Package-Based Deploy projects. Deploys a FlexDeploy Salesforce zip file from the FD_ARTIFACTS_DIR. This file must have been created by the BuildSalesforce operation.

Target Properties

Property Name

Property Code

Required

Description

Property Name

Property Code

Required

Description

Salesforce Account Code

FDSF_ACCOUNT_CODE

Yes

Salesforce Account with all the required properties like User, Password, Client Id, etc

Salesforce HTTPS protocol

FDSF_HTTPS_PROTOCOL

No

The HTTPS protocol to use to secure the connection. Defaults to TLSv1.2. Used only in the case when username and password are provided in the cloud account

Salesforce Cli Path

FDSF_CLI_PATH

No

The Salesforce CLI Path. (Eg: C:\Program Files\Salesforce CLI\bin)

Salesforce API Version

FDSF_API_VERSION

No

The Salesforce API version to target.

This Default will likely change with each FlexDeploy server and Salesforce plugin release in the future.

The maximum supported version of Salesforce API that is supported is linked to the version of FlexDeploy currently running.

Cloud Account Properties

Property Name

Property Code

Required

Description

Property Name

Property Code

Required

Description

Salesforce User Email

FDSFCA_USER

Yes

Authentication User Email

Salesforce Password

FDSFCA_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

FDSFCA_SERVER_KEY_FILE

No

Path to a file containing the private key

Client Id

FDSFCA_CLIENT_ID

No

OAuth client ID (sometimes called the consumer key)

Development Org Type

FDSFCA_ORG_TYPE

No

Enter Org type for Development Environment. Eg: Sandbox or DevHub or Developer

Salesforce URL

FDSFCA_URL

No

The login URL of the instance the org lives on

Sandbox Name

FDSFCA_SANDBOX

No

The name of a Sandbox to access

Inputs

Input Name

Input Code

Required

Description

Input Name

Input Code

Required

Description

Check Only

FDSF_INP_CLI_CHECK_ONLY

No

Check to only validate the deployment. Uncheck to complete the deployment normally.

Uses the "--checkonly" parameter while executing the command.

Artifact Test Level

FDSF_INP_ARTIFACT_TEST_LEVEL

No

Test Level for current artifact/package. Overrides Test Level set for the package.

Accepted values are NoTestRun, RunSpecifiedTests, RunLocalTests and, RunAllTestsInOrg.

Uses the --testlevel" parameter while executing the command.

Artifact Tests

FDSF_INP_ARTIFACT_TESTS

No

Tests for current artifact/package. Overrides Tests set for the package.

Only used when the Test Level input is set to RunSpecifiedTests.

Uses the "--runtests" parameter while executing the command.

Outputs

Output Name

Required

Description

Output Name

Required

Description

FDSF_DEPLOYMENT_ID

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

FDSF_OUT_NUMBERTESTFAIL

No

Number Test cases Fail

FDSF_OUT_NUMBERTESTSUCCESS

No

Number Test cases Success

FDSF_OUT_NUMBERTESTRUN

No

Number Test cases Run

FDSF_OUT_TESTPERCENTAGE

No

Test Percentage

FDSF_OUT_CODECOVERAGEPERCENTAGE

No

Code Coverage Percentage

Artifacts 

This operation consumes artifacts from the artifacts repository.

Endpoint Selection

This operation will select all available endpoints associated to the Target.

Endpoint Execution

This operation will execute on any one of the selected endpoints and will be random in the determination of which one.

The following macros are not currently supported in the footer:
  • style