Create new JBoss Tools Documentation Jira issue

This will launch the Jboss Tools Jira page - to complete your feedback please login if needed, and submit the Jira.

JBoss.orgCommunity Documentation

Chapter 3. Reference

3.1. Process tab
3.1.1. Processing Task section
3.1.2. Selected Task Details Section
3.2. Options Tab
3.2.1. Smooks Configuration section
3.2.2. Filter Settings Filter section
3.3. Source Tab
3.3.1. XML Source Editor
3.3.2. Error underlining in Graphical Editor
3.3.3. Smooks Configuration File Validator
3.4. Properties View
3.4.1. Decode Configuration
3.4.2. Apply Template Wizard

This chapter includes detailed reference information about all tabs of the Smooks Configuration Editor.

3.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.

Two Sections of the Process tab.

Figure 3.1. Two Sections of the Process tab.


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.

OptionDescriptionDefault
Add TaskSelect 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

 
DeleteClick this option if you want to delete some task from the section. Note:you can't delete input task because it's required. 
Input MethodsChoose 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

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.

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

Selected Task Details Section for Input XML Task.

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:

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

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

OptionDescriptionDefault
Input typeSelect 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.

    • Quote Character - Quote character.

    • Record Name - Name of csv record element.

    • Root Name - Name of csv root element.

    • 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.

    • Skip Lines - Number of lines to skip before processing starts.

  • EDI

    • Target Profile - Defines the output transformation profile

    • Encoding - The character encoding.

    • 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 output transformation profile

    • Array Element Name - The element name of an array element.

    • Encoding - encoding: The default encoding of any JSON message InputStream processed by this Reader.

    • 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.

    • 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.

    • Root Name - The element name of the document root.

    • 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 - Defines the output transformation 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 DataYou should select a data file using Add and Delete buttons 
Input Model ViewUsing this view you can see the structure of your input file.If the file has been changed, to see the changes click Refreshlink. 

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

Selected Task Details Section for Mapping Task.

Figure 3.7. Selected Task Details Section for Mapping Task.


This graphical editor allows you to perform drag&drop operation with the nodes of transformed 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.

Using the popup menu in the Selected Task Details section you can manage the diagram elements on the canvas.

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

Table 3.3. Popup menu. Selected Task Details section.

OptionDescriptionDefault
AddSelect one of the following tasks:

  • Java Class - adds bean context item to the config file. This option is available when no elements are selected and a user right click the canvas.

  • Expession Binding - adds expression based binding to selected java binding element.

  • Value Binding - adds Value binding (<jb:value>) to the selected java binding element.

  • Bean Binding - adds Wiring binding (<jb:wiring>) to the selected java binding element.

 
UndoBy this option you can revert the changes made at the previous step.  
RedoBy this option you can redo the changes made at the previous step.  
DeleteThis option is available only if you select some element on the canvas. Click this option if you want to delete the element from it.  
Auto LayoutSets the default layout of the elements on the canvas. 
PropertiesClick this option if you want to add Properties view to the current perspective. The just opened Properties view will automatically reflect the properties of the selected diagram element.  
Input MethodsChoose 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

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

Selected Task Details Section for Template Task.

Figure 3.8. Selected Task Details Section for Template Task.


Popup menu similar to the one in Selected Task Details section for Java Mapping Task is also available here.

3.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.

Options tab of the Smooks Configuration File editor

Figure 3.9.  Options tab of the Smooks Configuration File editor


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

Smooks Configuration section of Options tab

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.

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

Filter Settings section of Options tab

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.4. Options Tab. Filter Settings section.

OptionDescriptionDefault
Stream Filter TypeDetermines 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

SAX
Default Serialization is OnDefines 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.false

3.3. Source Tab

This section provides information about Smooks Source Editor Page.

You can use this editor to edit the Smooks Configuration file directly.

Graphical Editor

Figure 3.12. Graphical Editor


If the Smooks tools can't understand the configuration file or the configuration file is illegal (XML structure isn't right for Smooks Configuration file, etc.), the error is underlined.

Graphical Editor

Figure 3.13. Graphical Editor


Smooks configuration file validator will validate your Smooks configuration file. Just right-click on the file and then click on the Validate button. The validator can be enabled/disabled in Window -> Preferences -> Validation:

Validation: Smooks Configuration File Validator

Figure 3.14. Validation: Smooks Configuration File Validator


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:

Smooks Configuration File Validator Settings

Figure 3.15. Smooks Configuration File Validator Settings


For more details about Smooks editor, also see the movie, "Overview of the Smooks Editor".

3.4. Properties View

Properties View is available for some elements on the canvas of Java Mapping and Apply Template Tasks,like:

To add Properties View to the opened perspective the user can either open Window->Show View->Preferences in the toolbar or right click the element which properties he wants to inspect and select Properties in the popup menu.On the picture below you can see how this view looks like when some csv template is selected.

Properties View

Figure 3.16. Properties View


This view is fully syncronized with the canvas of Smooks Configuration Editor. This means that when you change selected element by click,the properties of a new element are immediatly displayed in it. Using Properties View you can edit all the properties of the selected item.

Synchronization between Properties View and the canvas

Figure 3.17. Synchronization between Properties View and the canvas


Smooks tools support decode parameter configuration through the Decode tab in Properties View activated by clicking the connection between input model and bean items.

On the picture below you can see an example of decode configurations for mapping some Input Model Item to Date format:

Decode Configuration tab in Properties View

Figure 3.18. Decode Configuration tab in Properties View


The descriptions of the Decode Configuration tab options are listed in the following table:

Table 3.5. Decode Configuration tab in Properties View

OptionDescription 
DecoderSelect from the dropdown list the type of decoder you need.  
Decoder ParametersFor most of decoders Decoder Parametres table is empty. But some of the decoders require additional configuration (like Date decoder on the picture above),so you should configure them by editing the corresponding line in the Value row. For example for Date Decoder:

  • format - Date format string.

  • locale country - ISO Country Code. Upper case two-letter code defined by ISO-3166.

  • locale language - ISO Language Code. Lower case two-letter code defined by ISO-639.

 

The Decoder Parameters section for EnumDecoder quite differs from other types of decoders. See the picture below:

EnumDecoder in Properties View

Figure 3.19. EnumDecoder in Properties View


The Decoder Parameters section for EnumDecoder in Properties View consists of 2 rows:

  • From Data Value - The lines in this row are editable. You can change them according to the names of enum types you used in input file.

  • To Enum Value - The lines in this row are not editable. Here a set of all constants declared in mapped Enum type is listed. The user is responsible for correspondence between the values in these two rows.

For more information about different decoder parametres read Smooks Technology Documentation.

The Apply Template Wizard helps you to add a new Apply Template Task to Smooks configuration file. You can call it from the popup menu when Java Mapping item in Processing Task section is selected by following Add Task > Apply Template (see Apply Template configuration picture).

The wizard consists of several pages:

  1. The first one includes only one option to adjust.The user should select in which of the two formats(XML or CSV) he prefers to create an output message:

    The first page of Apply Template Wizard

    Figure 3.20. The first page of Apply Template Wizard


  2. The second page is specific for each of the output message formats: