Skip to main content
Solved

Linking Help Documentation to Java Transformers Built with Plugin SDK

  • September 22, 2025
  • 1 reply
  • 66 views
courtney_m
Contributor
Forum|alt.badge.img+19

Hi Everyone,

 

I have a java-based custom transformer built with the FME plugin SDK.  I created an HTML help file for my custom transformer, and I would like to link it to the transformer, so it can be displayed in FME Form when I right-click on the transformer and click help.  Where does the HTML file need to be placed, and where/how do tell the transformer about the help file?  Do I need to add something to the .fmw or the .java file, or both?  If so, do you have examples or documentation on what code needs to be added?

 

Thank you for your time!

Best answer by courtney_m

In case anyone else is curious, I heard back from Safe Software support regarding this question.  Apparently it is not possible to implement help documentation for transformers built with the FME Plugin SDK for Java.  The only way to build fully enabled 3rd party transformers is through the FME Package SDK for Python.  So, if I want to link my handy HTTP help documentation to my java-based transformer, I have to first rebuild it in Python using the FME Package SDK.

danilo_fme
nvasta
This post is closed to further activity.
It may be an old question, an answered question, an implemented idea, or a notification-only post.
Please check post dates before relying on any information in a question or answer.
For follow-up or related questions, please post a new question or idea.
If there is a genuine update to be made, please contact us and request that the post is reopened.

1 reply

courtney_m
Contributor
Forum|alt.badge.img+19
  • courtney_mContributor
  • Author
  • Contributor
  • Best Answer
  • September 26, 2025

In case anyone else is curious, I heard back from Safe Software support regarding this question.  Apparently it is not possible to implement help documentation for transformers built with the FME Plugin SDK for Java.  The only way to build fully enabled 3rd party transformers is through the FME Package SDK for Python.  So, if I want to link my handy HTTP help documentation to my java-based transformer, I have to first rebuild it in Python using the FME Package SDK.

crystalwang

Community Stats

32,127
Posts
121,961
Replies
39,777
Members

Latest FME

Terms & ConditionsCookie settingsAccessibility statement
A product of
Safe Software respectfully acknowledges that we live, learn and work on the traditional and unceded territories of the Kwantlen, Katzie, and Semiahmoo First Nations.