Add Custom Modules to Your Project

You can add your custom Mule module to your Mule projects in Anypoint Studio.

These instructions assume that you developed your Mule module using the Mule SDK, and that you followed the proper setup steps.
See the Mule SDK introductory instructions for more details.

You can install custom modules using the Studio UI, or by manually adding them as a Maven dependency in your project’s pom.xml file.

From Studio

To install a local custom module from Studio:

  1. In the top menu bar, select the Manage dependencies icon 20.

  2. Under Mule Project, select Modules:

    manage modules
  3. Select the green plus icon (2%) and select From Maven:

    add modules from maven
  4. In the properties window, configure your custom module’s Maven coordinates:

    add modules maven ui

    This information is available in your module’s pom.xml file.

From Maven

Because Mule modules are developed as Maven projects, you can install them from a local or online Maven repository:

  1. In your Anypoint Studio project, edit the pom.xml file with the groupId, artifactId, and version of your Mule module.
    This information is available in your module’s pom.xml file. For example:

    <parent>
        <groupId>org.mule.extensions</groupId>
        <artifactId>mule-ee-core-modules-parent</artifactId>
        <version>1.1.0-SNAPSHOT</version>
    </parent>
    
    <groupId>com.mulesoft.mule.modules</groupId>
    <artifactId>mule-secure-configuration-property-module</artifactId>
    <packaging>mule-extension</packaging>
    <version>1.0.0-SNAPSHOT</version>
    
    <name>Mule Secure Configuration Property Extension</name>
    <description>Mule extension for loading encrypted properties</description>

    It is also reflected in the folder structure in which the Mule module was installed ($MAVEN_REPOS_HOME/groupID_path/artifactId/version).

    For the example above, your Anypoint Studio pom.xml file should add the following dependency:

    <dependency>
    	<groupId>com.mulesoft.mule.modules</groupId>
    	<artifactId>mule-secure-configuration-property-module</artifactId>
    	<version>1.0.0-SNAPSHOT</version>
    	<classifier>mule-plugin</classifier>
    </dependency>

    Note that the <classifier> element is set to mule-plugin. This automatically installs the mule-plugin into your project’s palette.

  2. Save your changes to your Studio project’s pom.xml file.

After Anypoint Studio downloads the new dependency, you’ll see your new Mule module in the Studio palette. In this example, there is a Secure Properties module listed in the Mule Palette view.
There’s also a new Secure Properties Config element available in the Global Elements editor, and the new XML namespace and XML tags are available in the XML configuration file editor.

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub