My particular use case is for Salesforce ant deployment. I wanted to replace some metadata before I deploy to the target org which will allow me to automate the process. I can fetch metadata from my sandbox org and when it gets deployed to the target org like production the values will be updated.
You should have the latest ant-salesforce.jar as a requirement. You can grab the latest ant migration tool from here – https://help.salesforce.com/articleView?id=code_tools_ant_using.htm&type=5
My sample script entails having a conditional check before doing the replace a logic with Custom Labels. This is how my build XML looks.
| <project name="Retrieve and Deploy SFDC metadata" default="sfdcDetails" basedir="." xmlns:sf="antlib:com.salesforce"> | |
| <property file="${basedir}/environments/${environment}.properties"/> | |
| <condition property="sf.username" value=""> <not> <isset property="sf.username"/> </not> </condition> | |
| <condition property="sf.password" value=""> <not> <isset property="sf.password"/> </not> </condition> | |
| <condition property="sf.sessionId" value=""> <not> <isset property="sf.sessionId"/> </not> </condition> | |
| <taskdef resource="net/sf/antcontrib/antlib.xml" classpath="${basedir}/ant-contrib-1.0b3.jar"/> | |
| <taskdef resource="com/salesforce/antlib.xml" uri="antlib:com.salesforce"> | |
| <classpath> | |
| <pathelement location="${basedir}/ant-salesforce.jar" /> | |
| </classpath> | |
| </taskdef> | |
| <property name="passwordToken" value="${sf.password}${sf.token}"/> | |
| <property name="srcDir" value="${basedir}/src" /> | |
| <target name="sfdcDetails"> | |
| <echo>Base Dir: ${basedir}</echo> | |
| <echo>Environment: ${environment}</echo> | |
| <echo>Username: ${sf.username}</echo> | |
| <echo>Server url: ${sf.serverurl}</echo> | |
| </target> | |
| <!-- Remove unwanted metadata specified on this target --> | |
| <target name="copyMetadata"> | |
| <echo>Copying source to ${srcDir} to exclude unwanted files</echo> | |
| <antcall target="replaceCustomLabels" /> | |
| <antcall target="replaceCaseWorkflowsAlertEmails" /> | |
| </target> | |
| <property name="test.email" value="ertm2@genesisenergy.co.nz" /> | |
| <target name="replaceCustomLabels"> | |
| <if> | |
| <available file="${basedir}/labels/CustomLabels.labels" /> | |
| <then> | |
| <replaceregexp byline="false" | |
| match="(<shortDescription>Partner Community Domain</shortDescription>\s*<value>)https://sandbox-mydomain.cs90.force.com/" | |
| replace="\https://mydomain.force.com/"> | |
| <fileset dir="${basedir}/src/labels" erroronmissingdir="false"> | |
| <include name="CustomLabels.labels"/> | |
| </fileset> | |
| </replaceregexp> | |
| </then> | |
| </if> | |
| </target> | |
| <!-- deploy the changes to target org --> | |
| <target name="deployMetadata" depends="sfdcDetails,copyMetadata"> | |
| <echo level="info">Performing the deploy</echo> | |
| <sf:deploy | |
| username="${sf.username}" | |
| password="${passwordToken}" | |
| serverurl="${sf.serverurl}" | |
| deployRoot="${srcDir}" | |
| pollWaitMillis="${sf.pollWaitMillis}" | |
| maxPoll="${sf.maxPoll}" | |
| > | |
| </sf:deploy> | |
| </target> | |
| <!-- Run test on the to target org --> | |
| <target name="deployEmptyCheckOnly" depends="sfdcDetails,copyMetadata"> | |
| <echo level="info">Testing the deploy</echo> | |
| <sf:deploy | |
| checkOnly="true" | |
| logType="Debugonly" | |
| username="${sf.username}" | |
| password="${passwordToken}" | |
| serverurl="${sf.serverurl}" | |
| deployRoot="${srcDir}" | |
| pollWaitMillis="${sf.pollWaitMillis}" | |
| maxPoll="${sf.maxPoll}"> | |
| </sf:deploy> | |
| </target> | |
| <macrodef name="git"> | |
| <attribute name="dir" default="" /> | |
| <attribute name="branch" default="master" /> | |
| <sequential> | |
| <exec executable="git" dir="@{dir}"> | |
| <arg value="pull" /> | |
| <arg value="origin" /> | |
| <arg value="@{branch}" /> | |
| </exec> | |
| </sequential> | |
| </macrodef> | |
| <target name="checkoutFromGit"> | |
| <echo>Issuing git pull from directory: ${git.dir}</echo> | |
| <echo>Pulling from branch: ${git.branch}</echo> | |
| <git dir="${git.dir}" branch="${git.branch}" /> | |
| </target> | |
| </project> |
by Additional library you would need to perform the conditional check is ant-contrib.jar file. You can grab the latest library from here – http://ant-contrib.sourceforge.net/
If you try to run the script without the library you might end with the error below.
Fix Ant Build Error: Problem: failed to create task or type if
On the build.xml simply add the reference to the library.
| <taskdef resource="net/sf/antcontrib/antlib.xml" classpath="${basedir}/ant-contrib-1.0b3.jar"/> |
If everything is in place, like the properties file has the right credentials, running the following command should deploy your code and replace the values as per your ant script.
ant -Denvironment=prod -buildfile build.xml deployMetadataSource code available here – https://github.com/olopsman/salesforce-ant