Authentication Methods for the Omnistudio Build Tool (Managed Package)

For the managed package runtime, use one of three available authentication methods for the Build Tool: Salesforce DX CLI, org properties files, or OAuth authentication. Salesforce DX CLI is recommended.

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

Salesforce DX CLI

If you’re using a Salesforce DX org, use -sfdx.username for authentication. The Build Tool uses the Salesforce DX information from sf org display --target-org <username or alias>. The org can be a scratch org, or one authorized through sf org login web.

Org Properties Files

Alternatively, create your own property files for your source and target Salesforce orgs with these settings:

sf.username = < Salesforce Username > 
sf.password = < Salesforce Password + Security Token > 
sf.loginUrl = < https://login.salesforce.com or https://test.salesforce.com for Sandbox >

Use this command format:

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

If your CI/CD server is behind a proxy, specify the proxy URL with a username and password by adding this line to your property file:

sf.httpProxy: http://[<Proxy server Username>:<Proxy server Password>@]<Proxy hostname>[:<Proxy Port>]

For best results, use named properties files for each org. For example:

build_source.properties and build_target.properties

OAuth

As another alternative, the Build Tool supports OAuth style information sent through the command line or property file.

vlocity packExport -sf.accessToken <accessToken> -sf.instanceUrl <instanceUrl> -sf.sessionId <sessionId>

If you use the OAuth method, include oauthConnection: true in your job file.