You are here:
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.
Required Editions
| Available in: Enterprise and Unlimited Editions that have Consumer Goods Cloud enabled. |
Use this command to import core or custom contracts from a Modeler Content Package (MCP) zip generated in Windows Server based Modeler, or design contracts from a VS Code based Modeler DesignContracts.zip to $workspace/src in your Modeler workspace. A valid Modeler workspace is a prerequisite to use this command.
sf modeler workspace utils importContracts -i <value> [--json] [-p
<value>] [-c]
Here are the descriptions of the command parameters.
| Parameter | Value |
|---|---|
-i
|
Required. Specifies the path to MCP.zip or DesignContracts.zip. |
-p
|
Optional. Specifies the path to the src directory in your
Modeler workspace. If the path is unspecified, the working directory is considered
as the workspace. |
-c
|
Optional. Use the flag to import only the core contracts (.core.xml) from a custom Modeler Content Package (MCP) zip. If this flag is set, custom contracts are skipped during import. If this flag is not set, only the custom contracts (*.xml) are imported from the custom MCP.zip and core contracts are skipped. |
--json
|
Optional. Specifies that JSON is the output format. |
During the import of contracts, these transformations occur:
- When you import contracts from MCP.zip to $workspace/src, the system converts all business logic XML files to JavaScript (bl.js) files.
- When you import contracts from DesignContracts.zip to $workspace/src, the system modifies the .core.xml files to .xml files.
Did this article solve your issue?
Let us know so we can improve!
