Preparing Your Operator to Build

After you complete your code, there are only a few things left to do before you upload it to the Team Studio web application. You must edit two more files - pom.xml and plugins.xml. You can also customize the icon that is displayed for your operator at this point.

Prerequisites

You must have created the runtime class.

Procedure

  1. Open the pom.xml file in the PluginTemplateProject folder and find the following line:
    <artifactId>plugin-template</artifactId>
  2. Replace it with the name you want the compiled .jar file to have. This is the only thing you need to modify in this file. The other code in pom.xml does the work of downloading dependencies based on the Team Studio Custom Operator SDK. Thus, to call your output jar MyColumnFilter.jar, you would edit the artifactId line to say:
    <artifactId>MyColumnFilter</artifactId>
  3. When you update your pom.xml file, IntelliJ might show a pop-up directing you to import changes to Maven Projects. Before proceeding, click Import Changes, which refreshes the dependencies necessary to build your operator.
    Now you need to specify the signature class to the plugins.xml file. This tells Team Studio where to find information about the operator after uploading the JAR.
  4. Open PluginTemplateProject/src/main/resources/plugins.xml. It should look like this:
    <?xml version="1.0" encoding="UTF-8"?>
    <alpine-plugins>
    </alpine-plugins>
  5. Add the Signature class (the one with the metadata) to this file as follows:
    <?xml version="1.0" encoding="UTF-8"?>
    <alpine-plugins>
     <plugin>
       <signature-class>com.mycompany.plugins.MyColumnFilterSignature</signature-class>
     </plugin>
    </alpine-plugins>

    Note that you must use the full package name to refer to your signature class.

    Important: Be sure to fill in those two fields, or your operator will not build.
  6. Follow the instructions in How To Compile and Run the Sample Operators to build your operators and upload them to the Team Studio web application.
    You should now have a fully functioning Column Filter operator, using the new Custom Operator framework in Spark and Scala.