Prerequisites

Operating Systems

We support these operating systems.

• Windows—Windows 10 or later, Windows Server 2019 (64-bit and 32-bit) or later
• Mac— the latest version (Intel and M1)

Code Editor or IDE

Visual Studio Code based Modeler for Consumer Goods Cloud is based on Visual Studio Code editor. Salesforce fully supports Modeler for this IDE in the current and future releases. You can use any code editor, but to ensure full support for Modeler and access to future enhancements, we strongly recommend that you use Visual Studio Code (VS Code).

Source Control Management

You can use any source control management system (SCM). We highly recommend that you create and use Git repository to host the Modeler contracts.

Node.js

Install the latest update of Node.js 20. For instructions on manually installing Node on Mac or Windows, see the product documentation.

For Windows - In the setup wizard, ensure that the Automatically install the necessary tools checkbox is unselected.

To check the version of Node.js installation, run node --version.

Salesforce CLI

Install Salesforce CLI by using npm. See Install the CLI with npm.

To install the sf executable, run npm install @salesforce/cli --global.

If you upgrade your node version, reinstall Salesforce CLI and other plugins that you had installed.

Tip To view the list of plugins installed on your machine, run sf plugins.

Python

Install Python 3.12. Ensure that Python is in the path variable. Then install setuptools for Python using the command - pip install setuptools or pip3 install setuptools, depending on your Python installation.

For installation instructions, refer to Python.

Microsoft Visual Studio Build Tools

For Windows only - install Visual Studio Build Tools with these software:

• Download Visual Studio Community Edition from here.
• Install Desktop development with C++ type of Workload
• Install the latest version of Windows 10 SDK. Windows 11 SDK isn't supported.

Browser

The simulator app of Visual Studio Code based Modeler works in Google Chrome (incognito mode recommended). Make sure that only one instance of Chrome browser in incognito mode is used at a time to avoid authentication mismatch or other errors.

Salesforce Org with Consumer Goods Cloud

Ensure that your Salesforce admin has set up and configured the Salesforce org with Consumer Goods Cloud Mobile Sync Package and Consumer Goods Cloud managed package with the required permissions sets. When you launch the simulator app, the mobile app framework connects to the org through CG Cloud Sync Engine and synchronizes data to the simulated UI of the offline mobile app.

Configure CORS Allowlist

The VS Code based Modeler uses the URL http://localhost:3000 to render the simulator app UI.

Add the requesting origin (http://localhost:3000) to the CORS allowed list in your Salesforce org. You can ignore the warning message from the org as this isn’t a https URL.