Hide Forgot
Date of First Response: 2008-09-25 05:23:10 project_key: SOA The Smooks documentation contained in the SOA-P docset is lightweight. The docs on the Smooks website is a little bit out of sync with the capabilities of the SOA-P. The docs in this area need illustrate the the typical SOA use cases: - ASCII to XML - XML to XML - XML to POJO
Darrin, talk with Tom Fennelly. If we can't get anything in for this release then we can target the CP.
I received an email from Darrin, so I'll comment here on the issue. The docs for Smooks v1.0.x are available here: http://milyn.codehaus.org/docs/v1.0/SmooksUserGuide_v1.0.html
Can we just include it "as is"?
Emailed Darrin for comments
all of http://milyn.codehaus.org/docs/v1.0/SmooksUserGuide_v1.0.html ? No, will take way too long, and at lot of it might be out of context for SOA There are 4 or 5 transform quickstarts... might just include references to them?
I don't believe anything in http://milyn.codehaus.org/docs/v1.0/SmooksUserGuide_v1.0.html is "out of context". Much like the Drools & jBPM user guides, they are focused on individual project usage but the knowledge is still valuable. Documentation that describe how the transform quickstarts are working would be very useful. Specifically, how the smooks-config.xml, smooks-res.xml and SmooksAction is working to address those problem spaces.
What is the status of this? We either include the docs in the next few days or push this out. It can't hold up the release. Worst case: let's include a link to the Smooks docs!
I'm going to add a list of the quickstarts & the some of the descriptions from their readme.txts, And a link to the smooks docs.
in the Programmers Guide that is
Content added to the Programmers Guide. end of section 2 - Message Transformation, of chapter 5 - Other Services. There are a number of QuickStarts included that provide different examples of implementing transformations. 1. jboss-as/samples/quickstarts/transform_CSV2XML/ This quickstart demonstrates how to transform a comma separated value (CSV) file to an xml. The tranformation is done by configuring Smooks and performing two transformations, the first one from CSV to an intermediate xml format, and then the second from the intermediate xml format to the target xml. 2. jboss-as/samples/quickstarts/transform_XML2POJO/ This quickstart illustrates the use of Smooks to perform a simple transformation to convert an XML file into Java POJOs. 3. jboss-as/samples/quickstarts/transform_XML2POJO2/ This quickstart demonstrates the transform of two different XML files to a common set of POJOs. 4. jboss-as/samples/quickstarts/transform_XML2XML_simple/ This is a very basic example of how to manually define and apply a Message Transformation within JBossESB. It applies a very simple XSLT to a SampleOrder.xml message and prints the before and after XML to the console. 5. jboss-as/samples/quickstarts/transform_XML2XML_date_manipulation/ This Quickstart continues on from the transformation_XML2XML_simple Quickstart and demonstrates how you can simplify your transformations by combining XSLT with Java. Java is used to perform the string manipulation on the SampleOrder date field (OrderDate.java) and XSLT is used for providing a template for output. The original and the transformed SampleOrder.xml messages are printed to the Java console. 6. jboss-as/samples/quickstarts/transform_XML2XML_stream/ This is a very basic example of how to stream a fragment of a transformation to an ESB Service. The trick behind this is using a Smooks DOMVisitor that sends the element it is passed in its visitBefore and visitAfter. 7. jboss-as/samples/quickstarts/transform_EDI2XML_Groovy_XSLT/ This is the most advanced of the transform Quickstarts. Be sure to go through the other transformation Quickstarts before going through this. There's an accompanying Flash demo at http://labs.jboss.com/portal/jbossesb/resources/tutorials/xformation-demos/console-demo-03.html which walks you through this Quickstart. The complete Smooks documentation can be found on the Smooks project website at http:// milyn.codehaus.org/docs/v1.0/SmooksUserGuide_v1.0.html.
The pointer to the smooks docs is in the programmers' guide in CR1.
Attachment: Added: Screenshot-1.png
Verified in CR1