1. Documentation
2. 2024.1 (Latest) 2024.0 10.3 10.2 10.1 10.0 9.10 9.9 9.8 9.7 9.6 9.5 9.4 9.3 9.2 9.1 9.0 8.2 8.1 8.0 7.6
3. Developers
4. Extensions

Extensions

Learn step-by-step how to build and deploy your own RapidMiner extension. You can create your own operators, UI elements or data objects according to your needs.

Quick Start

1. Checkout the extension template.

2. In the file build.gradle, set the name of the extension (that is, replace 'Template' with the desired name). For example:

    extensionConfig {
   
        // The extension name
        name MyNewExtension
   

3. Initialize the extension project by executing the Gradle task initializeExtensionProject. For example:

    gradlew --no-daemon initializeExtensionProject
   

4. Add an icon for the extension by placing an image named icon.png in src/main/resources/META-INF/.

5. Build and install your extension by executing the installExtension Gradle task.

6. Start RapidMiner Studio and check whether your extension has been loaded.

7. Happy coding!

More information

• Try the tutorial for some hands-on practice.
• Visit GitHub for more RapidMiner open-source projects.

Templates & Tutorials

As extension developer you can provide both your own templates and tutorials. Templates are processes that serve as starting point for complex workflows and can be selected from the New Process menu. A tutorial is a series of processes accompanied by explanatory texts that can be used to introduce new functionality step by step. Tutorials can be started via the Learn menu.

• Custom templates – design and bundle custom templates.
• Custom tutorials – create and bundle custom tutorials.

Sample repositories

A sample repository can be used to ship sample data that does not belong to a template or tutorial with an extension.

• Sample repositories – create your own sample repositories.