You are here:
Install and Set Up Visual Studio Code Based Modeler
To work with contracts and to customize the Consumer Goods Cloud offline mobile app, install the Visual Studio Code based Modeler for Consumer Goods Cloud on a local machine .
Required Editions
| Available in: Enterprise, Performance, and Unlimited Editions that have Consumer Goods Cloud enabled |
Overview
The Visual Studio Code based Modeler command line interface (CLI) plugin is fully integrated into the Salesforce CLI. The Modeler CLI plugin helps you perform various Modeler operations such as validating contracts, building your custom app, running the simulation of your custom CG Cloud offline mobile app directly on your machine, and creating deployment packages.
- Prerequisites
Review the system requirements to get the most out of Visual Studio Code based Modeler for Consumer Goods Cloud and developer tools. - Install Modeler Salesforce CLI Plugin
After you install Salesforce CLI on your machine, install the Modeler Salesforce CLI plugin by using npm. - Update Modeler CLI Plugin
Update your Modeler CLI plugin to take advantage of the new and enhanced capabilities in the product. When a new version of the Modeler CLI plugin is available, a notification appears as a log message in the CLI console and you can run a command and update the plugin. - Set Up Git for Easy Integration of Releases
To update customized contracts from a newly-released version and to create a customized contract based on a specific version, we recommend that you set up your Git repository and branches as shown in this workflow. - Download Modeler Design Contracts
Download Visual Studio Code Based Modeler Modeler design contracts from the Custom - Managed section in Lightning App Builder. - CLI Command to Import Contracts to a Modeler Workspace
After you’ve created your Modeler workspace, clone the contracts to your Modeler workspace by using the importContracts CLI command. - Create a Connected App
To enable Visual Studio Code based Modeler to integrate with Salesforce via APIs, create a connected app. - Start the Simulator App for the First Time
After you create the Modeler workspace and generate a successful build in VS Code based Modeler, launch the simulator UI of the mobile app. Test the Consumer Goods Cloud offline mobile app as it appears on one of the available target platforms on a tablet or mobile phone. - Explore the Modeler Workspace
Your Modeler workspace contains a structure built by the Modeler CLI that holds the contracts and other artifacts. The workspace also contains other local configuration data that are required for the workspace or for generating output of the VS Code based Modeler build processes. - Create a Deployment Package
The Modeler deployment package contains the runtime artifacts (RTAs) required to deploy the CG Cloud offline mobile app. - Helpful Commands
Here’s a quick reference list of the Visual Studio (VS) Code Based Modeler CLI commands.
Did this article solve your issue?
Let us know so we can improve!
