This document describes the functionality provided by the Salesforce plugin.
The Salesforce plugin is an XL Deploy plugin that can perform deployments to Salesforce.
The plugin uses the Force.com Migration Tool for Salesforce integration.
- Deploy and undeploy Salesforce metadata packages
- XLD Server 5+
- Force.com Migration tool 37.0+
- Ant 1.7+
The connection to SFDC will be established from the server XL Deploy is running on. You can configure a proxy server to be used to connect to SFDC. In order to function, the XL Deploy server needs to have Apache Ant and the Force.com JAR file available on the filesystem. These are not provided by this plugin and need to be installed manually, although command to do it automatically are included in the src/test folder of this plugin source code.
If Ant is not already present on the XL Deploy server, please download from here and unzip to a location of your choice.
Download the Salesforce Jar from this repository to a location of your choice.
Plugin can be downloaded directly from the plugin's repository on Github.
Place the plugin's XLDP file in the <xld-home>/plugins directory.
For production usage, it problaby makes sense to hardcode the migration tool jar location and ant location instead of configuring it in the UI. You can edit your <xld-home>/ext/synthetic.xml file and copy the following snippet into it. Remember to change the default values for the location of your Ant executable and ant-salesforce.jar
<type-modification type="sfdc.Organization">
<property name="migrationToolJar" default="!!CHANGE ME!!" description="Absolute file reference to the ant-salesforce.jar" hidden="true" />
<property name="antExecutable" default="!!CHANGE ME!!" description="Absolute file reference to the ant executable (ant, ant.bat, ant.cmd)" hidden="true" />
</type-modification>
This plugin adds a new container type sfdc.Organization to the system. This type must be created under the Infrastructure root in the XLD repository.
| Property | Description |
|---|---|
| url | Salesforce login url. Default is https://login.salesforce.com |
| username | The Salesforce username for login |
| password | The Salesforce password for login. If you are using a security token, paste the 25-digit token value to the end of your password |
| proxyHost | If your network requires an HTTP proxy |
| proxyPort | If your network requires an HTTP proxy |
The MetadataPackage (sfdc.MetadataPackage) configuration item can be defined in a deployment package as a zip file.
Sample dars are available to show XLD deployment packaging. The dar use the codepkg sample from the Force.com Migration Tool.