Contact Us 1-800-596-4880
  1. Homepage
  2. Anypoint Code Builder

  3. Creating Integrations

Creating Integrations

logo cloud IDE Cloud IDE

logo desktop IDE Desktop IDE

Open Beta Release: The cloud IDE and AsyncAPI implementation support are in open beta. Any use of Anypoint Code Builder in its beta state is subject to the applicable beta services terms and conditions, available from the IDE.

To process your data with business logic, create an integration with connectors and other components in a Mule application.

A typical workflow includes one or more of the following tasks:

  1. Create or import an integration project:

  2. Add components to your project.

You can create multiple configuration XML files in your project. See Create an Additional Configuration XML File.

Before You Begin

Create an Integration Project

To create an integration project:

  1. In the activity bar of the IDE, click the (Anypoint Code Builder) icon.

  2. From Quick Actions, click Develop an Integration:

    Develop an Integration link highlighted in the Getting started section

  3. Specify a project name and location in the Develop an Integration form.

    Field Name Field Value

    Project Name

    Unique name for your project.

    This name is used as the title and name of the integration project file. For example, if the project name is "OAS Integration," the project file name is oas-integration.

    Project Location

    Your home directory or another directory you create. Click Browse to select a different directory for the integration.

    See Adding Folders to Your Home Directory.

    Don’t create the project within another project directory.

  4. Create a project from scratch, or start with an asset from Anypoint Exchange.

    • Start with an Empty Project

    • Start with a Project Template or Example

    Click Empty Project to start an integration project from scratch, without any preconfigured components.

    Create integration project from scratch.

    To import an existing integration template or example from Anypoint Exchange:

    1. Click Template or Example Project to import an existing integration template or example from Anypoint Exchange.

      Create integration project from an Exchange asset.

    2. If you intend to import a private asset associated with your business organization, log in to Anypoint Platform from the IDE to list the template or example in the search results.

      Searches for public assets do not require login.

    3. From the IDE, search for a template or for an example.

      Partial searches are accepted.

    4. Mouse over the asset that you want to add.

    5. Click Add Asset.

  5. Select a Mule runtime and Java version.

    You can select any of the supported Mule runtime and Java versions. The IDE saves your version settings to the project’s mule-artifact.json file. To set default Mule runtime and Java versions for the projects you create, see Version Settings for Mule, Java, and Connectors.

  6. Click Create Project.

    The IDE provides a notification if it is necessary to download the selected Mule runtime or Java version for the project. Mule runtime downloads to ${user.home}/AnypointCodeBuilder/runtimes, and the selected Java version downloads to ${user.home}/AnypointCodeBuilder/java.

When you create an integration project from scratch or if your project from Exchange does not contain a flow structure (Flow, Subflow, or Error handling component), the canvas UI provides the option to create one. Otherwise, the canvas UI generates a graphical representation of the imported asset’s components that you can use to start your configuration.

Create an Additional Configuration XML File

Anypoint Code Builder creates the initial Mule configuration XML file in src/main/mule within the Mule project.

You can create additional configuration files, for example, for an implementation file for a scaffolded interface or for global configurations that you can reference from an XML file.

To create a new configuration XML file:

  1. In the Explorer view, right-click the mule folder (src/main/mule) and select New Mule Configuration File…​.

  2. In the New Mule Configuration File…​ field that opens, provide a name for the new file without an extension.

    Provide name of Mule configuration XML file

    The name must be unique within the project. Permitted special characters are _ (underscore), - (hyphen), ., @, (, and ).

    The process automatically appends an xml extension to the file name and opens the new configuration XML file and its canvas UI within the IDE. The new configuration XML file contains the <mule/> element with default namespaces:

    <?xml version="1.0" encoding="UTF-8"?>
<mule xmlns="http://www.mulesoft.org/schema/mule/core"
      xmlns:doc="http://www.mulesoft.org/schema/mule/documentation"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://www.mulesoft.org/schema/mule/core http://www.mulesoft.org/schema/mule/core/current/mule.xsd">

</mule>

    The file’s canvas UI provides the same options for building your project file that appear when you create an integration project. For an example and to get started with your configuration, see Add a Component to Your Project.

See Also