You've just finished creating your Framework model and published it to your portal for your users. You now have the task to create a functional specification document that your users, future developers, business sponsors etc. will need to reference. The Model Report available in Framework Manager is not in a format that most users can follow so what are your options?

This process to create a nicely formatted HTML report involves transforming the Framework model.xml file into the HTML document by using an XSLT transformation in a Pentaho job. The process is quite simple. You can install the code by downloading the files found in the attached ZIP. Follow the instructions in the demo link for a step-by-step walk through of the process.

The XSLT file was created by the folks at Braintapper and I was lucky enough to get my hands on a copy. We use this process to document the Framework models for our client's frameworks. I'd like to thank the Braintapper developers for the code.

Notes: You will need to upload the CSS files to your hosting website and replace the CSS file locations in the getelements.xsl file so that they point to your hosted domain.

XSLT Code - Download Code

Instructions - Instructional Video