Page History

...

1. Once Eclipse is started, create a new Java project.
   1. Enter the project name and ensure you select a JRE compatible with the version of Yellowfin.
   2. Click Next and change the default output folder to <project-name>/ROOT/WEB-INF/classes.
      Image Removed
      
      
      
      
   3. Click Finish.
2. Import files from the installed Yellowfin.
   1. Right click on the project  and select Import.
      Image Removed
      
      
      
      
   2. Select File System and click Next.
      Image Removed
      
      
      
      
   3. Navigate to appserver/webapps/ROOT in the Yellowfin install directory. Select ROOT and click OK.
      Image Removed
      
      
      
      
   4. Select everything under ROOT and in the Advanced section, select the Create  links in workspace checkbox.
      Image Removed
      
      
      
      
   5. Click Finish. Files from the installed Yellowfin get linked to the plugin project.
      Image Removed
      
      
      

Configure the Project

1. Right click on the project and select Build Path > Configure Build Path  and select the Libraries tab
   Image Removed
   
   
   
2. Click Add JARs and type "i4" into the search bar. From the results, select i4-core.jar and i4-mi.jar from your plugin project. Click OK to save this and OK again in the build path config window.
   Image Removed
   
   
   
3. Create the following folder structure under src:  META-INF/services. 
   
   

4. Depending on which plugin is being developed, create a file with the full qualified name of the plugin interface, in the services directory.
   
   

   Yellowin Plugin	Interface	Description
   Transformation Step	com.hof.mi.etl.step.ETLStep	A Step which may be used in Data Transformation
   Analytic Function	com.hof.mi.interfaces.AnalyticalFunction	Analytic Functions used in Reports
   Data Type Converter	com.hof.mi.interfaces.Converter	Converts used at the View Level and Data Transformations
   Custom Formatter	com.hof.mi.interfaces.CustomFormatter	Formatting used in Reports
   Data Profiler	com.hof.mi.interfaces.DataSuggestionPlugin	Profile data for a field and and determine whether the implemented suggestion is applicable
   Icon Set	com.hof.mi.interfaces.IconSet	Defines an icon set for use with Report Alerts
   Third Party Connector	com.hof.mi.thirdparty.interfaces.AbstractDataSource	Connectors to an external API
   Canvas Widget	com.hof.mi.widgetcanvas.interfaces.CanvasObjectTemplate	Custom Widgets for the Dashboard, Storyboard and Report Output
   Source Platform	com.hof.sources.SourcePlatform	Define Source Types such as JDBC, JNDI, OLAP etc

   
   

   1. For example, name the file 'com.hof.mi.etl.step.ETLStep' if creating a Transformation Step.
      Image Removed
      
      
      
      
      
5. Create the plugin class by implementing one of the interfaces given above. The fully qualified classname should be added to the services file corresponding to the interface.
   So if the plugin being developed is a Data Transformation Step, add its fully qualfied class name to META-INF/services/com.hof.etl.step.ETLStep
   Image Removed
   
   
   
   If necessary, another transformation step may be added below this line.

...

1. Select Window > Preferences and go to the section for Tomcat
   Image Removed
   
   
   
2. Set Tomcat Home to <Yellowfin Install directory>/appserver and Contexts directory to <Yellowfin Install directory>/appserver/conf/Catalina/localhost
   
   
3. Expand the Tomcat section and click on Advanced. Add the plugin project to Tomcat's classpath.
   Image Removed
   
   
   
4. Adjust JVM Settings if necessary. You could use this to increase the memory available for Tomcat.
   
   
5. Select Source Path and add the plugin project.
   Image Removed
   
   
   
6. Click OK to save.
   
   
   
7. Start up tomcat from eclipse using the buttons in the toolbar
   Image Removed
   
   
   
8. The plugin will be now be available in Yellowfin
   Image Removed
   
   

...

1. Right click on the project and select Export > JAR file
2. Select only the package(s) to be exported and nothing else
   Image Removed
   
   
   
3. If the project has dependent JARs, put all of them and the Plugin JAR into one directory, zip into one archive, and give it the extension "yfp".

...

Debugging is easy as the Eclipse Tomcat plugin starts Tomcat in debug mode. Simply add breakpoints in code and ensure they are active.Image Removed