Copy Page

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account. You can also Sign Up for a new account.

<p>This tutorial illustrates is how to generate a stream of SAX events from an EDI stream and how that stream of SAX events feeds into Smooks to generate an XML model that can be transformed further (in this case it is not).</p>

<p> <br />
<strong><a href="http://svn.codehaus.org/milyn/trunk/smooks-examples/edi-to-xml"><strong>SVN</strong></a></strong> - <strong><a class="confluence-link unresolved" data-content-title="downloads" data-linked-resource-default-alias="downloads" href="#"><strong>Download</strong></a></strong> - <strong><a class="confluence-link" href="/display/MILYN/Tutorials" data-linked-resource-id="49525" data-linked-resource-type="page" data-linked-resource-default-alias="Tutorials" data-base-url="http://docs.codehaus.org"><strong>Other Tutorials</strong></a></strong></p>

<p>Other Relevant Info:</p>
<ul>
	<li><a class="confluence-link" href="/display/MILYN/Smooks+Example+-+csv-to-xml" data-linked-resource-id="24248654" data-linked-resource-type="page" data-linked-resource-default-alias="Smooks Example - csv-to-xml" data-base-url="http://docs.codehaus.org">csv-to-xml</a> tutorial.</li>
	<li><a class="confluence-link" href="/display/MILYN/Smooks+Example+-+edi-to-java" data-linked-resource-id="24248663" data-linked-resource-type="page" data-linked-resource-default-alias="Smooks Example - edi-to-java" data-base-url="http://docs.codehaus.org">edi-to-java</a> tutorial.</li>
	<li><a class="confluence-link" href="http://milyn.codehaus.org/javadoc/smooks-cartridges/edi/org/milyn/smooks/edi/SmooksEDIParser.html" shortcut-key="milyn_public_html" shortcut-parameter="javadoc/smooks-cartridges/edi/org/milyn/smooks/edi/SmooksEDIParser.html" data-linked-resource-default-alias="unnamed link" data-base-url="http://docs.codehaus.org">SmooksEDIParser Configuration</a>.  Also check out <a class="confluence-link" href="http://milyn.codehaus.org/javadoc/edisax/org/milyn/edisax/EDIParser.html" shortcut-key="milyn_public_html" shortcut-parameter="javadoc/edisax/org/milyn/edisax/EDIParser.html" data-linked-resource-default-alias="unnamed link" data-base-url="http://docs.codehaus.org">EDIParser</a>.</li>
	<li><a class="confluence-link" href="http://milyn.codehaus.org/javadoc/smooks/org/milyn/xml/SmooksXMLReader.html" shortcut-key="milyn_public_html" shortcut-parameter="javadoc/smooks/org/milyn/xml/SmooksXMLReader.html" data-linked-resource-default-alias="unnamed link" data-base-url="http://docs.codehaus.org">SmooksXMLReader</a>.  The extension point for Smooks configured stream parsers.</li>
</ul>

<p> <br />
<span style="text-decoration: underline;">To Build</span>: &quot;mvn clean install&quot;<br />
<span style="text-decoration: underline;">To Run</span>: &quot;mvn exec:java&quot;</p>

<p><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2FuY2hvcjp0cmFuc2Zvcm1lcn0&amp;locale=en_GB&amp;version=2" data-macro-name="anchor" data-macro-default-parameter="transformer"></p>
<h1>Transforming from EDI to XML</h1>

