node package manager
Easy sharing. Manage teams and permissions with one click. Create a free org ยป

datapack-utils

Vlocity Datapack utilities

Installation:

npm install -g datapack-utils

Utlities

Manifest

dpu manifest [diffRange] [jobFile]

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

Parameters:

  • diffRange - Any valid git diff range.

    optional: yes

    default: HEAD (uncommitted changes)

    examples:

    dpu manifest HEAD #Working Tree
    dpu manifest HEAD^ #Latest commit
    dpu manifest master... #All changes since your branch was created - very useful!
    dpu manifest HEAD~6 #Changes since 6 commits ago
    dpu manifest commit..commit #Create manifest based on 2 commits
    dpu manifest branch..branch #Create manifest based on diff between to branches
    
  • manifestFile - 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.

    optional: yes

    default: 'manifest'

    examples:

    dpu manifest HEAD^ myJobFile
    

Get

dpu get objectType objectName [propertyfile]

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

Parameters:

  • objectType - Type of Vlocity object to retrieve. `[layout, card, template, os]

    optional: no

    default: undefined

    examples:

    dpu get layout 360-dashboard 
    dpu get card client-profile 
    dpu get template svc-dashboardLayout 
    
  • objectName - Name of the object to be retrieved.

    optional: no

    default: undefined

    exapmples: see objectType examples

  • 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 get layout 360-dashboard my.properties
    dpu get layout ../property-files/360-dashboard my.properties
    

Search

dpu search objectType [objectName] [propertyfile]

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

Parameters:

  • objectType - Type of Vlocity object to retrieve. `[layout, card, template, os]

    optional: no

    default: undefined

    examples:

    dpu search layout
    dpu search card
    dpu search template
    
  • objectName - 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 layout 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 get layout 360-dashboard my.properties
    dpu get layout ../property-files/360-dashboard my.properties