Difference between revisions of "OtfWorkflowDesigner"

From emotive
Jump to navigation Jump to search
Line 25: Line 25:
 
* The author does not have to worry about layout details
 
* The author does not have to worry about layout details
  
−
A designer consists of the tittle bar, the procedure head region and the drawing page. The title bar displays the name of the current procedure, it helps users manage many opened procedures. You can arrange the order of the opened procedures by dragging the title bars. If there are so many opened procedures, some procedures may be hidden. To display the hidden procedures, click on the forward (>>) icon in the right end of the title bars and select the procedure you want to display. Each title bar has a context menu, right click on the title bar, a context menu will be displayed with the following entries:
+
 
 +
A designer consists of the tittle bar, the procedure head region and the drawing page. The title bar displays the name of the current procedure, it helps users manage many opened procedures. To view the content of a procedure tab, click on the title bar of the procedure and the procedure tab will be displayed ''at the top position''. You can arrange the order of the opened procedures by dragging and dropping the title bars to the desired position. If there are so many opened procedures, some procedures may be hidden. To display the hidden procedures, click on the forward (>>) icon in the right end of the title bars and select the procedure you want to display. You can move to the next procedure tab (i.e. the tab on the right of the current procedure) with the shortcut CTRL+TAB.
 +
 
 +
Each title bar has a context menu, right click on the title bar, a context menu will be displayed with the following entries:
  
 
{|{{TableHeader}}
 
{|{{TableHeader}}
Line 54: Line 57:
 
{{TableRowContextMenuHeader}}
 
{{TableRowContextMenuHeader}}
 
|-{{TableRow2}}
 
|-{{TableRow2}}
−
|'''Show in SolutionExplorer''' || style="width:600px;" | Finds and focuses on the current procedure in the Solution Explorer (expanding the parent item or scrolling the tree-view control, if necessary).
+
|'''Show in SolutionExplorer''' || style="width:750px;" | Finds and focuses on the current procedure in the Solution Explorer (expanding the parent item or scrolling the tree-view control, if necessary).
 
|-{{TableRow1}}
 
|-{{TableRow1}}
−
|'''New Procedure In-Parameter''' || style="width:600px;" | Adds a new in-parameter to the current procedure.
+
|'''New Procedure In-Parameter''' || style="width:750px;" | Adds a new in-parameter to the current procedure.
 
|-{{TableRow2}}
 
|-{{TableRow2}}
−
|'''New Procedure Out-Parameter''' || style="width:600px;" | Adds a new out-parameter to the current procedure.
+
|'''New Procedure Out-Parameter''' || style="width:750px;" | Adds a new out-parameter to the current procedure.
 
|-{{TableRow1}}
 
|-{{TableRow1}}
−
|'''New Procedure In/Out-Parameter''' || style="width:600px;" | Adds a new in/out-parameter to the current procedure.
+
|'''New Procedure In/Out-Parameter''' || style="width:750px;" | Adds a new in/out-parameter to the current procedure.
 
|-{{TableRow2}}
 
|-{{TableRow2}}
−
|'''New Local Variable''' || style="width:600px;" | Adds a new local parameter to the current procedure.
+
|'''New Local Variable''' || style="width:750px;" | Adds a new local parameter to the current procedure.
 
|}
 
|}
  
