Like what you see? Have a play with our trial version.

Error rendering macro 'rw-search'

null

Versions Compared

Old Version 9

changes.mady.by.user user-3484a

Saved on

compared with

New Version 10

changes.mady.by.user user-3484a

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Right click on the project and select Build Path > Configure Build Path  and select the Libraries tab.



  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.



  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 Stepcom.hof.mi.etl.step.ETLStepA Step which may be used in Data Transformation
    Analytic Functioncom.hof.mi.interfaces.AnalyticalFunctionAnalytic Functions used in Reports
    Data Type Convertercom.hof.mi.interfaces.ConverterConverts used at the View Level and Data Transformations
    Custom Formattercom.hof.mi.interfaces.CustomFormatterFormatting used in Reports
    Data Profilercom.hof.mi.interfaces.DataSuggestionPlugin

    Profile data for a field and and determine whether the implemented suggestion is applicable

    Icon Setcom.hof.mi.interfaces.IconSetDefines an icon set for use with Report Alerts
    Third Party Connectorcom.hof.mi.thirdparty.interfaces.AbstractDataSourceConnectors to an external API
    Canvas Widgetcom.hof.mi.widgetcanvas.interfaces.CanvasObjectTemplateCustom Widgets for the Dashboard, Storyboard and Report Output
    Source Platformcom.hof.sources.SourcePlatformDefine Source Types such as JDBC, JNDI, OLAP etc


    1. For instance if creating a Transformation Step, name your file 'com.hof.mi.etl.step.ETLStep'.




  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



    If necessary, another transformation step may be added below this line.



Configure Tomcat

The next phase step is to set up your Tomcat configurations. 

...

  1. Select Window > Preferences and go to the section for Tomcat

    Image Added

  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 Added

  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 Added

  6. Click OK to save.

  7. Start up tomcat from eclipse using the buttons in the toolbar

    Image Added

  8. The plugin will be now be available in Yellowfin

    Image Added

 

Tip

Changes to code get reflected instantly except when:

  • a method's signature is changed
  • new methods/members are are added to the class
  • new classes are added to the plugin package

In these cases, Tomcat must be restarted to apply changes.

...

  1. Right click on the project and select Export > JAR file
  2. Select only the package(s) to be exported and nothing else

    Image Added

  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 Added