Uwe, Here's the documentation we have for NARs which provides an example breakdown for a Processor that utilizes a Controller Service [1]. I would suggest looking at any of the NAR bundle that exist in the source tree today [2]. The UpdateAttribute NAR bundle is an example of a Processor and a Custom UI being bundled in the same NAR [3].
Matt [1] https://nifi.apache.org/docs/nifi-docs/html/developer-guide.html#nars [2] https://github.com/apache/nifi/tree/master/nifi-nar-bundles [3] https://github.com/apache/nifi/tree/master/nifi-nar-bundles/nifi-update-attribute-bundle On Mon, Mar 21, 2016 at 1:21 PM, Uwe Geercken <uwe.geerc...@web.de> wrote: > I am sorry for that. I have completely overlooked that. > > So tell me Matt how is it: I create an automatic package with eclipse and > maven and then manually put it in an archive? or is there a complete > automatic approach? > > Anything I have to specifically do with maven? And is there documentation > available? > > greetings and thanks for help. > > Uwe > > > Gesendet: Montag, 21. März 2016 um 14:04 Uhr > > Von: "Matt Burgess" <mattyb...@gmail.com> > > An: dev@nifi.apache.org > > Betreff: Re: Re: Re: Re: Processor additional documentation > > > > Uwe, > > > > The additional details piece appears to be a result of your ".nar" file > > actually being more like a ".jar", rather than a bundle that includes a > JAR > > which in turn includes your source code and docs. Since you did all the > > hard work with creating some useful processors, I took the liberty of > > moving some of your project stuff around into the NAR structure the folks > > have been referring to: > > > > https://github.com/uwegeercken/nifi_processors/pull/1 > > > > This will build a NAR that contains (among other things) a JAR with the > > classes, docs, and other processor resources, and is bundled such that > the > > framework can find everything it needs. I tested this and the Additional > > Details links work correctly. Cheers! > > > > Regards, > > Matt > > > > On Sun, Mar 20, 2016 at 1:31 PM, Joe Witt <joe.w...@gmail.com> wrote: > > > > > Uwe > > > > > > Noticed your other threads on great progress. That is awesome. > > > > > > Really want to help you get to the bottom of the additional details > > > piece though. We clearly have to do a better job with documenting (or > > > implementing) how to do this. Do you have any more details to share > > > on symptoms you're seeing? > > > > > > Thanks > > > Joe > > > > > > On Fri, Mar 18, 2016 at 5:35 PM, Uwe Geercken <uwe.geerc...@web.de> > wrote: > > > > Dan, > > > > > > > > ok. I was wrong. The index file is created - it's my > > > additionalDetails.html file that is missing. I have no idea what is > wrong. > > > > > > > > I will try it tomorrow - maybe I will find something with a clear > head. > > > > > > > > Rgds, > > > > > > > > Uwe > > > > > > > >> Gesendet: Freitag, 18. März 2016 um 19:14 Uhr > > > >> Von: "dan bress" <danbr...@gmail.com> > > > >> An: dev@nifi.apache.org > > > >> Betreff: Re: Re: Re: Processor additional documentation > > > >> > > > >> Uwe, > > > >> No, the index.html is generated for you. additionalDetails.html > is > > > your > > > >> responsibility only if you feel like the generated index.html > doesn't > > > fully > > > >> describe your processor. > > > >> > > > >> I would guess 80% of the included processors do not have > > > >> additionalDetails.html. If you haven't browsed here [1] at > examples of > > > the > > > >> generated index.html and user supplied additionalDetails.html, it > might > > > >> clear things up. > > > >> > > > >> [1] https://nifi.apache.org/docs.html > > > >> > > > >> Dan > > > >> > > > >> On Fri, Mar 18, 2016 at 11:08 AM Uwe Geercken <uwe.geerc...@web.de> > > > wrote: > > > >> > > > >> > Dan, > > > >> > > > > >> > but maybe I have a wrong understanding: do I have to create an > > > index.html > > > >> > file? Currently I have only created an additionalDetails.html > file. > > > >> > > > > >> > I will also try to reduce the html code to a minimum and see if > it is > > > a > > > >> > problem with my code. > > > >> > > > > >> > Bye, > > > >> > > > > >> > Uwe > > > >> > > > > >> > > Gesendet: Freitag, 18. März 2016 um 19:03 Uhr > > > >> > > Von: "dan bress" <danbr...@gmail.com> > > > >> > > An: dev@nifi.apache.org > > > >> > > Betreff: Re: Re: Processor additional documentation > > > >> > > > > > >> > > Uwe, > > > >> > > No its not a problem to have both index.html and > > > >> > additionalDetails.html > > > >> > > The NiFi framework generates nearly all of the documentation > for > > > your > > > >> > > processor for you. It will generate information about the > > > properties and > > > >> > > relationships your processor exposes to its users. If you need > to > > > >> > express > > > >> > > more about your processor, then that is where > additionalDetails.html > > > >> > comes > > > >> > > into play. For example, if your processor uses a custom query > > > language. > > > >> > > > > > >> > > Generated index.html example: > > > >> > > > > > >> > > > > > https://nifi.apache.org/docs/nifi-docs/components/org.apache.nifi.processors.attributes.UpdateAttribute/index.html > > > >> > > > > > >> > > additionalDetails.html example: > > > >> > > > > > >> > > > > > https://nifi.apache.org/docs/nifi-docs/components/org.apache.nifi.processors.attributes.UpdateAttribute/additionalDetails.html > > > >> > > > > > >> > > On Fri, Mar 18, 2016 at 10:54 AM Uwe Geercken < > uwe.geerc...@web.de> > > > >> > wrote: > > > >> > > > > > >> > > > Bryan, > > > >> > > > > > > >> > > > all looks ok. I looked into the nifi-home/work/docs folder. > There > > > is > > > >> > > > nothing but a components folder. Inside there is a folder for > my > > > >> > processor: > > > >> > > > com.datamelt.nifi.test.TemplateProcessor and inside the folder > > > there > > > >> > is a > > > >> > > > file index.html and it contains the code of my > > > additionalDetails.html > > > >> > file. > > > >> > > > > > > >> > > > when I open the file in the web browser it looks good. I > looked at > > > >> > other > > > >> > > > index.html files and they look similar. > > > >> > > > > > > >> > > > but I noted that some folders have an inde.html file AND an > > > >> > > > additionalDetails.html file. maybe that is the problem? > > > >> > > > > > > >> > > > greetings, > > > >> > > > > > > >> > > > Uwe > > > >> > > > > > > >> > > > > > > >> > > > > > > >> > > > Gesendet: Freitag, 18. März 2016 um 16:18 Uhr > > > >> > > > Von: "Bryan Bende" <bbe...@gmail.com> > > > >> > > > An: dev@nifi.apache.org > > > >> > > > Betreff: Re: Processor additional documentation > > > >> > > > Hi Uwe, > > > >> > > > > > > >> > > > Do you have the additionalDetails.html file in your > processors jar > > > >> > project, > > > >> > > > under src/main/resources? > > > >> > > > > > > >> > > > Similar to this: > > > >> > > > > > > >> > > > > > > >> > > > > > https://github.com/apache/nifi/tree/master/nifi-nar-bundles/nifi-solr-bundle/nifi-solr-processors/src/main/resources > > > >> > > > > > > >> > > > The expected project structure is described here: > > > >> > > > > > > >> > > > > > > >> > > > > > https://cwiki.apache.org/confluence/display/NIFI/Maven+Projects+for+Extensions#MavenProjectsforExtensions-ExampleProcessorBundleStructure[https://cwiki.apache.org/confluence/display/NIFI/Maven+Projects+for+Extensions#MavenProjectsforExtensions-ExampleProcessorBundleStructure] > > > >> > < > > > > https://cwiki.apache.org/confluence/display/NIFI/Maven+Projects+for+Extensions#MavenProjectsforExtensions-ExampleProcessorBundleStructure[https://cwiki.apache.org/confluence/display/NIFI/Maven+Projects+for+Extensions%23MavenProjectsforExtensions-ExampleProcessorBundleStructure] > > > > > > > >> > > > < > > > >> > > > > > https://cwiki.apache.org/confluence/display/NIFI/Maven+Projects+for+Extensions#MavenProjectsforExtensions-ExampleProcessorBundleStructure[https://cwiki.apache.org/confluence/display/NIFI/Maven+Projects+for+Extensions%23MavenProjectsforExtensions-ExampleProcessorBundleStructure] > > > >> > > > > > >> > > > > > > >> > > > If you think that part is setup correctly, can you check under > > > >> > > > nifi_home/work/docs and see if > > > >> > com.datamelt.nifi.test.TemplateProcessor is > > > >> > > > there? > > > >> > > > > > > >> > > > -Bryan > > > >> > > > > > > >> > > > On Fri, Mar 18, 2016 at 11:04 AM, Uwe Geercken < > > > uwe.geerc...@web.de> > > > >> > > > wrote: > > > >> > > > > > > >> > > > > > > > >> > > > > Hello, > > > >> > > > > > > > >> > > > > I am writing my first processor. As described in the > > > documentation, I > > > >> > > > have > > > >> > > > > added an HTML file to be used when the user selects "Usage": > > > >> > > > > > > > >> > > > > > > > docs/com.datamelt.nifi.test.TemplateProcessor/additionalDetails.html > > > >> > > > > > > > >> > > > > This is located in the root or the Processors nar file. > > > >> > > > > > > > >> > > > > The processor class is this: > > > >> > > > > > > > >> > > > > com/datamelt/nifi/test/TemplateProcessor.class > > > >> > > > > > > > >> > > > > The processor works, but selecting "Usage" won't show my > HTML > > > file. > > > >> > > > > > > > >> > > > > I understood that I write the HTML file and Nifi will picks > it > > > up > > > >> > when it > > > >> > > > > starts. Or is this not true? > > > >> > > > > > > > >> > > > > Thanks for feedback, > > > >> > > > > > > > >> > > > > Uwe > > > >> > > > > > > > >> > > > > > > >> > > > > > >> > > > > >> > > > > > >