−
Right click on an activity (or one activity of the selected activities, see below), there will be a context menu with the following entries:
+
Right click on an activity (or one activity of the selected activities, [[#SLActs|see below]]), there will be a context menu with the following entries:
  
 
{|{{TableHeader}}
 
{|{{TableHeader}}
 
{{TableRowContextMenuHeader}}
 
{{TableRowContextMenuHeader}}
 
|-{{TableRow2}}
 
|-{{TableRow2}}
−
|'''Cut''' || style="width:600px;" | Cuts the activity or the selected activities.
+
|'''Cut''' || style="width:750px;" | Cuts the activity or the selected activities.
 
|-{{TableRow1}}
 
|-{{TableRow1}}
−
|'''Copy''' || style="width:600px;" | Copies the activity or the selected activities.
+
|'''Copy''' || style="width:750px;" | Copies the activity or the selected activities.
 
|-{{TableRow2}}
 
|-{{TableRow2}}
−
|'''Delete''' || style="width:600px;" | Deletes the activity or the selected activities.
+
|'''Delete''' || style="width:750px;" | Deletes the activity or the selected activities.
 
|-{{TableRow1}}
 
|-{{TableRow1}}
−
|'''Paste''' || style="width:600px;" | Pastes the copied or cut activity (or selected activities) below the current activity.
+
|'''Paste''' || style="width:750px;" | Pastes the copied or cut activity (or selected activities) below the current activity.
 
|-{{TableRow2}}
 
|-{{TableRow2}}
−
|'''Add Comment''' || style="width:600px;" | Adds a new comment and link to the current activity.
+
|'''Add Comment''' || style="width:750px;" | Adds a new comment and link to the current activity.
 
|-{{TableRow1}}
 
|-{{TableRow1}}
−
|'''Surround With >> Group''' || style="width:600px;" | Creates a new Group activity to surround the current activity or the selected activities (i.e. the activities will be moved into the new Group activity).
+
|'''Surround With >> Group''' || style="width:750px;" | Creates a new Group activity to surround the current activity or the selected activities (i.e. the activities will be moved into the new Group activity).
 
|-{{TableRow2}}
 
|-{{TableRow2}}
−
|'''Surround With >> Handler''' || style="width:600px;" | Creates a new Handler activity to surround the current activity or the selected activities (i.e. the activities will be moved into the Try-branch of new Handler activity).
+
|'''Surround With >> Handler''' || style="width:750px;" | Creates a new Handler activity to surround the current activity or the selected activities (i.e. the activities will be moved into the Try-branch of new Handler activity).
 
|-{{TableRow1}}
 
|-{{TableRow1}}
−
|'''Extract Procedure''' || style="width:600px;" | Extracts the activity or the selected activities into a new procedure and creates a new ProcedureCall to call the new procedure (see the ????section below for more information).
+
|'''Extract Procedure''' || style="width:750px;" | Extracts the activity or the selected activities into a new procedure and creates a new ProcedureCall to call the new procedure (see the ????section below for more information).
 
|-{{TableRow2}}
 
|-{{TableRow2}}
−
|'''Disable/Enable''' || style="width:600px;" | Disables/Enables the activity or the selected activities. Note that the disabled activities will not be executed and all the errors and warning related to these activities will not be displayed except the check rule Core-Chk011.  
+
|'''Disable/Enable''' || style="width:750px;" | Disables/Enables the activity or the selected activities. Note that the disabled activities will not be executed and all the errors and warning related to these activities will not be displayed except the check rule Core-Chk011.  
 
|-{{TableRow1}}
 
|-{{TableRow1}}
−
|'''New Local Variable''' || style="width:600px;" | Adds a new local variable to the current procedure.
+
|'''New Local Variable''' || style="width:750px;" | Adds a new local variable to the current procedure.
 
|-{{TableRow2}}
 
|-{{TableRow2}}
−
|'''Remove/Add Realisation''' || style="width:600px;" | Removes/Adds realisation of the current activity. Note that you can only add realisation to some certain activities (EmptyBranch, EmptyParallel, EmptyHandler, Group, EmptyGroup, EmptyMutexGroup).
+
|'''Remove/Add Realisation''' || style="width:750px;" | Removes/Adds realisation of the current activity. Note that you can only add realisation to some certain activities (EmptyBranch, EmptyParallel, EmptyHandler, Group, EmptyGroup, EmptyMutexGroup).
 
|-{{TableRow1}}
 
|-{{TableRow1}}
−
|'''Toogle Breakpoint''' || style="width:600px;" | Adds a break point to the current activity (see [[Debugging section]] for more information).
+
|'''Toogle Breakpoint''' || style="width:750px;" | Adds a break point to the current activity (see [[Debugging section]] for more information).
 
|}
 
|}
  
Line 109: Line 112:
 
# If you want to configure the activity, please use the Properties window or the Properties dialog box.
 
# If you want to configure the activity, please use the Properties window or the Properties dialog box.
  
−
===Adding further realisation for activities===
+
===Adding further realisations for activities===
 
An activity may have more than one realisation, see [[OTX basic concepts]], below is an example of adding further realisation for an activity:
 
An activity may have more than one realisation, see [[OTX basic concepts]], below is an example of adding further realisation for an activity:
  
Line 132: Line 135:
 
In the Workflow Designer, one or more activities (nodes) can be copied, cut, pasted , or deleted, please proceed as follows:
 
In the Workflow Designer, one or more activities (nodes) can be copied, cut, pasted , or deleted, please proceed as follows:
  
 +
{{Anchor|SLActs|}}
 
<ol>
 
<ol>
 
<li> Select an activity in the sequence, or select many activities by holding the '''CTRL key''' down and clicking on the all activities you want to select. You can also hold the '''SHIFT key''' and use mouse to drag a retangle to select all the covered activities.</li>
 
<li> Select an activity in the sequence, or select many activities by holding the '''CTRL key''' down and clicking on the all activities you want to select. You can also hold the '''SHIFT key''' and use mouse to drag a retangle to select all the covered activities.</li>
Line 152: Line 156:
 
|2.4  
 
|2.4  
 
| style="width:3px;" |
 
| style="width:3px;" |
−
| To copy and paste the selected activities by drag-and-drop: click and hold the mouse on one of the selected activities and drag them to the position you want to copy and paste (do not release the mouse), then hold down the '''CTRL key''' and release the mouse at the position (i.e. drop the activities at the position while holding the CTRL key)
+
| To copy and paste the selected activities by drag-and-drop: click and hold the mouse on one of the selected activities and drag them to the position you want to copy and paste (do not release the mouse), then hold down the '''CTRL key''' and release the mouse at the position (i.e. drop the activities at the position while holding the CTRL key).
 
|}</li>
 
|}</li>
−
<li> To move the selected activities, click and hold the mouse on one of the selected activities and drag them onto the new position (it must be a valid location i.e. where the green pluses appear) and release the mouse</li>
+
<li> To move the selected activities, click and hold the mouse on one of the selected activities and drag them onto the new position (it must be a valid location i.e. where the green pluses appear) and release the mouse.</li>
 
</ol>
 
</ol>
  
−
==Adjusting the navigation and the presentation of the sequence==
+
==Navigation and display of the sequence==
 
===Navigating and zooming in the sequence===
 
===Navigating and zooming in the sequence===
 
Within a sequence, you can move the view of the sequence up/down or left/right by using the mouse wheel, the arrow keys or the scroll bars.
 
Within a sequence, you can move the view of the sequence up/down or left/right by using the mouse wheel, the arrow keys or the scroll bars.
  
−
To zoom in and out of a sequence, you can hold down the CTRL-key and use the mouse wheel, or you can use the slider in the right corner of the Status Bar located at the bottom of the OTF, see the image. Here you can also click on the "Reset zoom factor" button to set the designer appearance back to the default zoom (i.e. 100%), or the "Fit to window" button to reduce the zoom sothat all the activities can be displayed. You can only change the zoom level of a sequence from 10% to 400%.
+
To zoom in and out of a sequence, you can hold down the CTRL-key and use the mouse wheel, or you can use the slider in the right corner of the Status Bar located at the bottom of the OTF, see the image below. Note, you can only change the zoom level from 10% to 400%. Beside the slider, you can find the "Reset zoom factor" command to set the designer appearance back to the default zoom (i.e. 100%), or the "Fit to window" command to reduce the zoom sothat the entire sequence can be displayed, note that the minimum zoom percentage is 10%. You can also find the "Reset zoom factor" and the "Fit to window" commands in the tab "Display" of the [[OtfMenuBar|Ribbon]].  
  
 
{{ImageStyleCenter|WorkflowDesignerZoom.png||Zooming within the workflow designer}}
 
{{ImageStyleCenter|WorkflowDesignerZoom.png||Zooming within the workflow designer}}
  
−
===Adjusting the presentation of the sequence===
+
===Adjusting the display of the sequence===
−
The OTF allows for adjusting the detail level of the activity representation in the sequence. To change the detail level, please select the level in the "Designer Appearance" section of the tab "Display" of the [[OtfMenuBar|Ribbon menu bar]]. There are 6 detail level for the presentation of the activities as shown below:
+
The OTF allows for adjusting the display of the sequence such as the detail level, the display quality, or the max width of the activities ect. To adjust the display of the sequence, you can find the corresponding commands in the tab "Display" of the [[OtfMenuBar|Ribbon]].  
  
−
All
+
In the "Designer Appearance" section of the tab "Display", there are 6 detail levels for the presentation of the activities as shown below:
  
−
It will be shown all available information within an activity
+
{|{{TableHeader}}
−
 
+
|- style="background: gray; color: white; vertical-align:top;"
−
Standard
+
| '''Detail level''' || '''Description'''
−
 
+
|-{{TableRow2}}
−
It will be shown all available information up to the specification within an activity
+
|'''1 - All''' || Shows all available information within an activity.
−
 
+
|-{{TableRow1}}
−
Compressed
+
|'''2 - Standard''' || Shows all available information except the specification within an activity.
−
 
+
|-{{TableRow2}}
−
It will be shown only the name and a generated text for the function of an activity
+
|'''3 - Compressed''' || Shows only the name and generated text of the function of an activity.
−
 
+
|-{{TableRow1}}
−
Minimal
+
|'''4 - Test Step''' || Shows only the name, the validFor property and the specification of an activity, and sets the Test Step mode active.
−
 
+
|-{{TableRow2}}
−
It will be shown only the name of an activity
+
|'''5 - Code''' || Shows the specification and the generated text of the funtion of an activity {{Question|in pseudo code style}}.
 +
|-{{TableRow1}}
 +
|'''6 - Specification''' || Shows only the name and the specification of an activity.
 +
|}
  
−
Specification
+
Here in the "Display" tab, you can also set the the max width of the activities in the sequence by selecting the size in the "Max Width" combo-box. If you check the option "Fixed Width" all the activities will be displayed exactly according to the selected max width; otherwise, only the activities with the display content longer than the max width will be limited by the max width.
  
−
It will be shown only the name and the specification of an activity
+
Besides, you can use the command "Quality of Display" in the "Display" tab to set the display quality to High or to Low. The low display quality will turn off the softening and shadow effects, which is suitable in case that you want to see the text clearer or your computer performs slow with the softening and shadow effects. You can also find this command in the status bar at the bottom of the OTF.
  
−
You also have the opportunity to "View comments"The free comments on or off and the"Quality of representation"To be set high or low. A low quality of representation is only for the elderly, weak computers recommended.
+
Finally, you can show or hide all the floating comments in the sequence by using the command "Display Comments". You can also find this command in the status bar at the bottom of the OTF.
  
  
 
==Printing and capturing of sequence==
 
==Printing and capturing of sequence==

Revision as of 10:31, 1 August 2014


EDITING...

Overview

The Workflow Designer is the central interface to input and arrange OTX nodes. It helps the authors create, edit and understand the test sequences graphically. The following main tasks will be implemented with the OTX Designer:

  • Specification
  • Realization
  • Documentation

The structure and functions of the Workflow Designer are described in the following sections.

Structure

In the Workflow Designer, test sequences can be edited graphically, see the image below. The Designer may consist of one or many tabs, each tab corresponds to a procedure ( a flow sequence/a workflow???). Within a sequence, the various activities (OTX nodes) are drawn together into a sequence on a white page. These activities can be configured through the dockable Properties window or the Properties dialog box. The activities are executed sequentially from top to bottom.

...

The sequences are presented in the form of a generic flowchart. This means that the author has only the ability to add individual items to, edit and adjust the presentation details. However, it has no direct influence on the position of the elements. It may include such activities so do not move the mouse to another location, such as in MS Visio. This supports the generic approach of OTX and has the following advantages:

  • The representation is generated solely from the OTX data without further meta data
  • The depiction of the sequence is independent of the flavor of the author
  • The same OTX sequence is the same on different computers
  • The author does not have to worry about layout details


A designer consists of the tittle bar, the procedure head region and the drawing page. The title bar displays the name of the current procedure, it helps users manage many opened procedures. To view the content of a procedure tab, click on the title bar of the procedure and the procedure tab will be displayed at the top position. You can arrange the order of the opened procedures by dragging and dropping the title bars to the desired position. If there are so many opened procedures, some procedures may be hidden. To display the hidden procedures, click on the forward (>>) icon in the right end of the title bars and select the procedure you want to display. You can move to the next procedure tab (i.e. the tab on the right of the current procedure) with the shortcut CTRL+TAB.

Each title bar has a context menu, right click on the title bar, a context menu will be displayed with the following entries:

Menu entry Description
Close Closes the current procedure.
Close all except this Closes all opened procedure except the current procedure.
Open document folder Opens the package folder containing the current document in a new window with Windows Explorer.

In the procedure head region, the relevant information of the procedure are presented below:

  • Name
  • Parameter (In-, Out- and InOut- parameters)
  • ValidFor
  • Implemented Signature
  • Specification

The drawing page contains the actual sequence of a procedure. It consists of a series of activities, see the image above.

Some elements in the Workflow Designer have the context menus which supports editing the element or adding variables or parameters for the procedure ect. Below are the short descriptions and guidelines for the context menus:

Right click on any where in the drawing page except the activites (nodes), there will be a context menu with the following entries:

Menu entry Description
Show in SolutionExplorer Finds and focuses on the current procedure in the Solution Explorer (expanding the parent item or scrolling the tree-view control, if necessary).
New Procedure In-Parameter Adds a new in-parameter to the current procedure.
New Procedure Out-Parameter Adds a new out-parameter to the current procedure.
New Procedure In/Out-Parameter Adds a new in/out-parameter to the current procedure.
New Local Variable Adds a new local parameter to the current procedure.

Right click on an activity (or one activity of the selected activities, see below), there will be a context menu with the following entries:

Menu entry Description
Cut Cuts the activity or the selected activities.
Copy Copies the activity or the selected activities.
Delete Deletes the activity or the selected activities.
Paste Pastes the copied or cut activity (or selected activities) below the current activity.
Add Comment Adds a new comment and link to the current activity.
Surround With >> Group Creates a new Group activity to surround the current activity or the selected activities (i.e. the activities will be moved into the new Group activity).
Surround With >> Handler Creates a new Handler activity to surround the current activity or the selected activities (i.e. the activities will be moved into the Try-branch of new Handler activity).
Extract Procedure Extracts the activity or the selected activities into a new procedure and creates a new ProcedureCall to call the new procedure (see the ????section below for more information).
Disable/Enable Disables/Enables the activity or the selected activities. Note that the disabled activities will not be executed and all the errors and warning related to these activities will not be displayed except the check rule Core-Chk011.
New Local Variable Adds a new local variable to the current procedure.
Remove/Add Realisation Removes/Adds realisation of the current activity. Note that you can only add realisation to some certain activities (EmptyBranch, EmptyParallel, EmptyHandler, Group, EmptyGroup, EmptyMutexGroup).
Toogle Breakpoint Adds a break point to the current activity (see Debugging section for more information).
Icons Note.png Above are only the common and important menu entries. There are also some other menu entries in the context menu when you right-click on some compound nodes, or some sub-branch of a compound nodes that can not be mentioned here.

Handling activities

Adding activities

To add an activity to the sequence, please follow the instructions as described below:

  1. Find the corresponding activity from the Toolbox.
  2. Drag the activity from the Toolbox into the sequence, note that there will be green plus signs displayed at the valid locations for this activity.
  3. Drop activity on one of the plus sign sothat the plus sign is replaced by the icon of the activity.
  4. If the insertion is not in the visible range of the sequence, drag the activity on one of the blue arrows at the edges of the Workflow Designer.
  5. The drawing page will be scrolled toward the appropriate direction to to show the unseen range, move the mouse out of the blue arrow to stop scrolling.
  6. Drop the activity at the valid location sothat the activity is generated in the appropriate place.
  7. If you want to configure the activity, please use the Properties window or the Properties dialog box.

Adding further realisations for activities

An activity may have more than one realisation, see OTX basic concepts, below is an example of adding further realisation for an activity:

  1. Drag an activity from the Toolbox into the sequence and drop it on a green plus sign (see example above).
  2. Drag another activity from the Toolbox into the sequence and drop it on the existing activity to add further realisation, a context menu will be displayed.
  3. Select the entry "Integrate" in the context menu to integrate the second activity with the first activity as the further realisation.
  4. To add another realisation to the activity with many realisations, drag a new activity onto the display area of the realisations in the middle of the activity???.
  5. There will be no context menu, the new activity will automtically become a realisation in the activity.
  6. If you want to configure the realisation, click on the realisation icon in the activity with many realisation and use the Properties window or the Properties dialog box.
Icons Note.png Besides using a new activity to add further realisation, you can also use an existing activity to add further realisation by drag-and-drop.

Replacing activities

You can replace an existing activity with another activity. If the existing activity has a specification, the new activity will inherit the same specification. To replace an activity, please proceed as follows:

  1. Drag an activity from the Toolbox into the sequence and drop it on an existing activity in the workflow.
  2. When the context menu appears, select the entry "Replace" and the existing activity will be replaced with the new activity.
Icons Note.png Besides using a new activity to replace an existing activity, you can also use an existing activity to replace another activity by drag-and-drop.

Editing a sequence

In the Workflow Designer, one or more activities (nodes) can be copied, cut, pasted , or deleted, please proceed as follows:

  1. Select an activity in the sequence, or select many activities by holding the CTRL key down and clicking on the all activities you want to select. You can also hold the SHIFT key and use mouse to drag a retangle to select all the covered activities.
  2. To deselect some of the selected activities, hold down CTRL key and click on each activity you want to deselect
  3. There are many ways to copy, cut, delete or paste the selected activities:
    2.1 Use the keyboard shortcuts (CTRL+C: Copy, CTRL+X: Cut, DEL: Delete, CTRL+V: Paste) with the selected activities, note that you can paste on an activity or on an empty flow.
    2.2 Use the context menu by right-clicking on one of the selected activities (or on an empty flow to paste) and selecting the corresponding entry
    2.3 Use the corresponding command buttons in the tab "Start" of the Ribbon menu bar.
    2.4 To copy and paste the selected activities by drag-and-drop: click and hold the mouse on one of the selected activities and drag them to the position you want to copy and paste (do not release the mouse), then hold down the CTRL key and release the mouse at the position (i.e. drop the activities at the position while holding the CTRL key).
  4. To move the selected activities, click and hold the mouse on one of the selected activities and drag them onto the new position (it must be a valid location i.e. where the green pluses appear) and release the mouse.

Navigation and display of the sequence

Navigating and zooming in the sequence

Within a sequence, you can move the view of the sequence up/down or left/right by using the mouse wheel, the arrow keys or the scroll bars.

To zoom in and out of a sequence, you can hold down the CTRL-key and use the mouse wheel, or you can use the slider in the right corner of the Status Bar located at the bottom of the OTF, see the image below. Note, you can only change the zoom level from 10% to 400%. Beside the slider, you can find the "Reset zoom factor" command to set the designer appearance back to the default zoom (i.e. 100%), or the "Fit to window" command to reduce the zoom sothat the entire sequence can be displayed, note that the minimum zoom percentage is 10%. You can also find the "Reset zoom factor" and the "Fit to window" commands in the tab "Display" of the Ribbon.

px
Zooming within the workflow designer

Adjusting the display of the sequence

The OTF allows for adjusting the display of the sequence such as the detail level, the display quality, or the max width of the activities ect. To adjust the display of the sequence, you can find the corresponding commands in the tab "Display" of the Ribbon.

In the "Designer Appearance" section of the tab "Display", there are 6 detail levels for the presentation of the activities as shown below:

Detail level Description
1 - All Shows all available information within an activity.
2 - Standard Shows all available information except the specification within an activity.
3 - Compressed Shows only the name and generated text of the function of an activity.
4 - Test Step Shows only the name, the validFor property and the specification of an activity, and sets the Test Step mode active.
5 - Code Shows the specification and the generated text of the funtion of an activity in pseudo code style???.
6 - Specification Shows only the name and the specification of an activity.

Here in the "Display" tab, you can also set the the max width of the activities in the sequence by selecting the size in the "Max Width" combo-box. If you check the option "Fixed Width" all the activities will be displayed exactly according to the selected max width; otherwise, only the activities with the display content longer than the max width will be limited by the max width.

Besides, you can use the command "Quality of Display" in the "Display" tab to set the display quality to High or to Low. The low display quality will turn off the softening and shadow effects, which is suitable in case that you want to see the text clearer or your computer performs slow with the softening and shadow effects. You can also find this command in the status bar at the bottom of the OTF.

Finally, you can show or hide all the floating comments in the sequence by using the command "Display Comments". You can also find this command in the status bar at the bottom of the OTF.


Printing and capturing of sequence

Retrieved from "http://emotive.de/wiki/index.php?title=OtfWorkflowDesigner&oldid=1048"