Service Orchestration Functional Specification - Orchestration Designer - Property Editors

$Revision: 1.3 $
$Date: 2006/06/20 10:34:50 $

Note: This document contains hidden sections. You may show them using the following links: Reader Notes: Hide / Show  |  Author Notes: Hide / Show

1. Introduction

2. Specification

Customizer Contents

Validation

General Design Rules

• The insets between the components and the boundary of the dialogs should be 12 px.'
• The insets between the components and the boundary of a tabbed pane should be 11 px from top and 8 px from left, right and bottom.
• There should be 17 px gap between the content of the dialog and bottom button group.
• Within the panels, there should be 5 px inset between related components, and 11 px between unrelated components.
• Scrollpanes should have a border.

2. Process Editor

Main

• Mnemonics are assigned as follows:
  
• ^Name
• ^Target Namespace
• ^Query Language
• ^Expression Language
• ^Suppress Join Failure
• ^Enable Instance ^Compensation
• ^Abstract Process

Variables

• Missing mnemonics, suggesting:
  
• ^Add
• ^Edit
• ^Remove
  

• Mnemonics is assigned as follows:
  
• ^Name
• ^Simple Type
  
• ^Message Type
• ^ Element Type
  
• The content of the Name text field (the default value) is selected, in order to allow the user to immediately start typing a new name without the need to remove the content of the field first.
• This does not apply to the "Edit" dialog!
  
• If the Name is empty, the OK button should be disabled and a validation message should appear, saying "Name is required."
• If the Name is not unique or invalid identifier, a validation message "Name must be unique!" should appear.

• The title should reflect the action that invoked the dialog; thus here it should be "Choose Simple Type"
• The label under the tree should be: "Simple Type:"
  
• First node should be selected, when the dialog appears, to announce that keyboard navigation is possible.
• Items should be ordered alphabetically.
  

• The title should reflect the action that invoked the dialog; thus here it should be "Choose Message Type"
• The label under the tree should be: "Message Type:"
  
• Scrollpane should have a border.
• The focus should be on the first node of the tree when dialog appears.
• The root node "Message Types" is not neccesary, should be removed

• The title should reflect the action that invoked the dialog; thus here it should be "Choose Element Type"
• The root node "Element Types" is not neccesary, should be removed (not necessary). What about just having the schema and WSDL files as siblings, without any parent?
• Scrollpane should have a border.
• The focus should be on the first node of the tree when dialog appears.

Properties

Property Aliases

Correlation Set

Assign Activity

Expression Builder

Invoke Activity

• The focus should be in the tree when the dialog pops up.
  
• Create button should be enabled on the Process node as well as on Variables Container.
  
• There should be Expand/Collapse button on the Process node or it should not be possible to collapse it. (Ok, this is controversial as well, you may argue, and I would need to check guidelines). But makes sense, does it?
• The OK button should be disabled if any variable is not selected.
• Variables of compatible types should be highlighted and first should be preselected. Or maybe the dialog should show only variables of compatible types ...

Receive Activity

Reply Activity

Conditional Case of an If activity

onMessage Editor

onAlarm Editor

Partner Link

This is the original content - specification of the modal dialogs - very incomplete. Should be replaced with mockups for rich content of the properties window.

+-----------------------------------------------------+
| Edit(Add) Assign Activity                           |
+-----------------------------------------------------+
| Name: | assignPaymentLineItem                     | |
|                                                     |
| Copy Rules:                                         |
| |----------------------------------|  [    Add    ] |
| |       From       |       To      |  [    Edit   ] | 
| |----------------------------------|  [   Remove  ] |
| |                  |               |                |
| |                  |               |  [  Move Up  ] |
| |                  |               |  [ Move Down ] |
| |                  |               |                |
| |                  |               |                |
| |----------------------------------|                |
|                                                     |
|                       [  OK  ]  [ Cancel ] [ Help ] |
+-----------------------------------------------------+

Choosers Summary

Type Chooser - Element Type

• Add a Variable
  TODO-postTPR3: Also Add a Property

