Salesforce Vlocity Manager

A Visual Studio Code extension that provides a user-friendly interface for creating manifest yaml file and retrieving Salesforce vlocity components. Create yaml file and retrieve vlocity components with just a few clicks.

Features

1. Automatic Vlocity Component Type Loading

All vlocity component types available in your connected org will be automatically loaded when the extension starts, providing a complete list of available vlocity component types.

Automatic vlocity component type loading

2. vlocity component Type Search and Selection

You can search for a particular vlocity component type with keyword filtering, making it easy to find the specific vlocity component type you need.

3. Smart Component Loading

On selecting a vlocity component type, all components of that type will be automatically loaded in a table, except for currently selected components or those already in existing sfdx-vlocity-retrieve.yaml. This prevents duplicate selections and ensures efficient workflow.

Retrieved components

4. Component Search and Selection

You can search for a particular component with comma-separated keyword filtering, allowing you to quickly find specific components within a vlocity component type.

Search and select components using keyword filters

5. Selected Components Management

On selecting a component, Add button will displayed.

Add button

On cicking Add button, all selected components will be available in the selected components table for retrieval. The table provides a clear overview of all selected components with their vlocity component types.

Selected components table with vlocity component types

6. Existing Retrieve Yaml Support

Components available in existing sfdx-vlocity-retrieve.yaml are also loaded back to the selected components table, allowing you to continue working with your existing vlocity component selections.

7. Smart Component Filtering

Selected components will not be available for future selection, preventing duplicates. If you remove a component from the selected components table, that component will be available back for future selection.

8. Component Availability Alerts

If selected vlocity component has components and all components are already selected, you will be alerted that there are no more components to select.

Alert when all components are selected and no more components are available for selection

9. sfdx-vlocity-retrieve.yaml Generation and Retrieval

On clicking Retrieve Components, sfdx-vlocity-retrieve.yaml will be created in the vlocity folder and selected components will be retrieved from your Salesforce org.Components are retrieved in a volocity/src folder which will be created, if it is not existing. Moreover, dependecies of the selected components also will retrieved automatically. Those dependencies will be added back to selected components table in italics and light blue backcolur.

Retrieving components

Automatically generated sfdx-vlocity-retrieve.yaml with selected components

Retrieved selected components successfully

10. Retrieval Status Tracking

Real-time status updates are provided for each component during the retrieval process:

• - (default): Not yet retrieved
• ✅ Success (green): Component retrieved successfully
• ❌ Failed (red): Component retrieval failed

Prerequisites

• Visual Studio Code
• Salesforce CLI (sf) installed and configured
• Authenticated Salesforce org connection

Installation

1. Download the .vsix file
2. Open VS Code
3. Press Ctrl+Shift+P and type "Extensions: Install from VSIX"
4. Select the downloaded .vsix file
5. Restart VS Code

Usage

Opening the Extension

Method 1: Command Palette

1. Press Ctrl+Shift+P
2. Type "Salesforce: Open Vlocity Manager"
3. Press Enter

Method 2: Context Menu

1. Right-click on any folder in the Explorer
2. Select "Open Vlocity Manager"

Requirements

• Salesforce CLI: Must be installed and available in PATH
• Authenticated Org: Run sf org login web to authenticate
• Salesforce Project: Must be in a valid Salesforce DX project directory

Version History

1.0.0

• Implemented easy way to select vlocity components, create retrieve yml and retreieve the slected vlocity components
• No pain of finding the exact name of vlocity component

License

MIT License - see LICENSE file for details

Author

Shabu Thomas
Email: ars.shabu@gmail.com

Note: This extension requires an active Salesforce CLI installation and authenticated org connection to function properly.