Omnistudio Build Tool Command Examples (Managed Package)

This information is for Omnistudio for Managed Packages. For Omnistudio on standard runtime, see Omnistudio Help.

packExport

Retrieve all metadata from the org as data packs as defined in the job file and write them to the local file system in a format that's friendly to version control.

vlocity -propertyfile <filepath> -job <filepath> packExport

packExportSingle

Export a single data pack and all its dependencies. To export the single data pack with no dependencies, set the depth.

vlocity -propertyfile <filepath> -job <filepath> packExportSingle -type <VlocityDataPackType> -id <Salesforce Id> -depth <Integer>

The depth value is optional. To export the single data pack, set the depth value to 0.To export the single data pack and its first-level dependencies, set the depth value to 1.

packExportAllDefault

Retrieve all metadata instead of using the job file definition.

vlocity -propertyfile <filepath> -job <filepath> packExportAllDefault

packDeploy

Deploy all contents in the project path of the job file to the Salesforce org.

vlocity -propertyfile <filepath> -job <filepath> packDeploy

cleanOrgData

Find and fix issues in the org data. The command adds values to missing global keys and detects duplicate global keys. Duplicate global keys must be fixed in the org.

vlocity -propertyfile <filepath> -job <filepath> cleanOrgData

validateLocalData

Find and fix issues in the local data files. The command detects missing and duplicate global keys. To add missing global keys and change duplicate global keys to a new GUID, use the --fixLocalGlobalKeys argument.

vlocity -propertyfile <filepath> -job <filepath> validateLocalData --fixLocalGlobalKeys

refreshProject

Rebuild the folders for the data at the project path. The command also resolves any missing references between the files to ensure they deploy in the correct order.

vlocity -propertyfile <filepath> -job <filepath> refreshProject

packContinue

Resume the export or deploy job that was running before being canceled or if there was an unexpected error. 

vlocity -propertyfile <filepath> -job <filepath> packContinue

packRetry

Restart the job that was previously running and set all errors back to ready to deploy.

vlocity -propertyfile <filepath> -job <filepath> packRetry

packGetDiffs

Retrieve a list of files that are different locally than in the org.

vlocity -propertyfile <filepath> -job <filepath> packGetDiffs

packGetDiffsAndDeploy

Find all files that are different locally than in the target org. Then deploy only the data packs that have changed or are new.

vlocity -propertyfile <filepath> -job <filepath> packGetDiffsAndDeploy

While this operation can take longer, it’s a great way to ensure that you’re not updating items in your org more than is necessary.