Individualizing Your Extension Settings

If you didn't open the file build.gradle in the extension template project yet, open it now.

extensionConfig {

    // The extension name
    name 'MyTest'

    /*
    * Optional parameter that defines the extension namespace. The namespace is also used as artifactId.
    * If not defined, the namespace will be infered from the extension name by replacing whitespace characters
    * by an underscore and converting the name to lower case (e.g. 'Web Mining' becomes 'web_mining').
    */
    namespace = 'my_test'

    /*
     * Optional parameter that defines the extension display version. This is used in some UIs.
     * If not defined, the display version will be the same as the regular (technical) version. 
     */
    // displayVersion = '2025.0.0'

    /*
     * The artifact group which will be used when publishing the extensions Jar
     * and for package customization when initializing the project repository.
     *
     * It is 'com.rapidminer.extension' by default.
     */
    groupId = 'com.rapidminer.extension'

    /*
     * The extension vendor which will be displayed in the extensions about box
     * and for customizing the license headers when initializing the project repository.
     *
     * It is 'Altair Engineering Inc.' by default.
     */
    vendor = "Altair Engineering Inc."

    /*
     * The vendor homepage which will be displayed in the extensions about box
     * and for customizing the license headers when initializing the project repository.
     *
     * It is 'www.altair.com' by default.
     */
    homepage = "www.altair.com"

    // define the Altair AI Studio version and additional Altair RapidMiner extension dependencies as needed
    dependencies {
        rapidminer '10.1.1'
        //extension namespace: 'text', version: '10.0.0'
    }
}

// Define third party library dependencies
dependencies {
//compile 'com.google.guava:guava:26.0'
}

Changing settings

First, change the following entries in the build.gradle file to meet your individual needs:

Give your extension a name
Define the namespace, if you don't want it to be derived from the name
Optionally, define the display version that is shown to the user, when looking into the "About Installed Extensions" dialog
Define the groupId (it will be the name of your Java package)
Define the vendor
Specify your website
If your extension depends on other Altair RapidMiner extensions, define them as extension dependencies
If your extension depends on third-party libraries, define them as dependencies

You don't know how to use libraries in Gradle?

If you don’t know how to use your libraries or third-party libraries in Gradle, check out the Gradle User Guide chapter about dependency management.

Initializing the project

To start, open a command prompt (for Windows, it is, for example, the Windows Power Shell). Browse to the extension template project and execute the following command:

./gradlew --no-daemon initializeExtensionProject

In your project folder, there are now some additional files and folders. We will go through most them in the next steps.

If you don't see the new files and folders in your project, refresh the project folder in your IDE.

../img/project-initialized.png

Adding an extension icon

The next step is to select an icon (48x48 pixels) for your extension. Name it icon.png and put it into the folder src/main/resources/META-INF. If the folder META-INF does not yet exist, create it and put your icon inside.

Installing the extension

If you are using Eclipse, select the project in the Gradle Tasks view and double-click the task installExtension.

In IntelliJ IDEA, you can execute the installExtension task in the Gradle tool window on the right.

../img/intellij-install-extension.png

Otherwise, open a command prompt, browse to the extension template project, and execute the following command:

./gradlew installExtension

Starting Altair AI Studio

If Altair AI Studio is not yet installed, download and install it. Then, open Altair AI Studio and check whether your extension was loaded successfully. To check, open the Extensions > About Installed Extensions menu. You should see an entry About NAME Extension... with your extension's name. Select this entry and verify that the icon is loaded successfully and the vendor and URL are shown correctly.

Next, create your own operator.

Categories

Versions