JBoss Tools SVN: r20363 - in trunk/seam/docs/reference/en: images/directory_structure and 1 other directories.
by jbosstools-commits＠lists.jboss.org
Author: smukhina
Date: 2010-02-18 11:58:18 -0500 (Thu, 18 Feb 2010)
New Revision: 20363
Modified:
trunk/seam/docs/reference/en/images/create_new_seam/create_seam_15.png
trunk/seam/docs/reference/en/images/create_new_seam/create_seam_16.png
trunk/seam/docs/reference/en/images/directory_structure/directory_structure_3.png
trunk/seam/docs/reference/en/modules/directory_structure.xml
Log:
JBDS-979 - CDI project facet is added - images are updated
Modified: trunk/seam/docs/reference/en/images/create_new_seam/create_seam_15.png
===================================================================
(Binary files differ)
Modified: trunk/seam/docs/reference/en/images/create_new_seam/create_seam_16.png
===================================================================
(Binary files differ)
Modified: trunk/seam/docs/reference/en/images/directory_structure/directory_structure_3.png
===================================================================
(Binary files differ)
Modified: trunk/seam/docs/reference/en/modules/directory_structure.xml
===================================================================
--- trunk/seam/docs/reference/en/modules/directory_structure.xml 2010-02-18 16:10:47 UTC (rev 20362)
+++ trunk/seam/docs/reference/en/modules/directory_structure.xml 2010-02-18 16:58:18 UTC (rev 20363)
@@ -95,7 +95,7 @@
<title>Changing the Seam Version</title>
<para>To upgrade or downgrade your projects Seam version use the facet preferences. You
- should right-click your project and choose <emphasis>
+ should right-click your project, open its <property>Properties</property> and choose <emphasis>
<property>Project Facets</property>
</emphasis> category. Next select <emphasis>
<property>Seam</property>
14 years, 4 months
- 1
- 0
JBoss Tools SVN: r20362 - in trunk: jsf/tests/org.jboss.tools.jsf.vpe.jsf.test/resources/jsfTest/WebContent/pages/JBIDE/5872 and 3 other directories.
by jbosstools-commits＠lists.jboss.org
Author: yradtsevich
Date: 2010-02-18 11:10:47 -0500 (Thu, 18 Feb 2010)
New Revision: 20362
Added:
trunk/jsf/tests/org.jboss.tools.jsf.vpe.jsf.test/resources/jsfTest/WebContent/pages/JBIDE/5872/
trunk/jsf/tests/org.jboss.tools.jsf.vpe.jsf.test/resources/jsfTest/WebContent/pages/JBIDE/5872/JBIDE-5872.html
trunk/jsf/tests/org.jboss.tools.jsf.vpe.jsf.test/src/org/jboss/tools/jsf/vpe/jsf/test/jbide/EditFontFamilyTest_JBIDE5872.java
Modified:
trunk/jsf/tests/org.jboss.tools.jsf.vpe.jsf.test/src/org/jboss/tools/jsf/vpe/jsf/test/JsfAllTests.java
trunk/vpe/plugins/org.jboss.tools.vpe/src/org/jboss/tools/vpe/editor/toolbar/format/FontNameFormatController.java
Log:
https://jira.jboss.org/jira/browse/JBIDE-5872
VPE throws java.lang.NullPointerException, while editing font-family
- fixed
- JUnit created
Added: trunk/jsf/tests/org.jboss.tools.jsf.vpe.jsf.test/resources/jsfTest/WebContent/pages/JBIDE/5872/JBIDE-5872.html
===================================================================
--- trunk/jsf/tests/org.jboss.tools.jsf.vpe.jsf.test/resources/jsfTest/WebContent/pages/JBIDE/5872/JBIDE-5872.html (rev 0)
+++ trunk/jsf/tests/org.jboss.tools.jsf.vpe.jsf.test/resources/jsfTest/WebContent/pages/JBIDE/5872/JBIDE-5872.html 2010-02-18 16:10:47 UTC (rev 20362)
@@ -0,0 +1,5 @@
+<html>
+<body>
+ <button style='FONT-FAMILY: "serif"'>bla bla</button>
+</body>
+</html>
\ No newline at end of file
Modified: trunk/jsf/tests/org.jboss.tools.jsf.vpe.jsf.test/src/org/jboss/tools/jsf/vpe/jsf/test/JsfAllTests.java
===================================================================
--- trunk/jsf/tests/org.jboss.tools.jsf.vpe.jsf.test/src/org/jboss/tools/jsf/vpe/jsf/test/JsfAllTests.java 2010-02-18 15:38:34 UTC (rev 20361)
+++ trunk/jsf/tests/org.jboss.tools.jsf.vpe.jsf.test/src/org/jboss/tools/jsf/vpe/jsf/test/JsfAllTests.java 2010-02-18 16:10:47 UTC (rev 20362)
@@ -18,6 +18,7 @@
import org.jboss.tools.jsf.vpe.jsf.test.jbide.ChangeMessageBundleTest_JBIDE5818;
import org.jboss.tools.jsf.vpe.jsf.test.jbide.ContextMenuDoubleInsertionTest_JBIDE3888;
+import org.jboss.tools.jsf.vpe.jsf.test.jbide.EditFontFamilyTest_JBIDE5872;
import org.jboss.tools.jsf.vpe.jsf.test.jbide.FacetProcessingTest;
import org.jboss.tools.jsf.vpe.jsf.test.jbide.JBIDE1105Test;
import org.jboss.tools.jsf.vpe.jsf.test.jbide.JBIDE1460Test;
@@ -122,6 +123,7 @@
TestSuite suite = new TestSuite("Tests for Vpe Jsf components"); //$NON-NLS-1$
// $JUnit-BEGIN$
+ suite.addTestSuite(EditFontFamilyTest_JBIDE5872.class);
suite.addTestSuite(ChangeMessageBundleTest_JBIDE5818.class);
suite.addTestSuite(TestForUsingComponentsLibrariesWithDefaultNamespace.class);
suite.addTestSuite(EditingSPecialSymbolsVPE_JBIDE3810.class);
Added: trunk/jsf/tests/org.jboss.tools.jsf.vpe.jsf.test/src/org/jboss/tools/jsf/vpe/jsf/test/jbide/EditFontFamilyTest_JBIDE5872.java
===================================================================
--- trunk/jsf/tests/org.jboss.tools.jsf.vpe.jsf.test/src/org/jboss/tools/jsf/vpe/jsf/test/jbide/EditFontFamilyTest_JBIDE5872.java (rev 0)
+++ trunk/jsf/tests/org.jboss.tools.jsf.vpe.jsf.test/src/org/jboss/tools/jsf/vpe/jsf/test/jbide/EditFontFamilyTest_JBIDE5872.java 2010-02-18 16:10:47 UTC (rev 20362)
@@ -0,0 +1,72 @@
+/*******************************************************************************
+ * Copyright (c) 2007-2009 Red Hat, Inc.
+ * Distributed under license by Red Hat, Inc. All rights reserved.
+ * This program is made available under the terms of the
+ * Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributor:
+ * Red Hat, Inc. - initial API and implementation
+ ******************************************************************************/
+package org.jboss.tools.jsf.vpe.jsf.test.jbide;
+
+import org.eclipse.jface.text.TextViewer;
+import org.eclipse.jface.viewers.ISelectionProvider;
+import org.eclipse.jface.viewers.SelectionChangedEvent;
+import org.eclipse.swt.custom.StyledText;
+import org.eclipse.swt.graphics.Point;
+import org.eclipse.wst.sse.ui.StructuredTextEditor;
+import org.jboss.tools.jsf.vpe.jsf.test.JsfAllTests;
+import org.jboss.tools.vpe.editor.VpeController;
+import org.jboss.tools.vpe.ui.test.TestUtil;
+import org.jboss.tools.vpe.ui.test.VpeTest;
+
+/**
+ * Test for JBIDE-5872: VPE throws java.lang.NullPointerException,
+ * while editing font-family.
+ *
+ * @see <a href="https://jira.jboss.org/jira/browse/JBIDE-5872">JBIDE-5872</a>
+ * @author Yahor Radtsevich (yradtsevich)
+ */
+public class EditFontFamilyTest_JBIDE5872 extends VpeTest {
+ private static final Point EDIT_POSITION = new Point(3, 40);
+ private static final int SELECTION_LENGTH = 1;
+ private static final String TEST_PAGE_NAME = "JBIDE/5872/JBIDE-5872.html";
+
+ public EditFontFamilyTest_JBIDE5872(String name) {
+ super(name);
+ }
+
+ /**
+ * Deletes quote after style attribute. This may lead to NPE.
+ *
+ * @see <a href="https://jira.jboss.org/jira/browse/JBIDE-5872">JBIDE-5872</a>
+ */
+ public void testEditFontFamily() throws Throwable {
+ TestUtil.waitForJobs();
+ setException(null);
+
+ VpeController vpeController
+ = openInVpe(JsfAllTests.IMPORT_PROJECT_NAME, TEST_PAGE_NAME);
+ StructuredTextEditor sourceEditor = vpeController.getSourceEditor();
+ TextViewer textViewer = sourceEditor.getTextViewer();
+ StyledText textWidget = textViewer.getTextWidget();
+
+ int offset = getCaretOffset(textViewer, EDIT_POSITION);
+ textWidget.setSelectionRange(offset, SELECTION_LENGTH);
+ textWidget.insert("");
+ TestUtil.waitForIdle();
+
+ ISelectionProvider selectionProvider = sourceEditor.getSelectionProvider();
+ vpeController.selectionChanged(new SelectionChangedEvent(
+ selectionProvider, selectionProvider.getSelection()));
+
+ if(getException() != null) {
+ throw new Exception(getException());
+ }
+ }
+
+ private static int getCaretOffset(TextViewer textViewer, Point position) {
+ return TestUtil.getLinePositionOffcet(textViewer, position.x, position.y);
+ }
+}
Modified: trunk/vpe/plugins/org.jboss.tools.vpe/src/org/jboss/tools/vpe/editor/toolbar/format/FontNameFormatController.java
===================================================================
--- trunk/vpe/plugins/org.jboss.tools.vpe/src/org/jboss/tools/vpe/editor/toolbar/format/FontNameFormatController.java 2010-02-18 15:38:34 UTC (rev 20361)
+++ trunk/vpe/plugins/org.jboss.tools.vpe/src/org/jboss/tools/vpe/editor/toolbar/format/FontNameFormatController.java 2010-02-18 16:10:47 UTC (rev 20362)
@@ -14,6 +14,7 @@
import org.jboss.tools.vpe.editor.template.textformating.FormatAttributeData;
import org.jboss.tools.vpe.editor.toolbar.format.css.StyleAttribute;
import org.jboss.tools.vpe.editor.toolbar.format.css.StyleProperty;
+import org.jboss.tools.vpe.editor.toolbar.format.css.Token;
import org.w3c.dom.Attr;
/**
@@ -80,33 +81,34 @@
* enabled)
*/
public void setToolbarItemEnabled(boolean enabled) {
- comboBlockFormat.setEnabled(enabled);
- if (enabled) {
- Attr style = getStyleAttributeFromSelectedNode(true);
- if (style != null) {
- StyleAttribute styleAttribute = new StyleAttribute(style);
- StyleProperty fontProperty = styleAttribute
- .getProperty(STYLE_PROPERTY_NAME);
- if (fontProperty != null) {
- String fontName = fontProperty.getPropertyValue()
- .getDirtyValue().trim();
- if (fontName != null) {
- fontName = fontName.replaceAll(REPLACE_VALUE, EMPTY);
- if (getComboBlockFormat().getText().equalsIgnoreCase(
- fontName)) {
- return;
- }
- String[] items = this.getComboBlockFormat().getItems();
- for (int i = 0; i < items.length; i++) {
- if (items[i].equalsIgnoreCase(fontName)) {
- this.getComboBlockFormat().select(i);
- return;
- }
- }
+ comboBlockFormat.setEnabled(enabled);
+ if (enabled) {
+ Attr style = getStyleAttributeFromSelectedNode(true);
+ if (style != null) {
+ StyleAttribute styleAttribute = new StyleAttribute(style);
+ StyleProperty fontProperty
+ = styleAttribute.getProperty(STYLE_PROPERTY_NAME);
+ if (fontProperty != null) {
+ Token fontPropertyValue = fontProperty.getPropertyValue();
+ if (fontPropertyValue != null) {
+ String fontName
+ = fontPropertyValue.getDirtyValue().trim();
+ fontName = fontName.replaceAll(REPLACE_VALUE, EMPTY);
+ if (getComboBlockFormat().getText().equalsIgnoreCase(
+ fontName)) {
+ return;
+ }
+ String[] items = this.getComboBlockFormat().getItems();
+ for (int i = 0; i < items.length; i++) {
+ if (items[i].equalsIgnoreCase(fontName)) {
+ this.getComboBlockFormat().select(i);
+ return;
+ }
+ }
+ }
+ }
}
}
- }
- }
- getComboBlockFormat().select(0);
+ getComboBlockFormat().select(0);
}
-}
\ No newline at end of file
+}
14 years, 4 months
- 1
- 0
JBoss Tools SVN: r20361 - branches/jbosstools-3.1.0.RC2/birt/features/org.jboss.tools.birt.feature.
by jbosstools-commits＠lists.jboss.org
Author: dgolovin
Date: 2010-02-18 10:38:34 -0500 (Thu, 18 Feb 2010)
New Revision: 20361
Modified:
branches/jbosstools-3.1.0.RC2/birt/features/org.jboss.tools.birt.feature/feature.xml
Log:
org.eclipse.birt.integration.wtp.ui should not be packaged into tools.birt feature
Modified: branches/jbosstools-3.1.0.RC2/birt/features/org.jboss.tools.birt.feature/feature.xml
===================================================================
--- branches/jbosstools-3.1.0.RC2/birt/features/org.jboss.tools.birt.feature/feature.xml 2010-02-18 14:44:30 UTC (rev 20360)
+++ branches/jbosstools-3.1.0.RC2/birt/features/org.jboss.tools.birt.feature/feature.xml 2010-02-18 15:38:34 UTC (rev 20361)
@@ -18,12 +18,6 @@
%license
</license>
- <!-- <url>
- <update label="%updateSiteName" url="http://download.jboss.org/jbosstools/updates/stable/galileo/"/>
- </url> -->
- <!-- this is a DEPENDENCY SITE, not a DISCOVERY SITE, so there's no point having it be discovered AFTER the feature's already installed
- <discovery label="Business Intelligence and Reporting Tools (BIRT) Updates" url="http://download.eclipse.org/birt/update-site/2.5/"/>
- -->
<requires>
<import feature="org.eclipse.birt" version="2.3.1"/>
<import feature="org.eclipse.birt.integration.wtp" version="2.3.1"/>
@@ -50,10 +44,4 @@
version="0.0.0"
unpack="false"/>
- <plugin
- id="org.eclipse.birt.integration.wtp.ui"
- download-size="0"
- install-size="0"
- version="0.0.0"/>
-
</feature>
14 years, 4 months
- 1
- 0
JBoss Tools SVN: r20360 - trunk/jsf/tests/org.jboss.tools.jsf.vpe.jsf.test/src/org/jboss/tools/jsf/vpe/jsf/test/jbide.
by jbosstools-commits＠lists.jboss.org
Author: mareshkau
Date: 2010-02-18 09:44:30 -0500 (Thu, 18 Feb 2010)
New Revision: 20360
Modified:
trunk/jsf/tests/org.jboss.tools.jsf.vpe.jsf.test/src/org/jboss/tools/jsf/vpe/jsf/test/jbide/TestFViewLocaleAttribute_JBIDE5218.java
Log:
Unstable JUnit has been fixed, now we have delay fich enough for update job start
Modified: trunk/jsf/tests/org.jboss.tools.jsf.vpe.jsf.test/src/org/jboss/tools/jsf/vpe/jsf/test/jbide/TestFViewLocaleAttribute_JBIDE5218.java
===================================================================
--- trunk/jsf/tests/org.jboss.tools.jsf.vpe.jsf.test/src/org/jboss/tools/jsf/vpe/jsf/test/jbide/TestFViewLocaleAttribute_JBIDE5218.java 2010-02-18 14:40:20 UTC (rev 20359)
+++ trunk/jsf/tests/org.jboss.tools.jsf.vpe.jsf.test/src/org/jboss/tools/jsf/vpe/jsf/test/jbide/TestFViewLocaleAttribute_JBIDE5218.java 2010-02-18 14:44:30 UTC (rev 20360)
@@ -161,6 +161,7 @@
/*
* Wait until new value is applied and children are refreshed.
*/
+ TestUtil.delay(500);
TestUtil.waitForIdle();
assertTrue("Current locale should be 'en_GB'", "en_GB".equalsIgnoreCase(fViewElement.getAttribute("locale"))); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
doc = controller.getXulRunnerEditor().getDOMDocument();
14 years, 4 months
- 1
- 0
JBoss Tools SVN: r20359 - trunk/seam/tests/org.jboss.tools.seam.ui.bot.test/src/org/jboss/tools/seam/ui/bot/test.
by jbosstools-commits＠lists.jboss.org
Author: vpakan(a)redhat.com
Date: 2010-02-18 09:40:20 -0500 (Thu, 18 Feb 2010)
New Revision: 20359
Modified:
trunk/seam/tests/org.jboss.tools.seam.ui.bot.test/src/org/jboss/tools/seam/ui/bot/test/TestControl.java
Log:
Use SWTJBTExt.isServerRuntimeDefined() method.
Modified: trunk/seam/tests/org.jboss.tools.seam.ui.bot.test/src/org/jboss/tools/seam/ui/bot/test/TestControl.java
===================================================================
--- trunk/seam/tests/org.jboss.tools.seam.ui.bot.test/src/org/jboss/tools/seam/ui/bot/test/TestControl.java 2010-02-18 14:38:19 UTC (rev 20358)
+++ trunk/seam/tests/org.jboss.tools.seam.ui.bot.test/src/org/jboss/tools/seam/ui/bot/test/TestControl.java 2010-02-18 14:40:20 UTC (rev 20359)
@@ -6,11 +6,9 @@
import org.eclipse.swtbot.swt.finder.SWTBot;
import org.eclipse.swtbot.swt.finder.waits.Conditions;
import org.eclipse.swtbot.swt.finder.widgets.SWTBotShell;
-import org.eclipse.swtbot.swt.finder.widgets.SWTBotTable;
import org.eclipse.swtbot.swt.finder.widgets.SWTBotTree;
import org.jboss.tools.test.TestProperties;
-import org.jboss.tools.ui.bot.ext.types.IDELabel;
-import org.jboss.tools.ui.bot.ext.types.IDELabel.PreferencesDialog;
+import org.jboss.tools.ui.bot.ext.SWTJBTExt;
import org.jboss.tools.ui.bot.test.JBTSWTBotTestCase;
import org.jboss.tools.ui.bot.test.WidgetVariables;
@@ -130,28 +128,8 @@
/**Creates any Server Runtime + Server. */
protected void createServerRuntime(Properties serverType){
- // Check if server is not already defined
- bot.menu(IDELabel.Menu.WINDOW).menu(IDELabel.Menu.PREFERENCES).click();
- bot.shell(IDELabel.Shell.PREFERENCES).activate();
- bot.tree().expandNode(IDELabel.PreferencesDialog.SERVER_GROUP).select(
- PreferencesDialog.RUNTIME_ENVIRONMENTS);
- SWTBotTable tbRuntimeEnvironments = bot.table();
- boolean createRuntime = true;
- int numRows = tbRuntimeEnvironments.rowCount();
- if (numRows > 0) {
- int currentRow = 0;
- while (createRuntime && currentRow < numRows) {
- if (tbRuntimeEnvironments.cell(currentRow, 0).equalsIgnoreCase(
- serverType.getProperty("runtimeName"))) {
- createRuntime = false;
- } else {
- currentRow++;
- }
- }
- }
- bot.button(IDELabel.Button.OK).click();
-
- if (createRuntime){
+
+ if (SWTJBTExt.isServerRuntimeDefined(bot,serverType.getProperty("runtimeName"))){
bot.menu("File").menu("New").menu("Other...").click();
SWTBotTree tree = bot.tree();
tree.expandNode("Server").select("Server");
@@ -164,6 +142,7 @@
bot.textWithLabel("Home Directory").setText(serverType.getProperty("runtimePath"));
bot.button("Finish").click();
}
+
}
/** Creates any Seam runtime. */
14 years, 4 months
- 1
- 0
JBoss Tools SVN: r20358 - trunk/jst/tests/org.jboss.tools.ui.bot.ext/src/org/jboss/tools/ui/bot/ext.
by jbosstools-commits＠lists.jboss.org
Author: vpakan(a)redhat.com
Date: 2010-02-18 09:38:19 -0500 (Thu, 18 Feb 2010)
New Revision: 20358
Modified:
trunk/jst/tests/org.jboss.tools.ui.bot.ext/src/org/jboss/tools/ui/bot/ext/SWTJBTExt.java
Log:
Added methods testing existence of Server Runtime
Modified: trunk/jst/tests/org.jboss.tools.ui.bot.ext/src/org/jboss/tools/ui/bot/ext/SWTJBTExt.java
===================================================================
--- trunk/jst/tests/org.jboss.tools.ui.bot.ext/src/org/jboss/tools/ui/bot/ext/SWTJBTExt.java 2010-02-18 14:32:40 UTC (rev 20357)
+++ trunk/jst/tests/org.jboss.tools.ui.bot.ext/src/org/jboss/tools/ui/bot/ext/SWTJBTExt.java 2010-02-18 14:38:19 UTC (rev 20358)
@@ -21,11 +21,13 @@
import org.eclipse.swtbot.swt.finder.finders.UIThreadRunnable;
import org.eclipse.swtbot.swt.finder.results.WidgetResult;
import org.eclipse.swtbot.swt.finder.widgets.SWTBotMenu;
+import org.eclipse.swtbot.swt.finder.widgets.SWTBotTable;
import org.eclipse.swtbot.swt.finder.widgets.SWTBotTree;
import org.eclipse.swtbot.swt.finder.widgets.SWTBotTreeItem;
import org.jboss.tools.ui.bot.ext.helper.ContextMenuHelper;
import org.jboss.tools.ui.bot.ext.types.IDELabel;
import org.jboss.tools.ui.bot.ext.types.ViewType;
+import org.jboss.tools.ui.bot.ext.types.IDELabel.PreferencesDialog;
/**
* Provides JBoss Tools common operations based on SWTBot element operations
* @author Vladimir Pakan
@@ -294,5 +296,77 @@
public void addServerToServerViewOnWizardPage (String serverGroup , String serverType){
addServerToServerViewOnWizardPage (bot,serverGroup , serverType);
}
-
+ /**
+ * Returns true if runtimeName Server Runtime is defined
+ * @param runtimeName
+ * @return
+ */
+ public boolean isServerRuntimeDefined(String runtimeName){
+ return SWTJBTExt.isServerRuntimeDefined(bot,runtimeName);
+ }
+
+ /**
+ * Returns true if runtimeName Server Runtime is defined
+ * @param bot
+ * @param runtimeName
+ * @return
+ */
+ public static boolean isServerRuntimeDefined(SWTWorkbenchBot bot,String runtimeName){
+
+ boolean serverRuntimeNotDefined = true;
+
+ bot.menu(IDELabel.Menu.WINDOW).menu(IDELabel.Menu.PREFERENCES).click();
+ bot.shell(IDELabel.Shell.PREFERENCES).activate();
+ bot.tree().expandNode(IDELabel.PreferencesDialog.SERVER_GROUP).select(
+ PreferencesDialog.RUNTIME_ENVIRONMENTS);
+
+ SWTBotTable tbRuntimeEnvironments = bot.table();
+ int numRows = tbRuntimeEnvironments.rowCount();
+ if (numRows > 0) {
+ int currentRow = 0;
+ while (serverRuntimeNotDefined && currentRow < numRows) {
+ if (tbRuntimeEnvironments.cell(currentRow, 0).equalsIgnoreCase(
+ runtimeName)) {
+ serverRuntimeNotDefined = false;
+ } else {
+ currentRow++;
+ }
+ }
+ }
+
+ bot.button(IDELabel.Button.OK).click();
+
+ return !serverRuntimeNotDefined;
+
+ }
+ /**
+ * Returns true if any Server Runtime is defined
+ * @param bot
+ * @return
+ */
+ public static boolean isServerRuntimeDefined(SWTWorkbenchBot bot){
+
+ bot.menu(IDELabel.Menu.WINDOW).menu(IDELabel.Menu.PREFERENCES).click();
+ bot.shell(IDELabel.Shell.PREFERENCES).activate();
+ bot.tree().expandNode(IDELabel.PreferencesDialog.SERVER_GROUP).select(
+ PreferencesDialog.RUNTIME_ENVIRONMENTS);
+ boolean isServerRuntimeDefined = bot.table().rowCount() > 0;
+
+ bot.button(IDELabel.Button.OK).click();
+
+ return isServerRuntimeDefined;
+
+ }
+
+ /**
+ * Returns true if any Server Runtime is defined
+ * @param bot
+ * @return
+ */
+ public boolean isServerRuntimeDefined(){
+
+ return SWTJBTExt.isServerRuntimeDefined(bot);
+
+ }
+
}
14 years, 4 months
- 1
- 0
JBoss Tools SVN: r20357 - in trunk: jst/tests/org.jboss.tools.ui.bot.ext/src/org/jboss/tools/ui/bot/ext and 1 other directory.
by jbosstools-commits＠lists.jboss.org
Author: vpakan(a)redhat.com
Date: 2010-02-18 09:32:40 -0500 (Thu, 18 Feb 2010)
New Revision: 20357
Modified:
trunk/hibernatetools/tests/org.jboss.tools.hibernate.ui.bot.test/src/org/jboss/tools/hibernate/ui/bot/testcase/MappingFileTest.java
trunk/jst/tests/org.jboss.tools.ui.bot.ext/src/org/jboss/tools/ui/bot/ext/SWTBotExt.java
Log:
Replace overriden method editorByTitle() with swtBotEditorExtByTitle()
Modified: trunk/hibernatetools/tests/org.jboss.tools.hibernate.ui.bot.test/src/org/jboss/tools/hibernate/ui/bot/testcase/MappingFileTest.java
===================================================================
--- trunk/hibernatetools/tests/org.jboss.tools.hibernate.ui.bot.test/src/org/jboss/tools/hibernate/ui/bot/testcase/MappingFileTest.java 2010-02-18 11:25:38 UTC (rev 20356)
+++ trunk/hibernatetools/tests/org.jboss.tools.hibernate.ui.bot.test/src/org/jboss/tools/hibernate/ui/bot/testcase/MappingFileTest.java 2010-02-18 14:32:40 UTC (rev 20357)
@@ -112,7 +112,7 @@
pageBot.selectPage("Source");
// Check code completion
- SWTBotEditorExt editor = bot.editorByTitle(Project.CLASS1 + ".hbm.xml");
+ SWTBotEditorExt editor = bot.swtBotEditorExtByTitle(Project.CLASS1 + ".hbm.xml");
String search = "</id>";
List<String> lines = editor.getLines();
Modified: trunk/jst/tests/org.jboss.tools.ui.bot.ext/src/org/jboss/tools/ui/bot/ext/SWTBotExt.java
===================================================================
--- trunk/jst/tests/org.jboss.tools.ui.bot.ext/src/org/jboss/tools/ui/bot/ext/SWTBotExt.java 2010-02-18 11:25:38 UTC (rev 20356)
+++ trunk/jst/tests/org.jboss.tools.ui.bot.ext/src/org/jboss/tools/ui/bot/ext/SWTBotExt.java 2010-02-18 14:32:40 UTC (rev 20357)
@@ -70,8 +70,7 @@
log.info("Table selected");
return super.table();
}
- @Override
- public SWTBotEditorExt editorByTitle(String fileName) {
+ public SWTBotEditorExt swtBotEditorExtByTitle(String fileName) {
SWTBotEditor editor = super.editorByTitle(fileName);
return new SWTBotEditorExt(editor.toTextEditor().getReference(), (SWTWorkbenchBot)this);
}
14 years, 4 months
- 1
- 0
JBoss Tools SVN: r20356 - trunk/bpel/docs/reference/en.
by jbosstools-commits＠lists.jboss.org
Author: ochikvina
Date: 2010-02-18 06:25:38 -0500 (Thu, 18 Feb 2010)
New Revision: 20356
Modified:
trunk/bpel/docs/reference/en/master.xml
trunk/bpel/docs/reference/en/master_output.xml
Log:
<html><head><meta name="qrichtext" content="1" /></head><body style="font-size:9pt;font-family:Sans Serif">
<p>https://jira.jboss.org/jira/browse/JBDS-1104 - Updated versions,corrected master_output file</p>
</body></html>
Modified: trunk/bpel/docs/reference/en/master.xml
===================================================================
--- trunk/bpel/docs/reference/en/master.xml 2010-02-18 11:09:18 UTC (rev 20355)
+++ trunk/bpel/docs/reference/en/master.xml 2010-02-18 11:25:38 UTC (rev 20356)
@@ -28,12 +28,12 @@
<author><firstname>Denny</firstname><surname>Xu</surname><email>dxu(a)redhat.com</email></author>
<author><firstname>Grid</firstname><surname>Qian</surname><email>fqian(a)redhat.com</email></author>
<copyright>
- <year>2009</year>
+ <year>2009</year>
<year>2010</year>
<holder>JBoss by Red Hat</holder>
</copyright>
<releaseinfo>
- Version: 1.0.0.CR1
+ Version: 1.0.0.CR2
</releaseinfo>
<abstract>
<title/>
Modified: trunk/bpel/docs/reference/en/master_output.xml
===================================================================
--- trunk/bpel/docs/reference/en/master_output.xml 2010-02-18 11:09:18 UTC (rev 20355)
+++ trunk/bpel/docs/reference/en/master_output.xml 2010-02-18 11:25:38 UTC (rev 20356)
@@ -8,503 +8,505 @@
<!ENTITY deploy SYSTEM "modules/deploy.xml">
-]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff">
-
- <bookinfo>
- <title>JBoss BPEL User Guide</title>
-
- <corpauthor>
- <inlinemediaobject>
- <imageobject role="fo">
- <imagedata fileref="images/jbosstools_logo.png" format="PNG"></imagedata>
- </imageobject>
- <imageobject role="html">
- <imagedata></imagedata>
- </imageobject>
- </inlinemediaobject>
- </corpauthor>
- <author><firstname>Denny</firstname><surname>Xu</surname><email>dxu(a)redhat.com</email></author>
- <author><firstname>Grid</firstname><surname>Qian</surname><email>fqian(a)redhat.com</email></author>
- <pubdate>August 2009</pubdate>
- <copyright>
- <year>2009</year>
- <holder>JBoss by Red Hat</holder>
- </copyright>
- <releaseinfo><diffmk:wrapper diffmk:change="changed">
- Version: 1.0.0.CR1
- </diffmk:wrapper></releaseinfo>
-<abstract>
- <title></title>
- <para>
- <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/bpel_ref_guide/pdf/B...">PDF version</ulink>
- </para>
-</abstract>
-
-
- </bookinfo>
-
- <toc></toc>
-
-<chapter id="overview" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/bpel/docs/reference/en/modules/overview.xml">
- <title>JBoss BPEL project Overview</title>
-
- <para>JBoss BPEL project is a WS-BPEL 2.0 project that gives a way to create, edit, validate and deploy BPEL files to JBoss BPEL runtime. It is based on Eclipse
- <ulink url="http://www.eclipse.org/bpel/">BPEL
- project </ulink>. </para>
-
- <para>It improves the Eclipse BPEL project in the following way: </para>
- <itemizedlist>
- <listitem><para> Implements close integration with JBoss BPEL runtime. Adds a new project type for the deployment to JBoss BPEL runtime.</para></listitem>
- <listitem><para> Supports two ways of deployment: one way is to deploy a bpel project directly to JBoss BPEL runtime. The other way is to deploy bpel files in JBoss ESB project to JBoss BPEL runtime. </para></listitem>
- <listitem><para> Improves the BPEL validator and increases Eclipse BPEL editor's quality. </para></listitem>
- </itemizedlist>
-
- <para>
- <ulink url="http://docs.oasis-open.org/wsbpel/2.0/OS/wsbpel-v2.0-OS.html">WS-BPEL 2.0</ulink>
- stands for Web Service Business Process Execution Language. Like EAI, BPEL is an XML-based language,
- but BPEL is more specific and targeted. A programmer uses BPEL to join sometimes
- disparate functions into an integrated process, resulting in a seamless use of the Internet to
- conduct business transactions ranging from simple money exchanges to complex calculations and
- asset reallocation.
- </para>
-
-<section>
- <title>Key Features of JBoss BPEL project</title>
- <para>Let's start with looking through the table of the main features of JBoss BPEL editor project: </para>
-
- <table>
-
- <title>Key Functionality for JBoss BPEL editor project</title>
- <tgroup cols="2">
- <colspec align="left" colnum="1" colwidth="2*"></colspec>
- <colspec colnum="2" colwidth="4*"></colspec>
- <thead>
- <row>
- <entry>Feature</entry>
- <entry>Benefit</entry>
-
- </row>
- </thead>
- <tbody>
- <row>
- <entry><para>WS-BPEL 2.0 support</para></entry>
- <entry><para>JBoss BPEL project supports the newest WS-BPEL 2.0 specifications. </para></entry>
- </row>
- <row>
- <entry><para>Close integration with JBoss BPEL runtime</para></entry>
- <entry><para>There are two ways to deploy BPEL files to JBoss BPEL runtime.
- The user can deploy a BPEL project as a whole and can deploy BPEL files in
- JBoss ESB project to JBoss BPEL runtime. </para></entry>
- </row>
- <row>
- <entry><para>BPEL file editor</para></entry>
- <entry><para>The user can use the editor separately to edit a BPEL file. </para></entry>
- </row>
- <row>
- <entry><para>BPEL file validator</para></entry>
- <entry><para>The validator can give the error messages about BPEL files to the user. </para></entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
-</section>
-
-</chapter>
-
-<chapter id="install" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/bpel/docs/reference/en/modules/install.xml">
- <title>Installation JBoss BPEL Tools</title>
- <section id="installeclipse">
- <title>Installation JBoss BPEL editor</title>
- <para>At first, you need Eclipse 3.5. You can get it from <ulink url="http://www.eclipse.org/downloads/download.php?file=/technology/epp/downlo...">Eclipse Web Site</ulink>.
- </para>
- <para>The JBoss BPEL editor is included into JBoss Tools.
- You have some methods to install JBoss Tools.
- See <ulink url="http://www.jboss.org/tools/download/installation.html">Installing JBoss Tools</ulink> for more information.</para>
- <para>If you want to install only the JBoss BPEL editor, you can install it from <ulink url="http://jboss.org/tools/download/dev.html">JBoss Tools</ulink> page separately.
- Please, note, that only JBoss Tools 3.1 or higher version includes JBoss BPEL editor.
- </para>
- </section>
- <section id="installRuntime">
- <title>Installation JBoss BPEL Runtime</title>
- <para>If you want to deploy a BPEL project to JBoss server,
- you should download JBoss BPEL Runtime by yourself. The JBoss BPEL Runtime
- is named RiftSaw. You can get it from <ulink url="http://jboss.org/riftsaw">JBoss RiftSaw page </ulink>.
- </para>
- </section>
-</chapter>
-
-<chapter id="detail" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/bpel/docs/reference/en/modules/detail.xml">
- <title>Creating and editing a BPEL project</title>
- <para>In the chapter we describe the necessary steps to create a new BPEL project and edit the BPEL files.
- First of all, you should create a BPEL project.
- </para>
- <section id="createproject">
- <title>Creating a BPEL project</title>
- <para>Create the project by selecting
- <emphasis><property moreinfo="none">New > Project... > BPEL 2.0 > BPEL Project</property></emphasis> from the menu bar.
- Then click the <property moreinfo="none">Next</property> button.
- </para>
- <figure float="0">
- <title>New BPEL Project</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/detail_createproject_1.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>On this page of the <property moreinfo="none">New BPEL Project Wizard</property> enter a project name in the <property moreinfo="none">Project Name</property>
- field,e.g enter <property moreinfo="none">HelloWorld</property>.</para>
-
- <figure float="0">
- <title>New BPEL Project Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/detail_createproject_2.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Click the <property moreinfo="none">Finish</property> button. So you have created the BPEL project named <property moreinfo="none">HelloWorld</property>. Its structure is like this: </para>
- <figure float="0">
- <title>The BPEL Project structure</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/detail_createproject_3.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
- <section id="createprocess">
- <title>Creating a BPEL process</title>
- <para>Now you should create a BPEL process. You can create it by selecting
- <emphasis><property moreinfo="none">New > Others... > BPEL 2.0 > New BPEL Process File</property></emphasis>.
- </para>
- <figure float="0">
- <title>New BPEL Process File</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/detail_createprocess_1.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Click the <property moreinfo="none">Next</property> button. Enter the following information:</para>
- <table>
-
- <title>Fields and values</title>
- <tgroup cols="2">
- <colspec align="left" colnum="1" colwidth="2*"></colspec>
- <colspec colnum="2" colwidth="4*"></colspec>
- <thead>
- <row>
- <entry>Field</entry>
- <entry>Value</entry>
-
- </row>
- </thead>
- <tbody>
- <row>
- <entry><para>BPEL Process Name</para></entry>
- <entry><para>enter a process name. For example, <property moreinfo="none">HelloWorld</property>.</para></entry>
- </row>
- <row>
- <entry><para>Namespace</para></entry>
- <entry><para>enter or select a namespace for the BPEL process.</para></entry>
- </row>
- <row>
- <entry><para>Template</para></entry>
- <entry><para>select a template for the BPEL process. When you select the template, you will see the information about the template below on the page.</para></entry>
- </row>
-
- </tbody>
- </tgroup>
- </table>
-
- <figure float="0">
- <title>New BPEL Process File Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/detail_createprocess_2.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Click the <property moreinfo="none">Next</property> button. On the second page make sure that the folder <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">HelloWorld/bpelContent</diffmk:wrapper></property> is selected.
- Click <property moreinfo="none">Finish</property>.
- </para>
- <note>
- <para>All of your files that are used in your BPEL project must be under the <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">bpelContent</diffmk:wrapper></property> folder. Only in this case
- these files can be deployed to JBoss server.
- </para>
- </note>
-
- <para>Up to now, you have got a simple BPEL process as on the screen below.</para>
- <figure float="0">
- <title>A simple BPEL Process File</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/detail_createprocess_3.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>The next step, you can do is to edit the BPEL process file and then deploy it to JBoss server. </para>
- </section>
- <section id="editprocess">
- <title>Editing a BPEL process file</title>
- <para>If the <emphasis><property moreinfo="none">Properties view</property></emphasis> and <emphasis><property moreinfo="none">Palette view</property></emphasis> are not opened, you can open the views by right-clicking the BPEL editor and selecting
- <property moreinfo="none">Show in Properties</property>, <property moreinfo="none">Show Palette in Palette view</property>. Then you should have the view like this:
- </para>
- <figure float="0">
- <title>The BPEL editor view</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/detail_editprocess_1.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>In the <emphasis><property moreinfo="none">Palette view</property></emphasis>, you can drag a BPEL element to the BPEL editor and drop it in the place you want.</para>
- <para>In the <emphasis><property moreinfo="none">Properties view</property></emphasis>, you can get the information about every element of the BPEL process.
- In the BPEL editor select any element you want,and then
- the element's properties will be shown in the Properties view.The table below describes the tabs of the Properties view:
- </para>
- <table>
-
- <title>Tabs of the Property view</title>
- <tgroup cols="2">
- <colspec align="left" colnum="1" colwidth="2*"></colspec>
- <colspec colnum="2" colwidth="4*"></colspec>
- <thead>
- <row>
- <entry>Tab</entry>
- <entry>Description</entry>
-
- </row>
- </thead>
- <tbody>
- <row>
- <entry><para>Description</para></entry>
- <entry><para>Shows the descriptive information about the element,e.g. <property moreinfo="none">Name</property> of the element.</para></entry>
- </row>
- <row>
- <entry><para>Details</para></entry>
- <entry><para>Shows the detailed and important information about the element.
- It is the most important section of an element.
- Most of the properties of an element are set in this section.</para></entry>
- </row>
- <row>
- <entry><para>Join Behavior</para></entry>
- <entry><para>Shows the <property moreinfo="none">Join Failure</property> property of the element.</para></entry>
- </row>
- <row>
- <entry><para>Documentation</para></entry>
- <entry><para>Shows the <property moreinfo="none">documentation</property> sub-element of an element.</para></entry>
- </row>
- <row>
- <entry><para>Other</para></entry>
- <entry><para>Every BPEL element has its own sections: Correlation section, Message Exchange section, and so on. We will
- introduce them while using them.</para></entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <para>In order to see how a simple BPEL process works in action, you should do some steps as below: </para>
- <itemizedlist>
- <listitem>
- <para>Add an <property moreinfo="none">Assign</property> element between the <property moreinfo="none">receiveInput</property> element and <property moreinfo="none">replyOutput</property> element.</para>
- </listitem>
- <listitem>
- <para>Click the <property moreinfo="none">Assign</property> element in the BPEL editor in order to get the properties information of it in the Properties view.
- </para>
- </listitem>
- <listitem>
- <para>In the <property moreinfo="none">Details</property> section of Properties view, you should click the <property moreinfo="none">New</property> button to add a <property moreinfo="none">copy</property> sub-element to the element.
- Assign "input->payload->input" to "output->payload->result". At this time, an "<property moreinfo="none">initializer</property>" popup dialog appears. Click on the <property moreinfo="none">Yes</property> button in the dialog.
- </para>
- <figure float="0">
- <title>Add <property moreinfo="none">Assign</property> to the process</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/detail_editprocess_2.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
- <listitem>
- <para>Open the file "<property moreinfo="none">HelloWorldArtifacts.wsdl</property>" in the "<property moreinfo="none">HelloWorld</property>" project by double-clicking the file. Right-click the WSDL editor and select
- <property moreinfo="none">Add Service</property>. A new service should appear in the editor. Name it <property moreinfo="none">HelloWorldProcessService</property>. It has the Port
- named <property moreinfo="none">NewPort</property>. Select it, right-click on it and rename it to <property moreinfo="none">HelloWorldProcessPort</property> in the Properties
- view.
- </para>
- <figure float="0">
- <title>Add <property moreinfo="none">Service</property> to the WSDL file</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/detail_editprocess_3.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
- <listitem>
- <para>Right-click somewhere in the whitespace of the WSDL editor and select
- <property moreinfo="none">Add Binding</property>. A new Binding component will appear in the editor. Name it <property moreinfo="none">HelloWorldSOAPBinding</property>. Select it, in the
- General tab of the Properties view and select <property moreinfo="none">HelloWorld</property> as a port type in the <property moreinfo="none">PortType</property>. Then click on the
- <property moreinfo="none">Generate Binding Content...</property> button to open the <property moreinfo="none">Binding Wizard</property>. In the wizard, select <property moreinfo="none">SOAP </property>
- as the <property moreinfo="none">Protocol</property>. Finally, click the <property moreinfo="none">Finish</property> button to close the wizard.
- </para>
- <figure float="0">
- <title>Add a <property moreinfo="none">Binding</property> to the WSDL file</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/detail_editprocess_4.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
- <listitem>
- <para>Click the <property moreinfo="none">HelloWorldProcessPort</property> property in the General section of the Properties view, select <property moreinfo="none">HelloWorldSOAPBinding</property> in
- the <property moreinfo="none">Binding</property> combobox. In the <property moreinfo="none">Address</property> field input <ulink url="http://localhost:8080/bpel/processes/HelloWorld?wsdl">http://localhost:8080/bpel/processes/HelloWorld?wsdl</ulink>.
- </para>
- <figure float="0">
- <title>Add the <property moreinfo="none">HelloWorldSOAPBinding</property> to the <property moreinfo="none">HelloWorldProcessPort</property></title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/detail_editprocess_5.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
- </itemizedlist>
- <para>Now you have finished creating a simple BPEL process.As a next step, you can deploy the BPEL project to JBoss BPEL Runtime.</para>
-
- </section>
-</chapter>
-
-
-<chapter id="deploy" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/bpel/docs/reference/en/modules/deploy.xml">
- <title>Deploy a JBoss BPEL project to JBoss BPEL Runtime</title>
- <section id="createdeploy">
- <title>Creating a bpel-deploy.xml file</title>
- <para>If you want to deploy a BPEL project to JBoss BPEL Runtime, you should create a bpel-deploy.xml file.
- JBoss tools can help you to create it:
- </para>
- <itemizedlist>
- <listitem>
- <para>Create the bpel-deploy.xml by selecting
- <emphasis><property moreinfo="none">New > Other... > BPEL 2.0 > Apache ODE Deployment Descriptor</property></emphasis>. Click the <property moreinfo="none">Next</property> button.
- </para>
- <figure float="0">
- <title>New BPEL Deploy file</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/deploy_createdeploy_1.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
- <listitem>
- <para>On the next wizard page you should enter the following information:</para>
- <para><emphasis><property moreinfo="none">BPEL Project</property></emphasis>: Click the <property moreinfo="none">Browse...</property> button to select the BPEL project in your workspace which you want to deploy to the runtime.
- Please note, that you should select the <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">bpelContent</diffmk:wrapper></property> folder in your new BPEL project as a value of <property moreinfo="none">BPEL Project</property> field because the bpel-deploy.xml should be created in this place.
- </para>
- <para><emphasis><property moreinfo="none">File name</property></emphasis>: The default value is bpel-deploy.xml. Please, don't change it.</para>
- <para>Click on <property moreinfo="none">Finish</property> button to close the wizard and a new bpel-deploy.xml file will be created.</para>
- <figure float="0">
- <title>New BPEL Deploy file Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/deploy_createdeploy_2.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
- <listitem>
- <para>Double-click the bpel-deploy.xml file to open it in ODE Descriptor Deployment Editor.
- In the <property moreinfo="none">Inbound Interfaces</property> section, click the
- <property moreinfo="none">Associated Port</property> column and select <property moreinfo="none">HelloWorldProcessPort</property>
- in the dropdown box.The <property moreinfo="none">Related Service</property> and <property moreinfo="none">Binding Used</property>
- columns should be automatically filled in. Save the <emphasis><property moreinfo="none">bpel-deploy.xml</property></emphasis>.
- </para>
- <figure float="0">
- <title>bpel-deploy.xml file editor</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/deploy_createdeploy_3.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
- </itemizedlist>
- </section>
- <section id="createruntime">
- <title>Creating JBoss BPEL Server</title>
- <para>Suppose you have installed the <property moreinfo="none">JBoss BPEL Runtime-RiftSaw</property>, now you can create a server for JBoss BPEL runtime.</para>
- <itemizedlist>
- <listitem>
- <para>Open the <property moreinfo="none">JBoss Server view</property> by selecting
- <emphasis><property moreinfo="none">Windows > Show View > Other... > Server > JBoss Server view</property></emphasis>.
- </para>
- </listitem>
- <listitem>
- <para>Right-click the JBoss Server view and select
- <emphasis><property moreinfo="none">New > Server</property></emphasis> to open the New Server Wizard:
- </para>
- <figure float="0">
- <title>New Server Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/deploy_createdeploy_4.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
- <listitem>
- <para>Select <property moreinfo="none">JBoss AS 5.1 </property>as a server type. </para>
- <note>
- <para>Please note, that only JBoss As 5.1 or higher version supports BPEL.</para>
- </note>
- </listitem>
- <listitem>
-
- <para>Click the <property moreinfo="none">Next</property> button. On the next page, you should input your <emphasis><property moreinfo="none">JBoss As</property></emphasis> location. Then click the <property moreinfo="none">Next</property> button and
- you will get the page like this:
- </para>
- <figure float="0">
- <title>Add resource to the server</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/deploy_createdeploy_5.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
- <listitem>
- <para>Select <property moreinfo="none">HelloWorld</property>, then click the <property moreinfo="none">Add </property> button to add the project to the server.
- Then click on the <property moreinfo="none">Finish</property> button.
- </para>
- <para>Start the server by right-clicking on the server and selecting the <property moreinfo="none">Start</property> item. </para>
-
- <figure float="0">
- <title>The started server</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/deploy_createdeploy_6.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>If some aspects of server creation is not clear, please, read <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/as/html_single/index...">JBoss Server Manager Reference Guide</ulink> for more details.</para>
- </listitem>
- <listitem>
- <para>You can enter the link <ulink url="http://localhost:8080/bpel/processes.html">http://localhost:8080/bpel/processes.html</ulink> to the browser to get the deployed processes.</para>
- <figure float="0">
- <title>The BPEL console</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/deploy_createdeploy_7.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
- </itemizedlist>
- <para>If there's anything we didn't cover or you can't figure out, please feel free to visit our <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss Tools Users Forum</ulink> to ask questions.
- There we are also waiting for your suggestions and comments.</para>
- </section>
-</chapter>
-</book>
+]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff">
+
+ <bookinfo>
+ <title>JBoss BPEL User Guide</title>
+
+ <corpauthor>
+ <inlinemediaobject>
+ <imageobject role="fo">
+ <imagedata fileref="images/jbosstools_logo.png" format="PNG"></imagedata>
+ </imageobject>
+ <imageobject role="html">
+ <imagedata></imagedata>
+ </imageobject>
+ </inlinemediaobject>
+ </corpauthor>
+ <author><firstname>Denny</firstname><surname>Xu</surname><email>dxu(a)redhat.com</email></author>
+ <author><firstname>Grid</firstname><surname>Qian</surname><email>fqian(a)redhat.com</email></author>
+ <copyright>
+ <year>2009</year>
+ <year diffmk:change="added"><diffmk:wrapper diffmk:change="added">2010</diffmk:wrapper></year>
+ <holder>JBoss by Red Hat</holder>
+ </copyright>
+ <releaseinfo><diffmk:wrapper diffmk:change="changed">
+ Version: 1.0.0.CR2
+ </diffmk:wrapper></releaseinfo>
+<abstract>
+ <title></title>
+ <para>
+ <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/bpel_ref_guide/pdf/B...">PDF version</ulink>
+ </para>
+</abstract>
+
+
+ </bookinfo>
+
+ <toc></toc>
+
+<chapter id="overview" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/bpel/docs/reference/en/modules/overview.xml">
+ <title>JBoss BPEL project Overview</title>
+
+ <para>JBoss BPEL project is a WS-BPEL 2.0 project that gives a way to create, edit, validate and deploy BPEL files to JBoss BPEL runtime. It is based on Eclipse
+ <ulink url="http://www.eclipse.org/bpel/">BPEL
+ project </ulink>. </para>
+
+ <para>It improves the Eclipse BPEL project in the following way: </para>
+ <itemizedlist>
+ <listitem><para> Implements close integration with JBoss BPEL runtime. Adds a new project type for the deployment to JBoss BPEL runtime.</para></listitem>
+ <listitem><para> Supports two ways of deployment: one way is to deploy a bpel project directly to JBoss BPEL runtime. The other way is to deploy bpel files in JBoss ESB project to JBoss BPEL runtime. </para></listitem>
+ <listitem><para> Improves the BPEL validator and increases Eclipse BPEL editor's quality. </para></listitem>
+ </itemizedlist>
+
+ <para>
+ <ulink url="http://docs.oasis-open.org/wsbpel/2.0/OS/wsbpel-v2.0-OS.html">WS-BPEL 2.0</ulink>
+ stands for Web Service Business Process Execution Language. Like EAI, BPEL is an XML-based language,
+ but BPEL is more specific and targeted. A programmer uses BPEL to join sometimes
+ disparate functions into an integrated process, resulting in a seamless use of the Internet to
+ conduct business transactions ranging from simple money exchanges to complex calculations and
+ asset reallocation.
+ </para>
+
+<section>
+ <title>Key Features of JBoss BPEL project</title>
+ <para>Let's start with looking through the table of the main features of JBoss BPEL editor project: </para>
+
+ <table>
+
+ <title>Key Functionality for JBoss BPEL editor project</title>
+ <tgroup cols="2">
+ <colspec align="left" colnum="1" colwidth="2*"></colspec>
+ <colspec colnum="2" colwidth="4*"></colspec>
+ <thead>
+ <row>
+ <entry>Feature</entry>
+ <entry>Benefit</entry>
+
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><para>WS-BPEL 2.0 support</para></entry>
+ <entry><para>JBoss BPEL project supports the newest WS-BPEL 2.0 specifications. </para></entry>
+ </row>
+ <row>
+ <entry><para>Close integration with JBoss BPEL runtime</para></entry>
+ <entry><para>There are two ways to deploy BPEL files to JBoss BPEL runtime.
+ The user can deploy a BPEL project as a whole and can deploy BPEL files in
+ JBoss ESB project to JBoss BPEL runtime. </para></entry>
+ </row>
+ <row>
+ <entry><para>BPEL file editor</para></entry>
+ <entry><para>The user can use the editor separately to edit a BPEL file. </para></entry>
+ </row>
+ <row>
+ <entry><para>BPEL file validator</para></entry>
+ <entry><para>The validator can give the error messages about BPEL files to the user. </para></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+</section>
+
+</chapter>
+
+<chapter id="install" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/bpel/docs/reference/en/modules/install.xml">
+ <title>Installation JBoss BPEL Tools</title>
+ <section id="installeclipse">
+ <title>Installation JBoss BPEL editor</title>
+ <para>At first, you need Eclipse 3.5. You can get it from <ulink url="http://www.eclipse.org/downloads/download.php?file=/technology/epp/downlo...">Eclipse Web Site</ulink>.
+ </para>
+ <para>The JBoss BPEL editor is included into JBoss Tools.
+ You have some methods to install JBoss Tools.
+ See <ulink url="http://www.jboss.org/tools/download/installation.html">Installing JBoss Tools</ulink> for more information.</para>
+ <para>If you want to install only the JBoss BPEL editor, you can install it from <ulink url="http://jboss.org/tools/download/dev.html">JBoss Tools</ulink> page separately.
+ Please, note, that only JBoss Tools 3.1 or higher version includes JBoss BPEL editor.
+ </para>
+ </section>
+ <section id="installRuntime">
+ <title>Installation JBoss BPEL Runtime</title>
+ <para>If you want to deploy a BPEL project to JBoss server,
+ you should download JBoss BPEL Runtime by yourself. The JBoss BPEL Runtime
+ is named RiftSaw. You can get it from <ulink url="http://jboss.org/riftsaw">JBoss RiftSaw page </ulink>.
+ </para>
+ </section>
+</chapter>
+
+<chapter id="detail" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/bpel/docs/reference/en/modules/detail.xml">
+ <title>Creating and editing a BPEL project</title>
+ <para>In the chapter we describe the necessary steps to create a new BPEL project and edit the BPEL files.
+ First of all, you should create a BPEL project.
+ </para>
+ <section id="createproject">
+ <title>Creating a BPEL project</title>
+ <para>Create the project by selecting
+ <emphasis><property moreinfo="none">New > Project... > BPEL 2.0 > BPEL Project</property></emphasis> from the menu bar.
+ Then click the <property moreinfo="none">Next</property> button.
+ </para>
+ <figure float="0">
+ <title>New BPEL Project</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/detail_createproject_1.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>On this page of the <property moreinfo="none">New BPEL Project Wizard</property> enter a project name in the <property moreinfo="none">Project Name</property>
+ field,e.g enter <property moreinfo="none">HelloWorld</property>.</para>
+
+ <figure float="0">
+ <title>New BPEL Project Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/detail_createproject_2.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Click the <property moreinfo="none">Finish</property> button. So you have created the BPEL project named <property moreinfo="none">HelloWorld</property>. Its structure is like this: </para>
+ <figure float="0">
+ <title>The BPEL Project structure</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/detail_createproject_3.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+ <section id="createprocess">
+ <title>Creating a BPEL process</title>
+ <para>Now you should create a BPEL process. You can create it by selecting
+ <emphasis><property moreinfo="none">New > Others... > BPEL 2.0 > New BPEL Process File</property></emphasis>.
+ </para>
+ <figure float="0">
+ <title>New BPEL Process File</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/detail_createprocess_1.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Click the <property moreinfo="none">Next</property> button. Enter the following information:</para>
+ <table>
+
+ <title>Fields and values</title>
+ <tgroup cols="2">
+ <colspec align="left" colnum="1" colwidth="2*"></colspec>
+ <colspec colnum="2" colwidth="4*"></colspec>
+ <thead>
+ <row>
+ <entry>Field</entry>
+ <entry>Value</entry>
+
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><para>BPEL Process Name</para></entry>
+ <entry><para>enter a process name. For example, <property moreinfo="none">HelloWorld</property>.</para></entry>
+ </row>
+ <row>
+ <entry><para>Namespace</para></entry>
+ <entry><para>enter or select a namespace for the BPEL process.</para></entry>
+ </row>
+ <row>
+ <entry><para>Template</para></entry>
+ <entry><para>select a template for the BPEL process. When you select the template, you will see the information about the template below on the page.</para></entry>
+ </row>
+
+ </tbody>
+ </tgroup>
+ </table>
+
+ <figure float="0">
+ <title>New BPEL Process File Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/detail_createprocess_2.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Click the <property moreinfo="none">Next</property> button. On the second page make sure that the folder <property moreinfo="none">HelloWorld/bpelContent</property> is selected.
+ Click <property moreinfo="none">Finish</property>.
+ </para>
+ <note>
+ <para>All of your files that are used in your BPEL project must be under the <property moreinfo="none">bpelContent</property> folder. Only in this case
+ these files can be deployed to JBoss server.
+ </para>
+ </note>
+
+ <para>Up to now, you have got a simple BPEL process as on the screen below.</para>
+ <figure float="0">
+ <title>A simple BPEL Process File</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/detail_createprocess_3.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>The next step, you can do is to edit the BPEL process file and then deploy it to JBoss server. </para>
+ </section>
+ <section id="editprocess">
+ <title>Editing a BPEL process file</title>
+ <para>If the <emphasis><property moreinfo="none">Properties view</property></emphasis> and <emphasis><property moreinfo="none">Palette view</property></emphasis> are not opened, you can open the views by right-clicking the BPEL editor and selecting
+ <property moreinfo="none">Show in Properties</property>, <property moreinfo="none">Show Palette in Palette view</property>. Then you should have the view like this:
+ </para>
+ <figure float="0">
+ <title>The BPEL editor view</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/detail_editprocess_1.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>In the <emphasis><property moreinfo="none">Palette view</property></emphasis>, you can drag a BPEL element to the BPEL editor and drop it in the place you want.</para>
+ <para>In the <emphasis><property moreinfo="none">Properties view</property></emphasis>, you can get the information about every element of the BPEL process.
+ In the BPEL editor select any element you want,and then
+ the element's properties will be shown in the Properties view.The table below describes the tabs of the Properties view:
+ </para>
+ <table>
+
+ <title>Tabs of the Property view</title>
+ <tgroup cols="2">
+ <colspec align="left" colnum="1" colwidth="2*"></colspec>
+ <colspec colnum="2" colwidth="4*"></colspec>
+ <thead>
+ <row>
+ <entry>Tab</entry>
+ <entry>Description</entry>
+
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><para>Description</para></entry>
+ <entry><para>Shows the descriptive information about the element,e.g. <property moreinfo="none">Name</property> of the element.</para></entry>
+ </row>
+ <row>
+ <entry><para>Details</para></entry>
+ <entry><para>Shows the detailed and important information about the element.
+ It is the most important section of an element.
+ Most of the properties of an element are set in this section.</para></entry>
+ </row>
+ <row>
+ <entry><para>Join Behavior</para></entry>
+ <entry><para>Shows the <property moreinfo="none">Join Failure</property> property of the element.</para></entry>
+ </row>
+ <row>
+ <entry><para>Documentation</para></entry>
+ <entry><para>Shows the <property moreinfo="none">documentation</property> sub-element of an element.</para></entry>
+ </row>
+ <row>
+ <entry><para>Other</para></entry>
+ <entry><para>Every BPEL element has its own sections: Correlation section, Message Exchange section, and so on. We will
+ introduce them while using them.</para></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ <para>In order to see how a simple BPEL process works in action, you should do some steps as below: </para>
+ <itemizedlist>
+ <listitem>
+ <para>Add an <property moreinfo="none">Assign</property> element between the <property moreinfo="none">receiveInput</property> element and <property moreinfo="none">replyOutput</property> element.</para>
+ </listitem>
+ <listitem>
+ <para>Click the <property moreinfo="none">Assign</property> element in the BPEL editor in order to get the properties information of it in the Properties view.
+ </para>
+ </listitem>
+ <listitem>
+ <para>In the <property moreinfo="none">Details</property> section of Properties view, you should click the <property moreinfo="none">New</property> button to add a <property moreinfo="none">copy</property> sub-element to the element.
+ Assign "input->payload->input" to "output->payload->result". At this time, an "<property moreinfo="none">initializer</property>" popup dialog appears. Click on the <property moreinfo="none">Yes</property> button in the dialog.
+ </para>
+ <figure float="0">
+ <title>Add <property moreinfo="none">Assign</property> to the process</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/detail_editprocess_2.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+ <listitem>
+ <para>Open the file "<property moreinfo="none">HelloWorldArtifacts.wsdl</property>" in the "<property moreinfo="none">HelloWorld</property>" project by double-clicking the file. Right-click the WSDL editor and select
+ <property moreinfo="none">Add Service</property>. A new service should appear in the editor. Name it <property moreinfo="none">HelloWorldProcessService</property>. It has the Port
+ named <property moreinfo="none">NewPort</property>. Select it, right-click on it and rename it to <property moreinfo="none">HelloWorldProcessPort</property> in the Properties
+ view.
+ </para>
+ <figure float="0">
+ <title>Add <property moreinfo="none">Service</property> to the WSDL file</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/detail_editprocess_3.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+ <listitem>
+ <para>Right-click somewhere in the whitespace of the WSDL editor and select
+ <property moreinfo="none">Add Binding</property>. A new Binding component will appear in the editor. Name it <property moreinfo="none">HelloWorldSOAPBinding</property>. Select it, in the
+ General tab of the Properties view and select <property moreinfo="none">HelloWorld</property> as a port type in the <property moreinfo="none">PortType</property>. Then click on the
+ <property moreinfo="none">Generate Binding Content...</property> button to open the <property moreinfo="none">Binding Wizard</property>. In the wizard, select <property moreinfo="none">SOAP </property>
+ as the <property moreinfo="none">Protocol</property>. Finally, click the <property moreinfo="none">Finish</property> button to close the wizard.
+ </para>
+ <figure float="0">
+ <title>Add a <property moreinfo="none">Binding</property> to the WSDL file</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/detail_editprocess_4.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+ <listitem>
+ <para>Click the <property moreinfo="none">HelloWorldProcessPort</property> property in the General section of the Properties view, select <property moreinfo="none">HelloWorldSOAPBinding</property> in
+ the <property moreinfo="none">Binding</property> combobox. In the <property moreinfo="none">Address</property> field input <ulink url="http://localhost:8080/bpel/processes/HelloWorld?wsdl">http://localhost:8080/bpel/processes/HelloWorld?wsdl</ulink>.
+ </para>
+ <figure float="0">
+ <title>Add the <property moreinfo="none">HelloWorldSOAPBinding</property> to the <property moreinfo="none">HelloWorldProcessPort</property></title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/detail_editprocess_5.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+ </itemizedlist>
+ <para>Now you have finished creating a simple BPEL process.As a next step, you can deploy the BPEL project to JBoss BPEL Runtime.</para>
+
+ </section>
+</chapter>
+
+
+<chapter id="deploy" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/bpel/docs/reference/en/modules/deploy.xml">
+ <title>Deploy a JBoss BPEL project to JBoss BPEL Runtime</title>
+ <section id="createdeploy">
+ <title>Creating a bpel-deploy.xml file</title>
+ <para>If you want to deploy a BPEL project to JBoss BPEL Runtime, you should create a bpel-deploy.xml file.
+ JBoss tools can help you to create it:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>Create the bpel-deploy.xml by selecting
+ <emphasis><property moreinfo="none">New > Other... > BPEL 2.0 > Apache ODE Deployment Descriptor</property></emphasis>. Click the <property moreinfo="none">Next</property> button.
+ </para>
+ <figure float="0">
+ <title>New BPEL Deploy file</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/deploy_createdeploy_1.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+ <listitem>
+ <para>On the next wizard page you should enter the following information:</para>
+ <para><emphasis><property moreinfo="none">BPEL Project</property></emphasis>: Click the <property moreinfo="none">Browse...</property> button to select the BPEL project in your workspace which you want to deploy to the runtime.
+ Please note, that you should select the <property moreinfo="none">bpelContent</property> folder in your new BPEL project as a value of <property moreinfo="none">BPEL Project</property> field because the bpel-deploy.xml should be created in this place.
+ </para>
+ <para><emphasis><property moreinfo="none">File name</property></emphasis>: The default value is bpel-deploy.xml. Please, don't change it.</para>
+ <para>Click on <property moreinfo="none">Finish</property> button to close the wizard and a new bpel-deploy.xml file will be created.</para>
+ <figure float="0">
+ <title>New BPEL Deploy file Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/deploy_createdeploy_2.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+ <listitem>
+ <para>Double-click the bpel-deploy.xml file to open it in ODE Descriptor Deployment Editor.
+ In the <property moreinfo="none">Inbound Interfaces</property> section, click the
+ <property moreinfo="none">Associated Port</property> column and select <property moreinfo="none">HelloWorldProcessPort</property>
+ in the dropdown box.The <property moreinfo="none">Related Service</property> and <property moreinfo="none">Binding Used</property>
+ columns should be automatically filled in. Save the <emphasis><property moreinfo="none">bpel-deploy.xml</property></emphasis>.
+ </para>
+ <figure float="0">
+ <title>bpel-deploy.xml file editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/deploy_createdeploy_3.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+ </itemizedlist>
+ </section>
+ <section id="createruntime">
+ <title>Creating JBoss BPEL Server</title>
+ <para>Suppose you have installed the <property moreinfo="none">JBoss BPEL Runtime-RiftSaw</property>, now you can create a server for JBoss BPEL runtime.</para>
+ <itemizedlist>
+ <listitem>
+ <para>Open the <property moreinfo="none">JBoss Server view</property> by selecting
+ <emphasis><property moreinfo="none">Windows > Show View > Other... > Server > JBoss Server view</property></emphasis>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>Right-click the JBoss Server view and select
+ <emphasis><property moreinfo="none">New > Server</property></emphasis> to open the New Server Wizard:
+ </para>
+ <figure float="0">
+ <title>New Server Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/deploy_createdeploy_4.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+ <listitem>
+ <para>Select <property moreinfo="none">JBoss AS 5.1 </property>as a server type. </para>
+ <note>
+ <para>Please note, that only JBoss As 5.1 or higher version supports BPEL.</para>
+ </note>
+ </listitem>
+ <listitem>
+
+ <para>Click the <property moreinfo="none">Next</property> button. On the next page, you should input your <emphasis><property moreinfo="none">JBoss As</property></emphasis> location. Then click the <property moreinfo="none">Next</property> button and
+ you will get the page like this:
+ </para>
+ <figure float="0">
+ <title>Add resource to the server</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/deploy_createdeploy_5.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+ <listitem>
+ <para>Select <property moreinfo="none">HelloWorld</property>, then click the <property moreinfo="none">Add </property> button to add the project to the server.
+ Then click on the <property moreinfo="none">Finish</property> button.
+ </para>
+ <para>Start the server by right-clicking on the server and selecting the <property moreinfo="none">Start</property> item. </para>
+
+ <figure float="0">
+ <title>The started server</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/deploy_createdeploy_6.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>If some aspects of server creation is not clear, please, read <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/as/html_single/index...">JBoss Server Manager Reference Guide</ulink> for more details.</para>
+ </listitem>
+ <listitem>
+ <para>You can enter the link <ulink url="http://localhost:8080/bpel/processes.html">http://localhost:8080/bpel/processes.html</ulink> to the browser to get the deployed processes.</para>
+ <figure float="0">
+ <title>The BPEL console</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/deploy_createdeploy_7.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+ </itemizedlist>
+ <para>If there's anything we didn't cover or you can't figure out, please feel free to visit our <ulink
+ url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201"
+ >JBoss Tools Users Forum</ulink> to ask questions.
+ There we are also waiting for your suggestions and comments.</para>
+ </section>
+</chapter>
+</book>
14 years, 4 months
- 1
- 0
JBoss Tools SVN: r20355 - trunk/smooks/docs/reference/en.
by jbosstools-commits＠lists.jboss.org
Author: ochikvina
Date: 2010-02-18 06:09:18 -0500 (Thu, 18 Feb 2010)
New Revision: 20355
Modified:
trunk/smooks/docs/reference/en/master.xml
trunk/smooks/docs/reference/en/master_output.xml
Log:
<html><head><meta name="qrichtext" content="1" /></head><body style="font-size:9pt;font-family:Sans Serif">
<p>https://jira.jboss.org/jira/browse/JBDS-1104 - Updated versions,corrected master_output file</p>
</body></html>
Modified: trunk/smooks/docs/reference/en/master.xml
===================================================================
--- trunk/smooks/docs/reference/en/master.xml 2010-02-18 10:35:18 UTC (rev 20354)
+++ trunk/smooks/docs/reference/en/master.xml 2010-02-18 11:09:18 UTC (rev 20355)
@@ -32,11 +32,11 @@
<holder>JBoss by Red Hat</holder>
</copyright>
<releaseinfo>
- Version: 1.1.0.M2
+ Version: 1.1.0.CR2
</releaseinfo>
<abstract>
- <title />
+ <title/>
<para>
<ulink
url="http://download.jboss.org/jbosstools/nightly-docs/en/smooks/pdf/Smooks_Re...">PDF version</ulink>
Modified: trunk/smooks/docs/reference/en/master_output.xml
===================================================================
--- trunk/smooks/docs/reference/en/master_output.xml 2010-02-18 10:35:18 UTC (rev 20354)
+++ trunk/smooks/docs/reference/en/master_output.xml 2010-02-18 11:09:18 UTC (rev 20355)
@@ -3,1130 +3,933 @@
"http://www.docbook.org/xml/4.3/docbookx.dtd"
[
-<!ENTITY introduction SYSTEM "modules/introduction.xml">
-<!ENTITY quickstart SYSTEM "modules/quick_start.xml">
-<!ENTITY smooksformeditor_graphicaltab SYSTEM "modules/smooksformeditor_graphicalpage.xml">
-<!ENTITY smooksformeditor_configurationtab SYSTEM "modules/smooksformeditor_configurationpage.xml">
-<!ENTITY smooksformeditor_sourcetab SYSTEM "modules/smooksformeditor_sourcepage.xml">
-]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff">
-
- <bookinfo>
-
- <title>Smooks Dev Tools Reference Guide</title>
- <corpauthor>
- <inlinemediaobject>
- <imageobject role="fo">
- <imagedata fileref="images/jbosstools_logo.png" format="PNG"></imagedata>
- </imageobject>
- <imageobject role="html">
- <imagedata></imagedata>
- </imageobject>
- </inlinemediaobject>
- </corpauthor>
- <author>
- <firstname>Xue(Dart)</firstname>
- <surname>Peng</surname>
- </author>
-
- <pubdate>November 2008</pubdate>
- <copyright>
- <year>2009</year>
- <holder>JBoss by Red Hat</holder>
- </copyright>
- <releaseinfo><diffmk:wrapper diffmk:change="changed">
- Version: 1.1.0.CR1
- </diffmk:wrapper></releaseinfo>
-
- <abstract>
- <title></title>
- <para>
- <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/smooks/pdf/Smooks_Re...">PDF version</ulink>
- </para>
- </abstract>
-
-
- </bookinfo>
- <toc></toc>
-
-<chapter id="introduction" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/smooks/docs/reference/en/modules/introduction.xml">
- <?dbhtml filename="introduction.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Tools</keyword>
- <keyword>Smooks</keyword>
- <keyword>JBDS</keyword>
- </keywordset>
- </chapterinfo>
- <title>Introduction</title>
- <para>This chapter gives you a short introduction to Smooks, Smooks tools and its installation.</para>
- <para>First, have a look at the key features of Smooks tools:</para>
- <section>
- <title>Key Features of Smooks Tools</title>
- <para>Here, we provide you with a key functionality which is integrated in Smooks tools.</para>
- <table>
-
- <title>Key Functionality for Smooks Tools</title>
- <tgroup cols="3">
-
- <colspec align="left" colnum="1" colwidth="2*"></colspec>
- <colspec colnum="2" colwidth="4*"></colspec>
- <colspec align="left" colnum="3" colwidth="2*"></colspec>
-
- <thead>
- <row>
- <entry>Feature</entry>
- <entry>Benefit</entry>
- <entry>Chapter</entry>
- </row>
- </thead>
-
- <tbody>
-
- <row>
- <entry><para>Smooks Configuration File Wizard</para></entry>
- <entry><para>Smooks tools allows to create/edit the Smooks configuration file for Java2Java data transformation.</para></entry>
- <entry>
- <link linkend="config_file_wizzard">Smooks Configuration File Wizard</link>
- </entry>
- </row>
-
- <row>
- <entry><para>Smooks Editor</para></entry>
- <entry><para>Smooks Editor helps configure the created Smooks configuration file.</para></entry>
- <entry>
- <link linkend="quickstart_formeditor">Smooks Editor</link>
- </entry>
- </row>
-
- </tbody>
-
- </tgroup>
- </table>
-
-
-
- </section>
-
-
-
- <section>
- <title>What is Smooks?</title>
-
- <para><property moreinfo="none">Smooks</property> is a Java Framework/Engine for processing XML and non XML
- data (CSV, EDI, Java, JSON etc).</para>
- <para></para>
- <para>
- <orderedlist continuation="restarts" inheritnum="inherit" numeration="upperroman">
- <listitem>
- <para><emphasis role="bold">Transformation</emphasis>: Perform a wide range of
- Data Transforms. Supports many different Source and Result types
- -XML/CSV/EDI/Java/JSON to XML/CSV/EDI/Java/JSON.</para>
- </listitem>
- <listitem>
- <para><emphasis role="bold">Java Binding</emphasis>: Bind into a Java Object
- Model from any data source (CSV, EDI, XML, Java, JSON etc). </para>
- </listitem>
-
- <listitem>
- <para><emphasis role="bold">Huge Message Processing</emphasis>: Process huge
- messages (GBs) - Split, Transform and Route message fragments to JMS, File,
- Database etc destinations. Route multiple message formats to multiple
- destinations in a single pass over a message. </para>
- </listitem>
-
- <listitem>
- <para><emphasis role="bold">Message Enrichment</emphasis>: Enrich a message with
- data from a Database, or other Datasources. </para>
- </listitem>
-
- <listitem>
- <para><emphasis role="bold">Combine</emphasis>: Combine the above features in
- different ways e.g. add Message Enrichment as part of a Splitting and
- Routing process. </para>
- </listitem>
- </orderedlist>
- </para>
- <figure float="0">
- <title>Smooks</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/introduction/introduction1.png" scale="90"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para> For More informations about <property moreinfo="none">Smooks</property>, please visit <ulink url="http://www.smooks.org">Smooks official site</ulink>.</para>
- </section>
- <section>
- <title>What is Smooks Tools?</title>
-
- <para>Smooks tools is a set of graphical tools for editing Smooks configuration file
- based on Eclipse.</para>
- <figure float="0">
- <title>Smooks Form editor</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/introduction/introduction2.png" scale="90"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
- <section>
- <title>How to install Smooks dev tools?</title>
-
- <para> The Smooks tools was included by the <property moreinfo="none">JBoss Tools</property> since 3.0.0
- Beta1 version. You can download the <property moreinfo="none">JBoss Tools</property> from <ulink url="http://jboss.org/tools/download.html">JBoss download site</ulink>.</para>
- <para> Smooks tools (<property moreinfo="none">JBoss Tools</property>) run with the latest Eclipse and
- other required plug-ins (GEF, EMF, etc.).</para>
- <para> You should download the latest IDE for Java EE developers from <ulink url="http://www.eclipse.org/downloads/"> Eclipse site</ulink>. It contains many plug-ins (
- GEF, EMF, etc. ) required by Smooks dev tools. </para>
-
- <para>Now let's progress to more advanced topics.</para>
- </section>
-
-</chapter>
-
-
-<chapter id="quickstart" role="updated" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/smooks/docs/reference/en/modules/quick_start.xml" xreflabel="Quick Start">
- <?dbhtml filename="quick_start.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Tools</keyword>
- <keyword>Smooks</keyword>
- <keyword>JBDS</keyword>
- <keyword>java</keyword>
- </keywordset>
- </chapterinfo>
- <title>Quick Start</title>
- <para> This "Quick Start" will show how to use the <property moreinfo="none">Smooks tools</property> to create/edit the Smooks
- configuration file for Java2Java data transformation.</para>
- <para> This chapter gives you a brief understanding of the <property moreinfo="none">Smooks tools</property>.</para>
- <section>
- <title>Download Smooks Java-to-Java Example</title>
- <para> Visit <ulink url="http://www.blogjava.net/Files/reloadcn/smooks_java_java.zip">smooks examples page</ulink> to download the "java-to-java" example project. </para>
- <tip>
- <title>Tip:</title>
-
- <para> The example project is based on Maven, we suggest you to create a new eclipse
- Java project, copy the example code and .jar files from the example project and paste
- them into the eclipse Java project. </para>
- </tip>
- </section>
- <section>
- <title>Mapping rules</title>
- <para>At the begining of working with Smooks tools,
- we need to understand the Java-to-Java mapping rules of this example.
- The transform input Java class is <emphasis><property moreinfo="none">example.sourcemodel.Order</property></emphasis> , its structure looks like this :
- </para>
- <figure float="0">
- <title>Order class</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/sourcemodel_structured.jpg"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Let's describe the structure of <emphasis><property moreinfo="none">example.sourcemodel.Order</property></emphasis> in short:</para>
- <itemizedlist>
- <listitem><para>Order class contains a <property moreinfo="none">Header</property> class and a <property moreinfo="none">List</property> class.</para></listitem>
- <listitem><para>The <property moreinfo="none">Header</property> class has <property moreinfo="none">customerName</property>,<property moreinfo="none">customerNumber</property>,<property moreinfo="none">priority</property> as properties.</para></listitem>
- <listitem><para>In Order class the objects of the OrderItem class are stored in the List.</para></listitem>
- <listitem><para>OrderItem has <property moreinfo="none">price</property>,<property moreinfo="none">productId</property>,<property moreinfo="none">quantity</property> as its properties.</para></listitem>
- </itemizedlist>
- <para>Let's look at the transform target Java class : <emphasis><property moreinfo="none">LineOrder</property></emphasis>.</para>
- <para>On the screen below you can see its structure:</para>
- <figure float="0">
- <title>LineOrder class</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/targetmodel_structured.jpg"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <itemizedlist>
- <listitem><para><property moreinfo="none">LineOrder</property> class contains 3 properties:<property moreinfo="none">customerId</property>,<property moreinfo="none">customerName</property>,<property moreinfo="none">priority</property> and an array of lineItems.</para></listitem>
- <listitem><para>The <property moreinfo="none">Header</property> class has <property moreinfo="none">customerName</property>,<property moreinfo="none">customerNumber</property>,<property moreinfo="none">priority</property> as its properties.</para></listitem>
- <listitem><para>OrderItem objects are stored in a List.</para></listitem>
- </itemizedlist>
- <para>Now it's the time to define the mapping rules to transform the input source java class to the target java class:</para>
- <itemizedlist>
- <listitem><para>Each instance of the Order class should be mapped with an instance of the LineOrder class.</para></listitem>
- <listitem><para>The value of <property moreinfo="none">customerName</property> of the Header class should be assigned to the <property moreinfo="none">customerName</property> property of a LineOrder instance.</para></listitem>
- <listitem><para>The value of <property moreinfo="none">customerNumber</property> of the Header class should be assigned to the <property moreinfo="none">customerId</property> property of a LineOrder instance.</para></listitem>
- <listitem><para>The value of <property moreinfo="none">priority</property> of the Header class should be assigned to the <property moreinfo="none">priority</property> property of LineOrder instance.</para></listitem>
- <listitem><para>For the <property moreinfo="none">orderitems</property> List of the Order instance, it's necessary to map a new lineItems array instance of LineOrder ,
- and each OrderItem instance in the orderItems List should be transformed to a LineItem instance,
- those instances will be put into the lineItems array.</para></listitem>
- <listitem><para>The value of <property moreinfo="none">productId</property> of the OrderItem instance should be assigned to the 'productCode' of LineItem.</para></listitem>
- <listitem><para>The value of <property moreinfo="none">price</property> of OrderItem should be assigned to the <property moreinfo="none">unitPrice</property> of LineItem.</para></listitem>
-
- </itemizedlist>
- </section>
-
- <section id="config_file_wizzard">
- <title>Smooks Configuration File Wizard</title>
- <para>Select the Smooks Java-to-Java example project that you created and right-click,
- select the menu <emphasis><property moreinfo="none">New > Other</property>,</emphasis> then find
- <emphasis><property moreinfo="none">Smooks > Smooks Configuration File</property>.</emphasis>
- Click the <emphasis>
- <property moreinfo="none">Next</property>
- </emphasis> button. </para>
- <figure float="0">
- <title>Selecting Smooks Configuration File Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/quick_start1.png" scale="90"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>The first wizard page is a file path creation page. Select the <emphasis>
- <property moreinfo="none">src</property>
- </emphasis> folder to be the files container, and input the name
- <emphasis><property moreinfo="none">smooks-config.xml</property>.</emphasis> Click
- <emphasis><property moreinfo="none">Next</property>.</emphasis></para>
- <figure float="0">
- <title>Choosing the configuration file container and the file name</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/quick_start2.png" scale="90"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para><diffmk:wrapper diffmk:change="changed">The second wizard page is allows you to select Smooks configuration file version. Select the appropriate one and click </diffmk:wrapper><emphasis><property moreinfo="none">Finish</property></emphasis><diffmk:wrapper diffmk:change="changed"> to complete the wizard.</diffmk:wrapper></para>
-
-
-
- <!--<para> As the quick start introduces how to create/edit the Java-to-Java Smooks
- configuration file, let's select the<emphasis>
- <property>Java-to-Java</property>
- </emphasis> type as the source/target transform data type. </para>
-
- <figure>
- <title>Selecting Data Type</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/quick_start3.png" scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>On the next page you are prompted to choose the source data for transformation.
- Let's select the <property>Order</property> class from the example project as
- the source JavaBean class.</para>
-
- <figure>
- <title>Selecting the Source Data</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/quick_start4.png" scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Then the wizard page asks you to choose the target data for transformation. We select
- the <property>ListOrder</property> class as the target JavaBean class.</para>
- <figure>
- <title>Selecting the Target Data</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/quick_start5.png" scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para/>
-
- <tip>
- <title>Tip:</title>
- <para>You can omit two these steps and just press
- <emphasis><property>Finish</property>.</emphasis> This will open the empty
- Smooks Configuration file. It's possible to <link
- linkend="graphicaleditor_datalink">select source/target data</link> afterwards
- in the Smooks Graph editor.</para>
- </tip>-->
- </section>
- <section id="quickstart_formeditor">
- <title>Smooks Editor</title>
-
- <para>When all the wizard steps are passed, a new Smooks Configuration file is created and
- the <property moreinfo="none">Smooks Configuration Editor</property> will be opened automatically:</para>
- <figure float="0">
- <title>Smooks Editor</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/quick_start6.png" scale="90"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>On the bottom of this editor there are 5 tabs, they are :
-
- Overview, Reader, Message Filter, Graph, Source.</para>
- <section id="graphicaleditor_datalink">
- <title>Adding the input data</title>
- <para>At first, we need to add the Order class as the input data.
- To do this, click the Reader tab, swich to the Reader/Input editor page</para>
-
- <!--<para> This editor contains several parts: <table>
- <title>The Smooks Editor Parts</title>
- <tgroup cols="2">
-
- <colspec colnum="1" align="left" colwidth="1*"/>
- <colspec colnum="2" colwidth="5*"/>
-
- <thead>
- <row>
- <entry>Editor feature</entry>
- <entry>Functionality</entry>
- </row>
- </thead>
-
- <tbody>
-
- <row>
- <entry>
- <para>Problems area</para>
- </entry>
- <entry>
- <para>If there are any errors when you are editing the file, the
- Problems area displays them</para>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>Source data tree</para>
- </entry>
- <entry>
- <para>The tree displays a structure of the transformed source
- data</para>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>Target data tree</para>
- </entry>
- <entry>
- <para>The tree displays a structure of the transformed target
- data</para>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>Mapping graphical area</para>
- </entry>
- <entry>
- <para>Show the data mapping connection lines</para>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>Source/Target data selection links</para>
- </entry>
- <entry>
- <para>Click the link, and <link linkend="graphicaleditor_datalink"
- >Data Selection wizard</link> is opened helping you to
- choose the source/target data</para>
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- </para>-->
-
-
- <para>To choose the transform data you should open <emphasis>
- <property moreinfo="none">Reader</property></emphasis> tab and click <emphasis>
- <property moreinfo="none">Add</property></emphasis> button in the Input Data section.</para>
- <figure float="0">
- <title>Input Data section</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/quick_start_6a.png" scale="90"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>After clicking the button the <property moreinfo="none">Data Type Selection wizard</property> is
- opened, and there are many data types in the list: Java, XML etc.</para>
- <note>
- <title>Note</title>
- <para> There will become more and more data types on the list as the development goes on.
- </para>
- </note>
-
- <figure float="0">
- <title>Data Type Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/quick_start7.png" scale="90"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Select the <emphasis>
- <property moreinfo="none">Java</property>
- </emphasis> data type and click <emphasis><property moreinfo="none">Next</property>,</emphasis> you will
- see the JavaBean class selection page:</para>
-
- <figure float="0">
- <title>JavaBean Data Selection</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/quick_start8.png" scale="90"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para> Let's select the Order class from the example project as the source JavaBean class.After that click <emphasis>
- <property moreinfo="none">Finish</property>
- </emphasis> and you should see the just added java class, being displayed in the Input Data Section.
- </para>
- <figure float="0">
- <title>Displaying the Structure of the Transformed Data</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/quick_start9.png" scale="90"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
- <section>
- <title>Adding the target Bean</title>
- <para>After adding the input data, let's switch to the Message Filter page:</para>
- <figure float="0">
- <title>Displaying the Structure of the Transformed Data</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/quick_start9a.png" scale="90"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Click the <property moreinfo="none">Add</property> button, the <property moreinfo="none">Add Child</property> wizard page will be shown, let's select the <property moreinfo="none">Java Binding v1.2 -> Bean v1.2</property> and click <emphasis><property moreinfo="none">OK</property></emphasis> to add the Bean :
- </para>
- <figure float="0">
- <title>Add Child wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/quick_start9b.png" scale="90"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Then we can find on the Message Filter page the <property moreinfo="none">Bean v1.2</property> item added, click on it ,a Bean v1.2 section should appear to the right of the page.
- The section represents a GUI for editing <property moreinfo="none">Bean v1.2</property> properties:</para>
- <figure float="0">
- <title>Bean v1.2 section</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/quick_start9c.png" scale="90"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>You should input <property moreinfo="none">
- lineOrder</property> as the Bean's id in the "Bean Id" field.Then you should click <property moreinfo="none">Browse</property> button
- near the <property moreinfo="none">Class</property> textfield and select LineOrder as the Bean's class.</para>
- <note>
- <para>
- When you enter a value for the <property moreinfo="none">Class</property> text field,
- you can type 'Alt + /' and the content assist pop dialog will be shown,
- so it's will increase the efficiency. If 'Alt + /' doesn't work,
- try to use the 'Ctrl + space'('Key Assist' of Eclipse).
- </para>
- </note>
- <para>Let's click the <property moreinfo="none">Add Binding</property> link at the bottom of this page,
- it will show a dialog to ask the binding of what Bean properties you will prefer to add.
- Select all and click OK, you will see a list of Binding elements added under the Bean item.</para>
- <para>Then you should add an array of beans called <property moreinfo="none">lineItems</property> and a Bean LineItem.These two classes and Id values are:</para>
- <para>Array Bean:</para>
- <itemizedlist>
- <listitem><para>BeanId : lineItems;</para></listitem>
- <listitem><para>Class : example.trgmodel.LineItem[]</para></listitem>
- </itemizedlist>
- <para>LineItem Bean :</para>
- <itemizedlist>
- <listitem><para>BeanId : lineItem;</para></listitem>
- <listitem><para>Class : example.trgmodel.LineItem</para></listitem>
- </itemizedlist>
- <note>
- <para>
- In Smooks , to be an array of Beans , the class value should end with '[]'. This means that this bean is an array type.
-
- </para>
- </note>
- <para>To finish this work, use the <property moreinfo="none">Add Binding</property> link to add all the bindings for the Bean.</para>
- </section>
-
-
- </section>
- <section id="quickstart_mapping">
- <title>Mapping</title>
-
-
- <para>How to map the java class just added?</para>
-
- <para>First, you should know what to transform:</para>
-
- <orderedlist continuation="restarts" inheritnum="inherit" numeration="loweralpha">
- <listitem>
- <para>Bind the <emphasis>
- <property moreinfo="none">"customerName"</property>
- </emphasis> property of the <property moreinfo="none">Order#header</property> to the <emphasis>
- <property moreinfo="none">"customerName"</property>
- </emphasis> property of <property moreinfo="none">LineOrder</property>.</para>
- </listitem>
- <listitem>
- <para>Bind the <emphasis>
- <property moreinfo="none">"customerNumber"</property>
- </emphasis> property of the <property moreinfo="none">Order#header</property> to the <emphasis>
- <property moreinfo="none">"customerId"</property>
- </emphasis> property of <property moreinfo="none">LineOrder</property>.</para>
- </listitem>
- <listitem>
- <para>Bind the <emphasis>
- <property moreinfo="none">"price"</property>
- </emphasis> property of the <property moreinfo="none">OrderItem</property> to the <emphasis>
- <property moreinfo="none">"unitPrice"</property>
- </emphasis> property of <property moreinfo="none">LineItem</property>.</para>
- </listitem>
- <listitem>
- <para>Bind the <emphasis>
- <property moreinfo="none">"productId"</property>
- </emphasis> property of the <property moreinfo="none">OrderItem</property> to the <emphasis>
- <property moreinfo="none">"productCode"</property>
- </emphasis> property of <property moreinfo="none">LineItem</property>.</para>
- </listitem>
- <listitem>
- <para>Bind the <emphasis>
- <property moreinfo="none">"quantity"</property>
- </emphasis> property of the <property moreinfo="none">OrderItem</property> to the <emphasis>
- <property moreinfo="none">"unitQuantity"</property>
- </emphasis> property of <property moreinfo="none">LineItem</property>.</para>
- </listitem>
- </orderedlist>
-
- <para> Make sense?
- You should open Design tab and click Add button. In opened Add Child Wizard,please, select <emphasis>
- <property moreinfo="none">Add Smooks Resource>Java Binding>Bindings</property></emphasis>.
- </para>
- <para>First of all, you should bind <emphasis>
- <property moreinfo="none">Order</property></emphasis> to <emphasis>
- <property moreinfo="none">LineOrder</property></emphasis>. To do this one <emphasis>
- <property moreinfo="none">Bindings</property></emphasis> Item should be added to the Resource List.</para>
- <figure float="0">
- <title>Mapping</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/quick_start10.png" scale="90"></imagedata>
- </imageobject>
- </mediaobject>
- </figure><para>Click on it and you should see <emphasis>
- <property moreinfo="none">Bindings</property></emphasis> Section to the right of <emphasis>
- <property moreinfo="none">Message Filtering Resources</property></emphasis>.Write <emphasis> <property moreinfo="none">lineOrder</property></emphasis> in the <emphasis>
- <property moreinfo="none">Bean id</property></emphasis> field.</para>
- <para>Select <emphasis>
- <property moreinfo="none">example.trgmodel.LineOrder</property></emphasis> in the <emphasis>
- <property moreinfo="none">Class</property></emphasis> field and <emphasis>
- <property moreinfo="none">example.srcmodel.Order</property></emphasis> in the <emphasis>
- <property moreinfo="none">Name</property></emphasis> field.Your <emphasis> <property moreinfo="none">Smooks Configuration Editor</property></emphasis> should look like this: </para>
- <figure float="0">
- <title>Mapping</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/quick_start11.png" scale="90"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Now you should bind two values <emphasis> <property moreinfo="none">"customerNumber"</property>
- </emphasis> property of the <property moreinfo="none">Order#header</property> to the <emphasis>
- <property moreinfo="none">"customerId"</property>
- </emphasis> property of <property moreinfo="none">LineOrder</property>.To do this right click your just created <emphasis>
- <property moreinfo="none">Bindings Item >Add Smooks Resource>Value</property></emphasis>
- .</para>
-
- <figure float="0">
- <title> Mapping Editor</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/quick_start12.png" scale="90"></imagedata>
- </imageobject>
- </mediaobject>
- </figure><note>
- <title>Note:</title>
- <para>Please, remember that the root nodes of the source data and target data *MUST* be
- connected.</para>
- <para>This rule is not only for Java-to-Java, but also is relevant for
- XML-to-Java </para>
- </note>
- <para> Do the same operation with the
- other properties in this and other classes.</para>
- <para>It's also necessary to bind <emphasis>
- <property moreinfo="none">orderItems</property></emphasis> property of the <emphasis>
- <property moreinfo="none">Order</property></emphasis> to <emphasis>
- <property moreinfo="none">lineItems</property></emphasis> property of <emphasis>
- <property moreinfo="none">LineOrder</property></emphasis>.The difference from the previous steps is that the <emphasis>
- <property moreinfo="none">orderItems</property></emphasis> is presented by the list of <emphasis>
- <property moreinfo="none">Order</property></emphasis> and <emphasis>
- <property moreinfo="none">lineItems</property></emphasis> is the massive of <emphasis>
- <property moreinfo="none">LineItem</property></emphasis> .To do the binding,you should use <emphasis>
- <property moreinfo="none">Wiring Item</property></emphasis>.First you should create a new Binding item. This is a configuration that allows you to construct an object graph .Select <emphasis>
- <property moreinfo="none">example.trgmodel.LineItem[]</property></emphasis> in the Class field and orderItems in the Name field,in bean Id write lineItems.
- Your Smooks Configuration Editor should look like this:
- </para>
- <figure float="0">
- <title> Creating Wiring Item</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/quick_start13a.png" scale="90"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para> Then you should right click <emphasis>
- <property moreinfo="none">lineOrder</property></emphasis> binding item<emphasis>
- <property moreinfo="none">>Add Smooks Resource>Wiring</property></emphasis>.Select <emphasis>
- <property moreinfo="none">lineItem</property></emphasis> in <emphasis>
- <property moreinfo="none">Bean id Ref</property></emphasis>.
- </para>
- <para>The final step is to add new Wiring item to lineOrder <property moreinfo="none">Binding</property>.In the <property moreinfo="none">Bean id Ref</property> select <emphasis>
- <property moreinfo="none">lineItems</property></emphasis> and in <emphasis>
- <property moreinfo="none">Property</property></emphasis> select <emphasis>
- <property moreinfo="none">lineItems</property></emphasis>.</para>
-<!--
- <para>Next, you are going to bind the properties of the <property>OrderItem</property> to
- the properties of the <property>LineItem</property>.</paa>
- <para>Select the <emphasis>
- <property>"price"</property>
- </emphasis> and drag it onto the <emphasis>
- <property>"unitPrice"</property>
- </emphasis> of the other side tree viewer. The Problems area shows an
- error:</para>
- <figure>
- <title>Connection Error 1</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/quick_start12.png" scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>How to deal with the error?</para>
- <para>Please click the <emphasis>
- <property>Fix it</property></emphasis> link, a menu is popped-up with several
- resolve methods on it.</para>
- <figure>
- <title>Fixing the Connection Error</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/quick_start13.png" scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para> Select the first resolve method: <emphasis>
- 'Connect the "OrderItem" to the
- "LineItem" '.</emphasis> As the result the <emphasis>
- <property>"OrderItem"</property></emphasis> is connected with
- the <emphasis>
- <property>"LineItem"</property>.</emphasis></para>
- <para>But the notify message area still shows some other errors:</para>
- <figure>
- <title>Connection Error 2</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/quick_start14.png" scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>OK, let's deal with the fire error. Click the <emphasis>
- <property>Fix it</property></emphasis> link and
- select the first resolve method. The <emphasis>
- <property>"orderItems"</property></emphasis> is connected with
- the <emphasis>
- <property>"lineItems"</property>.</emphasis></para>
-
- <tip>
- <title>Tip:</title>
- <para> Why does the error occur?</para>
- <para> You will find that, if you only connect the property node without connecting the
- parent node of the property, the "connection error" occurs.</para>
- <para>The connection of the "price-to-unitPrice" is the
- "Binding Connection", but it needs an "Instance Creation
- Connection" - the connection of the
- "OrderItem-to-LineItem".</para>
- </tip>
- <para> After that, connect <emphasis>
- <property>"quantity"</property></emphasis> to the <emphasis>
- <property>"unitQuantity"</property></emphasis> and <emphasis>
- <property>"productId"</property></emphasis> to the
- <emphasis>
- <property>"productCode"</property>:</emphasis></para>
- <figure>
- <title>Complete Mapping</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/quick_start/quick_start15.png" scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>-->
- <para>Now, you should save the file and the <property moreinfo="none">Smooks tools</property> generate the correct
- configuration file content.</para>
- <para>OK, let run the test class: <property moreinfo="none">example.Main</property>. (Please, make sure that the Smooks engine
- loads the correct configuration file).</para>
- <para>Success!</para>
- </section>
-</chapter>
-
- <!--&smooksformeditor_graphicaltab;-->
-
-<chapter id="smooksformeditor_configurationtab" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/smooks/docs/reference/en/modules/smooksformeditor_configurationpage.xml" xreflabel="Smooks Configuration Editor Page">
- <?dbhtml filename="smooks_form_editor_configurationtab.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Tools</keyword>
- <keyword>Smooks</keyword>
- <keyword>JBDS</keyword>
- </keywordset>
- </chapterinfo>
- <title>Smooks Design Page</title>
- <para>In this section you will explore the details of Smooks Design Page usage.</para>
- <para><property moreinfo="none">Smooks Design Page</property> is one tab of the <property moreinfo="none">Smooks Editor</property>. </para>
- <figure float="0">
- <title>Design Page</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/config_page/config_page1.png" scale="90"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>This page consists of 3 sections: Message Filtering Resources, Input Data and the section devoted to the configurations of a selected in a Message Filtering Resources section Item.</para>
- <para> You can bind classes <link linkend="quickstart_mapping">using Bindings item
- </link> on the Design page of the <property moreinfo="none">Smooks Editor</property>. </para>
- <para><emphasis>
- <property moreinfo="none">Resource list</property></emphasis> item in <emphasis>
- <property moreinfo="none">Message Filtering Resources</property></emphasis> corresponds to the root element of the <emphasis>
- <property moreinfo="none">smooks-config.xml</property></emphasis> file.You can configurate the next four properties using corresponding fields:</para>
- <itemizedlist>
- <listitem><para><emphasis>
- <property moreinfo="none">default-selector</property></emphasis>:Defines the selector that will be applied to all resource-config elements in the <emphasis>
- <property moreinfo="none">smooks-config.xml</property></emphasis>, where a selector is not defined. </para></listitem>
- <listitem><para><emphasis>
- <property moreinfo="none">default-selector-namespace</property></emphasis>:Defines the default selector namespace. </para></listitem>
- <listitem><para><emphasis>
- <property moreinfo="none">default-target-profile</property></emphasis>: Defines the default target profile that will be applied to all resources in the smooks-config.xml. </para></listitem>
- <listitem><para><emphasis>
- <property moreinfo="none">default-condition-ref</property></emphasis>:The condition is applied to resources where an empty "condition" element (i.e. <code><condition/></code>)is defined.The condition element does not reference a globally defined condition. </para></listitem>
- </itemizedlist>
- <para> The configuration editor also edits the <link linkend="configurationpage_parsetype">Smooks parse
- type</link> and manages the <link linkend="configurationpage_importfile">Import
- Files</link>.</para>
- <section id="selector-dialog">
- <title>Selector generate dialog</title>
- <para>Using <emphasis>
- <property moreinfo="none">Selector generate dialog</property></emphasis> you can allow the user to select a node for generation <property moreinfo="none">"selector"</property> for smooks-config file.
- To open the dialog you should left click <property moreinfo="none">Browse</property> button in <emphasis>
- <property moreinfo="none">Default Selector</property></emphasis> section.
- </para>
- <figure float="0">
- <title>Selector generate dialog</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/config_page/config_page2a.png" scale="90"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para> When the dialog is opened you should click <property moreinfo="none">"Click to add input data"</property>to set the selector.
- In the opened <emphasis>
- <property moreinfo="none">Data Type Selection</property></emphasis> Wizard you should choose the type of the file and the file itself you want to load to the <emphasis>
- <property moreinfo="none">Selector generate dialog</property></emphasis>.After that your dialog should look nearly like that:</para>
- <figure float="0">
- <title>Selector generate dialog after adding Input Data</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/config_page/config_page2b.png" scale="90"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>The final step is to choose the node you want to make a selector for <emphasis>
- <property moreinfo="none">smooks-config.xml</property></emphasis>.</para>
- </section>
- <section id="configurationpage_parsetype">
-
- <title>Smooks Parse Type</title>
- <para>If your config file doesn't contain <emphasis>
- <property moreinfo="none">Global Parametres</property></emphasis> item yet, you should add it by right click <emphasis>
- <property moreinfo="none">Resource List>Add Smooks Resource>Global Parametres</property></emphasis>.After this step you should add <emphasis>
- <property moreinfo="none">Param</property></emphasis> to just created <emphasis>
- <property moreinfo="none">Global Parametres</property></emphasis>. </para>
- <figure float="0">
- <title>Adding Param to created Global Parametres</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/config_page/config_page2.png" scale="90"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Then left click <emphasis>
- <property moreinfo="none">Param</property>
- </emphasis>and in the Param section, you will see a set of text fields: <emphasis>
- <property moreinfo="none">Name</property></emphasis>,<emphasis>
- <property moreinfo="none">Type</property></emphasis> and <emphasis>
- <property moreinfo="none">Text</property></emphasis>.<emphasis>
- <property moreinfo="none">Name</property></emphasis> value is required. To set a parse type you should write SAX/DOM to the
- <emphasis>
- <property moreinfo="none">Text</property></emphasis> field.</para>
-
- <figure float="0">
- <title>Filling Param section field Name and Text Value for set a Parse Type</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/config_page/config_page3.png" scale="90"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>To apply changes to the <emphasis>
- <property moreinfo="none">smooks-config.xml</property></emphasis> click <emphasis>
- <property moreinfo="none">Save</property></emphasis> button (<emphasis>
- <property moreinfo="none">Ctrl+S</property></emphasis>). </para>
- </section>
- <section id="configurationpage_importfile">
-
- <title>Import Smooks Configuration page</title>
- <para> Right click <emphasis>
- <property moreinfo="none">Resource List>Add Smooks Resource>Import Smooks Configuration</property>
- </emphasis>, then you should see a new <emphasis>
- <property moreinfo="none">Import Smooks Configuration</property>
- </emphasis>item in the list (see the figure below).</para>
-
- <figure float="0">
- <title>Import Data</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/config_page/config_page3a.png" scale="90"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Left click the added item and to the left of <emphasis>
- <property moreinfo="none">Message Filtering Resources Import Smooks Configuration </property></emphasis> section should appear. Click the <emphasis>
- <property moreinfo="none">Browse</property>
- </emphasis> button and select the file you want to import(see <link linkend="file_selection">File selection</link> section). </para>
- <para>Click <emphasis>
- <property moreinfo="none">Save</property></emphasis> and the <code><import></code> tag with the corresponding file path as a <emphasis>
- <property moreinfo="none">file</property></emphasis> property will be added to the <emphasis>
- <property moreinfo="none">smooks-config.xml</property></emphasis>.</para>
- </section>
- <section id="file_selection">
- <title>File selection</title>
- <para>Some attributes in Smooks elements should store path to a file as a value
- (e.g. attribute <emphasis><property moreinfo="none">"mappingModel"</property></emphasis> of the element <emphasis><property moreinfo="none">"edi:reader"</property></emphasis>).
- You can see a Browse button near the fields, that set such a value to the attribute
- (e.g. <emphasis><property moreinfo="none">"Mapping Model"</property></emphasis> field set a value to the <emphasis><property moreinfo="none">"mappingModel"</property></emphasis> attribute).
- </para>
- <figure float="0">
- <title>EDI:Reader element</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/config_page/config_page6.png" scale="90"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>
- When you click <emphasis><property moreinfo="none">Browse</property></emphasis>, the dialog prompts you click one of two buttons:
- <emphasis><property moreinfo="none">Browse File System</property></emphasis> and <emphasis><property moreinfo="none">Browse WorkSpace</property></emphasis>.
- </para>
- <figure float="0">
- <title>Browse dialog</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/config_page/config_page7.png" scale="90"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Using the buttons you can locate the file you need. If you click <emphasis>
- <property moreinfo="none">Browse File System</property></emphasis> button you specify the path of, or browse to, a file system directory.
- </para>
- <figure float="0">
- <title>Browse file system</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/config_page/config_page8.png" scale="90"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <para>
- If you click <emphasis><property moreinfo="none">Browse WorkSpace</property></emphasis> button, you specify the path of, or browse to, a workspace relative working directory.
- </para>
- <figure float="0">
- <title>Browse Workspace</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/config_page/config_page9.png" scale="90"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
- <!--<section id="configurationpage_datedecoder">
- <title>Date Decoder Detail Page</title>
-
- <para>Date Decoder is a resourceConfig element in the Smooks configuration file. It
- describes how to transform the "Date" type.</para>
- <para> Click the <emphasis>
- <property>New</property>
- </emphasis> button to open the <property>New Resource Type wizard</property>
- dialog.</para>
- <figure>
- <title>Resource Type Selection Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/config_page/config_page4.png" scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>There are several resource type on the list. Select the <emphasis>
- <property>Date Decoder</property>
- </emphasis> and click the <emphasis>
- <property>Finish</property>
- </emphasis> button, a new <emphasis>
- <property>Date Decoder</property>
- </emphasis> item was added and shown on the resource type list.</para>
- <para> There are several parameters in the <emphasis>
- <property>Date Decoder</property>
- </emphasis> resourceConfig element:</para>
-
- <para>
-
- <itemizedlist>
- <listitem>
- <para>Format</para>
- </listitem>
-
- <listitem>
- <para>Locale-Language</para>
-
- </listitem>
-
- <listitem>
- <para>Locale-Country</para>
-
- </listitem>
- </itemizedlist>
- </para>
-
- <para> You can modify the parameters of the <emphasis>
- <property>Date Decoder</property></emphasis> item with the left detail page.</para>
-
- <figure>
- <title>Date Decoder Detail Page</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/config_page/config_page1.png" scale="90"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para> When you defined a new <emphasis>
- <property>Date Decoder</property></emphasis>, then you can use the <link
- linkend="graphicalpage_propertiesview">JavaBean Properties</link> GUI to set
- it to be the "Java type".</para>
- <para>Now when we've learnt Smooks Configuration Editor Page, let's have a look at one more Smooks Editor Page - Smooks Source Editor Page and investigate its functionality</para>
-
-
- <para> The XML fragment generated by Smooks tools for the "Date
- Decoder": </para> <para> <programlisting> <![CDATA[<resource-config
- selector="decoder:DateLong">
- <resource>org.milyn.javabean.decoders.DateDecoder</resource> <param
- name="locale-language">en</param> <param name="format">yyy-MM-dd
- HH:mm:ss</param> <param name="locale-country">IE</param>
- </resource-config>]]> </programlisting> </para>
-
- </section>
-
- <section id="configurationpage_documenttype"> <title>Document Type
- Detail Page</title> <para> </para> </section> <section
- id="configurationpage_unhandleresourceconfig"> <title>Unhandle
- ResourceConfig</title> </section>
- -->
-</chapter>
-
-
-<chapter id="smooksformeditor_sourcetab" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/smooks/docs/reference/en/modules/smooksformeditor_sourcepage.xml" xreflabel="Smooks Source Editor Page">
- <?dbhtml filename="smooks_form_editor_sourcetab.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Tools</keyword>
- <keyword>Smooks</keyword>
- <keyword>JBDS</keyword>
- </keywordset>
- </chapterinfo>
- <title>Smooks Source Editor Page</title>
- <para>This section provides information about Smooks Source Editor Page.</para>
- <section>
- <title>XML Source Editor</title>
- <para>You can use this editor to edit the Smooks Configuration file directly. </para>
- <figure float="0">
- <title>Graphical Editor</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/source_editor/source_editor1.png" scale="90"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
- <section>
- <title>Error underlining in Graphical Editor</title>
- <para>If the <property moreinfo="none">Smooks tools</property> 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.</para>
- <figure float="0">
- <title>Graphical Editor</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/source_editor/source_editor2.png" scale="90"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- <!--note>
- <title>Tip:</title>
- <para> When the error message panel is displayed, other editors ( Graphical Editor,
- Configuration Editor ) are disabled. </para>
- <para> You can't edit the configuration file with other editors until file becomes
- valid. </para>
- </note-->
-
-
-
- </section>
-
- <section>
- <title>Smooks Configuration File Validator</title>
- <para>Smooks configuration file validator will validate your Smooks configuration file. Just right-click on the file and then click on the <property moreinfo="none">Validate</property> button. The validator can be enabled/disabled in <emphasis><property moreinfo="none">Window -> Preferences -> Validation</property></emphasis>:</para>
-
- <figure float="0">
- <title>Validation: Smooks Configuration File Validator</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/source_editor/smooks_conf_validator.png" scale="90"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>You can set up your Smooks validator to include, exclude groups to validate and specify rules for validation. Just click on the <property moreinfo="none">Settings</property> button and use the options provided:</para>
-
- <figure float="0">
- <title>Smooks Configuration File Validator Settings</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/source_editor/smooks_conf_validator_settings.png" scale="90"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
-
- <para>We hope, our guide will help you to get started with JBoss Smooks Tools. Besides, for additional information you are welcome on <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss forum</ulink>.</para>
-
- </section>
-
-
-
-
-</chapter>
-
-</book>
+<!ENTITY introduction SYSTEM "modules/introduction.xml">
+<!ENTITY tasks SYSTEM "modules/tasks.xml">
+<!ENTITY references SYSTEM "modules/references.xml">
+<!ENTITY summary SYSTEM "modules/summary.xml">
+]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff">
+
+ <bookinfo>
+
+ <title>Smooks Dev Tools Reference Guide</title>
+ <corpauthor>
+ <inlinemediaobject>
+ <imageobject role="fo">
+ <imagedata fileref="images/jbosstools_logo.png" format="PNG"></imagedata>
+ </imageobject>
+ <imageobject role="html">
+ <imagedata></imagedata>
+ </imageobject>
+ </inlinemediaobject>
+ </corpauthor>
+ <author>
+ <firstname>Xue(Dart)</firstname>
+ <surname>Peng</surname>
+ </author>
+ <copyright>
+ <year><diffmk:wrapper diffmk:change="changed">2009,2010</diffmk:wrapper></year>
+ <holder>JBoss by Red Hat</holder>
+ </copyright>
+ <releaseinfo><diffmk:wrapper diffmk:change="changed">
+ Version: 1.1.0.CR2
+ </diffmk:wrapper></releaseinfo>
+
+ <abstract>
+ <title></title>
+ <para>
+ <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/smooks/pdf/Smooks_Re...">PDF version</ulink>
+ </para>
+ </abstract>
+
+
+ </bookinfo>
+ <toc></toc>
+
+<chapter id="introduction" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/smooks/docs/reference/en/modules/introduction.xml">
+ <?dbhtml filename="introduction.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Tools</keyword>
+ <keyword>Smooks</keyword>
+ <keyword>JBDS</keyword>
+ </keywordset>
+ </chapterinfo>
+ <title>Introduction</title>
+ <para>This chapter gives you a short introduction to Smooks, Smooks tools and its installation.</para>
+ <para>First, have a look at the key features of Smooks tools:</para>
+ <section>
+ <title>Key Features of Smooks Tools</title>
+ <para>Here, we provide you with a key functionality which is integrated in Smooks tools.</para>
+ <table>
+
+ <title>Key Functionality for Smooks Tools</title>
+ <tgroup cols="3">
+
+ <colspec align="left" colnum="1" colwidth="2*"></colspec>
+ <colspec colnum="2" colwidth="4*"></colspec>
+ <colspec align="left" colnum="3" colwidth="2*"></colspec>
+
+ <thead>
+ <row>
+ <entry>Feature</entry>
+ <entry>Benefit</entry>
+ <entry>Chapter</entry>
+ </row>
+ </thead>
+
+ <tbody>
+
+ <row>
+ <entry><para>Smooks Configuration File Wizard</para></entry>
+ <entry><para>Smooks tools allows to create/edit the Smooks configuration file for Java2Java data transformation.</para></entry>
+ <entry>
+ <link linkend="config_file_wizzard">Smooks Configuration File Wizard</link>
+ </entry>
+ </row>
+
+ <row>
+ <entry><para>Smooks Editor</para></entry>
+ <entry><para>Smooks Editor helps configure the created Smooks configuration file.</para></entry>
+ <entry>
+ <link linkend="process_tab">Smooks Editor</link>
+ </entry>
+ </row>
+
+ </tbody>
+
+ </tgroup>
+ </table>
+
+
+
+ </section>
+
+
+
+ <section>
+ <title>What is Smooks?</title>
+
+ <para><property moreinfo="none">Smooks</property> is a Java Framework/Engine for processing XML and non XML
+ data (CSV, EDI, Java, JSON etc).</para>
+ <para></para>
+ <para>
+ <orderedlist continuation="restarts" inheritnum="inherit" numeration="upperroman">
+ <listitem>
+ <para><emphasis role="bold">Transformation</emphasis>: Perform a wide range of
+ Data Transforms. Supports many different Source and Result types
+ -XML/CSV/EDI/Java/JSON to XML/CSV/EDI/Java/JSON.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Java Binding</emphasis>: Bind into a Java Object
+ Model from any data source (CSV, EDI, XML, Java, JSON etc). </para>
+ </listitem>
+
+ <listitem>
+ <para><emphasis role="bold">Huge Message Processing</emphasis>: Process huge
+ messages (GBs) - Split, Transform and Route message fragments to JMS, File,
+ Database etc destinations. Route multiple message formats to multiple
+ destinations in a single pass over a message. </para>
+ </listitem>
+
+ <listitem>
+ <para><emphasis role="bold">Message Enrichment</emphasis>: Enrich a message with
+ data from a Database, or other Datasources. </para>
+ </listitem>
+
+ <listitem>
+ <para><emphasis role="bold">Combine</emphasis>: Combine the above features in
+ different ways e.g. add Message Enrichment as part of a Splitting and
+ Routing process. </para>
+ </listitem>
+ </orderedlist>
+ </para>
+ <figure float="0">
+ <title>Smooks</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/introduction/introduction1.png" scale="90"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para><diffmk:wrapper diffmk:change="changed"> For more informations about </diffmk:wrapper><property moreinfo="none">Smooks</property>, please visit <ulink url="http://www.smooks.org">Smooks official site</ulink>.</para>
+ </section>
+ <section>
+ <title>What is Smooks Tools?</title>
+
+ <para>Smooks tools is a set of graphical tools for editing Smooks configuration file
+ based on Eclipse.</para>
+ <figure float="0">
+ <title>Smooks Form editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/introduction/introduction2.png" scale="90"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The easiest way to use the Smooks Configuration Editor is to create a project
+ (Java project, an ESB project, etc.), right-click on it and select </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">New -> Other</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">
+ to open the New wizard. Drill into </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Smooks -> Smooks Configuration File</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">
+ and continue through the wizard. We recommend using a minimum Smooks level of 1.1 or 1.2, but if you're using it in a deployed service, it depends on what version your runtime supports.
+ Once the file is created, it will open in the Smooks Configuration Editor.</diffmk:wrapper></para>
+ </section>
+ <section>
+ <title>How to install Smooks dev tools?</title>
+
+ <para> The Smooks tools was included by the <property moreinfo="none">JBoss Tools</property> since 3.0.0
+ Beta1 version. You can download the <property moreinfo="none">JBoss Tools</property> from <ulink url="http://jboss.org/tools/download.html">JBoss download site</ulink>.</para>
+ <para> Smooks tools (<property moreinfo="none">JBoss Tools</property>) run with the latest Eclipse and
+ other required plug-ins (GEF, EMF, etc.).</para>
+ <para> You should download the latest IDE for Java EE developers from <ulink url="http://www.eclipse.org/downloads/"> Eclipse site</ulink>. It contains many plug-ins (
+ GEF, EMF, etc. ) required by Smooks dev tools. </para>
+ <para><diffmk:wrapper diffmk:change="added">The Smooks Configuration depends on having all of the appropriate Smooks runtime jars in the path of the Eclipse Plug-in or Java Project in the Eclipse workspace.
+
+ The easiest solution is to do the following:
+ </diffmk:wrapper><itemizedlist>
+ <listitem><para><diffmk:wrapper diffmk:change="added">1) Download the Smooks distribution from here: http://www.smooks.org/mediawiki/index.php?title=Downloads .
+ Grab the latest "ALL" distribution (as of today, it is the Smooks v.1.2.2 "ALL" distribution) and it will include binaries, examples, etc.</diffmk:wrapper></para></listitem>
+ <listitem><para><diffmk:wrapper diffmk:change="changed">2) Extract files from the archive somewhere on your machine.</diffmk:wrapper></para></listitem>
+ <listitem><para><diffmk:wrapper diffmk:change="changed">3) In your Eclipse workspace, copy the Smooks jars into a directory of your Eclipse plug-in or Java project named "lib".</diffmk:wrapper></para></listitem>
+ <listitem><para><diffmk:wrapper diffmk:change="added">4) For your Eclipse Plug-in or Java Project, right-click on the project and select Properties.</diffmk:wrapper></para></listitem>
+ <listitem><para><diffmk:wrapper diffmk:change="added">5) Select the "Java Build Path" item in the Properties list, select the Libraries tab, and click "Add JARs"
+ </diffmk:wrapper></para></listitem>
+ <listitem><para><diffmk:wrapper diffmk:change="changed">6) In the Jar Selection dialog, select all the jars in the "lib" directory mentioned in step 3 and click </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="added">OK</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed">.
+ </diffmk:wrapper></para></listitem>
+ <listitem><para><diffmk:wrapper diffmk:change="changed">7) Click </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">OK</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed"> to close the Properties dialog. Now you should see a "Referenced Libraries" node that appeared in your project hierarchy in Eclipse.
+ </diffmk:wrapper></para></listitem>
+ </itemizedlist>
+
+ </para>
+ <para><diffmk:wrapper diffmk:change="added">Now let's progress to more advanced topics.</diffmk:wrapper></para>
+ </section>
+
+</chapter>
+
+
+<chapter diffmk:change="added" id="process_page" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/smooks/docs/reference/en/modules/tasks.xml">
+ <?dbhtml filename="tasks.html"?>
+ <chapterinfo diffmk:change="added">
+ <keywordset diffmk:change="added">
+ <keyword diffmk:change="added"><diffmk:wrapper diffmk:change="added">JBoss Tools</diffmk:wrapper></keyword>
+ <keyword diffmk:change="added"><diffmk:wrapper diffmk:change="added">Smooks</diffmk:wrapper></keyword>
+ <keyword diffmk:change="added"><diffmk:wrapper diffmk:change="added">JBDS</diffmk:wrapper></keyword>
+ </keywordset>
+ </chapterinfo>
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Tasks</diffmk:wrapper></title>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">This chapter describes the main tasks a user can be faced during Smooks tools usage.</diffmk:wrapper></para>
+ <section id="config_file_wizzard">
+ <title><diffmk:wrapper diffmk:change="changed">New Smooks Configuration File Creation</diffmk:wrapper></title>
+ <para><diffmk:wrapper diffmk:change="changed">Select the project where you want to create new Smooks Configuration File and right-click on it,
+ select in the menu </diffmk:wrapper><emphasis><property moreinfo="none">New > Other</property>,</emphasis><diffmk:wrapper diffmk:change="changed"> then find
+ </diffmk:wrapper><emphasis><property moreinfo="none">Smooks > Smooks Configuration File</property>.</emphasis><diffmk:wrapper diffmk:change="changed">
+ Click the </diffmk:wrapper><emphasis>
+ <property moreinfo="none">Next</property>
+ </emphasis> button. </para>
+ <figure float="0">
+ <title>Selecting Smooks Configuration File Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/quick_start/quick_start1.png" scale="90"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>The first wizard page is a file path creation page. Select the <emphasis>
+ <property moreinfo="none">src</property>
+ </emphasis><diffmk:wrapper diffmk:change="changed"> folder to be the files container, and input the name
+ </diffmk:wrapper><emphasis><property moreinfo="none">smooks-config.xml</property>.</emphasis><diffmk:wrapper diffmk:change="changed"> Click
+ </diffmk:wrapper><emphasis><property moreinfo="none">Next</property>.</emphasis></para>
+ <figure float="0">
+ <title>Choosing the configuration file container and the file name</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/quick_start/quick_start2.png" scale="90"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para><diffmk:wrapper diffmk:change="changed">The second wizard page allow you to select Smooks configuration file version. Select the appropriate one and click </diffmk:wrapper><emphasis><property moreinfo="none">Finish</property></emphasis> to complete the wizard.</para>
+ </section>
+ <section diffmk:change="added">
+ <title><diffmk:wrapper diffmk:change="changed">Input Task Configuring</diffmk:wrapper></title>
+ <para>
+ <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Input task configuring</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed"> is an obligatory step for your smooks project creation.
+ You can configure it on the Process page of the editor: look for the "Input Task" in the Process Map at the top of the page.
+ </diffmk:wrapper></para>
+ <figure float="0">
+ <title><diffmk:wrapper diffmk:change="changed">Input Task Configuring</diffmk:wrapper></title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/process_page/process1.png" scale="90"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para><diffmk:wrapper diffmk:change="added">Select it and you will see all the properties to set for the Input reader of your Smooks configuration.
+ "Input type" corresponds to the type of data that you will be working with.
+ For example, to work with incoming CSV (Comma-separated Values) data, you would specify "CSV" in the drop-down list.
+ Each reader type has slightly different configuration details that must be set in the "Input configuration" area.
+ For instance, the CSV reader requires you to specify details such as the encoding, quote character, separator character, and the list of incoming fields.
+ The EDI reader requires the encoding and the path to the Mapping Model describing the incoming data.
+ In the </diffmk:wrapper><emphasis><diffmk:wrapper diffmk:change="added">Input data</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> section, you specify some sample data that conforms to your reader configuration.
+ </diffmk:wrapper></para>
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">
+ Once you've specified your reader configuration and sample data, you can see the input model rendered in a tree form in the </diffmk:wrapper><emphasis><diffmk:wrapper diffmk:change="added">Input model</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="changed"> section.
+ On the picture below you can see the correct configuration of some XML input task.
+ </diffmk:wrapper></para>
+ <figure float="0">
+ <title><diffmk:wrapper diffmk:change="changed">Input Task Configuring</diffmk:wrapper></title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/process_page/process2.png" scale="90"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+ <section diffmk:change="added">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">"Java Mapping" or "Apply Template"?</diffmk:wrapper></title>
+
+ <para><diffmk:wrapper diffmk:change="added">Though there are many options in Smooks as far as what you can do with input
+ data such as transformation, routing, and persistence, this version
+ of the Smooks Configuration Editor focuses only on these areas:
+ mapping to java and applying templates to create different output formats.
+ If you have a set of Java classes you want to use the incoming data for,
+ you can use the "Java Mapping" task to specify those classes and use drag and
+ drop to map between the input model generated by the reader and elements in the output model.
+ Or if you simply want to transform your output to one or more formats, you can use the "Apply Template"
+ task to map it to a CSV file, XML or XSD file (and other formats in the future).
+ </diffmk:wrapper><note><title>Note</title>
+ <para><diffmk:wrapper diffmk:change="changed">Now you can't transform your output directly,
+ using only Input and Template tasks.
+ You should use Mapping as an interagent between these tasks.</diffmk:wrapper></para>
+ </note>
+ </para>
+ </section>
+ <section diffmk:change="added" id="mapping">
+ <title><diffmk:wrapper diffmk:change="changed">Java Mapping Task</diffmk:wrapper></title>
+
+ <para><diffmk:wrapper diffmk:change="changed">
+ If you decide to do Java Mapping, you need to make sure that your Input reader has been set up and you have some sample data specified.
+ Then you should select </diffmk:wrapper><emphasis><diffmk:wrapper diffmk:change="added">Input Task</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="changed"> in the Process tab and click the plus (+) sign to the right of the icon.
+ Select </diffmk:wrapper><emphasis><diffmk:wrapper diffmk:change="added">Java Mapping</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> from the popup menu and it will appear to the right, connected to </diffmk:wrapper><emphasis diffmk:change="added"><diffmk:wrapper diffmk:change="added">Input Task</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added">. Then select </diffmk:wrapper><emphasis diffmk:change="added"><diffmk:wrapper diffmk:change="added">Java Mapping</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="changed"> task.
+ </diffmk:wrapper></para>
+ <figure float="0">
+ <title><diffmk:wrapper diffmk:change="changed">Java Mapping configuration</diffmk:wrapper></title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/process_page/process3.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para><diffmk:wrapper diffmk:change="changed">Another method of adding </diffmk:wrapper><emphasis><diffmk:wrapper diffmk:change="added">Java Mapping</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> element
+ to the canvas in the Processing Tasks section is to right click Input Task
+ element and select </diffmk:wrapper><emphasis diffmk:change="added"><diffmk:wrapper diffmk:change="added">Java Mapping</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="changed"> in the popup menu </diffmk:wrapper></para>
+ <figure float="0">
+ <title><diffmk:wrapper diffmk:change="changed">Java Mapping configuration</diffmk:wrapper></title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/process_page/process4.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para><diffmk:wrapper diffmk:change="changed">
+ Right-click on the canvas in an empty space and select "Add ->Java Class".
+ </diffmk:wrapper></para>
+ <figure float="0">
+ <title><diffmk:wrapper diffmk:change="changed">Java Mapping configuration</diffmk:wrapper></title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/process_page/process5.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>
+ <emphasis><diffmk:wrapper diffmk:change="added">Java Bean Creation</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> wizard appears.
+ Specify a unique identifier for the new class, the class path,
+ whether it's an array or not, and if it is a collection, also specify the collection class.
+ If the Java class is specified, you'll see a list of the properties in the box below.
+ Click </diffmk:wrapper><emphasis diffmk:change="added"><diffmk:wrapper diffmk:change="added">Finish</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="changed"> when you're done.
+ Now with the input and output models on the canvas, you can click and drag
+ from the various input elements to corresponding output elements.
+ Make sure to connect collection elements to corresponding collection elements.
+ Finally your mapping should look nearly like the one on the picture below.
+ </diffmk:wrapper></para>
+ <figure float="0">
+ <title><diffmk:wrapper diffmk:change="changed">Final Mapping schema</diffmk:wrapper></title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/process_page/process6.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+ <section diffmk:change="added">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Apply Template Task</diffmk:wrapper></title>
+
+ <para><diffmk:wrapper diffmk:change="added">The "Apply Template" task works very similarly to the </diffmk:wrapper><link diffmk:change="added" linkend="mapping"><diffmk:wrapper diffmk:change="added">"Java Mapping" task</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added">, where you map between an input model and an output model.
+ Select the </diffmk:wrapper><emphasis diffmk:change="added"><diffmk:wrapper diffmk:change="added">Java Mapping</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> task you want to use as the input model in the Process Map pane and click the plus (+) sign to the right of the icon.
+ </diffmk:wrapper></para>
+ <figure float="0">
+ <title><diffmk:wrapper diffmk:change="changed">Apply Template configuration</diffmk:wrapper></title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/process_page/process7.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para><diffmk:wrapper diffmk:change="added">
+ Select "Apply Template" from the popup menu and it will appear to the right, connected to the task you created it from. Then select the "Apply Template" task.
+ Once you've defined your template model, you can click and drag from the various input elements to corresponding output elements in the template. Make sure to connect collection elements to corresponding collection elements
+ </diffmk:wrapper></para>
+ </section>
+ <section diffmk:change="added">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Smooks Configuration testing using Smooks Run Configuration</diffmk:wrapper></title>
+
+ <para><diffmk:wrapper diffmk:change="added">This option is intended to view the results of Smooks transforming procedure.
+ For more detailed information about this option please go </diffmk:wrapper><ulink diffmk:change="added" url="http://community.jboss.org/wiki/UsingtheSmooksRunConfigurationtotestSmook..."><diffmk:wrapper diffmk:change="added">here</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para>
+ </section>
+</chapter>
+<chapter id="reference" diffmk:change="added" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/smooks/docs/reference/en/modules/references.xml">
+ <?dbhtml filename="reference.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Tools</keyword>
+ <keyword>Smooks</keyword>
+ <keyword>JBDS</keyword>
+ </keywordset>
+ </chapterinfo>
+ <title>Reference</title>
+ <para>This chapter includes detailed reference information about Smooks Tools.</para>
+ <section>
+ <title>Smooks Configuration Editor</title>
+ <para>This chapter describes the following tabs of the Smooks Configuration Editor:</para>
+
+ <itemizedlist>
+ <listitem><para><link linkend="process_tab">Process tab</link></para></listitem>
+ <listitem><para><link linkend="options_tab">Options tab</link></para></listitem>
+ <listitem><para><link linkend="smooksformeditor_sourcetab">Source tab</link></para></listitem>
+ </itemizedlist>
+ <section id="process_tab">
+ <title>Process tab</title>
+ <para>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:<emphasis>Open With->Smooks Configuration Editor</emphasis>.</para>
+ <para>The Process tab has two sections:</para>
+ <itemizedlist>
+ <listitem><para><link linkend="processing_task_section">Processing Task section</link></para></listitem>
+ <listitem><para><link linkend="selected_task_details">Selected Task Details section</link></para></listitem>
+ </itemizedlist>
+ <para>You can see them on the picture below.</para>
+ <figure>
+ <title>Two Sections of the Process tab.</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/reference/reference_1.png" scale="90"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <section id="processing_task_section">
+ <title>Processing Task section</title>
+ <para>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: </para>
+ <para>The descriptions of the popup menu options are in the following table.</para>
+ <table>
+ <title>Process Tab. Processing Task section.</title>
+ <tgroup cols="3">
+ <colspec colnum="1" align="left" colwidth="1*"/>
+ <colspec colnum="2" align="left" colwidth="3*"/>
+ <colspec colnum="3" align="left" colwidth="1*"/>
+
+ <thead>
+ <row>
+ <entry>Option</entry>
+ <entry>Description</entry>
+ <entry>Default</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>Add Task</entry>
+ <entry>Select one of the following tasks according to the necessary type of Source and Result types of the files:
+ <itemizedlist>
+ <listitem><para><emphasis>Input</emphasis> -this task is required and
+ appears automatically when Smooks config file is created.
+ You should just configure it properly.</para></listitem>
+ <listitem><para><emphasis>Java Mapping</emphasis></para></listitem>
+ <listitem><para><emphasis>Apply Template</emphasis></para></listitem>
+ </itemizedlist>
+ </entry>
+ <entry></entry>
+ </row>
+
+ <row>
+ <entry>Delete</entry>
+ <entry>Click this option if you want to delete some task from the section.
+ Note:you can't delete input task because it's required.</entry>
+ <entry></entry>
+
+ </row>
+
+ <row>
+ <entry>Input Methods</entry>
+ <entry>Choose one of the following methods:
+ <itemizedlist>
+ <listitem><para>System</para></listitem>
+ <listitem><para>Simple</para></listitem>
+ <listitem><para>Amharic(EZ+)</para></listitem>
+ <listitem><para>Cedilla</para></listitem>
+ <listitem><para>Cyrillic</para></listitem>
+ <listitem><para>Inuktitut</para></listitem>
+ <listitem><para>IPA</para></listitem>
+ <listitem><para>Multipress</para></listitem>
+ <listitem><para>SCIM Bridge Input Method</para></listitem>
+ <listitem><para>SCIM Input Method</para></listitem>
+ <listitem><para>Thai-Lio</para></listitem>
+ <listitem><para>Tigrigna-Eritrean(EZ+)</para></listitem>
+ <listitem><para>Tigrigna-Ethiopian(EZ+)</para></listitem>
+ <listitem><para>Vietnamese</para></listitem>
+ <listitem><para>X input Method</para></listitem>
+ </itemizedlist>
+ </entry>
+ <entry>System</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </section>
+ <section id="selected_task_details">
+ <title>Selected Task Details Section</title>
+ <para>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. </para>
+ <section>
+ <title>Selected Task Details Section for Input Task.</title>
+ <para>On the picture below you can find an example of Selected Task Details Section view
+ if XML is selected as input type.</para>
+
+ <figure>
+ <title>Selected Task Details Section for Input XML Task.</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/reference/reference_2.png" scale="90"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>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.</para>
+
+ <para>Here are the screens of these configuration options:</para>
+ <itemizedlist>
+ <listitem><para>CSV:</para>
+ <figure>
+ <title>Selected Task Details Section for Input CSV Task.</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/reference/reference_3.png" />
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+ <listitem><para>EDI:</para>
+ <figure>
+ <title>Selected Task Details Section for Input EDI Task.</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/reference/reference_4.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+ <listitem><para>JSON:</para>
+ <figure>
+ <title>Selected Task Details Section for Input JSON Task.</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/reference/reference_5.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+ <listitem><para>Custom:</para>
+ <figure>
+ <title>Selected Task Details Section for Input Custom Task.</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/reference/reference_6.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+ </itemizedlist>
+ <para>All the input task configuration positions can be found in the table below:</para>
+ <table>
+ <title>Selected Task Details Section. Options for Input Task.</title>
+ <tgroup cols="3">
+ <colspec colnum="1" align="left" colwidth="1*"/>
+ <colspec colnum="2" align="left" colwidth="3*"/>
+ <colspec colnum="3" align="left" colwidth="1*"/>
+ <thead>
+ <row>
+ <entry>Option</entry>
+ <entry>Description</entry>
+ <entry>Default</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>Input type</entry>
+ <entry>Select your type of input file.
+ If don't find your type in the list,you should use Custom type:
+ <itemizedlist>
+ <listitem><para>No Input</para></listitem>
+ <listitem><para>XML</para></listitem>
+ <listitem><para>Java</para></listitem>
+ <listitem><para>XSD/WSDL</para></listitem>
+ <listitem><para>CSV</para></listitem>
+ <listitem><para>EDI</para></listitem>
+ <listitem><para>JSON</para></listitem>
+ <listitem><para>Custom</para></listitem>
+ </itemizedlist>
+ </entry>
+ <entry>XML</entry>
+ </row>
+
+ <row>
+ <entry>Input configuration
+
+ </entry>
+ <entry>
+ <itemizedlist>
+ <listitem><para><emphasis>No Input</emphasis> -no info required</para></listitem>
+ <listitem><para><emphasis>XML</emphasis> -no info required</para></listitem>
+ <listitem><para><emphasis>Java</emphasis> -no info required</para></listitem>
+ <listitem><para><emphasis>XSD/WSDL</emphasis> -no info required</para></listitem>
+ <listitem><para><emphasis>CSV</emphasis></para><itemizedlist>
+ <listitem><para><emphasis>Fields</emphasis> -Comma separated list of CSV record field names
+ </para></listitem>
+ <listitem><para><emphasis>Separator Character</emphasis> -Field separator character. Default of ','.
+ </para></listitem>
+ <listitem><para><emphasis>Quote Character</emphasis> -Quote character. Default of '"'.
+ </para></listitem>
+ <listitem><para><emphasis>Record Name</emphasis> -Name of csv record element.Default:csv-record</para></listitem>
+ <listitem><para><emphasis>Root Name</emphasis> -Name of csv root element.Default:csv-set</para></listitem>
+ <listitem><para><emphasis>indent</emphasis> -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
+ </para></listitem>
+ <listitem><para><emphasis>Skip Lines</emphasis> -Number of lines to skip before processing starts. Default of 0.
+
+ </para></listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem><para><emphasis>EDI</emphasis></para>
+ <itemizedlist>
+ <listitem><para><emphasis>Target Profile</emphasis> -Defines the target profile
+ </para></listitem>
+ <listitem><para><emphasis>Encoding</emphasis> -The character encoding. Default "UTF-8"</para></listitem>
+ <listitem><para><emphasis>Mapping Model</emphasis> -Defines the EDI Mapping Model configuration for processing the
+ EDI message stream to a stream of SAX events that can be processed by Smooks.</para></listitem>
+ <listitem><para><emphasis>Validate</emphasis> -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.
+ </para></listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem><para><emphasis>JSON</emphasis></para>
+ <itemizedlist>
+ <listitem><para><emphasis>Target Profile</emphasis> -Defines the target profile</para></listitem>
+ <listitem><para><emphasis>Array Element Name</emphasis> -The element name of a array element. Default of 'element'.
+ </para></listitem>
+ <listitem><para><emphasis>Encoding</emphasis> -encoding: The default encoding of any JSON message
+ InputStream processed by this Reader. Default of 'UTF-8'.</para></listitem>
+ <listitem><para><emphasis>Illegal Element Name Char Replacement</emphasis> -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.
+ </para></listitem>
+ <listitem><para><emphasis>Indent</emphasis> -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.
+ </para></listitem>
+ <listitem><para><emphasis>Key Prefix on Numeric</emphasis> -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.
+ </para></listitem>
+ <listitem><para><emphasis>Key Whitespace Replacement</emphasis> -The replacement character for whitespaces in a JSON map key.
+ By default this not defined, so that the reader doesn't search for whitespaces.
+ </para></listitem>
+ <listitem><para><emphasis>Null Value Replacement</emphasis> -The replacement string for JSON NULL values. Default is ""(an empty string). </para></listitem>
+ <listitem><para><emphasis>Root Name</emphasis> -The element name of the document root. Default of 'json'.
+ </para></listitem>
+ <listitem><para><emphasis>Key Maps</emphasis> -Defines a JSON element name mapping
+ The "from" key will be replaced with the "to" key or the contents of the element.
+ </para></listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem><para><emphasis>Custom</emphasis></para>
+ <itemizedlist>
+ <listitem><para><emphasis>Target Profile</emphasis> -</para></listitem>
+ <listitem><para><emphasis>Class</emphasis> -Custom reader class.</para></listitem>
+ <listitem><para><emphasis>Handlers</emphasis> -Set a handler on the reader instance e.g. an EntityResolver, ErrorHandler etc.
+ </para></listitem>
+ <listitem><para><emphasis>Features</emphasis> -Reader Features List</para></listitem>
+ <listitem><para><emphasis>Parametres</emphasis> -Resource Parameters</para></listitem>
+
+ </itemizedlist>
+ </listitem>
+ </itemizedlist></entry>
+ <entry><itemizedlist>
+ <listitem><para><emphasis>CSV</emphasis></para><itemizedlist>
+ <listitem><para>not defined</para></listitem>
+ <listitem><para>','</para></listitem>
+ <listitem><para>'"'</para></listitem>
+ <listitem><para>csv-record</para></listitem>
+ <listitem><para>csv-set</para></listitem>
+ <listitem><para>true</para></listitem>
+ <listitem><para>0</para></listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem><para><emphasis>EDI</emphasis></para>
+ <itemizedlist>
+ <listitem><para>not defined</para></listitem>
+ <listitem><para>UTF-8</para></listitem>
+ <listitem><para>not defined</para></listitem>
+ <listitem><para>true</para></listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem><para><emphasis>JSON</emphasis></para>
+ <itemizedlist>
+ <listitem><para>not defined</para></listitem>
+ <listitem><para>element</para></listitem>
+ <listitem><para>UTF-8</para></listitem>
+ <listitem><para>not defined</para></listitem>
+ <listitem><para>false</para></listitem>
+ <listitem><para>not defined</para></listitem>
+ <listitem><para>not defined</para></listitem>
+ <listitem><para>""(an empty string)</para></listitem>
+ <listitem><para>'json'</para></listitem>
+ <listitem><para>not defined</para></listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem><para><emphasis>Custom</emphasis></para>
+ <itemizedlist>
+ <listitem><para>no defaults</para></listitem>
+
+ </itemizedlist>
+ </listitem>
+ </itemizedlist></entry>
+ </row>
+ <row>
+ <entry>Input Data</entry>
+ <entry>You should select a data file using <emphasis>Add</emphasis> and <emphasis>Delete</emphasis> buttons</entry>
+ <entry></entry>
+ </row>
+ <row>
+ <entry>Input Model View</entry>
+ <entry>Using this view you can see the structure of your input file.If the file has been changed, to see the changes
+ click <emphasis>Refresh</emphasis>link.</entry>
+ <entry></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </section>
+ <section id="mapping_task"><title>Selected Task Details section for Java Mapping Task.</title>
+ <para>Selected Task Details section for this task is presented by the graf,
+ that lighten the process of java mapping. </para>
+ <figure>
+ <title>Selected Task Details Section for Mapping Task.</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/reference/reference_7.png" scale="90"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para> 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. </para>
+
+ </section>
+ <section><title>Selected Task Details section for Template Task.</title>
+ <para>Selected Task Details section for this task is presented by the graf,
+ that is similar to the one in the <link linkend="mapping_task">previous section</link>.
+ </para>
+ <figure>
+ <title>Selected Task Details Section for Template Task.</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/reference/reference_7a.png" scale="90"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+ </section>
+
+ </section>
+ <section id="options_tab">
+ <title>Options Tab</title>
+ <para>This section describes Options tab of the Smooks Configuration File editor, gives short recommendations how this tab can be used during the project configuring.</para>
+ <figure>
+ <title> Options tab of the Smooks Configuration File editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/reference/reference_8.png" scale="90"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <section>
+ <title>Smooks Configuration section</title>
+ <para>
+ In the <property>Smooks Configuration</property> section of <property>Options Tab</property>
+ only one element is availible:Smooks Platform Version
+ </para>
+ <figure>
+ <title>Smooks Configuration section of Options tab</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/reference/reference_9.png" scale="90"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>This parameter is not rechangable,
+ and is set according to the vesion of the Smooks libraries that are added to the project.
+ </para>
+ </section>
+
+ <section>
+ <title>Filter Settings Filter section</title>
+ <para>
+ In Filter Settings section you can set
+ the following global options responsible for Smooks filtering configuring:</para>
+ <figure>
+ <title>Filter Settings section of Options tab</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/reference/reference_10.png" scale="90"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>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.
+ </para>
+ <table>
+ <title>Options Tab. Filter Settings section.</title>
+ <tgroup cols="3">
+ <colspec colnum="1" align="left" colwidth="1*"/>
+ <colspec colnum="2" align="left" colwidth="3*"/>
+ <colspec colnum="3" align="left" colwidth="1*"/>
+
+ <thead>
+ <row>
+ <entry>Option</entry>
+ <entry>Description</entry>
+ <entry>Default</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>Stream Filter Type</entry>
+ <entry>Determines the type of processing model that will be used.
+ Please refer to <ulink url="http://www.smooks.org/mediawiki/index.php?title=V1.2:Smooks_v1.2_User_Gui...">
+ Filtering Process Selection section</ulink>
+ of the official Smooks User Guide for more information about these models:
+ <itemizedlist>
+ <listitem><para><emphasis>SAX</emphasis></para></listitem>
+ <listitem><para><emphasis>DOM</emphasis></para></listitem>
+ </itemizedlist>
+ </entry>
+ <entry>DOM</entry>
+ </row>
+
+ <row>
+ <entry>Default Serialization is On</entry>
+ <entry>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.</entry>
+ <entry>true</entry>
+
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </section>
+ </section>
+ <section id="smooksformeditor_sourcetab" xreflabel="Smooks Source Tab">
+
+ <title>Source Tab</title>
+ <para>This section provides information about Smooks Source Editor Page.</para>
+ <section>
+ <title>XML Source Editor</title>
+ <para>You can use this editor to edit the Smooks Configuration file directly. </para>
+ <figure>
+ <title>Graphical Editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/source_editor/source_editor1.png" scale="90"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+ <section>
+ <title>Error underlining in Graphical Editor</title>
+ <para>If the <property>Smooks tools</property> 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.</para>
+ <figure>
+ <title>Graphical Editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/reference/reference_11.png" scale="90"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ </section>
+
+ <section>
+ <title>Smooks Configuration File Validator</title>
+ <para>Smooks configuration file validator will validate your Smooks configuration file. Just right-click on the file and then click on the <property>Validate</property> button. The validator can be enabled/disabled in <emphasis><property>Window -> Preferences -> Validation</property></emphasis>:</para>
+
+ <figure>
+ <title>Validation: Smooks Configuration File Validator</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/source_editor/smooks_conf_validator.png" scale="90"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>You can set up your Smooks validator to include, exclude groups to validate and specify rules for validation. Just click on the <property>Settings</property> button and use the options provided:</para>
+
+ <figure>
+ <title>Smooks Configuration File Validator Settings</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/source_editor/smooks_conf_validator_settings.png" scale="90"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+
+ </section>
+ </section>
+ </section>
+</chapter>
+
+<chapter diffmk:change="added" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/smooks/docs/reference/en/modules/summary.xml">
+ <?dbhtml filename="summary.html"?>
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Summary</diffmk:wrapper></title>
+ <para><diffmk:wrapper diffmk:change="added">In conclusion, with this document you know all the capabilities of Smooks Tools and could easily start with them.
+ The chapters above walked you through the steps on how to create and configure some XML to JAVA mapping project.
+ If you have questions or suggestions concerned both the documentation and tools behavior,
+ you are welcome to JBoss Tools Users forum.
+ Please, use Jira to report bugs and requests on documentation.</diffmk:wrapper></para>
+
+ <section diffmk:change="added">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Other relevant resources on the topic</diffmk:wrapper></title>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">All JBoss Developer Studio/JBoss Tools release documentation you can find at
+ </diffmk:wrapper><ulink diffmk:change="added" url="http://docs.jboss.org/tools"><diffmk:wrapper diffmk:change="added">http://docs.jboss.org/tools</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added"> in the corresponding release directory.
+ </diffmk:wrapper></para>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The latest documentation builds are available at </diffmk:wrapper><ulink diffmk:change="added" url="http://download.jboss.org/jbosstools/nightly-docs"><diffmk:wrapper diffmk:change="added">http://download.jboss.org/jbosstools/nightly-docs</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added">. </diffmk:wrapper></para>
+<para diffmk:change="added"><diffmk:wrapper diffmk:change="added">For more information about Smooks technology please visit
+ </diffmk:wrapper><ulink diffmk:change="added" url="http://www.smooks.org/mediawiki/index.php?title=Main_Page"><diffmk:wrapper diffmk:change="added">
+ Smooks Technology Home Page</diffmk:wrapper></ulink></para>
+
+ </section>
+</chapter>
+
+</book>
14 years, 4 months
- 1
- 0
JBoss Tools SVN: r20354 - trunk/portlet/docs/reference/en.
by jbosstools-commits＠lists.jboss.org
Author: ochikvina
Date: 2010-02-18 05:35:18 -0500 (Thu, 18 Feb 2010)
New Revision: 20354
Modified:
trunk/portlet/docs/reference/en/master.xml
trunk/portlet/docs/reference/en/master_output.xml
Log:
<html><head><meta name="qrichtext" content="1" /></head><body style="font-size:9pt;font-family:Sans Serif">
<p>https://jira.jboss.org/jira/browse/JBDS-1104 - Updated versions,corrected master_output file</p>
</body></html>
Modified: trunk/portlet/docs/reference/en/master.xml
===================================================================
--- trunk/portlet/docs/reference/en/master.xml 2010-02-18 09:49:18 UTC (rev 20353)
+++ trunk/portlet/docs/reference/en/master.xml 2010-02-18 10:35:18 UTC (rev 20354)
@@ -45,12 +45,12 @@
<copyright>
<year>2008</year>
- <year>2009</year>
+ <year>2009</year>
<year>2010</year>
<holder>JBoss by Red Hat</holder>
</copyright>
<releaseinfo>
- Version: 1.1.0.CR1
+ Version: 1.1.0.CR2
</releaseinfo>
<abstract>
Modified: trunk/portlet/docs/reference/en/master_output.xml
===================================================================
--- trunk/portlet/docs/reference/en/master_output.xml 2010-02-18 09:49:18 UTC (rev 20353)
+++ trunk/portlet/docs/reference/en/master_output.xml 2010-02-18 10:35:18 UTC (rev 20354)
@@ -4,10 +4,12 @@
[<!ENTITY intro SYSTEM "modules/intro.xml">
<!ENTITY installation SYSTEM "modules/installation.xml">
+<!ENTITY portlet_tools_tasks SYSTEM "modules/portlet_tools_tasks.xml">
<!ENTITY starting_project SYSTEM "modules/starting_project.xml">
<!ENTITY jsf_portlet SYSTEM "modules/jsf_portlet.xml">
<!ENTITY seam_portlet SYSTEM "modules/seam_portlet.xml">
-<!ENTITY portlets_to_nonWTP_projects SYSTEM "modules/portlets_to_nonWTP_projects.xml">
+<!ENTITY reference SYSTEM "modules/reference.xml">
+<!ENTITY summary SYSTEM "modules/summary.xml">
<!ENTITY seamlink "../../seam/html_single/index.html">
<!ENTITY aslink "../../as/html_single/index.html">
@@ -20,982 +22,1666 @@
<!ENTITY jsftutoriallink "../../jsf_tools_tutorial/html_single/index.html">
<!ENTITY strutsreflink "../../struts_tools_ref_guide/html_single/index.html">
<!ENTITY strutstutoriallink "../../struts_tools_tutorial/html_single/index.html">
-]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff">
-
- <bookinfo>
- <title>JBoss Portal Tools Reference Guide</title>
- <corpauthor>
- <inlinemediaobject>
- <imageobject role="fo">
- <imagedata fileref="images/jbosstools_logo.png" format="PNG"></imagedata>
- </imageobject>
- <imageobject role="html">
- <imagedata></imagedata>
- </imageobject>
- </inlinemediaobject>
- </corpauthor>
- <author><firstname>Olga</firstname><surname>Chikvina</surname></author>
- <author><firstname>Snjezana</firstname><surname>Peco</surname><email>snjezana.peco(a)redhat.com</email></author>
- <author><firstname>Svetlana</firstname><surname>Mukhina</surname><email>smukhina(a)exadel.com</email></author>
- <author><firstname>Thomas</firstname><surname>Heute</surname><email>theute(a)jboss.org</email></author>
-
- <pubdate>September 2008</pubdate>
- <copyright>
- <year>2008</year>
- <year>2009</year>
- <holder>JBoss by Red Hat</holder>
- </copyright>
- <releaseinfo><diffmk:wrapper diffmk:change="changed">
- Version: 1.1.0.CR1
- </diffmk:wrapper></releaseinfo>
-
-<abstract>
- <title></title>
- <para>
- <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jboss_portal_tools_r...">PDF version</ulink>
- </para>
-</abstract>
-
-
- </bookinfo>
- <toc></toc>
-
-
-
-<chapter id="intro" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/portlet/docs/reference/en/modules/intro.xml" xreflabel="intro">
- <?dbhtml filename="intro.html"?>
- <title>Introduction</title>
-
- <para>Starting from 3.0.0.Alpha1 version, JBoss set of plugins extends <property moreinfo="none">JBoss Portal</property>
- features. Thus, this guide is intended to explain you how to manage the functionality
- <property moreinfo="none">JBoss Tools</property> provide to ease the development with <property moreinfo="none">JBoss
- Portal</property>.</para>
-
- <section id="preface">
- <title>Preface</title>
- <para><property moreinfo="none">JBoss Portal</property> provides an open source platform for hosting and
- serving a portal's Web interface, publishing and managing its content, and customizing
- its experience. It supports a wide range of features, including standard portlets,
- single sign-on, clustering, and internationalization.</para>
- </section>
-
- <section id="key_features">
- <title>Key Features</title>
- <para>The next table lists key features supplied by <property moreinfo="none">JBoss Portal Tools</property>.</para>
-
- <table>
- <title>Key Functionality of JBoss Portal Tools</title>
- <tgroup cols="3">
-
- <colspec align="left" colnum="1" colwidth="1*"></colspec>
- <colspec colnum="2" colwidth="5*"></colspec>
- <colspec align="left" colnum="3" colwidth="1*"></colspec>
-
- <thead>
- <row>
- <entry>Feature</entry>
- <entry>Benefit</entry>
- <entry>Chapter</entry>
- </row>
- </thead>
-
- <tbody>
-
- <row>
- <entry>
- <para>Wizards for creating Projects with Portlet Facets</para>
- </entry>
- <entry>
- <para>New Dynamic Web Project wizard allows you to select a proper
- Configuration to enable Portlet Facet in it.</para>
- </entry>
- <entry>
- <link linkend="creating_project_with_jbossportal">Creating a Dynamic
- Web Project</link>
- </entry>
- </row>
-
-
- <row>
- <entry>
- <para>Create Java Portlet wizard</para>
- </entry>
-
- <entry>
- <para>The wizard enables creating a JSR-186/JSR-286 compliant
- portlet.</para>
- </entry>
- <entry>
- <link linkend="adding_java_portlet">Adding Java Portlet to a
- project</link>
- </entry>
- </row>
-
- <row>
- <entry>
- <para>Create JSF/Seam Portlet wizard</para>
- </entry>
- <entry>
- <para>This wizard allows to create JSF/Seam portlets</para>
- </entry>
- <entry>
- <link linkend="jsf_portlet">Creating JSF Portlet</link>
- <link linkend="seam_portlet">Creating Seam Portlet</link>
- </entry>
- </row>
-
- </tbody>
- </tgroup>
- </table>
- </section>
-
- <section id="rel_resources">
- <title>Other relevant resources on the topic</title>
-
- <itemizedlist>
- <listitem>
- <para>
- <ulink url="http://www.jboss.org/jbossportal/">JBoss Portal Home Page</ulink>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <ulink url="http://wiki.jboss.org/wiki/JBossPortal">JBoss Portal Wiki</ulink>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <ulink url="http://www.jboss.org/tools/">JBoss Tools Home Page</ulink>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss Tools Forum</ulink>
- </para>
- </listitem>
-
- <listitem>
- <para>
- <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">The latest
- JBossTools/JBDS documentation builds</ulink>
- </para>
- </listitem>
-
- <listitem>
- <para>JBoss Developer Studio/JBoss Tools release documentation you can find at<ulink url="http://docs.jboss.org/tools/">http://docs.jboss.org/tools</ulink> in the corresponding release directory.</para>
- </listitem>
- </itemizedlist>
-
- </section>
-</chapter>
-
-
-<chapter id="installation" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/portlet/docs/reference/en/modules/installation.xml" xreflabel="installation">
- <?dbhtml filename="installation.html"?>
- <title>Installation issues</title>
-
- <para>This section provides you with the steps on how to start with <property moreinfo="none">JBoss
- Portal</property> and integrated features using <property moreinfo="none">JBoss Tools</property>.</para>
-
- <itemizedlist>
- <listitem>
- <para>First, you need to have Eclipse Ganymede with JBoss Tools 3.0.0.Alpha1 and higher installed.</para>
-
- <tip>
- <title>Tip:</title>
- <para>Read <ulink url="../../GettingStartedGuide/html_single/index.html#JBossToolsInstall">JBoss Tools
- Installation</ulink> section in our Getting Started documentation to find out
- how to install <property moreinfo="none">JBoss Tools</property> onto Eclipse.</para>
- </tip>
- </listitem>
-
- <listitem>
- <para>Next, download the JBoss Portal + JBoss AS bundle from <ulink url="http://www.jboss.org/jbossportal/download/index.html">JBoss Portal Download
- page</ulink></para>
-
- <note>
- <title>Note:</title>
- <para>You need JBoss Portal 2.7 if you want to work with a Portlet 2.0</para>
- </note>
-
- </listitem>
-
- <listitem>
- <para>Extract the bundle wherever you want on your hard drive</para>
- </listitem>
- </itemizedlist>
-
- <para>Now, when you have it installed, we are going to demonstrate some powerful features of
- <property moreinfo="none">JBoss Portal</property> tooling for Eclipse.</para>
-</chapter>
-
-
-<chapter id="starting_project" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/portlet/docs/reference/en/modules/starting_project.xml" xreflabel="starting_project">
- <?dbhtml filename="starting_project.html"?>
- <title>Starting the Project with JBoss Portal</title>
-
- <para>To get started with <property moreinfo="none">JBoss Portal</property> and <property moreinfo="none">JBoss
- Tools</property>, you should first have a Web Project pointed to the JBoss Portal Runtime.
- Thus, in this chapter we are going to show you how to create a Dynamic Web Project, add Java
- Portlet to it and deploy it to the <property moreinfo="none">JBoss Portal</property>.</para>
-
- <section id="creating_project_with_jbossportal">
- <title>Creating a Dynamic Web Project</title>
-
- <para>To create a Dynamic Web Project, go to <emphasis>
- <property moreinfo="none">File > New > Dynamic Web Project</property>
- </emphasis> if you are in the <property moreinfo="none">Web Perspective</property> or <property moreinfo="none">File >
- New > Other > Web > Dynamic Web Project</property> in any other Perspective. The
- first page of the New Dynamic Web Project wizard looks as follows.</para>
-
- <figure float="0">
- <title>New Dynamic Web Project</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/starting_project/starting_project_1.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Fill out the name of your project. Next, click the <emphasis>
- <property moreinfo="none">New</property>
- </emphasis> button in the <emphasis>
- <property moreinfo="none">Target Runtime</property>
- </emphasis> section to specify a new Target Runtime. Choose <emphasis>
- <property moreinfo="none"> JBoss Community > JBoss 4.2 Runtime</property>
- </emphasis> and select the <emphasis>
- <property moreinfo="none">Create a new local server</property>
- </emphasis> checkbox. Click <emphasis>
- <property moreinfo="none">Next</property>.</emphasis></para>
-
- <figure float="0">
- <title>New Server Runtime</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/starting_project/starting_project_2.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>On the next page you should give a name to the runtime. Let's call it <emphasis>
- <property moreinfo="none">JBoss Portal 2.7 Runtime</property>
- </emphasis>, and then point it to the location of your JBoss AS + Portal
- installation.</para>
-
- <figure float="0">
- <title>New Server Runtime Environment</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/starting_project/server_runtime_environment.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <note>
- <title>Note:</title>
-
- <para>The JBoss Tools Portlet feature has been tested using 2.6.5 and 2.7.0.ALPHA
- versions of <property moreinfo="none">JBoss Portal</property>. Remember, if you want to use Portlet
- version 2.0 (JSR-268), you have to choose JBoss Portal 2.7.</para>
- </note>
-
- <para>At this point a new JBoss Server instance will be created. Here you can verify the
- defined runtime information. If something is incorrect, press <emphasis>
- <property moreinfo="none">Back</property>
- </emphasis> to return on the previous wizard page.</para>
-
- <figure float="0">
- <title>Target Server</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/starting_project/starting_project_3.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Click <emphasis>
- <property moreinfo="none">Finish</property>.</emphasis></para>
-
- <para>On the next step you should click the <emphasis>
- <property moreinfo="none">Modify</property>
- </emphasis> button next to the <property moreinfo="none">Configuration</property> section to enable
- Portlet Facets for the project.</para>
-
- <figure float="0">
- <title>Setting the Project Configuration</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/starting_project/starting_project_4.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>On this page you should check the <emphasis>
- <property moreinfo="none">JBoss Core Portlet</property>
- </emphasis> and press <emphasis>
- <property moreinfo="none">OK</property>
- </emphasis>.</para>
-
- <figure float="0">
- <title>Enabling the Portlet Facet</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/starting_project/starting_project_4_a.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <note>
- <title>Note:</title>
- <para>If the portlet libraries aren't available in the runtime you targeted,
- JBoss Portlet facets will be hidden on this page.</para>
- <para>To made portal functionality always visible no matter what the runtime support,
- you should go to <emphasis>
- <property moreinfo="none">Window > Preferences</property>
- </emphasis> and then <emphasis>
- <property moreinfo="none">JBoss Tools > JBoss Portlet</property>
- </emphasis> and deselect <emphasis>
- <property moreinfo="none">Check runtimes for Portlet Components</property>
- </emphasis> checkbox (see figure below).</para>
- </note>
-
- <figure float="0">
- <title>JBoss Runtime Preferences</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/starting_project/portlet_preferences.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>The next page is for configuring web modules. Here all values are set, so you can
- leave everything as it is.</para>
-
- <figure float="0">
- <title>The Project Web Modules</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/starting_project/starting_project_5.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Finally, the last wizard page will ask you to add JBoss Portlet capabilities to your
- project. Here you can choose whether to set up user libraries, libraries provided by
- server runtime or not include libraries at all.</para>
-
- <itemizedlist>
- <listitem><para>To set up server runtime libraries, you need to select <emphasis>
- <property moreinfo="none">Libraries provided by server runtime</property></emphasis> in the list box.</para>
- </listitem>
- </itemizedlist>
-
- <figure float="0">
- <title>Including Server Runtime Libraries</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/starting_project/portlet_capabilities6.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <itemizedlist>
- <listitem>
- <para>For setting up user libraries, select <emphasis>
- <property moreinfo="none">User library</property></emphasis> in the list box and then press <emphasis>
- <property moreinfo="none">Add</property></emphasis> in the <emphasis>
- <property moreinfo="none">User Library</property></emphasis> section.</para>
- </listitem>
- </itemizedlist>
-
- <figure float="0">
- <title>Adding User Library</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/starting_project/portlet_capabilities1.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Then press <emphasis>
- <property moreinfo="none">New</property></emphasis> and type the user library name in the appeared dialog.</para>
-
- <figure float="0">
- <title>Adding User Library</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/starting_project/portlet_capabilities2.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Next add necessary jar's.</para>
-
- <figure float="0">
- <title>Adding the Portlet API Jar</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/starting_project/portlet_capabilities3.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Hit <emphasis>
- <property moreinfo="none">OK</property>.</emphasis> The user library will be added.
- </para>
-
- <figure float="0">
- <title>User Library Added</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/starting_project/portlet_capabilities4.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <itemizedlist>
- <listitem><para>If you don't need to include libraries at all, just deselect the <emphasis>
- <property moreinfo="none">Enable implementation library</property></emphasis> checkbox.</para>
- </listitem>
- </itemizedlist>
-
- <figure float="0">
- <title>Disabling Implementation Libraries</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/starting_project/portlet_capabilities5.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>After setting JBoss Portlet capabilities press <emphasis>
- <property moreinfo="none">Finish</property>.</emphasis></para>
-
- <para>That's it! Our base project is done.</para>
-
- </section>
-
- <section id="structure_overview">
- <title>The Project Structure Overview</title>
-
- <para>Now, let's look at the structure of the just created project.</para>
-
- <figure float="0">
- <title>The Project Structure Overview</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/starting_project/starting_project_6.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Here <property moreinfo="none">JBoos Tools</property> added JBoss Portlet facet to the project,
- created an empty <emphasis>
- <property moreinfo="none">portlet.xml</property>
- </emphasis> file and added the Portlet library to the project classpath.</para>
- </section>
-
- <section id="adding_java_portlet">
- <title>Adding a Java Portlet to the Project</title>
-
- <para>At this point we'll show what the steps you need to proceed to add a new Java
- Portlet to the project.</para>
-
- <para>Call the <property moreinfo="none">Create Portlet wizard</property> by selecting <emphasis>
- <property moreinfo="none">New > Other > JBoss Tools Web > Portlet > Java
- Portlet</property>.</emphasis></para>
-
- <figure float="0">
- <title>New Java Portlet</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/starting_project/starting_project_7.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>The wizard fills in the Web Project and Source Folder fields for you. Then you need to
- specify the Java package and the Class name and click <emphasis>
- <property moreinfo="none">Next</property>
- </emphasis>.</para>
-
- <figure float="0">
- <title>Specifying Class File Destination</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/starting_project/starting_project_8.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>On the other page you will be able to set the display name of the Portlet, a title, a
- description, the supported modes and init parameters.</para>
-
- <figure float="0">
- <title>Specifying Class File Destination</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/starting_project/starting_project_9.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>On the next screen you can define which methods from
- <emphasis>GenericPortlet</emphasis> you want to override.</para>
-
- <figure float="0">
- <title>Specifying Class File Destination</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/starting_project/starting_project_10.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>The last screen lets you build <property moreinfo="none">JBoss Portal</property> specific descriptors
- to create an instance during the deployment and place it directly on the Portal.</para>
-
- <figure float="0">
- <title>Specifying Class File Destination</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/starting_project/starting_project_11.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <tip>
- <title>Tip:</title>
-
- <para>If you uncheck the <emphasis> Create Portlet Instance</emphasis> checkbox,
- <property moreinfo="none">JBoss Tools</property> won't create the deployment elements
- in the <emphasis> default-object.xml</emphasis> and <emphasis>
- portlet-instances.xml</emphasis> files.</para>
- </tip>
-
- <para>Once Java Portlet is created, new resources have been added to the project structure.
- As you can see on the figure below, it adds a Java Portlet class (<emphasis>
- <property moreinfo="none">TestPortlet.java</property>
- </emphasis> in our case), <emphasis>
- <property moreinfo="none">default-object.xml</property>
- </emphasis> and <emphasis>
- <property moreinfo="none">portlet-instances.xml</property>
- </emphasis> files and updates <emphasis>
- <property moreinfo="none">portlet.xml</property>
- </emphasis> as well.</para>
-
- <figure float="0">
- <title>The structure of Web Project with Java Portlet created</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/starting_project/starting_project_12.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Thus, now the Project is ready to be built and deployed.</para>
- </section>
-
- <section id="deploying_to_portal">
- <title>Deploying a Portlet to JBoss Portal</title>
-
- <para>You can deploy the created project in the way you deploy any other Web Application.
- Right click on the project and do <emphasis>
- <property moreinfo="none">Run As > Run On Server</property>
- </emphasis> and accept the defaults. On the <emphasis>
- <property moreinfo="none">Add and Remove Projects</property>
- </emphasis> page move the created Project to the right and click <emphasis>
- <property moreinfo="none">Finish</property>.</emphasis></para>
-
- <figure float="0">
- <title>Deploying the Portlet Application</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/starting_project/starting_project_13.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>It will deploy the Portlet Web Application and start <property moreinfo="none">JBoss
- AS</property>.</para>
-
- <tip>
- <title>Tip:</title>
-
- <para>You should use <emphasis>http://localhost:8080/portal</emphasis> URL to see your
- Portlet in the Browser.</para>
- </tip>
-
- <para>In the Browser the Portlet looks as follows:</para>
-
- <figure float="0">
- <title>Java Portlet in the Browser Window</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/starting_project/starting_project_14.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Consequently, here you learnt how to create a Dynamic Web Project, add Java Portlet to
- it and deploy the project to <property moreinfo="none">JBoss Portal</property>.</para>
- </section>
-
-</chapter>
-
-
-<chapter id="jsf_portlet" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/portlet/docs/reference/en/modules/jsf_portlet.xml" xreflabel="jsf_portlet">
- <?dbhtml filename="jsf_portlet.html"?>
- <title>Creating JSF Portlet</title>
-
- <para>This chapter will explain how you can configure JSF Portlet within Dynamic Web
- Project and JSF Project by using the wizards <property moreinfo="none">JBoss Tools</property> provides.</para>
-
- <section id="jsf_portlet1">
- <title>Adding JSF Portlet to Dynamic Web Project</title>
-
- <para>To add JSF Portlet to a Dynamic Web Project, you should set the Configuration to <emphasis>
- <property moreinfo="none">JavaServer Faces v1.1 Project</property>
- </emphasis> or <emphasis>
- <property moreinfo="none">JavaServer Faces v1.2 Project</property>
- </emphasis> and configure the JSF Portlet Facets in the <property moreinfo="none">New Dynamic Web
- Project wizard</property> by clicking the <emphasis>
- <property moreinfo="none">Modify</property>
- </emphasis> button.</para>
-
- <figure float="0">
- <title>Setting the JSF Configuration</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_portlet/jsf_portlet1.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>On the Project Facets dialog you should select <property moreinfo="none">JBoss Core Portlet</property>
- and <property moreinfo="none">JBoss JSF Portlet</property> check boxes.</para>
-
- <figure float="0">
- <title>Enabling the Portlet Facets</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_portlet/jsf_portlet2.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Next wizard page is for configuring JSF Capabilities. You can leave everything as it
- is here.</para>
-
- <figure float="0">
- <title>JSF Capabilities</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_portlet/jsf_portlet3.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>To support Portlets in JSF/Seam applications <property moreinfo="none">JBoss Tools</property> works
- with <property moreinfo="none">JBoss Portlet Bridge</property>. Thus on the next page you should add JSF Portlet
- capabilities by pointing to the Portletbridge Runtime location.</para>
-
- <figure float="0">
- <title>JSF Capabilities</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_portlet/jsf_portlet4.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <tip>
- <title>Tip:</title>
-
- <para>You can download JBoss Portlet Bridge 1.0.0.B4 from <ulink url="http://www.jboss.org/portletbridge/download/">Portletbridge Download page</ulink>.</para>
- </tip>
-
- <para>Next click <emphasis>
- <property moreinfo="none">Finish</property>
- </emphasis> to organize the Project.</para>
- <para id="add_jsf_portlet">To add JSF Portlet to generated project you should call the
- <property moreinfo="none">Create Portlet wizard</property> by navigating to <emphasis>
- <property moreinfo="none">New > Other > JBoss Tools Web > Portlet > JSF/Seam
- Portlet</property>.</emphasis></para>
-
- <figure float="0">
- <title>Calling New Portlet Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_portlet/jsf_portlet5.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>As you see, the Seam and JSF Portlet wizards are merged into one. We set JSF
- Configuration for the project, so default values in this wizard will be set as for a JSF
- portlet.</para>
-
- <figure float="0">
- <title>Creating JSF Portlet</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_portlet/jsf_portlet6.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Click <emphasis>
- <property moreinfo="none">Finish</property>
- </emphasis> to complete JSF Portlet creation. Now you can deploy the project the same
- way as it was <link linkend="deploying_to_portal">described above</link>.</para>
-
- <para>In the Browser JSF Portlet looks as follows.</para>
-
- <figure float="0">
- <title>JSF Portlet in the Browser</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_portlet/jsf_portlet7.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
-
- <section id="jsf_portlet_to_JSF_project">
- <title>Adding JSF Portlet to JSF Project</title>
-
- <para>How to organize a JSF Project you can find out in our <ulink url="../../jsf_tools_ref_guide/html_single/index.html#new_jsf_project">JSF Tools Reference Guide</ulink>. Just
- remember to point Target Runtime to JBoss Portal directory location.</para>
-
- <figure float="0">
- <title>Creating New JSF Project</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_portlet/jsf_portlet8.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Before adding a Portlet to the project you should enable necessary facets for it.
- Right-click the created project and click <emphasis>
- <property moreinfo="none">Preferences</property>
- </emphasis> to open the <property moreinfo="none">Project Preferences</property> screen.</para>
- <para>On the <property moreinfo="none">Project Facets</property> page select the <emphasis>
- <property moreinfo="none">JBoss Core Portlet</property>
- </emphasis> and <emphasis>
- <property moreinfo="none">JBoss JSF Portlet</property>
- </emphasis> checkboxes. And then the screen will ask you to enable <emphasis>
- <property moreinfo="none">JavaServer Faces</property>
- </emphasis> facet as well.</para>
-
- <figure float="0">
- <title>Project Facets</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_portlet/jsf_portlet9.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Notice, <emphasis>
- <property moreinfo="none">"Further configuration required..."</property>
- </emphasis> warning appears at the bottom of the screen. It means that you should click
- it to configure JSF and JSF Portlet Capabilities in the project.</para>
-
- <figure float="0">
- <title>JSF Capabilities</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_portlet/jsf_portlet10.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <figure float="0">
- <title>Project Facets</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/jsf_portlet/jsf_portlet11.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>After setting the path to Portletbridge Runtime location, click <emphasis>
- <property moreinfo="none">OK</property>
- </emphasis> and then <emphasis>
- <property moreinfo="none">OK</property>
- </emphasis> again.</para>
-
- <para>Now you can add JSF Portlet to the generated JSF Project. How to do it we showed in
- <link linkend="add_jsf_portlet">the previous section</link>.</para>
- </section>
-</chapter>
-
-
-<chapter id="seam_portlet" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/portlet/docs/reference/en/modules/seam_portlet.xml" xreflabel="seam_portlet">
- <?dbhtml filename="seam_portlet.html"?>
- <title>Creating Seam Portlet</title>
-
- <para>This chapter covers the steps on how to configure Seam Portlet within Dynamic Web
- Project and Seam Project by using the wizards <property moreinfo="none">JBoss Tools</property> provides.</para>
-
- <section id="seam_portlet1">
- <title>Adding Seam Portlet to Dynamic Web Project</title>
-
- <para>To add Seam Portlet to a Dynamic Web Project first you should organize New Dynamic Web
- Project with the Configuration setting to <emphasis>
- <property moreinfo="none">JBoss Seam Portlet Project v2.0</property>.</emphasis></para>
-
- <figure float="0">
- <title>Calling New Portlet Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_portlet/seam_portlet1.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>It will add all needed facets to your project. By clicking the <emphasis>
- <property moreinfo="none">Modify</property>
- </emphasis> button you can observe the chosen configuration of facets as well as modify
- it. As you can see, all JBoss Portlets are checked.</para>
-
- <figure float="0">
- <title>Project Facets</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_portlet/seam_portlet2.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Next wizard pages are for adjusting the Project Web Modules and JSF Configuration.
- They include default values, so you can skip them by pressing <emphasis>
- <property moreinfo="none">Next</property>.</emphasis></para>
-
- <para>On the <property moreinfo="none">Seam Facet</property> page <ulink url="../../seam/html_single/index.html#seamFacet">set
- Connection Profile</ulink> and hit <emphasis>
- <property moreinfo="none">Next</property>.</emphasis></para>
-
- <figure float="0">
- <title>Seam Facet Settings</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_portlet/seam_portlet3.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Last wizard page will prompt you to set the path to Portletbridge Runtime
- location.</para>
-
- <figure float="0">
- <title>Setting the Portletbridge Runtime</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_portlet/seam_portlet4.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <tip>
- <title>Tip:</title>
-
- <para>Thus you should have JBoss Portlet Bridge downloaded and extracted somewhere on
- your hard drive. You can download JBoss Portlet Bridge 1.0.0.B4 from <ulink url="http://www.jboss.org/portletbridge/download/">www.jboss.org/portletbridge/download</ulink>.</para>
- </tip>
-
- <para>Now, to add Seam Portlet to the project you should follow to <emphasis>
- <property moreinfo="none">New > Other > JBoss Tools Web > Portlet > JSF/Seam
- Portlet</property>.</emphasis> This will call the wizard for creating JSF/Seam
- Portlets.</para>
-
- <figure float="0">
- <title>Calling the Create Portlet Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_portlet/seam_portlet5.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>As we set Seam Configuration for the Dynamic Web Project, the wizard puts the values
- as for Seam Portlet.</para>
-
- <figure float="0">
- <title>Creating Seam Portlet</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_portlet/seam_portlet6.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>After creating the Seam Portlet, you should <link linkend="deploying_to_portal">deploy
- the project to JBoss Portal</link> and start the Server. In a Browser
- you'll see the following:</para>
-
- <figure float="0">
- <title>Seam Portlet in the Browser</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_portlet/seam_portlet7.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
-
- <section id="seam_portlet_to_seam_project">
- <title>Adding Seam Portlet to Seam Project</title>
-
- <para>First start a Seam Project by following to <emphasis>
- <property moreinfo="none">New > Other > Seam > Seam Web Project</property>. </emphasis> On the first
- wizard page specify JBoss Portal directory location as <property moreinfo="none">Target
- Runtime</property> and <emphasis>
- <property moreinfo="none">JBoss Seam Portlet Project v2.0</property>
- </emphasis> as <property moreinfo="none">Configuration</property>.</para>
-
- <figure float="0">
- <title>Project Facets</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_portlet/seam_portlet8.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>Next steps will be the same as we did for the Dynamic Web Project in the <link linkend="seam_portlet1">Adding Seam Portlet to Dynamic Web Project</link>
- section.</para>
- </section>
-</chapter>
-
-
-<chapter id="portlets_to_nonWTP_projects" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/portlet/docs/reference/en/modules/portlets_to_nonWTP_projects.xml" xreflabel="portlets_to_nonWTP_projects">
- <?dbhtml filename="portlets_to_nonWTP_projects.html"?>
- <title>Adding Portlets to non-WTP Projects</title>
-
- <para>Starting from <property moreinfo="none">JBoss Tools 3.0.0.Beta1</property> version the JBoss Portlet
- wizards no longer require a WTP project to be able to create Portlets.</para>
-
- <note>
- <title>Note:</title>
- <para>Please note, if the project does not have the proper portlet API jar's, the generated
- classes will have compile errors.</para>
- </note>
-
- <para>In conclusion, with this document you've learnt how to get started with <property moreinfo="none">JBoss
- Portal</property> using <property moreinfo="none">JBoss Tools</property> suite of Eclipse plugins.
- The above chapters walked you through the steps on how to organize a web project with
- portlets which includes a sample staff and deploy it onto the <property moreinfo="none">JBoss
- Portal</property>.</para>
-
- <para>If you still have questions or suggestions you are always welcome on our <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">Forum</ulink>. Your feedback will be very much appreciated.</para>
-
-</chapter>
-
-
-</book>
+]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff">
+
+ <bookinfo>
+ <title><diffmk:wrapper diffmk:change="changed">JBoss Portlet Tools User Guide</diffmk:wrapper></title>
+ <corpauthor>
+ <inlinemediaobject>
+ <imageobject role="fo">
+ <imagedata fileref="images/jbosstools_logo.png" format="PNG"></imagedata>
+ </imageobject>
+ <imageobject role="html">
+ <imagedata></imagedata>
+ </imageobject>
+ </inlinemediaobject>
+ </corpauthor>
+ <author><firstname>Olga</firstname><surname>Chikvina</surname></author>
+ <author><firstname>Snjezana</firstname><surname>Peco</surname><email>snjezana.peco(a)redhat.com</email></author>
+ <author><firstname>Svetlana</firstname><surname>Mukhina</surname><email>smukhina(a)exadel.com</email></author>
+ <author><firstname>Thomas</firstname><surname>Heute</surname><email>theute(a)jboss.org</email></author>
+
+ <copyright>
+ <year>2008</year>
+ <year>2009</year>
+ <year diffmk:change="added"><diffmk:wrapper diffmk:change="added">2010</diffmk:wrapper></year>
+ <holder>JBoss by Red Hat</holder>
+ </copyright>
+ <releaseinfo><diffmk:wrapper diffmk:change="changed">
+ Version: 1.1.0.CR2
+ </diffmk:wrapper></releaseinfo>
+
+<abstract>
+ <title></title>
+ <para>
+ <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jboss_portal_tools_r...">PDF version</ulink>
+ </para>
+</abstract>
+
+
+ </bookinfo>
+ <toc></toc>
+
+
+
+<chapter id="intro" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/portlet/docs/reference/en/modules/intro.xml" xreflabel="intro">
+ <?dbhtml filename="intro.html"?>
+ <title>Introduction</title>
+
+ <para><diffmk:wrapper diffmk:change="changed">Starting from 3.0.0.Alpha1 version, JBoss set of plugins includes tools for supporting </diffmk:wrapper><property moreinfo="none">JBoss Portal</property><diffmk:wrapper diffmk:change="changed"> and JSR-186/JSR-286 portlets.
+ Thus, this guide is intended to explain you how to get started and manage </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="added">JBoss Portlet Tools</diffmk:wrapper></property>.</para>
+
+ <section id="preface">
+ <title><diffmk:wrapper diffmk:change="changed">What is JBoss Portal and Portlet Tools?</diffmk:wrapper></title>
+ <para><property moreinfo="none">JBoss Portal</property><diffmk:wrapper diffmk:change="added"> provides an open source platform for hosting and
+ serving a portal's Web interface, publishing and managing its content, and customizing
+ its experience. It supports a wide range of features, including standard portlets,
+ single sign-on, clustering, and internationalization. More about </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JBoss Portal</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> you can find visiting
+ its home page at: </diffmk:wrapper><ulink diffmk:change="added" url="http://www.jboss.org/jbossportal/"><diffmk:wrapper diffmk:change="added">http://www.jboss.org/jbossportal/</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para>
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">With </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JBoss Portlet Tools</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> you can easily create a Java, JSF and Seam portlet and deploy it to </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JBoss Portal</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para>
+ </section>
+
+ <section id="key_features">
+ <title><diffmk:wrapper diffmk:change="changed">Key Features of JBoss Portlet Tools</diffmk:wrapper></title>
+ <para diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JBoss Portlet Tools</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> supports the </diffmk:wrapper><ulink diffmk:change="added" url="http://www.jcp.org/en/jsr/detail?id=168"><diffmk:wrapper diffmk:change="added">JSR-168 Portlet Specification (Portlet 1.0)</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added"> and
+ </diffmk:wrapper><ulink diffmk:change="added" url="http://www.jcp.org/en/jsr/detail?id=286"><diffmk:wrapper diffmk:change="added">JSR-286 Portlet Specification (Portlet 2.0)</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added"> and works with
+ </diffmk:wrapper><ulink diffmk:change="added" url="http://www.jboss.org/portletbridge/"><diffmk:wrapper diffmk:change="added">JBoss Portlet Bridge</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added"> for supporting Portlets
+ in JSF/Seam applications. To enable these features, you need to add the JBoss Portlet facet to a new or an existing web project
+ (see </diffmk:wrapper><link diffmk:change="added" linkend="portlet_tools_tasks"><diffmk:wrapper diffmk:change="added">JBoss Portlet Tools Tasks</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added">). The project could be a non-WTP project, but you should know that
+ if it does not have the proper portlet API jar's the generated classes will have compile errors.</diffmk:wrapper></para>
+
+ <para>The next table lists key features supplied by <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">JBoss Portlet Tools</diffmk:wrapper></property>.</para>
+
+ <table>
+ <title><diffmk:wrapper diffmk:change="changed">Key Features of JBoss Portlet Tools</diffmk:wrapper></title>
+ <tgroup cols="3">
+
+ <colspec align="left" colnum="1" colwidth="1*"></colspec>
+ <colspec colnum="2" colwidth="5*"></colspec>
+ <colspec align="left" colnum="3" colwidth="1*"></colspec>
+
+ <thead>
+ <row>
+ <entry>Feature</entry>
+ <entry>Benefit</entry>
+ <entry>Chapter</entry>
+ </row>
+ </thead>
+
+ <tbody>
+
+ <row>
+ <entry>
+ <para><diffmk:wrapper diffmk:change="changed">JBoss Portlet facets</diffmk:wrapper></para>
+ </entry>
+ <entry>
+ <para><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JBoss Portlet Tools</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> provides the Java, JSF and Seam Portlet facets that could be enabled for a Web project.</diffmk:wrapper></para>
+ </entry>
+ <entry>
+ <diffmk:wrapper diffmk:change="changed">JBoss Portlet Tools Tasks</diffmk:wrapper></entry>
+ </row>
+ </tbody>
+
+ <row>
+ <entry>
+ <para><diffmk:wrapper diffmk:change="changed">Java Portlet wizard</diffmk:wrapper></para>
+ </entry>
+
+ <entry>
+ <para><diffmk:wrapper diffmk:change="changed">The wizard helps create a JSR-186/JSR-286 compliant
+ portlets</diffmk:wrapper></para>
+ </entry>
+ <entry>
+ <diffmk:wrapper diffmk:change="changed">Java Portlet Wizard</diffmk:wrapper></entry>
+ </row>
+ </tgroup>
+
+ <row>
+ <entry>
+ <para><diffmk:wrapper diffmk:change="changed">JSF/Seam Portlet wizard</diffmk:wrapper></para>
+ </entry>
+ <entry>
+ <para><diffmk:wrapper diffmk:change="changed">This wizard helps create JSF/Seam portlets</diffmk:wrapper></para>
+ </entry>
+ <entry>
+ <link diffmk:change="added" linkend="jsf_seam_portlet_wizard"><diffmk:wrapper diffmk:change="added">JSF/Seam Portlet Wizard</diffmk:wrapper></link>
+ </entry>
+ </row>
+ </table>
+ </section>
+ <section id="requirements_installation">
+ <title>Requirements and Installation</title>
+
+ <para><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JBoss
+ Portlet Tools</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> needs the following minimal requirements:</diffmk:wrapper></para>
+
+ <itemizedlist diffmk:change="added">
+ <listitem>
+ <para><diffmk:wrapper diffmk:change="added">Eclipse 3.4.2/Ganymede</diffmk:wrapper></para>
+ </listitem>
+ <listitem>
+ <para><diffmk:wrapper diffmk:change="changed">JBoss Tools 3.0.0.Alpha1 (for higher versions of JBoss Tools make sure you use the
+ </diffmk:wrapper><diffmk:wrapper diffmk:change="changed">compatible version of Eclipse</diffmk:wrapper><diffmk:wrapper diffmk:change="changed">)</diffmk:wrapper></para>
+ </listitem>
+ <listitem><para><diffmk:wrapper diffmk:change="added">JDK 5 or higher</diffmk:wrapper></para></listitem>
+ <listitem>
+ <para><diffmk:wrapper diffmk:change="changed">JBoss Portal + JBoss AS bundle from: </diffmk:wrapper><ulink url="http://www.jboss.org/jbossportal/download/index.html"><diffmk:wrapper diffmk:change="changed">http://www.jboss.org/jbossportal/download/index.html</diffmk:wrapper></ulink></para>
+ <note>
+ <title>Note:</title>
+ <para><diffmk:wrapper diffmk:change="added">JBoss Portlet Tools has been tested using 2.6.5 and 2.7.0.ALPHA
+ versions of </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JBoss Portal</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">. Remember, if you want to use Portlet
+ version 2.0 (JSR-268), you have to choose JBoss Portal 2.7.</diffmk:wrapper></para>
+ </note>
+ </listitem>
+ <listitem>
+ <para><diffmk:wrapper diffmk:change="added">JBoss Portlet Bridge (optionally) from: </diffmk:wrapper><ulink diffmk:change="added" url="http://www.jboss.org/portletbridge/downloads.html"><diffmk:wrapper diffmk:change="added">http://www.jboss.org/portletbridge/downloads.html</diffmk:wrapper></ulink></para>
+ </listitem>
+ </itemizedlist>
+
+ <para><property moreinfo="none"><diffmk:wrapper diffmk:change="added">JBoss Portlet Tools</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> is included as part of </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JBoss Tools</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> project.
+ Refer to </diffmk:wrapper><ulink diffmk:change="added" url="http://www.jboss.org/tools/download/installation.html"><diffmk:wrapper diffmk:change="added">http://www.jboss.org/tools/download/installation.html</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added">
+ for installation methods of </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JBoss Tools</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed">.</diffmk:wrapper></para>
+</section>
+</chapter>
+<chapter id="portlet_tools_tasks" xreflabel="portlet_tools_tasks">
+ <?dbhtml filename="portlet_tools_tasks.html"?>
+ <title>JBoss Portlet Tools Tasks</title>
+ <section id="starting_project">
+ <title>Creating and Deploying a Java Portlet</title>
+
+ <para>This chapter shows how to create a Dynamic Web Project, add a Java
+ Portlet to it and deploy it to the <property>JBoss Portal</property>.</para>
+
+ <section id="jboss_core_portlet">
+ <title>Creating a Web Project with JBoss Portlet Capabilities</title>
+ <para>Fallow the next procedure to create a Web project with JBoss Portlet capabilities pointed to the JBoss Portal runtime.</para>
+
+ <orderedlist>
+ <listitem>
+ <para>Go to <emphasis>
+ <property>File > New > Dynamic Web Project</property>
+ </emphasis> if you are in the <property>Web</property> perspective or <emphasis><property>File >
+ New > Other > Web > Dynamic Web Project</property></emphasis> in any other perspective.
+ The <property>New Dynamic Web Project</property> wizard appears.</para>
+
+ <figure>
+ <title>New Dynamic Web Project</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/starting_project/starting_project_1.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+
+ <listitem><para>Specify the name of the project.</para></listitem>
+
+ <listitem>
+ <para>Click <emphasis>
+ <property>New</property>
+ </emphasis> in the <emphasis>
+ <property>Target Runtime</property>
+ </emphasis> area to create a JBoss Portal runtime. Choose <emphasis>
+ <property>JBoss Community > JBoss 4.2 Runtime</property>
+ </emphasis> and select the <emphasis>
+ <property>Create a new local server</property>
+ </emphasis> check box below. Click <emphasis>
+ <property>Next</property>.</emphasis></para>
+
+ <figure>
+ <title>New Server Runtime</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/starting_project/starting_project_2.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+
+ <listitem>
+ <para>The <property>New Server Runtime Environment</property> wizard appears. In the <emphasis>
+ <property>Name</property></emphasis> field, type <emphasis>
+ <property>JBoss Portal 2.7 Runtime</property>,
+ </emphasis> and then use the <emphasis>
+ <property>Browse</property></emphasis> button to point to the location of JBoss Portal + JBoss AS extracted. Click <emphasis>
+ <property>Next</property></emphasis> to proceed.</para>
+
+ <figure>
+ <title>New Server Runtime Environment</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/starting_project/server_runtime_environment.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+
+ <listitem>
+ <para>At this point a new JBoss Server instance will be created. On the next page you can verify the
+ runtime information defined. If something is incorrect, press <emphasis>
+ <property>Back</property>
+ </emphasis> to return to the previous wizard page. Click <emphasis>
+ <property>Finish</property>.</emphasis></para>
+
+ <figure>
+ <title>Target Server</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/starting_project/starting_project_3.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+
+ <listitem>
+ <para>Click <emphasis>
+ <property>Modify</property>
+ </emphasis> in the <emphasis><property>Configuration</property></emphasis> area to enable
+ a portlet facet for the project.</para>
+
+ <figure>
+ <title>Setting the Project Configuration</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/starting_project/starting_project_4.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+
+ <listitem>
+ <para>In the <property>Project Facets</property> dialog, check <emphasis>
+ <property>JBoss Core Portlet</property>
+ </emphasis> and press <emphasis>
+ <property>OK</property>
+ </emphasis>.</para>
+
+ <figure>
+ <title>Enabling the JBoss Core Portlet Facet</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/starting_project/starting_project_4_a.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <note>
+ <title>Note:</title>
+ <para>If the portlet libraries aren't available in the runtime you targeted,
+ <emphasis>
+ <property>JBoss Portlets</property></emphasis> facets will be hidden on this page.</para>
+ <para>To make them always visible no matter what the runtime is set, you should enable the appropriate option in
+ <link linkend="preferences">JBoss Portlet Preferences</link>.</para>
+ </note>
+ </listitem>
+
+ <listitem>
+ <para>The <property>Java</property> and <property>Web Module</property> pages are for configuring Java and Web modules in the project.
+ Here all values are set, so leave everything as it is.</para>
+ </listitem>
+
+ <listitem>
+ <para>The last wizard page will ask you to add JBoss Portlet capabilities to the
+ project. Select <emphasis>
+ <property>Portlet Target Runtime Provider</property></emphasis> and click <emphasis>
+ <property>Finish</property></emphasis> to complete the project creation.</para>
+
+ <figure>
+ <title>Including the Portlet Libraries Provided by Target Runtime</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/starting_project/portlet_capabilities6.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <note>
+ <title>Note:</title>
+ <para>All types available under <emphasis>
+ <property>Portlet Implementation Library</property></emphasis> are fully described in the Wiki article at:
+ <ulink url="http://www.jboss.org/community/wiki/PortletFacetLibraries">http://www.jboss.org/community/wiki/PortletFacetLibraries</ulink>.</para>
+ </note>
+ </listitem>
+ </orderedlist>
+
+ <para>As the result, <property>JBoss Portlet Tools</property> adds <emphasis>
+ <property>JBoss Core Portlet</property></emphasis> facet to the project,
+ creates an empty <literal>portlet.xml</literal> file and adds the JBoss Portlet library to the project classpath.</para>
+
+ <figure>
+ <title>Portlet Project Structure Overview</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/starting_project/starting_project_6.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+
+ <section id="adding_java_portlet">
+ <title>Adding a Java Portlet to a Web Project</title>
+
+ <para>At the previous section you have created a web project with JBoss Portlet capabilities.
+ The next steps will show you how to add a new Java portlet to the project.</para>
+
+ <orderedlist>
+ <listitem>
+ <para>Right-click the project and follow to <emphasis>
+ <property>New > Other > JBoss Tools Web > Portlet > Java
+ Portlet</property>.</emphasis></para>
+
+ <figure>
+ <title>New Java Portlet</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/starting_project/starting_project_7.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+
+ <listitem>
+ <para>The <property>Create Portlet</property> wizard starts (for information about the wizard options, see
+ <link linkend="java_portlet_wizard">"Java Portlet Wizard"</link> in the guide reference).
+ The wizard fills in the <emphasis><property>Project</property></emphasis> and <emphasis>
+ <property>Source Folder</property></emphasis> fields for you. You should specify a Java package and a class name
+ (for instance, <emphasis>
+ <property>org.example</property></emphasis> and <emphasis>
+ <property>TestPortlet</property></emphasis>). Then click <emphasis>
+ <property>Next</property>
+ </emphasis>.</para>
+
+ <figure>
+ <title>Specifying Class File Destination</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/starting_project/starting_project_8.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+
+ <listitem><para>You may leave the next three pages with default values, on the last one hit <emphasis>
+ <property>Finish</property>.</emphasis></para>
+ </listitem>
+ </orderedlist>
+
+ <para>Once a Java portlet is created, new resources are added to the project structure: a Java portlet class (<literal>TestPortlet.java</literal>),
+ <literal>default-object.xml</literal> and <literal>portlet-instances.xml</literal> files and the <literal>portlet.xml</literal> descriptor is updated as well.</para>
+
+ <figure>
+ <title>Structure of the Project with a Java Portlet</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/starting_project/starting_project_12.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Thus, now the project is ready to be built and deployed.</para>
+ </section>
+
+ <section id="deploying_to_portal">
+ <title>Deploying a Portlet to JBoss Portal</title>
+
+ <para>You can deploy a portlet project in the way you deploy any other web application.</para>
+
+ <orderedlist>
+ <listitem>
+ <para>Right-click the project and do <emphasis>
+ <property>Run As > Run On Server</property>.
+ </emphasis> The <property>Run On Server</property> wizard starts.</para>
+
+ <figure>
+ <title>Running the Java Portlet on Server</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/starting_project/runOnServer.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+
+ <listitem>
+ <para>Select <emphasis><property>JBoss Portal 2.7 Server</property></emphasis> created before and click <emphasis><property>Next</property>.</emphasis></para>
+ </listitem>
+
+ <listitem>
+ <para>On the <emphasis>
+ <property>Add and Remove</property>
+ </emphasis> page move the created project to the right and click <emphasis>
+ <property>Finish</property>.</emphasis></para>
+
+ <figure>
+ <title>Deploying the Portlet Application</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/starting_project/starting_project_13.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>It will deploy the portlet application and start <property>JBoss
+ AS</property>.</para>
+ </listitem>
+
+ <listitem>
+ <para>Use the <emphasis>http://localhost:8080/portal/portal/default/default</emphasis> URL to see your
+ portlet in the browser.</para>
+
+ <figure>
+ <title>Java Portlet in the Browser Window</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/starting_project/starting_project_14.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+ </orderedlist>
+ </section>
+
+ </section>
+
+ <section diffmk:change="added" id="jsf_portlet" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/portlet/docs/reference/en/modules/jsf_portlet.xml">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Creating and Deploying a JSF Portlet</diffmk:wrapper></title>
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">This chapter will explain how you can configure a JSF portlet within a JSF project with JBoss Portlet capabilities
+ and then deploy it to </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JBoss Portal</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para>
+
+ <section diffmk:change="added" id="jsf_portlet1">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Creating a JSF Project with JBoss Portlet Capabilities</diffmk:wrapper></title>
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">You can create a JSF project with JBoss Portlet capabilities in two ways:</diffmk:wrapper></para>
+
+ <orderedlist continuation="restarts" diffmk:change="added" inheritnum="ignore">
+ <listitem diffmk:change="added">
+ <para><diffmk:wrapper diffmk:change="added">Create a dynamic Web project with the </diffmk:wrapper><emphasis diffmk:change="added"><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">JavaServer Faces</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added">
+ and </diffmk:wrapper><emphasis><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">JBoss JSF Portlet</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> facets enabled (
+ </diffmk:wrapper><link diffmk:change="added" linkend="create_dyn_web_proj_jsf"><diffmk:wrapper diffmk:change="added">the steps to proceed</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added">)</diffmk:wrapper></para>
+ </listitem>
+ <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Or create a JSF project using the wizard JBoss JSF Tools provides, then enable
+ JSF and JBoss Portlet facets and add JBoss Portlet capabilities (
+ </diffmk:wrapper><link diffmk:change="added" linkend="create_jsf_proj"><diffmk:wrapper diffmk:change="added">the steps to proceed</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added">)</diffmk:wrapper></para></listitem>
+ </orderedlist>
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Refer to the further sections for the procedures on how to do this.</diffmk:wrapper></para>
+
+ <section diffmk:change="added" id="create_dyn_web_proj_jsf">
+ <title><diffmk:wrapper diffmk:change="changed">Creating a Dynamic Web Project with the JBoss Portlet Capabilities</diffmk:wrapper></title>
+
+ <para><diffmk:wrapper diffmk:change="changed">The basic steps to create a dynamic Web project with the JBoss Portlet capabilities are as follows:</diffmk:wrapper></para>
+
+ <orderedlist continuation="restarts" diffmk:change="added" inheritnum="ignore">
+ <listitem diffmk:change="added">
+ <para><diffmk:wrapper diffmk:change="added">Start the </diffmk:wrapper><emphasis diffmk:change="added"><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Dynamic Web Project</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> wizard navigating to
+ </diffmk:wrapper><emphasis><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">File > New > Other > Web > Dynamic Web Project</diffmk:wrapper></property>.</emphasis></para>
+
+ <tip diffmk:change="added">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Tip:</diffmk:wrapper></title>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">You can also select the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Java EE</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> perspective and then go to
+ </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">File > New > Dynamic Web Project</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></emphasis></para>
+ </tip>
+
+ <figure float="0">
+ <title><diffmk:wrapper diffmk:change="changed">Setting the JSF Configuration</diffmk:wrapper></title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_portlet/jsf_portlet1.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Specify the project name and set the target runtime to </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JBoss Portal</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> by following the points 3, 4 and 5 in the
+ </diffmk:wrapper><link diffmk:change="added" linkend="jboss_core_portlet"><diffmk:wrapper diffmk:change="added">"Creating a Web Project with JBoss Portlet Capabilities"</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added"> procedure.</diffmk:wrapper></para>
+ </listitem>
+
+ <listitem diffmk:change="added">
+ <para><diffmk:wrapper diffmk:change="changed">In the </diffmk:wrapper><emphasis><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Configuration</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added">
+ area, click </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Modify</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> and enable </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JavaServer Faces</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">,</diffmk:wrapper></emphasis>
+ <emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JBoss Core Portlet</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> and </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JBoss JSF Portlet</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> facets.
+ Hit </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">OK</diffmk:wrapper></property>.</emphasis></para>
+
+ <figure float="0">
+ <title><diffmk:wrapper diffmk:change="changed">Enabling the Portlet Facets</diffmk:wrapper></title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_portlet/jsf_portlet2.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">You may leave the next two wizard pages with defaults, just press </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Next</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> to proceed.</diffmk:wrapper></para>
+ </listitem>
+
+ <listitem diffmk:change="added">
+ <para><diffmk:wrapper diffmk:change="added">On the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JBoss Portlet Capabilities</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> page, select </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Portlet Target Runtime Provider</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> and click </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Next</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></emphasis></para>
+
+ <figure float="0">
+ <title><diffmk:wrapper diffmk:change="changed">JBoss Portlet Capabilities</diffmk:wrapper></title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_portlet/jsf_portlet2a.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <tip diffmk:change="added">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Tip:</diffmk:wrapper></title>
+ <para><diffmk:wrapper diffmk:change="added">All types of the portlet implementation library are described more closely in the wiki article at:
+ </diffmk:wrapper><ulink diffmk:change="added" url="http://www.jboss.org/community/wiki/PortletFacetLibraries"><diffmk:wrapper diffmk:change="added">http://www.jboss.org/community/wiki/PortletFacetLibraries</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para>
+ </tip>
+ </listitem>
+
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Next wizard page is for configuring JSF capabilities. You can leave everything as it
+ is here.</diffmk:wrapper></para>
+
+ <figure float="0">
+ <title><diffmk:wrapper diffmk:change="changed">JSF Capabilities</diffmk:wrapper></title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_portlet/jsf_portlet3.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+
+ <listitem diffmk:change="added">
+ <para><diffmk:wrapper diffmk:change="changed">On the </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="added">JBoss JSF Portlet Capabilities</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> page, select
+ </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JSF Portlet Target Runtime Provider</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> as the JSF portlet implementation library. It will
+ copy Portlet Bridge libraries from the server runtime to the project classpath.</diffmk:wrapper></para>
+
+ <figure float="0">
+ <title><diffmk:wrapper diffmk:change="changed">JBoss JSF PortletCapabilities</diffmk:wrapper></title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_portlet/jsf_portlet4.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <tip>
+ <title>Tip:</title>
+ <para><diffmk:wrapper diffmk:change="changed">On this page, it is also possible to add the RichFaces libraries from the RichFaces distribution by checking
+ </diffmk:wrapper><emphasis><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Add/Change Richfaces Libraries</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></emphasis></para>
+ </tip>
+
+ <note diffmk:change="added">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Note:</diffmk:wrapper></title>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">You can select the </diffmk:wrapper><emphasis><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JSF Portletbridge Runtime Provider</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> type. Then it
+ is necessary to set the home of the Portlet Bridge distribution.</diffmk:wrapper></para>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">For information about all the JSF Portlet facet library providers, refer to the wiki article at:
+ </diffmk:wrapper><ulink diffmk:change="added" url="http://community.jboss.org/wiki/PortletFacetLibraries"><diffmk:wrapper diffmk:change="added">http://community.jboss.org/wiki/PortletFacetLibraries</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para>
+ </note>
+ </listitem>
+
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Click </diffmk:wrapper><emphasis><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Finish</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="changed"> The project will be created in the workbench.</diffmk:wrapper></para>
+ </listitem>
+ </orderedlist>
+ </section>
+
+ <section diffmk:change="added" id="create_jsf_proj">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Creating a JSF Project and adding the JBoss Portlet Capabilities</diffmk:wrapper></title>
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">How to organize a JSF project you can find out in the </diffmk:wrapper><ulink diffmk:change="added" url="../../jsf_tools_ref_guide/html_single/index.html#new_jsf_project"><diffmk:wrapper diffmk:change="added">JSF Tools User Guide</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added">. Just
+ remember to point the target runtime to </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JBoss Portal</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> directory location (see
+ how it is done for a dynamic Web project: steps 3, 4 and 5 in the
+ </diffmk:wrapper><link diffmk:change="added" linkend="jboss_core_portlet"><diffmk:wrapper diffmk:change="added">"Creating a Web Project with JBoss Portlet Capabilities"</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added"> procedure).</diffmk:wrapper></para>
+
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Creating New JSF Project</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/jsf_portlet/jsf_portlet8.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">To add the JBoss Portlet capabilities to the created JSF project you should complete the next steps:</diffmk:wrapper></para>
+
+ <orderedlist continuation="restarts" diffmk:change="added" inheritnum="ignore">
+ <listitem diffmk:change="added">
+ <para><diffmk:wrapper diffmk:change="changed">Right-click the project and click </diffmk:wrapper><emphasis>
+ <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Properties</diffmk:wrapper></property>
+ </emphasis><diffmk:wrapper diffmk:change="added"> to open the project </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Properties</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> sheet. Select </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Project Facets</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">
+ on the left and enable the </diffmk:wrapper><emphasis><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">JavaServer Faces</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed">,</diffmk:wrapper></emphasis>
+ <emphasis><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">JBoss Core Portlet</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="changed"> and </diffmk:wrapper><emphasis><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">JBoss JSF Portlet</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="changed"> facets.</diffmk:wrapper></para>
+
+ <figure float="0">
+ <title><diffmk:wrapper diffmk:change="changed">Project Facets</diffmk:wrapper></title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_portlet/jsf_portlet9.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+
+ <listitem diffmk:change="added">
+ <para><diffmk:wrapper diffmk:change="added">Notice, </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">"Further configuration available..."</diffmk:wrapper></property>
+ </emphasis><diffmk:wrapper diffmk:change="added"> warning appears at the bottom of the screen. It means that next you should configure the JSF Portlet capabilities in the project.
+ Click the link. The </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Modify Faceted Project</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> wizard appears.</diffmk:wrapper></para>
+ </listitem>
+
+ <listitem diffmk:change="added">
+ <para><diffmk:wrapper diffmk:change="added">Complete all wizard pages the same way as described in the steps 5, 6, 7 of the
+ </diffmk:wrapper><link diffmk:change="added" linkend="jboss_core_portlet"><diffmk:wrapper diffmk:change="added">"Creating a Dynamic Web Project with the JBoss Portlet Capabilities"</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added"> procedure.
+ Hit </diffmk:wrapper><emphasis><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">OK</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed">.</diffmk:wrapper></emphasis></para>
+ </listitem>
+
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">To apply the changes click </diffmk:wrapper><emphasis><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Apply</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="changed"> and then
+ </diffmk:wrapper><emphasis><property moreinfo="none"><diffmk:wrapper diffmk:change="added">OK</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> to close the project </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Properties</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> sheet.</diffmk:wrapper></para>
+ </listitem>
+ </orderedlist>
+ </section>
+ </section>
+
+ <section diffmk:change="added" id="jsf_portlet_to_JSF_project">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Adding a JSF Portlet to the Project and Deploying It to JBoss Portal</diffmk:wrapper></title>
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The previous section has shown how to create a JSF project with JBoss Portlet and JSF Portlet capabilities enabled. Use
+ the following procedure to add a JSF portlet to the created project and deploy it to </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JBoss Portal</diffmk:wrapper></property>.</para>
+
+ <orderedlist continuation="restarts" diffmk:change="added" inheritnum="ignore">
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Call the
+ </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Create Portlet</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> wizard by navigating to </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">New > Other > JBoss Tools Web > Portlet > JSF/Seam
+ Portlet</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> on the context menu of the project (for information about the wizard options, see
+ </diffmk:wrapper><link diffmk:change="added" linkend="jsf_seam_portlet_wizard"><diffmk:wrapper diffmk:change="added">"JSF/Seam Portlet Wizard"</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added"> in the guide reference).</diffmk:wrapper></para>
+
+ <figure float="0">
+ <title><diffmk:wrapper diffmk:change="changed">Calling New Portlet Wizard</diffmk:wrapper></title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_portlet/jsf_portlet5.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <tip>
+ <title>Tip:</title>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">As you see, the JSF and Seam Portlet wizards are merged into one. We have set the JSF
+ configuration for the project, so the default values in this wizard will be set as for a JSF
+ portlet.</diffmk:wrapper></para>
+ </tip>
+ </listitem>
+
+ <listitem diffmk:change="added">
+ <para><diffmk:wrapper diffmk:change="added">Leave all the wizard pages with default values by clicking the </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Next</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> button,
+ on the last one click </diffmk:wrapper><emphasis><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Finish</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="changed"> to complete the JSF portlet creation.</diffmk:wrapper></para>
+ </listitem>
+
+ <listitem diffmk:change="added">
+ <para><diffmk:wrapper diffmk:change="added">Complete the steps described in the </diffmk:wrapper><link diffmk:change="added" linkend="deploying_to_portal"><diffmk:wrapper diffmk:change="added">"Deploying a Portlet to JBoss Portal"</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added"> procedure to
+ deploy a JSF portlet to </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JBoss Portal</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">. Just use the other URL to see it in the browser:
+ </diffmk:wrapper><emphasis diffmk:change="added"><diffmk:wrapper diffmk:change="added">http://localhost:8080/portal/portal/default/JSFPortlet</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para>
+
+ <figure float="0">
+ <title><diffmk:wrapper diffmk:change="changed">JSF Portlet in the Browser</diffmk:wrapper></title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_portlet/jsf_portlet7.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+ </orderedlist>
+
+ </section>
+</section>
+
+
+ <section diffmk:change="added" id="seam_portlet" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/portlet/docs/reference/en/modules/seam_portlet.xml">
+ <title><diffmk:wrapper diffmk:change="changed">Creating and Deploying a Seam Portlet</diffmk:wrapper></title>
+
+ <para><diffmk:wrapper diffmk:change="changed">This chapter covers the steps on how to configure a Seam portlet within a Seam
+ project with the help of the </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">JBoss Portlet Tools</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed"> features.</diffmk:wrapper></para>
+
+ <section id="seam_portlet1">
+ <title><diffmk:wrapper diffmk:change="changed">Creating a Seam Project with JBoss Portlet Capabilities</diffmk:wrapper></title>
+
+ <para><diffmk:wrapper diffmk:change="added">Follow one of two ways of creating a Seam project with JBoss Portlet capabilities enabled:</diffmk:wrapper></para>
+ <orderedlist continuation="restarts" diffmk:change="added" inheritnum="ignore">
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Create a dynamic Web project with the </diffmk:wrapper><emphasis><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Seam</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="changed">
+ and </diffmk:wrapper><emphasis><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">JBoss Portlets</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> facets enabled (</diffmk:wrapper><link diffmk:change="added" linkend="create_dyn_web_proj_seam"><diffmk:wrapper diffmk:change="added">the steps to proceed</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added">)</diffmk:wrapper></para>
+ </listitem>
+ <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Or create a Seam project with the JBoss Seam portlet configuration using the wizard JBoss Seam Tools provides
+ and follow all the wizard steps to enable JBoss Portlet capabilities (</diffmk:wrapper><link diffmk:change="added" linkend="create_seam_proj"><diffmk:wrapper diffmk:change="added">the steps to proceed</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added">)</diffmk:wrapper></para></listitem>
+ </orderedlist>
+
+ <section diffmk:change="added" id="create_dyn_web_proj_seam">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Creating a Dynamic Web Project with Seam and JBoss Portlet Capabilities</diffmk:wrapper></title>
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">To create a dynamic Web project with Seam and JBoss Portlet capabilities you should take the following steps:</diffmk:wrapper></para>
+
+ <orderedlist continuation="restarts" diffmk:change="added" inheritnum="ignore">
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">In the </diffmk:wrapper><emphasis diffmk:change="added"><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">File</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> menu, go to
+ </diffmk:wrapper><emphasis><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">New > Other > Web > Dynamic Web Project</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed">.</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> The </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">New Dynamic Web Project</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">
+ wizard starts.</diffmk:wrapper></para>
+
+ <figure float="0">
+ <title><diffmk:wrapper diffmk:change="changed">Creating a New Dynamic Web Project</diffmk:wrapper></title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_portlet/seam_portlet1.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Give the project a name and follow the steps 3, 4, 5 of the
+ </diffmk:wrapper><link diffmk:change="added" linkend="jboss_core_portlet"><diffmk:wrapper diffmk:change="added">"Creating a Web Project with JBoss Portlet Capabilities"</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added"> procedure to set the target runtime.</diffmk:wrapper></para>
+ </listitem>
+
+ <listitem diffmk:change="added">
+ <para><diffmk:wrapper diffmk:change="added">In the </diffmk:wrapper><emphasis diffmk:change="added"><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Configuration</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> area of the first wizard page,
+ select </diffmk:wrapper><emphasis diffmk:change="added">
+ <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">JBoss Seam Portlet Project v2.0</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> It will add needed facets to the project.</diffmk:wrapper></para>
+
+ <tip diffmk:change="added">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Tip:</diffmk:wrapper></title>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">If you now click the </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Modify</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> button, you should see the
+ </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JavaServer Faces</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">,</diffmk:wrapper></emphasis> <emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Jboss Portlets</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added">
+ and </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Seam</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> facets enabled.</diffmk:wrapper></para>
+ </tip>
+
+ <figure float="0">
+ <title><diffmk:wrapper diffmk:change="changed">Project Facets</diffmk:wrapper></title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_portlet/seam_portlet2.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+
+ <listitem diffmk:change="added">
+ <para><diffmk:wrapper diffmk:change="added">The next two pages are for adjusting the project Java and Web modules.
+ They include the default values, so you can skip them by pressing </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Next</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></emphasis></para>
+ </listitem>
+
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">On the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Jboss Portlet Capabilities</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> page, select
+ </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Portlet Target Runtime Provider</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> as the portlet implementation library.</diffmk:wrapper></para>
+
+ <tip diffmk:change="added">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Tip:</diffmk:wrapper></title>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">All types of the portlet implementation library are described more closely in the wiki article at:
+ </diffmk:wrapper><ulink diffmk:change="added" url="http://www.jboss.org/community/wiki/PortletFacetLibraries"><diffmk:wrapper diffmk:change="added">http://www.jboss.org/community/wiki/PortletFacetLibraries</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para>
+ </tip>
+ </listitem>
+
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The next page is for configuring JSF capabilities. As it contains the default values, just click
+ </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Next</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> to proceed.</diffmk:wrapper></para>
+ </listitem>
+
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">On the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Seam Facet</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> page, set a Seam runtime and
+ a connection profile.</diffmk:wrapper></para>
+
+ <tip diffmk:change="added">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Tip:</diffmk:wrapper></title>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">For details about how to set a Seam runtime and a connection profile, see
+ </diffmk:wrapper><ulink diffmk:change="added" url="../../seam/html_single/index.html#seamFacet"><diffmk:wrapper diffmk:change="added">"Configure Seam Facet Settings"</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added"> in the Chapter 2,
+ </diffmk:wrapper><ulink diffmk:change="added" url="../../seam/html_single/index.html"><diffmk:wrapper diffmk:change="added">"Seam Dev Tools Reference Guide"</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para>
+ </tip>
+
+ <figure float="0">
+ <title><diffmk:wrapper diffmk:change="changed">Seam Facet Settings</diffmk:wrapper></title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_portlet/seam_portlet3.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+
+ <listitem diffmk:change="added">
+ <para><diffmk:wrapper diffmk:change="changed">On the </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">JBoss JSF Portlet Capabilities</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> page, select the
+ </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JSF Portlet Target Runtime Provider</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> type of the implementation library.</diffmk:wrapper></para>
+
+ <tip diffmk:change="added">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Tip:</diffmk:wrapper></title>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">If you have </diffmk:wrapper><property moreinfo="none">JBoss Portlet Bridge</property><diffmk:wrapper diffmk:change="added"> downloaded,
+ alternatively you can select </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JSF Portletbridge Runtime Provider</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> and then provide a path to
+ the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JBoss Portlet Bridge</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> distribution.</diffmk:wrapper></para>
+ </tip>
+
+ <figure float="0">
+ <title><diffmk:wrapper diffmk:change="changed">Setting Portlet Bridge Provider</diffmk:wrapper></title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_portlet/jsf_portlet4.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para><diffmk:wrapper diffmk:change="added">It will add </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JBoss Portlet Bridge</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> libraries to the project classpath.</diffmk:wrapper></para>
+ </listitem>
+
+ <listitem diffmk:change="added">
+ <para><diffmk:wrapper diffmk:change="changed">Hit </diffmk:wrapper><emphasis><property moreinfo="none">Finish</property></emphasis><diffmk:wrapper diffmk:change="changed"> to complete the project creation.</diffmk:wrapper></para>
+ </listitem>
+ </orderedlist>
+ </section>
+
+ <section diffmk:change="added" id="create_seam_proj">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Creating a Seam Project with JBoss Portlet Capabilities</diffmk:wrapper></title>
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The steps to create a Seam project with JBoss Portlet capabilities are as follows:</diffmk:wrapper></para>
+
+ <orderedlist continuation="restarts" diffmk:change="added" inheritnum="ignore">
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">In the </diffmk:wrapper><emphasis diffmk:change="added"><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">File</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> menu, go to </diffmk:wrapper><emphasis>
+ <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">New > Other > Seam > Seam Web Project</diffmk:wrapper></property>.</emphasis><diffmk:wrapper diffmk:change="added"> The </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">New Seam Project</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">
+ wizard appears.</diffmk:wrapper></para>
+ </listitem>
+
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Next steps are the same as in the </diffmk:wrapper><link diffmk:change="added" linkend="create_dyn_web_proj_seam"><diffmk:wrapper diffmk:change="added">"Creating a Dynamic Web Project with Seam and JBoss Portlet Capabilities"</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added">
+ procedure starting from the step 2.</diffmk:wrapper></para>
+ </listitem>
+ </orderedlist>
+ </section>
+ </section>
+
+ <section diffmk:change="added" id="seam_portlet_to_seam_project">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Adding a Seam Portlet to the Project and Deploying It to JBoss Portal</diffmk:wrapper></title>
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The previous section has shown you how to create a Web project with Seam and JBoss Portlet capabilities. Now you can create a Seam portlet
+ and deploy it to </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JBoss Portal</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> by following the next procedure:</diffmk:wrapper></para>
+
+ <orderedlist continuation="restarts" diffmk:change="added" inheritnum="ignore">
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">In the </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">File</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> or context menu of the project go to
+ </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">New > Other > JBoss Tools Web > Portlet > JSF/Seam
+ Portlet</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></emphasis></para>
+
+ <figure float="0">
+ <title><diffmk:wrapper diffmk:change="changed">Calling the Create Portlet Wizard</diffmk:wrapper></title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_portlet/seam_portlet5.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+
+ <listitem diffmk:change="added">
+ <para><diffmk:wrapper diffmk:change="added">The </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Create Portlet</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> wizard starts (for more information about wizard options, see
+ </diffmk:wrapper><link diffmk:change="added" linkend="jsf_seam_portlet_wizard"><diffmk:wrapper diffmk:change="added">"JSF/Seam Portlet Wizard"</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added"> in the guide reference).
+ As the Seam configuration is set for the project, the wizard puts the values as for Seam portlet.</diffmk:wrapper></para>
+
+ <figure float="0">
+ <title><diffmk:wrapper diffmk:change="changed">Creating Seam Portlet</diffmk:wrapper></title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_portlet/seam_portlet6.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+
+ <listitem diffmk:change="added">
+ <para><diffmk:wrapper diffmk:change="changed">Next two pages are filled out with default values, just press </diffmk:wrapper><emphasis><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Next</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> to
+ proceed. On the last one click </diffmk:wrapper><emphasis diffmk:change="added"><property moreinfo="none">Finish</property></emphasis><diffmk:wrapper diffmk:change="added"> to complete.</diffmk:wrapper></para>
+ </listitem>
+
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">To deploy and run the portlet on </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JBoss Portal</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> complete the steps described in the
+ </diffmk:wrapper><link linkend="deploying_to_portal"><diffmk:wrapper diffmk:change="changed">"Deploying a Portlet to JBoss Portal"</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added"> procedure. Just use the following URL to see it in the browser:
+ </diffmk:wrapper><emphasis diffmk:change="added"><diffmk:wrapper diffmk:change="added">http://localhost:8080/portal/portal/default/SeamPortlet</diffmk:wrapper></emphasis>.</para>
+
+ <figure float="0">
+ <title><diffmk:wrapper diffmk:change="changed">Seam Portlet in the Browser Window</diffmk:wrapper></title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_portlet/seam_portlet7.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+ </orderedlist>
+ </section>
+ </section>
+</chapter>
+ <chapter id="reference" xreflabel="reference">
+ <?dbhtml filename="reference.html"?>
+ <title>Reference</title>
+
+ <para>This chapter includes detailed reference information about <property>JBoss Portlet Tools</property>.</para>
+ <section id="project_overview">
+ <title>JBoss Portlet Descriptors</title>
+
+ <para>In order to a web project with portlets could be deployed to <property>JBoss Portal</property>, it should include certain descriptors.
+ The next table lists and describes these configuration files.</para>
+
+ <table>
+ <title>JBoss Portlet Descriptors</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Name</entry>
+
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>portlet.xml</entry>
+ <entry>The mandatory portlet descriptor defined by the <ulink url="http://www.jcp.org/en/jsr/detail?id=168">JSR-168 Portlet Specification</ulink>.
+ It is used during deployment.</entry>
+ </row>
+
+ <row>
+ <entry>portlet-instances.xml</entry>
+ <entry>The optional <property>JBoss Portal</property> specific descriptor. It allows to create a portlet instance from a portlet class definition.</entry>
+ </row>
+
+ <row>
+ <entry>*-object.xml</entry>
+ <entry>The optional <property>JBoss Portal</property> specific descriptor. It helps define the layout of the portal.</entry>
+ </row>
+
+ <row>
+ <entry>jboss-portlet.xml</entry>
+ <entry>The optional <property>JBoss Portal</property> specific descriptor. It allows to use JBoss
+ specific functionality within a portlet application.</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <para>For more detail information about each descriptor, see
+ <ulink url="http://docs.jboss.org/jbportal/v2.7.1/referenceGuide/html_single/#descrip...">"Portlet Descriptors"</ulink> in Chapter 6,
+ <ulink url="http://docs.jboss.org/jbportal/v2.7.1/referenceGuide/html_single/">"JBoss Portal Reference Guide"</ulink>.</para>
+ </section>
+
+ <section id="wizards">
+ <title>Wizards</title>
+ <para>This section describes the <property>JBoss Portlet Tools</property> wizards:</para>
+ <itemizedlist>
+ <listitem><para><link linkend="java_portlet_wizard">Java Portlet wizard</link></para></listitem>
+ <listitem><para><link linkend="jsf_seam_portlet_wizard">JSF/Seam Portlet wizard</link></para></listitem>
+ </itemizedlist>
+
+ <section id="java_portlet_wizard">
+ <title>Java Portlet Wizard</title>
+
+ <para>The <property>Java Portlet</property> wizard helps you create a new Java portlet (1.0 or 2.0). It is based on the WTP's Create Servlet wizard,
+ but adapted to JBoss Portlet. You can call it from the <emphasis><property>File</property></emphasis> or context menu of your project by following to
+ <emphasis><property>New > Other > JBoss Tools Web > Portlet > Java Portlet</property>.</emphasis></para>
+
+ <para>The wizard consists of the four pages:</para>
+
+ <orderedlist>
+ <listitem>
+ <para>The first one includes the next options to adjust:</para>
+
+ <table>
+ <title>Java Portlet Wizard. First Page Options.</title>
+ <tgroup cols="3">
+ <colspec colnum="1" align="left" colwidth="1*"/>
+ <colspec colnum="2" colwidth="3*"/>
+ <colspec colnum="3" align="left" colwidth="1*"/>
+
+ <thead>
+ <row>
+ <entry>Option</entry>
+ <entry>Description</entry>
+ <entry>Default</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>Project</entry>
+ <entry>Select the project to add a new Java portlet</entry>
+ <entry>The project selected when the wizard has been started</entry>
+ </row>
+
+ <row>
+ <entry>Source folder</entry>
+ <entry>The path to the source folder relative to the selected project</entry>
+ <entry>The source folder of the project selected in the <emphasis><property>Project</property></emphasis> field</entry>
+ </row>
+
+ <row>
+ <entry>Java package</entry>
+ <entry>Enter a package to contain a new portlet. Either type a valid package name or click
+ <emphasis><property>Browse</property></emphasis> to select a package via the dialog box.</entry>
+ <entry><blank></entry>
+ </row>
+
+ <row>
+ <entry>Class name</entry>
+ <entry>Type a name for a new Java portlet class</entry>
+ <entry><blank></entry>
+ </row>
+
+ <row>
+ <entry>Superclass</entry>
+ <entry>Type or click <emphasis><property>Browse</property></emphasis> to select a superclass for a Java portlet class</entry>
+ <entry>javax.portlet.GenericPortlet</entry>
+ </row>
+
+ <row>
+ <entry>Use an existing Portlet class</entry>
+ <entry>Select this check box if you want to use an existing Java portlet class. In the appeared
+ <emphasis><property>Class name</property></emphasis> field type or
+ click <emphasis><property>Browse</property></emphasis> to select an existing portlet class.</entry>
+ <entry>Cleared</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </listitem>
+
+ <listitem>
+ <para>The second wizard page is for specifying modifiers, interfaces to implement and method stubs to generate.</para>
+
+ <figure>
+ <title>Second Page of the Java Portlet Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/reference/javaPortlet2.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The descriptions of the options listed on this page are in the following table.</para>
+
+ <table>
+ <title>Java Portlet Wizard. Second Page Options.</title>
+ <tgroup cols="3">
+ <colspec colnum="1" align="left" colwidth="1*"/>
+ <colspec colnum="2" align="left" colwidth="3*"/>
+ <colspec colnum="3" align="left" colwidth="1*"/>
+
+ <thead>
+ <row>
+ <entry>Option</entry>
+ <entry>Description</entry>
+ <entry>Default</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>Modifiers</entry>
+ <entry>Select one or more access modifiers for a new Java portlet class:
+ <itemizedlist>
+ <listitem><para>Public</para></listitem>
+ <listitem><para>Abstract</para></listitem>
+ <listitem><para>Final</para></listitem>
+ </itemizedlist>
+ </entry>
+ <entry>Public</entry>
+ </row>
+
+ <row>
+ <entry>Interfaces</entry>
+ <entry>Click <emphasis><property>Add</property></emphasis> to choose interfaces that a new class implements</entry>
+ <entry><blank></entry>
+ </row>
+
+ <row>
+ <entry>Which method stubs would you like to create?</entry>
+ <entry>Choose which methods from superclass to override in the Java portlet class:
+ <itemizedlist>
+ <listitem><para>Constructors from superclass</para></listitem>
+ <listitem><para>Inherited abstract methods</para></listitem>
+ <listitem><para>init</para></listitem>
+ <listitem><para>doView</para></listitem>
+ <listitem><para>doDispatch</para></listitem>
+ <listitem><para>destroy</para></listitem>
+ <listitem><para>doEdit</para></listitem>
+ <listitem><para>processAction</para></listitem>
+ <listitem><para>getPortletConfig</para></listitem>
+ <listitem><para>doHelp</para></listitem>
+ <listitem><para>render</para></listitem>
+ </itemizedlist>
+ </entry>
+ <entry>Inherited abstract methods, doView</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </listitem>
+
+ <listitem>
+ <para>The third page is for adjusting the portlet deployment descriptor settings.</para>
+
+ <figure>
+ <title>Third Page of the Java Portlet Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/reference/javaPortlet3.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <table>
+ <title>Java Portlet Wizard. Third Page Options.</title>
+ <tgroup cols="3">
+ <colspec colnum="1" align="left" colwidth="1*"/>
+ <colspec colnum="2" align="left" colwidth="3*"/>
+ <colspec colnum="3" align="left" colwidth="1*"/>
+
+ <thead>
+ <row>
+ <entry>Option</entry>
+ <entry>Description</entry>
+ <entry>Default</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>Name</entry>
+ <entry>Enter the portlet name. It does not have to be the portlet class name.</entry>
+ <entry>The name of the portlet class</entry>
+ </row>
+
+ <row>
+ <entry>Display name</entry>
+ <entry>Enter the display name of the Java portlet</entry>
+ <entry>The name of the portlet class</entry>
+ </row>
+
+ <row>
+ <entry>Title</entry>
+ <entry>Enter the title of the portlet</entry>
+ <entry>The name of the portlet class</entry>
+ </row>
+
+ <row>
+ <entry>Description</entry>
+ <entry>Enter the description of the portlet's function</entry>
+ <entry><blank></entry>
+ </row>
+
+ <row>
+ <entry>Portlet Modes</entry>
+ <entry>Select one or more of three modes defined by the JSR-286 specification:
+ <itemizedlist>
+ <listitem><para><emphasis>View</emphasis> - generates markup reflecting the current state of the portlet;</para></listitem>
+ <listitem><para><emphasis>Edit</emphasis> - allows customizing the behavior of the portlet;</para></listitem>
+ <listitem><para><emphasis>Help</emphasis> - provides an information on how to use the portlet.</para></listitem>
+ </itemizedlist>
+ </entry>
+ <entry>View</entry>
+ </row>
+
+ <row>
+ <entry>Initialization Parameters</entry>
+ <entry>Specify initialization parameters to create an initial state inside your portlet class. Click
+ <emphasis><property>Add</property></emphasis> and fill in the
+ <emphasis><property>Name</property>,</emphasis> <emphasis><property>Value</property></emphasis> and
+ <emphasis><property>Description</property></emphasis> (optional) fields to set a parameter.</entry>
+ <entry><blank></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ </listitem>
+
+ <listitem>
+ <para>The last wizard page helps configure the JBoss Portlet specific descriptors.</para>
+
+ <figure>
+ <title>Last Page of the Java Portlet Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/reference/javaPortlet4.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <table>
+ <title>Java Portlet Wizard. Last Page Options.</title>
+ <tgroup cols="3">
+ <colspec colnum="1" align="left" colwidth="1*"/>
+ <colspec colnum="2" align="left" colwidth="3*"/>
+ <colspec colnum="3" align="left" colwidth="1*"/>
+
+ <thead>
+ <row>
+ <entry>Option</entry>
+ <entry>Description</entry>
+ <entry>Default</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>Create Portlet Instance</entry>
+ <entry>Clear the <emphasis><property>Create Portlet Instance</property></emphasis> check box,
+ if you don't wont the wizard to create the deployment elements
+ in the <literal>default-object.xml</literal> and <literal>
+ portlet-instances.xml</literal> files</entry>
+ <entry>Selected</entry>
+ </row>
+
+ <row>
+ <entry>If Exists</entry>
+ <entry>Select one of two options:
+ <itemizedlist>
+ <listitem><para><emphasis>overwrite</emphasis> - destroys the existing object and creates a new one based on the content of the deployment</para></listitem>
+ <listitem><para><emphasis>keep</emphasis> - maintains the existing object deployment or creates a new one if it does not exist</para></listitem>
+ </itemizedlist>
+ </entry>
+ <entry>overwrite</entry>
+ </row>
+
+ <row>
+ <entry>Instance Name</entry>
+ <entry>Enter a name of the portlet instance that the portlet window represents</entry>
+ <entry>[Portlet class name]Instance</entry>
+ </row>
+
+ <row>
+ <entry>Page Name</entry>
+ <entry>If set, the portlet page is created with the name defined</entry>
+ <entry><blank></entry>
+ </row>
+
+ <row>
+ <entry>Window Name</entry>
+ <entry>Enter a name of the portlet window</entry>
+ <entry>[Portlet class name]Window</entry>
+ </row>
+
+ <row>
+ <entry>Parent Reference</entry>
+ <entry>
+ <para>Define a reference to the parent object. The syntax for this element is <literal>[portal-instance].[portal-page]</literal>.</para>
+ <para>For example, <literal>default.default</literal> means that the window appears on the default page, in the default portal.</para>
+ </entry>
+ <entry>default.default</entry>
+ </row>
+
+ <row>
+ <entry>Region</entry>
+ <entry>Specify the region where the window should appear on the page</entry>
+ <entry>center</entry>
+ </row>
+
+ <row>
+ <entry>Height</entry>
+ <entry>Define the height of the window</entry>
+ <entry>1</entry>
+ </row>
+
+ <row>
+ <entry>Initial Window State</entry>
+ <entry>Set the window state indicator by selecting one of three states defined by the JSR-168 specification:
+ <itemizedlist>
+ <listitem><para><emphasis>normal</emphasis> - a portlet shares this page with other portlets</para></listitem>
+ <listitem><para><emphasis>minimized</emphasis> - a portlet may show very little information or none at all</para></listitem>
+ <listitem><para><emphasis>maximized</emphasis> - a portlet may be the only portlet displayed on this page</para></listitem>
+ </itemizedlist>
+ </entry>
+ <entry>maximized</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </listitem>
+ </orderedlist>
+ </section>
+
+ <section id="jsf_seam_portlet_wizard">
+ <title>JSF/Seam Portlet Wizard</title>
+
+ <para>The <property>JSF/Seam Portlet</property> wizard, that is merged into one JSF and Seam Portlet wizards, helps you create a
+ JSF/Seam portlet that uses the <property>JBoss Portlet Bridge</property> libraries. The default values in this wizard
+ depend on the configuration set for the project. For instance, if you set the JSF configuration, the default values in this wizard will be
+ as for a JSF portlet.</para>
+
+ <para>The <property>JSF/Seam Portlet</property> wizard could be started from the <emphasis><property>File</property></emphasis> or
+ context menu of your project by following to
+ <emphasis><property>New > Other > JBoss Tools Web > Portlet > JSF/Seam Portlet</property>.</emphasis></para>
+
+ <para>The wizard includes three pages to adjust JSF/Seam portlet setting:</para>
+
+ <orderedlist>
+ <listitem>
+ <para>The first wizard page asks to select a project to add JSF/Seam portlet and set a class file destination.</para>
+
+ <figure>
+ <title>First Page of the JSF Portlet Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/reference/jsf_seam_portlet1.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <table>
+ <title>JSF/Seam Portlet Wizard. First Page Options.</title>
+ <tgroup cols="3">
+ <colspec colnum="1" align="left" colwidth="1*"/>
+ <colspec colnum="2" align="left" colwidth="3*"/>
+ <colspec colnum="3" align="left" colwidth="1*"/>
+
+ <thead>
+ <row>
+ <entry>Option</entry>
+ <entry>Description</entry>
+ <entry>Default</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>Project</entry>
+ <entry>Select the project to add a new JSF/Seam portlet</entry>
+ <entry>The project selected when the wizard has been started</entry>
+ </row>
+
+ <row>
+ <entry>Class name</entry>
+ <entry>Type or click <emphasis><property>Browse</property></emphasis> to select a class for a JSF/Seam portlet</entry>
+ <entry>javax.portlet.faces.GenericFacesPortlet</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </listitem>
+
+ <listitem>
+ <para>The second page allows to configure a portlet deployment descriptors.</para>
+
+ <figure>
+ <title>Second Page of the JSF Portlet Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/reference/jsf_seam_portlet2.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <table>
+ <title>JSF/Seam Portlet Wizard. Second Page Options.</title>
+ <tgroup cols="3">
+ <colspec colnum="1" align="left" colwidth="1*"/>
+ <colspec colnum="2" align="left" colwidth="3*"/>
+ <colspec colnum="3" align="left" colwidth="1*"/>
+
+ <thead>
+ <row>
+ <entry>Option</entry>
+ <entry>Description</entry>
+ <entry>Default (JSF / Seam)</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>Name</entry>
+ <entry>Enter the portlet name. It does not have to be the portlet class name.</entry>
+ <entry>riPortlet / seamPortlet</entry>
+ </row>
+
+ <row>
+ <entry>Display name</entry>
+ <entry>Enter the display name of the Java portlet</entry>
+ <entry>JBoss JSF Portlet / JBoss Seam Portlet</entry>
+ </row>
+
+ <row>
+ <entry>Title</entry>
+ <entry>Enter the title of the portlet</entry>
+ <entry>JBoss JSF Portlet / JBoss Seam Portlet</entry>
+ </row>
+
+ <row>
+ <entry>Description</entry>
+ <entry>Enter the description of the portlet's function</entry>
+ <entry><blank></entry>
+ </row>
+
+ <row>
+ <entry>Portlet Modes</entry>
+ <entry>Select one or more of three modes defined by the JSR-286 specification:
+ <itemizedlist>
+ <listitem><para><emphasis>View</emphasis> - generates markup reflecting the current state of the portlet</para></listitem>
+ <listitem><para><emphasis>Edit</emphasis> - allows customizing the behavior of the portlet</para></listitem>
+ <listitem><para><emphasis>Help</emphasis> - provides an information on how to use the portlet</para></listitem>
+ </itemizedlist>
+ </entry>
+ <entry>View, Edit, Help / View</entry>
+ </row>
+
+ <row>
+ <entry>Initialization Parameters</entry>
+ <entry>Specify initialization parameters to create an initial state inside your portlet class. Click
+ <emphasis><property>Add</property></emphasis> and fill in the
+ <emphasis><property>Name</property>,</emphasis> <emphasis><property>Value</property></emphasis> and
+ <emphasis><property>Description</property></emphasis> (optional) fields to set a parameter.</entry>
+ <entry>javax.portlet.faces.defaultViewId.view, javax.portlet.faces.defaultViewId.edit,
+ javax.portlet.faces.defaultViewId.help / javax.portlet.faces.defaultViewId.view</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </listitem>
+
+ <listitem>
+ <para>The last wizard page helps you configure the JBoss Portlet specific information.</para>
+
+ <figure>
+ <title>Third Page of the JSF Portlet Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/reference/jsf_seam_portlet3.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <table>
+ <title>JSF/Seam Portlet Wizard. Third Page Options.</title>
+ <tgroup cols="3">
+ <colspec colnum="1" align="left" colwidth="1*"/>
+ <colspec colnum="2" align="left" colwidth="3*"/>
+ <colspec colnum="3" align="left" colwidth="1*"/>
+
+ <thead>
+ <row>
+ <entry>Option</entry>
+ <entry>Description</entry>
+ <entry>Default (JSF / Seam)</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>Create Portlet Instance</entry>
+ <entry>Clear the <emphasis><property>Create Portlet Instance</property></emphasis> check box,
+ if you don't wont the wizard to create the deployment elements
+ in the <literal>default-object.xml</literal> and <literal>
+ portlet-instances.xml</literal> files</entry>
+ <entry>Selected</entry>
+ </row>
+
+ <row>
+ <entry>If Exists</entry>
+ <entry>Select one of two options:
+ <itemizedlist>
+ <listitem><para><emphasis>overwrite</emphasis> - destroys the existing object and creates a new one based on the content of the deployment</para></listitem>
+ <listitem><para><emphasis>keep</emphasis> - maintains the existing object deployment or creates a new one if it does not exist</para></listitem>
+ </itemizedlist>
+ </entry>
+ <entry>overwrite</entry>
+ </row>
+
+ <row>
+ <entry>Instance Name</entry>
+ <entry>Enter a name of the portlet instance that the portlet window represents</entry>
+ <entry>JSFPortletInstance / SeamPortletInstance</entry>
+ </row>
+
+ <row>
+ <entry>Page Name</entry>
+ <entry>If set, the portlet page is created with the name defined</entry>
+ <entry>JSFPortlet / SeamPortlet</entry>
+ </row>
+
+ <row>
+ <entry>Window Name</entry>
+ <entry>Enter a name of the portlet window</entry>
+ <entry>JSFPortletWindow / SeamPortletWindow</entry>
+ </row>
+
+ <row>
+ <entry>Parent Reference</entry>
+ <entry>
+ <para>Define a reference to the parent object.</para>
+ <para>For example, <literal>default</literal> means that the page appears in the default portal.</para>
+ </entry>
+ <entry>default</entry>
+ </row>
+
+ <row>
+ <entry>Region</entry>
+ <entry>Specify the region where the window should appear on the page</entry>
+ <entry>center</entry>
+ </row>
+
+ <row>
+ <entry>Height</entry>
+ <entry>Define the height of the window</entry>
+ <entry>1</entry>
+ </row>
+
+ <row>
+ <entry>Initial Window State</entry>
+ <entry>Set the window state indicator by selecting one of three states defined by the JSR-168 specification:
+ <itemizedlist>
+ <listitem><para><emphasis>normal</emphasis> - a portlet shares this page with other portlets</para></listitem>
+ <listitem><para><emphasis>minimized</emphasis> - a portlet may show very little information or none at all</para></listitem>
+ <listitem><para><emphasis>maximized</emphasis> - a portlet may be the only portlet displayed on this page</para></listitem>
+ </itemizedlist>
+ </entry>
+ <entry>maximized</entry>
+ </row>
+
+ <row>
+ <entry>Create JBoss Application</entry>
+ <entry>
+ <para>Select to add the <literal>jboss-app.xml</literal> descriptor.</para>
+ <para><emphasis>riPortletApp / seamPortletApp</emphasis> - the default name of the JBoss application. You can change it by
+ typing a new one in the <emphasis><property>JBoss Application Name</property></emphasis> field.</para>
+ </entry>
+ <entry>Selected</entry>
+ </row>
+
+ <row>
+ <entry>Add the jboss-portlet.xml file</entry>
+ <entry>Select to create the <literal>jboss-portlet.xml</literal> file</entry>
+ <entry>Selected</entry>
+ </row>
+
+ <row>
+ <entry>Copy JSF Templates</entry>
+ <entry>Select to add the folder with JSF templates (<literal>edit.jsp</literal>, <literal>help.jsp</literal>,
+ <literal>view.jsp</literal>) to the project</entry>
+ <entry>Cleared</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </listitem>
+ </orderedlist>
+ </section>
+ </section>
+
+ <section id="preferences">
+ <title>JBoss Portlet Preferences</title>
+
+ <para>To open <property>JBoss Portlet Preferences</property> property sheet, go to <emphasis>
+ <property>Window > Preferences</property>
+ </emphasis> and then <emphasis>
+ <property>JBoss Tools > JBoss Portlet</property>.
+ </emphasis></para>
+
+ <figure>
+ <title>JBoss Runtime Preferences</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/reference/portlet_preferences.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The <emphasis>
+ <property>Check runtimes for Portlet Components</property>
+ </emphasis> option makes the JBoss Portlet functionality always visible no matter what the runtime is set. By default the option is checked.</para>
+ </section>
+</chapter>
+<chapter diffmk:change="added" id="summary" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/portlet/docs/reference/en/modules/summary.xml" xreflabel="summary">
+ <?dbhtml filename="summary.html"?>
+ <title><diffmk:wrapper diffmk:change="changed">Summary</diffmk:wrapper></title>
+
+ <para><diffmk:wrapper diffmk:change="changed">In conclusion, with this document you could easily get started with </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">JBoss
+ Portlet Tools</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed">.
+ The above chapters walked you through the steps on how to organize a web project with
+ JBoss Portlet capabilities enabled, create a Java portlet, JSF or Seam portlet and deploy them to </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">JBoss
+ Portal</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed">. The document also includes the reference of </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">JBoss Portlet Tools</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed"> features.</diffmk:wrapper></para>
+
+ <para>If you have questions or suggestions concerned both the documentation and tools behavior, you are welcome
+ to <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss Tools Users forum</ulink>.</para>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Please, use </diffmk:wrapper><ulink diffmk:change="added" url="https://jira.jboss.org/jira/browse/JBDS"><diffmk:wrapper diffmk:change="added">Jira</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added"> to report bugs and requests on documentation.</diffmk:wrapper></para>
+
+ <section diffmk:change="added" id="rel_resources">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Other Relevant Resources on the Topic</diffmk:wrapper></title>
+
+ <itemizedlist diffmk:change="added">
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">
+ JBoss Portal home page: </diffmk:wrapper><ulink diffmk:change="added" url="http://www.jboss.org/jbossportal/"><diffmk:wrapper diffmk:change="added">http://www.jboss.org/jbossportal/</diffmk:wrapper></ulink>
+ </para>
+ </listitem>
+
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">
+ JBoss Portal Wiki at: </diffmk:wrapper><ulink diffmk:change="added" url="http://wiki.jboss.org/wiki/JBossPortal"><diffmk:wrapper diffmk:change="added">http://wiki.jboss.org/wiki/JBossPortal</diffmk:wrapper></ulink>
+ </para>
+ </listitem>
+
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">JBoss Portal documentation set at: </diffmk:wrapper><ulink diffmk:change="added" url="http://docs.jboss.org/jbportal/"><diffmk:wrapper diffmk:change="added">http://docs.jboss.org/jbportal/</diffmk:wrapper></ulink></para>
+ </listitem>
+
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">
+ JBoss Tools home page at: </diffmk:wrapper><ulink diffmk:change="added" url="http://www.jboss.org/tools/"><diffmk:wrapper diffmk:change="added">http://www.jboss.org/tools/</diffmk:wrapper></ulink>
+ </para>
+ </listitem>
+
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">
+ The latest JBossTools/JBDS documentation builds at: </diffmk:wrapper><ulink diffmk:change="added" url="http://download.jboss.org/jbosstools/nightly-docs/"><diffmk:wrapper diffmk:change="added">http://download.jboss.org/jbosstools/nightly-docs/</diffmk:wrapper></ulink>
+ </para>
+ </listitem>
+
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">JBoss Developer Studio/JBoss Tools release documentation you can
+ find at </diffmk:wrapper><ulink diffmk:change="added" url="http://docs.jboss.org/tools/"><diffmk:wrapper diffmk:change="added">http://docs.jboss.org/tools</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added"> in the corresponding release directory.</diffmk:wrapper></para>
+ </listitem>
+ </itemizedlist>
+
+ </section>
+</chapter>
+</book>
14 years, 4 months
- 1
- 0