Author: irooskov(a)redhat.com Date: 2011-06-06 22:43:07 -0400 (Mon, 06 Jun 2011) New Revision: 31856 Added: trunk/bpel/docs/reference/en-US/images/reference/Context_menu_01.png trunk/bpel/docs/reference/en-US/images/reference/Context_menu_02.png trunk/bpel/docs/reference/en-US/images/reference/Deployment_descriptor_editor_01.png trunk/bpel/docs/reference/en-US/images/reference/Dialog_cheet_sheet_01.png trunk/bpel/docs/reference/en-US/images/reference/Dialog_cheet_sheet_02.png trunk/bpel/docs/reference/en-US/images/reference/Dialog_quick_pick_01.png trunk/bpel/docs/reference/en-US/images/reference/Dialog_type_selection_01.png trunk/bpel/docs/reference/en-US/images/reference/Dialog_wsdl_creation_01.png trunk/bpel/docs/reference/en-US/images/reference/Dialog_wsdl_creation_02.png trunk/bpel/docs/reference/en-US/images/reference/Dialog_wsdl_selection_01.png trunk/bpel/docs/reference/en-US/images/reference/Editor_preferences_01.png trunk/bpel/docs/reference/en-US/images/reference/Editor_preferences_02.png trunk/bpel/docs/reference/en-US/images/reference/WSIL_browser_preferences_01.png trunk/bpel/docs/reference/en-US/images/reference/XPath_expression_editor_01.png trunk/bpel/docs/reference/en-US/images/reference/XPath_expression_editor_02.png Modified: trunk/bpel/docs/reference/en-US/reference.xml Log: updated with final content for reference section Added: trunk/bpel/docs/reference/en-US/images/reference/Context_menu_01.png =================================================================== (Binary files differ) Property changes on: trunk/bpel/docs/reference/en-US/images/reference/Context_menu_01.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/bpel/docs/reference/en-US/images/reference/Context_menu_02.png =================================================================== (Binary files differ) Property changes on: trunk/bpel/docs/reference/en-US/images/reference/Context_menu_02.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/bpel/docs/reference/en-US/images/reference/Deployment_descriptor_editor_01.png =================================================================== (Binary files differ) Property changes on: trunk/bpel/docs/reference/en-US/images/reference/Deployment_descriptor_editor_01.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/bpel/docs/reference/en-US/images/reference/Dialog_cheet_sheet_01.png =================================================================== (Binary files differ) Property changes on: trunk/bpel/docs/reference/en-US/images/reference/Dialog_cheet_sheet_01.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/bpel/docs/reference/en-US/images/reference/Dialog_cheet_sheet_02.png =================================================================== (Binary files differ) Property changes on: trunk/bpel/docs/reference/en-US/images/reference/Dialog_cheet_sheet_02.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/bpel/docs/reference/en-US/images/reference/Dialog_quick_pick_01.png =================================================================== (Binary files differ) Property changes on: trunk/bpel/docs/reference/en-US/images/reference/Dialog_quick_pick_01.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/bpel/docs/reference/en-US/images/reference/Dialog_type_selection_01.png =================================================================== (Binary files differ) Property changes on: trunk/bpel/docs/reference/en-US/images/reference/Dialog_type_selection_01.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/bpel/docs/reference/en-US/images/reference/Dialog_wsdl_creation_01.png =================================================================== (Binary files differ) Property changes on: trunk/bpel/docs/reference/en-US/images/reference/Dialog_wsdl_creation_01.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/bpel/docs/reference/en-US/images/reference/Dialog_wsdl_creation_02.png =================================================================== (Binary files differ) Property changes on: trunk/bpel/docs/reference/en-US/images/reference/Dialog_wsdl_creation_02.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/bpel/docs/reference/en-US/images/reference/Dialog_wsdl_selection_01.png =================================================================== (Binary files differ) Property changes on: trunk/bpel/docs/reference/en-US/images/reference/Dialog_wsdl_selection_01.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/bpel/docs/reference/en-US/images/reference/Editor_preferences_01.png =================================================================== (Binary files differ) Property changes on: trunk/bpel/docs/reference/en-US/images/reference/Editor_preferences_01.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/bpel/docs/reference/en-US/images/reference/Editor_preferences_02.png =================================================================== (Binary files differ) Property changes on: trunk/bpel/docs/reference/en-US/images/reference/Editor_preferences_02.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/bpel/docs/reference/en-US/images/reference/WSIL_browser_preferences_01.png =================================================================== (Binary files differ) Property changes on: trunk/bpel/docs/reference/en-US/images/reference/WSIL_browser_preferences_01.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/bpel/docs/reference/en-US/images/reference/XPath_expression_editor_01.png =================================================================== (Binary files differ) Property changes on: trunk/bpel/docs/reference/en-US/images/reference/XPath_expression_editor_01.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Added: trunk/bpel/docs/reference/en-US/images/reference/XPath_expression_editor_02.png =================================================================== (Binary files differ) Property changes on: trunk/bpel/docs/reference/en-US/images/reference/XPath_expression_editor_02.png ___________________________________________________________________ Added: svn:mime-type + application/octet-stream Modified: trunk/bpel/docs/reference/en-US/reference.xml =================================================================== --- trunk/bpel/docs/reference/en-US/reference.xml 2011-06-07 01:07:04 UTC (rev 31855) +++ trunk/bpel/docs/reference/en-US/reference.xml 2011-06-07 02:43:07 UTC (rev 31856) @@ -219,7 +219,7 @@ </listitem> </itemizedlist> </section> - <section> + <section id="Reference-Wizard-Deployment_Descriptor"> <title>New BPEL Deployment Descriptor</title> <para> Use this wizard to create a <filename>Deployment Descriptor</filename> file. This file is a manifest for the web service and is required if the BPEL process is to be deployed to a runtime engine. @@ -1615,6 +1615,359 @@ </para> </section> </section> + <section> + <title>BPEL Deployment Descriptor editor</title> + <para> + Before a BPEL project can be deployed to the runtime engine, you must create what is called a <emphasis>deployment descriptor</emphasis>. This is simply a manifest file, serialized as XML, that describes all of the BPEL processes and their interfaces to the BPEL engine. The <emphasis>deployment descriptor</emphasis> file must be created in the root folder of your project. See <xref linkend="Reference-Wizard-Deployment_Descriptor" /> more information. + </para> + <para> + The <emphasis>deployment descriptor</emphasis> editor traverses the folder hierarchy in your project and searches for all BPEL files. Each process is then represented in a separate tab in the editor. The figure below shows two processes (HelloWorld and GoodbyeWorld). Each process must be configured before the project can be deployed. + </para> + <figure> + <title>Deployment descriptor editor example</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/Deployment_descriptor_editor_01.png"/> + </imageobject> + </mediaobject> + </figure> + <orderedlist> + <listitem> + <para> + Process selection tabs: Click on these tabs to display the configuration page for each process. + </para> + </listitem> + <listitem> + <para> + Initial process state: The process can be deployed in either an <emphasis>active</emphasis>, <emphasis>inactive</emphasis> or <emphasis>retired</emphasis> state. + </para> + </listitem> + <listitem> + <para> + Inbound interfaces selection: Select the WSDL port type that clients will use to invoke this service. + </para> + </listitem> + <listitem> + <para> + Output interfaces selection: Each invoked service (if any) will require you to select its port type. + </para> + </listitem> + <listitem> + <para> + Process-level monitoring events: Allow you to select which events are generated by the BPEL engine. This is currently unused but will be used in future for debugging the process. + </para> + </listitem> + <listitem> + <para> + Scope-level monitoring events: The BPEL engine can be configured to generate monitoring events for each Scope defined in the process. + </para> + </listitem> + </orderedlist> + <para> + The only action required to configure a processes is to select the interfaces for inbound and outbound services used by the process; all other settings are optional. + </para> + </section> </section> + <section> + <title>Preference pages</title> + <para> + Certain aspects of the BPEL Designers behavior can be customized to suit your personal preference. + </para> + <section> + <title>Editor</title> + <figure> + <title>Editor preferences</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/Editor_preferences_01.png"/> + </imageobject> + </mediaobject> + </figure> + <para> + The editor behavior can be customized on this page. + </para> + </section> + <section> + <title>Expression editors</title> + <figure> + <title>Expression editor preferences</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/Editor_preferences_02.png"/> + </imageobject> + </mediaobject> + </figure> + <para> + This preference page is used to configure the XPath expression editor templates and is similar to other Eclipse editor template preference pages. + </para> + </section> + <section> + <title>WSIL browser</title> + <figure> + <title>WSIL browser preferences</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/WSIL_browser_preferences_01.png"/> + </imageobject> + </mediaobject> + </figure> + <para> + This preference page is used to configure a Web Services Inspection Language (WSIL) file. The file can contain references to WSDL files for external services as well as references to other WSIL files, either locally or on the web. This file is used to search for WSDLs when defining partner links in a process. <!-- See the Type Selection Dialog for more information. Also see the Eclipse Help documentation for generating a WSIL file. --> + </para> + </section> + </section> + <section> + <title>Dialogs</title> + <section> + <title>XPath expression editor (embedded control)</title> + <para> + The XPath expression editor provides context-sensitive assistance in the form of pop-up proposals. The light bulb icon <inlinemediaobject> + <imageobject> + <imagedata fileref="images/reference/XPath_expression_editor_01.png"/> + </imageobject> + </inlinemediaobject> indicates that content assist is available by pressing the <keycap>CTRL</keycap> and <keycap>SPACE</keycap> keys simultaneously. The editor will display appropriate help information based on what it knows about variables currently in-scope for the selected activity. An example is seen in the figure below: + </para> + <figure> + <title>Expression editor assistance example</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/XPath_expression_editor_02.png"/> + </imageobject> + </mediaobject> + </figure> + <note> + <para> + The BPEL 2.0 specification provides for the definition of an XPath language version at the process level, as well as the activity level (for those activities that make use of XPath). However, only XPath 1.0 is supported by the BPEL Designer and the JBoss Riftsaw runtime engine at this time. + </para> + </note> + </section> + <section> + <title>Quick pick (embedded control)</title> + <figure> + <title>Quick pick</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/Dialog_quick_pick_01.png"/> + </imageobject> + </mediaobject> + </figure> + <para> + Tree control is used in many proeprty pages for selecting message parts, partner links and operations. + </para> + </section> + <section> + <title>Type selection</title> + <para> + This dialog is displayed whenever the BPEL Designer requires you to select a message, message part, XML Schema type or XML element. Refer to the figure below for an explanation of each of the components of this dialog: + </para> + <figure> + <title>Type selection</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/Dialog_type_selection_01.png"/> + </imageobject> + </mediaobject> + </figure> + <orderedlist> + <listitem> + <para> + <guilabel>Type Name</guilabel>: Used to limit the items displayed in the <guilabel>Matches</guilabel> (4) list. Only items that begin with the text in this filter will be displayed. + </para> + </listitem> + <listitem> + <para> + <guilabel>Show XSD Types</guilabel>: Can be used to limit where the editor will search for XSD files. + </para> + </listitem> + <listitem> + <para> + <guilabel>Filter</guilabel>: Further reduces the number of matches according to types. + </para> + </listitem> + <listitem> + <para> + <guilabel>Matches</guilabel>: Displays the items matching the selected filters. Selecting an item in this list will update the <guilabel>Type Structure</guilabel> (5) tree view. + </para> + </listitem> + <listitem> + <para> + <guilabel>Type Structure</guilabel>: Displays the structure of the item selected in the <guilabel>Matches</guilabel> (4) list. Depending on the type of item requested, you may need to select an item from this tree control as well; the <guibutton>OK</guibutton> button being enabled is an indicated of a selection being required here. + </para> + </listitem> + <listitem> + <para> + <guibutton>Add Schema</guibutton>: If the required XML Schema has not been resolved, you can add it to the process’ imports by clicking this button. + </para> + </listitem> + </orderedlist> + </section> + <section id="Reference-Dialog-WSDL_Selection"> + <title>Select WSDL property</title> + <para> + This dialog allows you to select an existing WSDL property or create a new one. + </para> + <figure> + <title>Select a WSDL property</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/Dialog_wsdl_selection_01.png"/> + </imageobject> + </mediaobject> + </figure> + <orderedlist> + <listitem> + <para> + <guilabel>Property Name</guilabel>: Used to limit the items displayed in the <guilabel>Matches</guilabel> (3) list. Only those items that begin with the text in this filter will be displayed. + </para> + </listitem> + <listitem> + <para> + <guibutton>New</guibutton>: Click this button to create a new WSDL property. + </para> + </listitem> + <listitem> + <para> + <guilabel>Matches</guilabel>: Displays the items that match the <guilabel> Property Name</guilabel> (1), or all items if the filter is blank. + </para> + </listitem> + <listitem> + <para> + <guilabel>Property Type</guilabel>: Displays the type of an item selected in the <guilabel>Matches</guilabel> (3) list. + </para> + </listitem> + </orderedlist> + </section> + <section> + <title>Create WSDL property</title> + <para> + This dialog is used to create a new WSDL property and is displayed when you click the <guibutton>New</guibutton> button in <xref linkend="Reference-Dialog-WSDL_Selection" /> dialog. + </para> + <figure> + <title>Create a WSDL property</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/Dialog_wsdl_creation_01.png"/> + </imageobject> + </mediaobject> + </figure> + <orderedlist> + <listitem> + <para> + <guilabel>Name</guilabel>: Enter the name for the new property. + </para> + </listitem> + <listitem> + <para> + <guibutton>Defined As</guibutton>: Select how the property type will be defined. + </para> + </listitem> + <listitem> + <para> + <guilabel>Browse</guilabel>: Click this button to select the property type. + </para> + </listitem> + <listitem> + <para> + <guilabel>New</guilabel>: Click this button to create a new property alias. + </para> + </listitem> + <listitem> + <para> + <guilabel>Aliases</guilabel>: This list displays all property aliases defined for the property. + </para> + </listitem> + </orderedlist> + </section> + <section> + <title>Create WSDL property alias</title> + <para> + This dialog allows you to create a WSDL property alias for a selected property. + </para> + <figure> + <title>Create a WSDL property alias</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/Dialog_wsdl_creation_02.png"/> + </imageobject> + </mediaobject> + </figure> + <orderedlist> + <listitem> + <para> + <guilabel>Defined As</guilabel>: Select how the property alias type will be defined. + </para> + </listitem> + <listitem> + <para> + <guibutton>Browse</guibutton>: Click this button to select the property alias type. + </para> + </listitem> + <listitem> + <para> + <guilabel>Query</guilabel>: This editor allows you to use the XPath Expression Editor to define a query for the property alias. + </para> + </listitem> + </orderedlist> + </section> + <section> + <title>Cheat sheets</title> + <para> + Cheat sheets are part of the Eclipse <guilabel>Help</guilabel> framework, which provide interactive, step-by-step tutorials for plug-in tools. The BPEL Designer cheat sheet can be accessed by following <menuchoice><guimenuitem>Help</guimenuitem><guimenuitem>Cheat Sheets</guimenuitem></menuchoice>. You will then see the following screen: + </para> + <figure> + <title>Cheat sheet menu selection</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/Dialog_cheet_sheet_01.png"/> + </imageobject> + </mediaobject> + </figure> + <para> + The cheat sheet will open in a separate view as show below. Click on the <guibutton>Click to begin</guibutton> link to begin. + </para> + <figure> + <title>Cheat sheet menu</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/Dialog_cheet_sheet_02.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + </section> + <section> + <title>Icons, buttons and menus</title> + <para> + The BPEL Designer does not contribute any toolbar buttons, or main menu actions. + </para> + <section> + <title>Context menu</title> + <para> + The context menu is activated when the right mouse button is clicked while the mouse is over an activity figure on the drawing canvas. + </para> + <figure> + <title>Cheat sheet menu</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/Context_menu_01.png"/> + </imageobject> + </mediaobject> + </figure> + <para> + The <guibutton>Add</guibutton> and <guibutton>Insert Before</guibutton> sub-menus contain the same actions. The sub-menu is displayed in the figure below: + </para> + <figure> + <title>Cheat sheet menu</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/Context_menu_02.png"/> + </imageobject> + </mediaobject> + </figure> + <para> + The items within the <guibutton>Add</guibutton> sub-menu appends the activity after the currently selected one, while those within the <guibutton>Insert Before</guibutton> sub-menu insert the new activity before the current one. + </para> + </section> + </section> </chapter>