|---------------------------------------|
| Select Type                           |
|---------------------------------------|
| Select an element type:               |
| |-----------------------------------| |
| | -- [S] schema1.xsd                | |
| | |   -- [e] elementType1
| | |   -- [e] elementType2
| | -- [S] schema2.xsd
| | |   -- [e] elementType1
| | |   -- [e] elementType2
| | -- [W] wsdlfile1.wsdl
| | |   -- [e] elementType1
| | |   -- [e] elementType2
| | -- [W] wsdlfile2.wsdl
| | |   -- [e] elementType1
| | |   -- [e] elementType2
| | -- [S] folderA\schema3.xsd
| | -- [W] folderA\wsdlfile3.wsdl
| | |   -- [e] elementType1
| | |   -- [e] elementType2 
| | -- [W] folderA\folderB\wsdlfile3.wsdl
| | |   -- [e] elementType1
| | |   -- [e] elementType2
| | -- [S] folderA\folderB\zipcodes.xsd
| |     -- [e] elementType1
| |     -- [e] elementType2          | |
| |----------------------------------- |
| [ ] Show Imported Files Only         |
|                                      |
| Type: |                            | |
|                  [  Ok  ] [ Cancel ] |
|--------------------------------------|

• The title of the window is "Select Type"
• The tree contains all the available web resources - see the section related to all choosers - and the element types that are defined in those resources.
  

Type Chooser - Simple Type

Type Chooser - Message Type

Property Chooser

|---------------------------------------|
| Select a Property                     |
|---------------------------------------|
| Select a property:                    |
| |-----------------------------------| |
| | -- [W] wsdlfile1.wsdl
| | |   -- [p] property1
| | |   -- [p] property2
| | -- [W] wsdlfile2.wsdl
| | |   -- [p] property1
| | |   -- [p] property2
| | -- [W] folderA\wsdlfile3.wsdl
| | |   -- [p] property1
| | |   -- [p] property2 
| | -- [W] folderA\folderB\wsdlfile3.wsdl
| | |   -- [p] property1
| | |   -- [p] property2
| |----------------------------------- |
| [x] Show Imported Files Only         |
|                                      |
|                  [  Ok  ] [ Cancel ] |
|--------------------------------------|

• The title of the window is "Select Property"
• The tree does not have a single root node.
• The tree contains avaialable WSDL files and properties defined in these files - see the section related to all choosers. The specification of the property node follows:
  
• [p] property
  - label: name of the property
  - tooltip: type of the property (fully qualified name)
  

Shared Behaviour of All Choosers

• The tree does not have a single root node.
• The tree contains:
• [S] Schema file and [W] WSDL file nodes
  - on top level all the available web resources (contained in or referenced by the project)
  - ordered alphabetically, whereas the structure is kept - i.e. first all the files from root are shown; then all the files from the first folder; then all the files from the first folder within the first folder, etc.
  - tooltip: target namespace of the web resource
  
• [e] Element Type
  - label: localname of the element type
• The checkbox "Show Imported Files Only" is unselected by default. Its value is kept across invocations of the dialog and the IDE.
  If it is selected, the tree does not contain all the available web resources but only those, which are being improted by the currently edited process.
  
• If a type from file, which has not been imported yet, is chosen, the file is imported automatically, while the prefix is determined with an algorithm described in Add Import Dialog. If any acceptable prefix was not found, the Add Import Dialog pops up (with prefilled values) and the user is supposed to fill in the prefix manually.
  
• If the "Add Import" dialog is not confirmed, the focus goes back to the type chooser.
  

Add Import Dialog

|----------------------------------------------|
| Add Import                                   |
|----------------------------------------------|
| File:      |                    | [ Browse ] |
| Namespace: |                    |            |
|                                              |
| <validation message>                         |
|                          [  Ok  ] [ Cancel ] |
|----------------------------------------------|

• File - editable text field
• If the dialog is brought up implicitly, the text field is preset with the relevevant file.
• Once the file is set (with a browse button or manually - on focus lost) the namespace and prefix text fields are filled out.
  
• Browse button
• Brings up a file chooser allowing the user to pick a web resources available to the process.
• Namespace - non editable text field
• The namespace is determined from the file.
• Validation - if any of the following cases occurs, the Ok button is disabled and one of the following messages appear:
  
• If the file is not valid: "File is not valid."
• If the file does not exist: "File does not exist."
• Once confirmed, the dialog will add <import> element into the BPEL process and namespace prefix definition in the the root node of the BPEL file. The prefix is unique and determined automatically, as most of the users probably don't care about prefixes much.