Chapter 3. Reference

3.1.1. Process tab

The Process tab of the Smooks Configuration Editor helps to configure different types of transformations. By default smooks configuration file is opened in this editor.If you have another default settings for editor opening you should left click smooks configuration file and select:Open With->Smooks Configuration Editor.

The Process tab has two sections:

You can see them on the picture below.

Figure 3.1. Two Sections of the Process tab.

3.1.1.1. Processing Task section

Using the popup menu in the Processing Task section you can select which types of technologies(templating or mapping ones) you will use for transofmation:

The descriptions of the popup menu options are in the following table.

Table 3.1. Process Tab. Processing Task section.

Option	Description	Default
Add Task	Select one of the following tasks according to the necessary type of Source and Result types of the files: Input -this task is required and appears automatically when Smooks config file is created. You should just configure it properly. Java Mapping Apply Template
Delete	Click this option if you want to delete some task from the section. Note:you can't delete input task because it's required.
Input Methods	Choose one of the following methods: System Simple Amharic(EZ+) Cedilla Cyrillic Inuktitut IPA Multipress SCIM Bridge Input Method SCIM Input Method Thai-Lio Tigrigna-Eritrean(EZ+) Tigrigna-Ethiopian(EZ+) Vietnamese X input Method	System

3.1.1.2. Selected Task Details Section

The options of this section depends on the selected task in the Processing Task section. Because there are 3 types of tasks there are 3 different sets of its options in the Selected Task Details Section. They will be described one by one.

3.1.1.2.1. Selected Task Details Section for Input Task.

On the picture below you can find an example of Selected Task Details Section view if XML is selected as input type.

Figure 3.2. Selected Task Details Section for Input XML Task.

As you can see on the picture above Input Configuration section is empty for XML input file. But this section has special configuration options for CSV,EDI,JSON,Custom input files.

Here are the screens of these configuration options:

CSV:
Figure 3.3. Selected Task Details Section for Input CSV Task.
EDI:
Figure 3.4. Selected Task Details Section for Input EDI Task.
JSON:
Figure 3.5. Selected Task Details Section for Input JSON Task.
Custom:
Figure 3.6. Selected Task Details Section for Input Custom Task.

All the input task configuration positions can be found in the table below:

Table 3.2. Selected Task Details Section. Options for Input Task.

Option	Description	Default
Input type	Select your type of input file. If don't find your type in the list,you should use Custom type: No Input XML Java XSD/WSDL CSV EDI JSON Custom	XML
Input configuration	No Input -no info required XML -no info required Java -no info required XSD/WSDL -no info required CSV Fields -Comma separated list of CSV record field names Separator Character -Field separator character. Default of ','. Quote Character -Quote character. Default of '"'. Record Name -Name of csv record element.Default:csv-record Root Name -Name of csv root element.Default:csv-set indent -Add indentation character data to the generated event stream. This simply makes the generated event stream easier to read in its serialized form. Useful for testing etc.Default:true Skip Lines -Number of lines to skip before processing starts. Default of 0. EDI Target Profile -Defines the target profile Encoding -The character encoding. Default "UTF-8" Mapping Model -Defines the EDI Mapping Model configuration for processing the EDI message stream to a stream of SAX events that can be processed by Smooks. Validate -This attribute turns on/off datatype validation in the EDI Parser. Validation is on by default. It makes sense to turn datatype validation off on the EDI Reader if the EDI data is being bound into a Java Object model. JSON Target Profile -Defines the target profile Array Element Name -The element name of a array element. Default of 'element'. Encoding -encoding: The default encoding of any JSON message InputStream processed by this Reader. Default of 'UTF-8'. Illegal Element Name Char Replacement -If illegal characters are encountered in a JSON element name then they are replaced with this value. By default this is not defined, so that the reader doesn't doesn't search for illegal characters. Indent -Add indentation character data to the generated event stream. This simply makes the generated event stream easier to read in its serialized form. Useful for testing etc.Default:false. Key Prefix on Numeric -The prefix character to add if the JSON node name starts with a number. By default this is not defined, so that the reader doesn't search for element names that start with a number. Key Whitespace Replacement -The replacement character for whitespaces in a JSON map key. By default this not defined, so that the reader doesn't search for whitespaces. Null Value Replacement -The replacement string for JSON NULL values. Default is ""(an empty string). Root Name -The element name of the document root. Default of 'json'. Key Maps -Defines a JSON element name mapping The "from" key will be replaced with the "to" key or the contents of the element. Custom Target Profile - Class -Custom reader class. Handlers -Set a handler on the reader instance e.g. an EntityResolver, ErrorHandler etc. Features -Reader Features List Parametres -Resource Parameters	CSV not defined ',' '"' csv-record csv-set true 0 EDI not defined UTF-8 not defined true JSON not defined element UTF-8 not defined false not defined not defined ""(an empty string) 'json' not defined Custom no defaults
Input Data	You should select a data file using Add and Delete buttons
Input Model View	Using this view you can see the structure of your input file.If the file has been changed, to see the changes click Refreshlink.

3.1.1.2.2. Selected Task Details section for Java Mapping Task.

Selected Task Details section for this task is presented by the graf, that lighten the process of java mapping.

Figure 3.7. Selected Task Details Section for Mapping Task.

This graphical editor allow you to perform drug/drop operations with the nodes of transform data to map the source data to target data. When you save the changes in the graphical editor the correct Smooks configuration file content will be generated.

3.1.1.2.3. Selected Task Details section for Template Task.

Selected Task Details section for this task is presented by the graf, that is similar to the one in the previous section.

Figure 3.8. Selected Task Details Section for Template Task.

3.1.2. Options Tab

This section describes Options tab of the Smooks Configuration File editor, gives short recommendations how this tab can be used during the project configuring.

Figure 3.9. Options tab of the Smooks Configuration File editor

3.1.2.1. Smooks Configuration section

In the Smooks Configuration section of Options Tab only one element is availible:Smooks Platform Version

Figure 3.10. Smooks Configuration section of Options tab

This parameter is not rechangable, and is set according to the vesion of the Smooks libraries that are added to the project.

3.1.2.2. Filter Settings Filter section

In Filter Settings section you can set the following global options responsible for Smooks filtering configuring:

Figure 3.11. Filter Settings section of Options tab

This behavior can be turned off using this global configuration parameter and can be overriden on a per fragment basis by targetting a Visitor implementation at that fragment that takes ownership of the Result writer (in the case of SAX filtering), or simply modifies the DOM (in the case of DOM filtering). As an example of this, see the FreeMarkerTemplateProcessor.

Table 3.3. Options Tab. Filter Settings section.

Option	Description	Default
Stream Filter Type	Determines the type of processing model that will be used. Please refer to Filtering Process Selection section of the official Smooks User Guide for more information about these models: SAX DOM	DOM
Default Serialization is On	Defines whether default serialization should be switched on. Default serialization being turned on leads to locating StreamResult/DOMResult to the Result objects provided to the Smooks.filterSource method and to serialization all the events to that Result.	true

You can set up your Smooks validator to include, exclude groups to validate and specify rules for validation. Just click on the Settings button and use the options provided:

Figure 3.15. Smooks Configuration File Validator Settings

Create new JBoss Tools Documentation Jira issue