Vlocode: Vlocity/Salesforce development integration for Visual Studio Code

This extension provides functionality for deploying, extracting and refreshing Vlocity metadata with Visual Studio Code. It is targeted at Vlocity/Salesforce developers who work with Vlocity and Salesforce metadata making commands available directly from with Visual Studio Code.

This extension uses JSForce, SFDX and the Vlocity build tools library for executing commands.

All settings for Vlocode are part of the .vscode settings file making it easy to maintain and change.

Vlocode also has broad support Salesforce metadata enabling deployment and retrieval of Salesforce metadata.

Features

Salesforce

• Auto create and update -meta.xml files automatically rename and create -meta.xml files when you create or rename APEX classes
• Export metadata export any metadata object using the command pallet
• Advance metadata deployments
  • Support deployment of both SFDX and Classic Metadata format
  • Support mixed source code deployment with Netadata defined both in SFDX format as well as in classic format
• Support LWC/Aura Support for both LWC and Aura deployments
• Deploy on save deploy files to the connected org on save
• Deploy multiple metadata files deploy one or more files in a single request to Salesforce
• Refresh/Retrieve metadata refresh/retrieve one or more files in a single request to Salesforce
• Easy creation of APEX classes automatically generate a boiler plate class definition and meta.xml file once you create a new APEX class file
• Execute anonymous support for executing anonymous APEX with different log levels and profiling
• Delete metadata from org delete APEX classes or other metadata from your org from within vscode
• ** Salesforce Logs viewer** using the integrated Log viewer you can view and open Salesforce debug logs directly from VSCode

Vlocity

• 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.
• Run Yaml Job Run any YAML job file directly from VSCode.
• Open in Salesforce directly open any Vlocity object in Salesforce.
• Clone Datapack clone any Datapack object from your IDE, usefull for cloning products or templates directly from VSCode
• Rename Datapack change the name of a Datapack and rebuild the file structure to match the new name
• Rebuild parentkeys rebuild and verify your source code for missing dependencies and rebuild the dependency 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
• Datapack explorer view all exportable objects available in the connected org and export them with a single click
• 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

Using a .vlocode config rule

Instead of configuring Vlocode through VSCodes workspace and user level settings you can also override configuration settings using a workspace-folder .vlocode-file. This allows to force a certain configuration value and can be usefull to ensure all developers on the project use the same configuration for exporting vlocity and Salesforce metadata

Sample of a .vlocode configuration-file

{
    "customJobOptionsYaml": "./vlocity/dataPacksJobs/default.yaml",
    "projectPath": "./vlocity/src",
    "salesforce": { 
        "apiVersion": "48.0"
    }
}

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.