Loading
Visual Studio Code Based Modeler for Consumer Goods Cloud
Table of Contents
Filter by (0)Add
Select Filters

          No results
          No results
          Here are some search tips

          Check the spelling of your keywords.
          Use more general search terms.
          Select fewer filters to broaden your search.

            Search all of Salesforce Help
            Search all of Salesforce Help
            Explore the Modeler Workspace

            You are here:

            1. Salesforce Help
            2. Docs
            3. Visual Studio Code Based Modeler

            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.

            Required Editions

            Available in: Enterprise, Performance, and Unlimited Editions that have Consumer Goods Cloud enabled

            When you create a Modeler workspace, here’s the high-level structure and contents of the Modeler workspace:

            • appl: This is the application folder.
              • build: The application build folder contains generator and validator results. This folder also stores the deployment.zip created by the generator when you run the package command.
                • app: This folder contains the clockwork, externalFiles, and replicationFiles directories.
                • localeSnippets
              • config: This is the application configuration folder.
                • config.json: This file contains the settings for both simulator and framework. For example, salesforce connection data, the unique ID of your Modeler workspace, and the simulator port.
              • data: The application data folder contains runtime information.
            • branch.config.json: This file contains configuration settings to manage and customize the behavior of individual branches within a project. This configuration is applicable for a branch.
              • USE_LATEST_XSD_VALIDATIONS - Configure the auto-completion capability in combination with the XML Language Support extension by Red Hat. This setting determines the XSD validations to use when the generator builds or validates contracts and the XSD files to link to the contract types in the $workspace/.vscode/settings.json file. Set the setting to true to enable the dynamic proposal of keywords during contract customization. Default is false.
            • contractSnippets: This folder contains the templates for commonly used contracts such as business object (BO), datasource (DS), list object(LO), lookup object (LU), print layout (PL), process (PR), UI, and ComplexPricing business logic files. You can easily copy and adapt the template contracts in this directory for customization purposes.
            • src: This is the source folder that contains the contract files. As part of the initial set up, extract the core contract files from the Modeler Design Contract zip to this folder. Subsequently, pull or fetch the contracts from the repository that you have set up, such as Git.
             
            Loading
            Salesforce Help | Article