1.1 Properties

Solenopsis uses a number of Ant based properties. These properties can be overridden from the command line via Ant -D params. To do so, its assumed you are calling the solenopsis.xml script file manually with Ant.

Please note: Initial versions of Solenopis assumed Ant 1.7.0 to be safe across most use cases. However, in later releases, Ant 1.9.4, isincluded with Solenopsis. We did not leverage the <local> task that was introduced in Ant 1.8.0. However, Solenopsis 1.2+ should take advantage of that task.

Any value

Property	Values	Default Value	Description
solenopsis.PROPERTIES		${HOME}/solenopsis.properties	Convenience property file to store all your solenopsis properties.
solenopsis.USER			If defined will override the user property set in the credentials file.
solenopsis.PASSWORD			If defined will override the password property set in the credentials file.
solenopsis.TOKEN			If defined will override the token property set in the credentials file.
solenopsis.ENVIRONMENTS			Space delimited names of orgs. These will refer to the names of credentials files and environments.
solenopsis.env.HOME			The root directory where all solenopsis env files exist.
solenopsis.env.credentials.HOME		[solenopsis.env.HOME]/credentials	The root directory where all solenopsis credentials files exist.
solenopsis.env.[name].HOME		[solenopsis.env.HOME]/env/[name]	The location to store files for an org locally.
solenopsis.temp.DIR		[java.io.tmpdir]/[user.name]/solenopsis/1.1	Temporary scratch directory solenopsis uses to build things for pushing, pulling, etc. By default it uses the Java system property, java.io.tmpdir (location for creating temporary files), the Java system property, user.name (user name of current user), solenopsis and 1.1.
solenopsis.env.MASTER			The name from solenopsis.ENVIRONMENTS that represents the master environment from which you will push or pull.
solenopsis.env.DEPENDENT			The name from solenopsis.ENVIRONMENTS that represents the dependent environment from which you will push or pull.
sf.destructiveChangesFile		destructiveChanges.xml	In newer metadata APIs you can name destructiveChanges.xml pre or post
sf.trace	true or false	false	When calling to Salesforce, will log the SOAP messages to the console.
sf.allowMissingFiles	true or false	true	When deploying, determines if the deploy should fail if files specified in the package.xml are missing from the deployable zip file
sf.runAllTests	true or false	false	If set to true, when deploying run all tests
sf.testLevel	""	false	Allows one to set the test level. See https://developer.salesforce.com/docs/atlas.en-us.daas.meta/daas/forcemigrationtool_deploy.htm
sf.maxPoll	Milliseconds	300	Number of milliseconds to wait when polling for results of a deployment.
sf.ignoreWarnings	true or false	false	If set to true, any warning and the deployment will fail and rollback.
sf.checkOnly	true or false	false	When deploying, if true will check the validity of deployed files without making any changes.
sf.logType	Can be one of None, Debugonly, Db, Profiling, Callout, or Detail.	None	Debug logging level when running tests.
sf.testClasses	Space delimited name of test classes	""	When running tests, the name of test classes to test. File names can end in .cls or not.
sf.filesContain	String to search for across all files	None	If this property is set, the value of the property is searched across all files. Any files containing that value will be pushed out.
sf.generateTests	Any value	None	When running tests, if this property is set, will generate the the <runTest> elements of the deploy task for every test class defined.
sf.ignoreFile	File name	""	When pushing/pulling, contains file name patterns of files to ignore.
sf.purgeIgnores		false	When pushing/pulling, if anything but "false" will cause removal of references within the sfdcignore file to be purged from profiles and permission sets for any classes or layouts.
sf.packageFile		""	If defined, should be the fully qualified path and file of a package.xml. On pulls and pushes will use that package.xml without computing from the master env.
sf.batchSize		300	The number of items to retrieve on mulit-part retrieves.
sf.types		""	When performing selective pulls, a comma separated list of all metadata types.
sf.version	24.0, 25.0, 26.0, 27.0, etc	26.0	Denotes the version of the Salesforce API to use.
sf.dryRun	Any value other than an empty string		If set to any value other than an empty string, will assume that Solenopsis should prepare to deploy but do any and all actions up to deployment.
sf.antFile		N/A	Absolute path to the Salesforce Ant Migration Tool jar.
sf.dumpFiles			If set (to any value), will generate a build.xml in the tmp dir of the task.
sf.showPasswords			If set (to any value) and sf.dumpFiles is set, will include the password and token in the generated build.xml (found in the tmp dir of the task).
sf.xsltDir			If set, should be the root directory containing XSLTs that can be applied to corresponding src files. The structure of the directory should resemble that of your source. So, for example to transform Admin.profile, create a dir in the XSLT dir entitled profiles/Admin.xsl and it will be applied to Admin.profile
sf.includePackageFile			If set, should be a fully qualified path and XML file resembling a standard package.xml containing things a normal pull or full-pull does not support.