<p>This example illustrates how to hook the EdiSax (<a href="http://milyn.codehaus.org/EdiSax">http://milyn.codehaus.org/EdiSax</a>) EDI parser into a Smooks based transform (filter operation).  It's another example of how non-XML streams can be processed by Smooks (see the <a class="confluence-link" href="/display/MILYN/Smooks+Example+-+csv-to-xml" data-linked-resource-id="24248654" data-linked-resource-type="page" data-linked-resource-default-alias="Smooks Example - csv-to-xml" data-base-url="http://docs.codehaus.org">csv-to-xml</a> example).</p>

<p>In this example, we simply configure in the EdiSax parser to process the EDI stream into XML.  We don't perform any other transforms on the underlying data. For an example of how other transform operations can be built on top of this edi-to-xml transform, see the <a class="confluence-link" href="/display/MILYN/Smooks+Example+-+edi-to-java" data-linked-resource-id="24248663" data-linked-resource-type="page" data-linked-resource-default-alias="Smooks Example - edi-to-java" data-base-url="http://docs.codehaus.org">edi-to-java</a> example.</p>

<p>So here's the source edi file that is to be transformed:</p>
<table class="wysiwyg-macro" data-macro-name="noformat" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e25vZm9ybWF0fQ&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>
HDR*1*0*59.97*64.92*4.95*Wed Nov 15 13:45:28 EST 2006
CUS*user1*Harry^Fletcher*SD
ORD*1*1*364*The 40-Year-Old Virgin*29.98
ORD*2*1*299*Pulp Fiction*29.99

</pre></td></tr></table>
<p>And this is the expected result of our transformation:</p>
<table class="wysiwyg-macro" data-macro-name="noformat" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e25vZm9ybWF0fQ&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>
&lt;Order>
        &lt;header>
                &lt;order-id>1&lt;/order-id>
                &lt;status-code>0&lt;/status-code>
                &lt;net-amount>59.97&lt;/net-amount>
                &lt;total-amount>64.92&lt;/total-amount>
                &lt;tax>4.95&lt;/tax>
                &lt;date>Wed Nov 15 13:45:28 EST 2006&lt;/date>
        &lt;/header>
        &lt;customer-details>
                &lt;username>user1&lt;/username>
                &lt;name>
                        &lt;firstname>Harry&lt;/firstname>
                        &lt;lastname>Fletcher&lt;/lastname>
                &lt;/name>
                &lt;state>SD&lt;/state>
        &lt;/customer-details>
        &lt;order-item>
                &lt;position>1&lt;/position>
                &lt;quantity>1&lt;/quantity>
                &lt;product-id>364&lt;/product-id>
                &lt;title>The 40-Year-Old Virgin&lt;/title>
                &lt;price>29.98&lt;/price>
        &lt;/order-item>
        &lt;order-item>
                &lt;position>2&lt;/position>
                &lt;quantity>1&lt;/quantity>
                &lt;product-id>299&lt;/product-id>
                &lt;title>Pulp Fiction&lt;/title>
                &lt;price>29.99&lt;/price>
        &lt;/order-item>
&lt;/Order>

</pre></td></tr></table>
<p><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2FuY2hvcjpjb25maWd1cmF0aW9ufQ&amp;locale=en_GB&amp;version=2" data-macro-name="anchor" data-macro-default-parameter="configuration"></p>

<h1>The Smooks Configuration</h1>
<p>We simply specify the <a class="confluence-link" href="http://milyn.codehaus.org/javadoc/smooks-cartridges/edi/org/milyn/smooks/edi/SmooksEDIParser.html" shortcut-key="milyn_public_html" shortcut-parameter="javadoc/smooks-cartridges/edi/org/milyn/smooks/edi/SmooksEDIParser.html" data-linked-resource-default-alias="unnamed link" data-base-url="http://docs.codehaus.org">SmooksEDIParser</a> as the stream parser.  More transformation configurations could be added to transform this message further.</p>

<p>Here's the configuration (&quot;smooks-config.xml&quot;):</p>

<table class="wysiwyg-macro" data-macro-name="noformat" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e25vZm9ybWF0fQ&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>
&lt;?xml version="1.0"?>
&lt;smooks-resource-list xmlns="http://www.milyn.org/xsd/smooks-1.0.xsd">

&lt;!-- Configure the EDI Parser to parse the message stream into a stream of SAX events. -->
	&lt;resource-config selector="org.xml.sax.driver">
		&lt;resource>org.milyn.smooks.edi.SmooksEDIParser&lt;/resource>
		&lt;param name="mapping-model">/example/edi-to-xml-order-mapping.xml&lt;/param>
	&lt;/resource-config>

&lt;/smooks-resource-list>
</pre></td></tr></table>
<p>Here's the edi mapping (&quot;/src/main/java/example/edi-to-xml-order-mapping.xml&quot;):
<br class="atl-forced-newline" /></p>
<table class="wysiwyg-macro" data-macro-name="noformat" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e25vZm9ybWF0fQ&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>
&lt;?xml version="1.0" encoding="UTF-8"?>
&lt;medi:edimap xmlns:medi="http://www.milyn.org/schema/edi-message-mapping-1.0.xsd">

&lt;medi:description name="DVD Order" version="1.0" />

&lt;medi:delimiters segment="&amp;#10;" field="*" component="^" sub-component="~" />

&lt;medi:segments xmltag="Order">

&lt;medi:segment segcode="HDR" xmltag="header">
			&lt;medi:field xmltag="order-id" />
			&lt;medi:field xmltag="status-code" />
			&lt;medi:field xmltag="net-amount" />
			&lt;medi:field xmltag="total-amount" />
			&lt;medi:field xmltag="tax" />
			&lt;medi:field xmltag="date" />
		&lt;/medi:segment>

&lt;medi:segment segcode="CUS" xmltag="customer-details">
			&lt;medi:field xmltag="username" />
			&lt;medi:field xmltag="name">
				&lt;medi:component xmltag="firstname" />
				&lt;medi:component xmltag="lastname" />
			&lt;/medi:field>
			&lt;medi:field xmltag="state" />
		&lt;/medi:segment>

&lt;medi:segment segcode="ORD" xmltag="order-item" maxOccurs="-1">
			&lt;medi:field xmltag="position" />
			&lt;medi:field xmltag="quantity" />
			&lt;medi:field xmltag="product-id" />
			&lt;medi:field xmltag="title" />
			&lt;medi:field xmltag="price" />
		&lt;/medi:segment>

&lt;/medi:segments>

&lt;/medi:edimap>
</pre></td></tr></table>

<p>The following illustrations attempts to visually describe the mapping that takes place (see <a class="confluence-link" href="http://milyn.codehaus.org/javadoc/edisax/org/milyn/edisax/EDIParser.html" shortcut-key="milyn_public_html" shortcut-parameter="javadoc/edisax/org/milyn/edisax/EDIParser.html" data-linked-resource-default-alias="unnamed link" data-base-url="http://docs.codehaus.org">EDIParser</a>):<br />
<img class="confluence-embedded-image confluence-external-resource" src="http://milyn.codehaus.org/javadoc/edisax/org/milyn/edisax/doc-files/edi-mapping.png" data-image-src="http://milyn.codehaus.org/javadoc/edisax/org/milyn/edisax/doc-files/edi-mapping.png"></p>

<h1>Executing The Transformation</h1>

<p>Again, it's exactly the same as with the <a class="confluence-link" href="/display/MILYN/Smooks+Example+-+java-basic" data-linked-resource-id="78566" data-linked-resource-type="page" data-linked-resource-default-alias="Smooks Example - java-basic" data-base-url="http://docs.codehaus.org">java-basic</a> tutorial:</p>
<table class="wysiwyg-macro" data-macro-name="noformat" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e25vZm9ybWF0fQ&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>
// Instantiate Smooks with the config...
Smooks smooks = new Smooks("smooks-config.xml");

// Filter the input message to the outputWriter...
smooks.filter(new StreamSource(messageIn), new StreamResult(messageOut));
</pre></td></tr></table>
<p>Of course, you'd typically cache the <a class="confluence-link" href="http://milyn.codehaus.org/javadoc/smooks/org/milyn/Smooks.html" shortcut-key="milyn_public_html" shortcut-parameter="javadoc/smooks/org/milyn/Smooks.html" data-linked-resource-default-alias="unnamed link" data-base-url="http://docs.codehaus.org">Smooks</a> instance.</p>

<p>See the <a href="http://svn.codehaus.org/milyn/trunk/smooks-examples/edi-to-xml/src/main/java/example/Main.java">example/Main.java</a> in the example source.</p>