Vlocity Datapack utilities

Installation:

npm install -g datapack-utils

Utlities

Manifest

dpu manifest --diff <diffRange> --output <jobFile>

Adds a manifest to a job file based on the given diff range.

Parameters:

• diff - Any valid git diff range.

  optional: yes

  default: HEAD (uncommitted changes)

  examples:

  dpu manifest --diff HEAD #Working Tree
  dpu manifest --diff HEAD^ #Latest commit
  dpu manifest --diff master... #All changes since your branch was created - very useful!
  dpu manifest --diff HEAD~6 #Changes since 6 commits ago
  dpu manifest --diff commit..commit #Create manifest based on 2 commits
  dpu manifest --diff branch..branch #Create manifest based on diff between to branches

• output - Name of the jobFile file relative to your working direcotry that you'd like to add the manifest to. The yaml extension is not required. If the jobfile does not exist, the resulting manifest will be output to the console. If output is not specified, the generated manifest will be logged to the console.

  optional: yes

  default: undefined s examples:

  dpu manifest --diff HEAD^ --output myJobFile

Get

dpu get --type <objectType> --assets <objectName,> --propertyfile <propertyfileName>

Retrieve the named active Vlocity object using the connection specified in the given propertyfile.

Parameters:

• objectType - Type of Vlocity object to retrieve. `[vlocityUILayout, VlocityCard, VlocityUITemplate, OmniScript, DataRaptor, IntegrationProcedure, CalculationMatrix, CalculationProcedure]

  optional: no

  default: undefined

  examples:

  dpu get --type VlocityUILayout --assets 360-dashboard 
  dpu get --type VlocityCard --assets client-profile 
  dpu get --type VlocityUITemplate --assets svc-dashboardLayout,svc-dashboard-card 

• objectName - Name of the object to be retrieved. Comma separated if multiple objects are to be exported. No spaces please!

  optional: no

  default: undefined

  examples: see objectType examples

• propertyFile - Name of the property file containing the connection details to be used. (Be carful not to commit your property files to the repo!)

  optional: yes

  default: build.properties

  examples:

  dpu get --type VlocityUILayout --assets 360-dashboard --propertyfile my.properties
  dpu get --type VlocityUILayout --assets 360-dashboard --propertyfile ../property-files/360-dashboard my.properties

Search

dpu search --type <objectType> --query <objectName> --job <jobfileName> --propertyfile <propertyfileName>

Search the specified Vlocity object using the connection specified in the propertyfile.

Parameters:

• objectType - Type of Vlocity object to retrieve. `[vlocityUILayout, VlocityCard, VlocityUITemplate, OmniScript, DataRaptor, IntegrationProcedure, CalculationMatrix, CalculationProcedure]

  optional: yes

  default: User Prompt

  examples:

  dpu search --type VlocityUILayout
  dpu search --type VlocityUITemplate
  dpu search --type OmniScript

• query - Name of the object to search for. If name is not given or no results returned, user will be prompted for input. Use query % wildcards to broaden search results

  optional: yes

  default: undefined

  examples:

  dpu search --type VlocityUILayout --query 360%

• propertyFile - Name of the property file containing the connection details to be used. (Be carful not to commit your proprty files to the repo!)

  optional: yes

  default: build.properties

  examples:

  dpu search --type VlocityUILayout --query 360-dashboard% --propertyfile my.properties
  dpu search --type VlocityUILayout --query 360-dashboard% --propertyfile ../property-files/360-dashboard my.properties

init-props

dpu init-props --propertyfile <propertyfileName>

The init props command will prompt the user through the process of creating a new properties file.

Expamle:

dpu init-props --propertyfile dev.properties
dpu init-props --propertyfile ../connections/quoting.dev.properties