You are here:
Use Visual Studio (VS) Code and the Salesforce Extensions for CRM Analytics Template Development
Microsoft Visual Studio (VS) Code provides the fastest, most efficient way to work with CRM Analytics templates. Here’s how to install and set up the tool.
The VS Code Salesforce Analytics Extension Pack lets you work iteratively with templates using Salesforce DX (SFDX) and Salesforce CLI Analytics commands. Manage the lifecycle of a templated app from VS Code. Create a template from a CRM Analytics app. Edit the template JSON files to make the app customizable with a configuration wizard. Deploy the app to a scratch org to test it. And store the files in your source code control system of choice to enable collaborative template development.
Install VS Code and Salesforce Extensions
Prerequisites: Install Salesforce CLI and the Analytics CLI plugin, and create a development org before you install Visual Studio (VS) Code. See Install the Analytics CLI plugin.
Install VS Code, and get it set up for template development with the Salesforce Extension Pack and Salesforce Analytics Extension Pack.
- Go to https://code.visualstudio.com/, and follow the instructions for downloading and installing VS Code.
- Open VS Code.
- Click the Extensions button, or open the View menu, and select Extensions.
- In the Search Extensions… field, enter Salesforce Extension Pack.
- Select Salesforce Extension Pack, and click Install.
- Search for the Salesforce Analytics Extension Pack, and install it.
Create a VS Code Project
- Open VS Code, open the View menu, and select Command Palette.
- Type SFDX: Create Project with Manifest in the palette, and select SFDX: Create Project with Manifest from the options that appear.
- Select Analytics, and enter a project name that’s easy for you to remember.
- Choose a directory on your computer to store the files for the project, then click Create Project. The VS Code refreshes and your project appears in the Explorer panel on the left.
Connect VS Code to Your Development Org
- In VS Code, open the command palette again, type Auth, and select SFDX: Authorize an Org.
- Select Project Default, then enter an alias for your org. Again, enter an alias you can easily remember. Press the Enter key.
- VS Code opens a browser to the Salesforce login page. Enter the credentials you used when you created your development org.
That opens the Home screen for your org. Any time you want to go right to your development org, enter the Auth command in the VS Code palette.
Issue Salesforce CLI commands for creating and managing Analytics templates from the VS Code Command Palette. See the Salesforce Analytics CLI Plugin Command Reference.
