Skip to content

Codeneos/vlocode

Repository files navigation

Build Status GitHub top language Technical Debt Bugs Vulnerabilities

Vlocode: Vlocity development tools for Visual Studio Code

This extension provides functionality for deploying, extracting and refreshing Vlocity datapacks from with Visual Studio Code. It is targeted at Vlocity/Salesforce developers who want work on Vlocity data from within their IDE and have the most commonly used datapacks commands available directly from with Visual Studio Code.

This extension uses of the official Vlocity build tools library for executing the import and export jobs, meaning the results will be the same way as produced by your CI environment.

Features

  • Retrieve & refresh Vlocity datapacks from within Visual Studio Code simplifying your workflow
  • Deploy exported Vlocity datapacks with a single click from within Visual Studio Code
  • Export any datapack enabled object directly from within VSCode. Datapack explorer
  • Open in Salesforce directly open any Vlocity object in Salesforce.
  • Restore and check parentkeys rebuild and verify your source code for missing dependencies and rebuild the dependecny graph
  • Check Integrity Check datapack integrity by finding missing references and rebuilding ParentKey files
  • Admin Commands Vlocode integrates common admin commands for Vlocity:
    • Refresh Pricebook Refreshes pricebook entries on the currently connected Salesforce org
    • Refresh Product Hierarchy Refresh the product hierarchy cache for the Vlocity CPQ
    • Update Product Attributes (JSON) Refresh the product attribute JSON definitions based on the attribute assignments Admin Commands
  • Datapack explorer view all exportable objects available in the connected org and export them with a single click Datapack explorer
  • Easy setup Simplified setup based on SFDX using session tokens instead; no need to acquire security tokens or copy-past passwords and usernames around.
  • SFDX Support username or alias to login to Salesforce

Requirements

  • Basic knowledge of Vlocity datapacks
  • Access to an Salesforce instance with the Vlocity managed package installed

Extension Settings

This extension contributes the following settings:

  • vlocity.projectPath: Path to the folder containing the Vlocity datapacks relative to the workspace's root folder, for example:
    • ./vlocity
    • ./datapacks
  • vlocity.verbose: Enable verbose logging to the output window
  • vlocity.activate: Automatically activate deployed datapacks
  • vlocity.customJobOptionsYaml: Path to the custom YAML that is used during deployment and export, see the official Vlocity Build repository for documentation on the format of this file.
  • vlocity.sfdxUsername: SFDX username; when this is specified the username, password, loginUrl and instanceUrl are ignored.