Importing Projects into Anypoint Code Builder

Import a project JAR file or folder into a workspace. A project directory contains a Mule application for an integration or implementation.

You can also import a Maven multi-module project and apply the properties, dependencies, and versions from a Maven parent POM file to the pom.xml file of each child module. For more information about the Maven parent POM file, see Maven Project Parent POM.

If you encounter an import issue, check for workarounds in Known Issues in the Anypoint Code Builder Release Notes or in Troubleshooting.

To export a JAR file that packages a project with resources from your application, see Exporting Mule Projects.

Before You Begin

Set up and access Anypoint Code Builder.
Close any open project.
Show me how
Select File > Close Folder.
Never open or unpack a project folder within another project folder.

Import and Open a Project in Anypoint Code Builder

Use Anypoint Code Builder to upload a project directory or shareable JAR file into a project workspace.

Import a Shareable Project JAR File into Anypoint Code Builder
Import a Project Folder into Anypoint Code Builder
Open a Project Folder

Import a Shareable Project JAR File into Anypoint Code Builder

Import a shareable JAR file for a snapshot of a Mule project into Anypoint Code Builder.

To create a shareable JAR, see Export Mule Project. The contents are lightweight because they don’t include dependencies. Anypoint Code Builder generates the dependencies configured in the pom.xml for the project.

To import a shareable JAR file in Anypoint Code Builder:

Ensure that no project is open.
Open the Command Palette.
Show me how
- Use the keyboard shortcuts:
  
  Mac: Cmd+Shift+p
  
  Windows: Ctrl+Shift+p
- Select View > Command Palette.
Provide the following command:
```
MuleSoft: Import a Mule Project
```
Navigate to the shareable JAR file to import, and click Select jar file to import.
Navigate to a folder to which to unpack the JAR file, such as your home directory or any folder outside of a Mule project folder.
Click Select project folder.

Anypoint Code Builder unpacks the shareable JAR file for your project into the selected folder.
If your Mule project folder is closed, open a workspace for the project at the project’s root directory.

In addition to loading the graphical canvas, Anypoint Code Builder also loads dependencies defined in the pom.xml for the project. If a Mule runtime or Java configuration is missing, set the versions to use from the canvas.

Libraries load to the target/repositories directory within the project folder.
Test your project:
1. In the open project, check for errors and make sure that the canvas and code editor load correctly, which indicates that component dependencies resolved.
2. Check for any configurations to modify, such as ports or file paths in the configuration XML.
3. Run and debug your project:
  
  For guidance, see Run Your Application in Debug Mode.

Import a Project Folder into Anypoint Code Builder

Although it is more common to import a shareable JAR file or to open a project workspace from file directory, you can also drag a Mule project folder into the Explorer view and open the project in a VS Code workspace.

Open any valid project folder, including a project from Anypoint Studio (Studio) that’s stored on your desktop. Alternatively, use the procedure in Open a Project Folder to open the project from your file directory instead of dragging and dropping the folder into Anypoint Code Builder.

To import a project folder into Anypoint Code Builder:

Ensure that no project is open.
Navigate to a location for your project folder:
1. Open the Command Palette.
  Show me how
  Use the keyboard shortcuts:
  
  Mac: Cmd+Shift+p
  
  Windows: Ctrl+Shift+p
  
  Select View > Command Palette.
2. Provide this command:
  File: Open Folder
3. Navigate to and select a folder for your imported project, such as your home directory or any folder outside of a Mule project folder, and then click Open.
Drag your project directory from your computer to the Explorer view in VS Code, for example:
Select Copy Folder.

If you instead select Add Folder to Workspace, you can start over by selecting the project in the Explorer, right clicking, and then selecting Remove Folder from Workspace. After removing, drag and copy the project folder to the Explorer without adding it to a workspace.
If your Mule project folder is closed, open a workspace for the project at the project’s root directory.

In addition to loading the graphical canvas, Anypoint Code Builder also loads dependencies defined in the pom.xml for the project. If a Mule runtime or Java configuration is missing, set the versions to use from the canvas.

Libraries load to the target/repositories directory within the project folder.
If prompted, click Set Version to set a supported Mule runtime or Java version in the Project Properties tab.
Test your project:
1. In the open project, check for errors and make sure that the canvas and code editor load correctly, which indicates that component dependencies resolved.
2. Check for any configurations to modify, such as ports or file paths in the configuration XML.
3. Run and debug your project:
  
  For guidance, see Run Your Application in Debug Mode.

Open a Project Folder

Open or reopen a project workspace folder for your application. This procedure works for projects built in Anypoint Code Builder and for projects stored on your desktop that are built in Anypoint Studio (Studio).

If your Mule project folder is closed, open the project at its root directory:
1. Open the Command Palette.
  Show me how
  Use the keyboard shortcuts:
  
  Mac: Cmd+Shift+p
  
  Windows: Ctrl+Shift+p
  
  Select View > Command Palette.
2. Provide this command:
  File: Open Folder...
3. Navigate to and select the root folder for your project, for example:
  Integration or Implementation Example
  
  Design Project Example
  
  Example of a root folder and subdirectories of an integration or implementation project in Anypoint Code Builder:
  
  VS Code treats the root as a workspace, which enables the canvas to load properly.
  
  Example of the root directory for an API design project in Anypoint Code Builder:
  The root of a project is the top-level folder that Anypoint Code Builder generates when you create a project. Do not navigate to the project root’s parent or ancestor directory or to one of its child or descendant directories.
Click a configuration XML file for your project if it doesn’t open automatically.
Click the (Show Mule graphical mode) icon in the activity bar to open the canvas if it doesn’t open automatically.
To monitor progress as the project loads, open the Output panel.
Show me how
- Use the keyboard shortcuts:
  
  Mac: Cmd+Shift+u
  
  Windows: Ctrl+Shift+u
- Select View > Output.
Select Mule DX Server from the dropdown list. To see scaffolding errors only, select Mule DX Server: Scaffolding from the list.
Test your project:
1. In the open project, check for errors and make sure that the canvas and code editor load correctly, which indicates that component dependencies resolved.
2. Check for any configurations to modify, such as ports or file paths in the configuration XML.
3. Run and debug your project:
  
  For guidance, see Run Your Application in Debug Mode.