Difference between revisions of "OtfSolutionExplorer"
| Line 4: | Line 4: | ||
{{FontColor|red||EDITING ...}} | {{FontColor|red||EDITING ...}} | ||
| − | {{ImageStyle2|OTFSolutionExplorer.png|300px|The Solution Explorer shows the | + | {{ImageStyle2|OTFSolutionExplorer.png|300px|The Solution Explorer shows the structure of an OTX solution}} |
| + | The Solution Explorer presents the whole OTX solution in a clear tree form. All the elements are displayed as nodes in the tree started from the root node to the ActionRealisation hierarchically. | ||
| − | + | All the elements of an OTX solution are listed below with the description of the important aspects, features and commands: | |
| − | |||
* [[#SL|Solution (root node)]] | * [[#SL|Solution (root node)]] | ||
* [[#Prj|Projects]] | * [[#Prj|Projects]] | ||
| + | * [[#Ref|References]] | ||
* [[#Pck|Packages]] | * [[#Pck|Packages]] | ||
* [[#Doc|Documents]] | * [[#Doc|Documents]] | ||
| Line 23: | Line 24: | ||
* [[#LD|Local Declarations]] | * [[#LD|Local Declarations]] | ||
* [[#Flw|Flow]] | * [[#Flw|Flow]] | ||
| + | |||
| Line 29: | Line 31: | ||
=={{Anchor|SL|}}Solution (root node)== | =={{Anchor|SL|}}Solution (root node)== | ||
| + | |||
| + | An OTX solution is a standard folder in the file system and it is displayed as the "root node" in the Solution Explorer. The OTX solution contains a solution file ('''*.otfSln''') with solution management information (see also [[OtfSolutionSetting|Solution Setting]] section), and another file ('''*.otfSuo''') to record debugging and display information. An OTX solution can have one or many OTX projects but it is not mandatory to have projects in the solution. These OTX projects are displayed as project nodes '''below the root node''' and only the project nodes are allowed here. The OTX projects may be located inside or outside the solution folder, the solution file references to these projects with relative paths or absolute paths. To load or to create a solution, you can use the [[OtfStartPage#OS|related functions]] in the [[OtfStartPage|Start Page]] or in the menu File of the [[OtfMenuBar|Ribbon menu bar]]. | ||
| + | |||
| + | The solution node has a context menu, right-click on the solution node to show this context menu. The functions of each entry of the context menu are described below: | ||
| + | {|{{TableHeader}} | ||
| + | {{TableRowContextMenuHeader}} | ||
| + | |-{{TableRow1}} | ||
| + | |Validate || Checks all the documents in the solution for any warnings or errors | ||
| + | |-{{TableRow2}} | ||
| + | |Build Solution || Builds the dll files (also the executable files or setup files i) of all the projects in the solution | ||
| + | |-{{TableRow1}} | ||
| + | |Change all paths to URI || Searches all the paths used in all the documents of the solution and changes them to URI | ||
| + | |-{{TableRow2}} | ||
| + | |Add >> New Project || Adds a new project to the current solution | ||
| + | |-{{TableRow1}} | ||
| + | |Add >> Existing Project || Adds an existing project to the current solution | ||
| + | |-{{TableRow2}} | ||
| + | |Add >> Import project from Ptx library || Adds a new project to the current solution from a Ptx library | ||
| + | |-{{TableRow1}} | ||
| + | | Subversion Control category || Handles Subversion tasks on the solution scope (See [[SubversionControl]] section for more information) | ||
| + | |-{{TableRow2}} | ||
| + | |Open Folder in Windows Explorer || Opens the solution folder in a new window | ||
| + | |-{{TableRow1}} | ||
| + | |Properties || Opens the [[OtfSolutionSetting|solution setting]] dialog | ||
| + | |} | ||
=={{Anchor|Prj|}}Projects== | =={{Anchor|Prj|}}Projects== | ||
| − | + | Like the OTX solution, an OTX project is a standard folder in the file system. It contains a project file ('''*.otfPrj''') with project management information, and the configuration files for each OTX extension library ect. (see [[OtfProjectSetting|Project Setting]] section for more information). An OTX project can have one or many OTX packages but it is not mandatory to have packages in the project. The OTX packages in a project are displayed as package nodes '''below the project node''' and only the packages nodes are allowed here. | |
| − | + | [[File:Exclamation.png]] Important: The names of all the elements below the project nodes shall conform the [[OtxNamingConventions|OTX Naming conventions]]! | |
| − | OTX documents as well as all global entities are uniquely identified by the complete package name plus the own name | + | OTX documents as well as all global entities are uniquely identified by the complete package name plus the own name??? |
=={{Anchor|Pck|}}Packages== | =={{Anchor|Pck|}}Packages== | ||
| Line 52: | Line 79: | ||
NoteImportant: At this time, the name of a package not be changed! solution : Create a new package you get there and move the documents via cut and paste. | NoteImportant: At this time, the name of a package not be changed! solution : Create a new package you get there and move the documents via cut and paste. | ||
| − | Dialog for adding a OTX | + | Dialog for adding a OTX packages |
| − | Dialog for adding a OTX | + | Dialog for adding a OTX packages |
=={{Anchor|Doc|}}Documents== | =={{Anchor|Doc|}}Documents== | ||
| − | A OTX | + | A OTX document is an XML file that describes all the data required for a drain. Within a OTX document can be referred to other OTX documents, see Imports . |
Documents are not automatically loaded with the project. Upload a document via a double click . using the left mouse button on the document | Documents are not automatically loaded with the project. Upload a document via a double click . using the left mouse button on the document | ||
Revision as of 08:16, 17 July 2014
EDITING ...
Template:ImageStyle2 The Solution Explorer presents the whole OTX solution in a clear tree form. All the elements are displayed as nodes in the tree started from the root node to the ActionRealisation hierarchically.
All the elements of an OTX solution are listed below with the description of the important aspects, features and commands:
- Solution (root node)
- Projects
- References
- Packages
- Documents
- Imports
- Validities
- Signatures
- Global Declarations
- Procedures
- Comments
- Parameters
- Throws
- Local Declarations
- Flow
Solution (root node)
An OTX solution is a standard folder in the file system and it is displayed as the "root node" in the Solution Explorer. The OTX solution contains a solution file (*.otfSln) with solution management information (see also Solution Setting section), and another file (*.otfSuo) to record debugging and display information. An OTX solution can have one or many OTX projects but it is not mandatory to have projects in the solution. These OTX projects are displayed as project nodes below the root node and only the project nodes are allowed here. The OTX projects may be located inside or outside the solution folder, the solution file references to these projects with relative paths or absolute paths. To load or to create a solution, you can use the related functions in the Start Page or in the menu File of the Ribbon menu bar.
The solution node has a context menu, right-click on the solution node to show this context menu. The functions of each entry of the context menu are described below:
| Menu entry | Description |
| Validate | Checks all the documents in the solution for any warnings or errors |
| Build Solution | Builds the dll files (also the executable files or setup files i) of all the projects in the solution |
| Change all paths to URI | Searches all the paths used in all the documents of the solution and changes them to URI |
| Add >> New Project | Adds a new project to the current solution |
| Add >> Existing Project | Adds an existing project to the current solution |
| Add >> Import project from Ptx library | Adds a new project to the current solution from a Ptx library |
| Subversion Control category | Handles Subversion tasks on the solution scope (See SubversionControl section for more information) |
| Open Folder in Windows Explorer | Opens the solution folder in a new window |
| Properties | Opens the solution setting dialog |
Projects
Like the OTX solution, an OTX project is a standard folder in the file system. It contains a project file (*.otfPrj) with project management information, and the configuration files for each OTX extension library ect. (see Project Setting section for more information). An OTX project can have one or many OTX packages but it is not mandatory to have packages in the project. The OTX packages in a project are displayed as package nodes below the project node and only the packages nodes are allowed here.
Important: The names of all the elements below the project nodes shall conform the OTX Naming conventions!
OTX documents as well as all global entities are uniquely identified by the complete package name plus the own name???
Packages
For structured storage of OTX documents in a file system called packages are used. A package is simply a folder in the file system of the the OTX-naming conventions corresponds.
Adding a Package:
Click with the right mouse button ( context menu ) on the root node or a package "Menu Adding "-" New Package ... "Select, which opens a dialog box Enter a meaningful name a Confirm your entry with "OK" button . Edit the properties:
NoteImportant: At this time, the name of a package not be changed! solution : Create a new package you get there and move the documents via cut and paste.
Dialog for adding a OTX packages Dialog for adding a OTX packages
Documents
A OTX document is an XML file that describes all the data required for a drain. Within a OTX document can be referred to other OTX documents, see Imports .
Documents are not automatically loaded with the project. Upload a document via a double click . using the left mouse button on the document
Adding a document:
Click with the right mouse button ( context menu ) on a package "Menu Adding "-" New Document ... "Select, which opens a dialog box Enter a meaningful name a Confirm your entry with "OK" button . Edit the self-sheep-th :
Select the item from Click with the left mouse button on the element (Create it not double!) The name of the element is directly editable in the tree . Exit the edit mode either via the " Return "key or by selecting with the mouse to another element Dialog for adding a OTX document Dialog for adding a OTX document
Imports
With the import element references can be made to other documents. Global names are then according to their visibility imported.
Importing a document:
Click with the right mouse button ( context menu ) to a document (If already a reference is added, you can also click the node import click). "Menu Adding "-" reference ... "Select, which opens a dialog box Under "Name ( prefix ) "a meaningful name one, which you can access on visible elements of the imported document within the document. Choose from the list below the relevant document from. It is the complete package name and the name of the OTX document presented, such as: "Package1.Package12.Package122: Document". Confirm your entry with "OK" button . Edit the self-sheep-th :
Click with the right mouse button ( context menu ) to the element Menu " Properties ... Select ", it opens a dialog box Edit the properties, see above, and confirm your entry by pressing the "Ok" button . Dialog for importing external documents Dialog for importing external documents You can now access the visible elements of the imported document within the current document. The elements are offered context-sensitive in the following form to choose from:
Prefix: element name examples: "MyImport1: MyProcedure1", "MyImport1: MyProcedureSignature1", "MyImport1: MyGlobalContextVariable1"
Validities
Validities serve the adaptation of processes to different environmental conditions. A Validity is any logical expression which usually consists of one or more contextual variables.
Add a Validity:
Click with the right mouse button ( context menu ) on the node Validities Menu " Add Item ... "Select, which opens a dialog box Enter a meaningful name in the Name field Optionally, you can under description a specification specify Then select the visibility off (Default value: Private) In the field condition a logical expression either manually or via the Expression Builder , a ("..." button). This usually consists of context variables . Confirm your entry with "OK" button . Edit the self-sheep-th :
Click with the right mouse button ( context menu ) to the element Menu " Properties ... Select ", it opens a dialog box Edit the properties, see above, and confirm your entry by pressing the "Ok" button . Dialog for adding / editing a Validity Dialog for adding / editing a Validity
Signatures
A signature is the description of the interface of a procedure or a screen .
Add a signature:
Click with the right mouse button ( context menu ) on the node Signatures Menu " Add Item ... "Select, which opens a dialog box Enter a meaningful name in the Name field Optionally, you can under description a specification specify Then select the visibility off (Default value: Private) Select the type of signature (realization). Please note that the type of implementation can not be changed later! Without realizing Procedure Signature Screen Signature Confirm your entry with "OK" button . Edit the self-sheep-th :
Click with the right mouse button ( context menu ) to the element Menu " Properties ... Select ", it opens a dialog box Edit the properties, see above, and confirm your entry by pressing the "Ok" button .
Global Declarations
Global declarations for constants and variables are valid in the whole document and can according to their visibility also be used in external documents.
Adding a global declaration:
Click with the right mouse button ( context menu ) on the node Declarations "Menu Add ... "and then the type of declaration select: Global constant, Context variable or Global variables. This opens a dialog box. Enter a meaningful name in the Name field Select the data type of the Decla-ra-tion Optionally, enter a Ini ti-al value of Then select the visibility off (Default value: Private) Optionally, you can under description a specification specify Confirm your entry with "OK" button . Edit the self-sheep-th :
Click with the right mouse button ( context menu ) to the element Menu " Properties ... Select ", it opens a dialog box Edit the properties, see above, and confirm your entry by pressing the "Ok" button . Dialog to add / edit global declarations Dialog to add / edit global declarations
Procedures
A procedure is the executable part of a OTX document. It describes the actual procedures / sequences. You can be the entry point of a flow system used (procedur with the name "main"), or other procedures outside the OTX document called.
Add a procedur:
Click with the right mouse button ( context menu ) on the nodes Procedures "Menu Add Item ... ", it opens a dialog box. Enter a meaningful name in the Name field Optionally, you can under description a specification specify Then select the visibility off (Default value: Private) Optionally, you can under ValidFor a Validity enter, see basic concepts . Furthermore, you can create a field in the next procedure Signature select which implements the procedur. In this case, all parameters of the procedur be covered by the signature. You can still decide whether the procedur to have a realization or not addition, see basic concepts . Confirm your entry with "OK" button . Edit the self-sheep-th :
Click with the right mouse button ( context menu ) to the element Menu " Properties ... Select ", it opens a dialog box Edit the properties, see above, and confirm your entry by pressing the "Ok" button . Run a procedure:
Click with the right mouse button ( context menu ) on the procedure Menu " from the end-lead-ing select ". The sequence is started. Dialog for adding / editing procedures Dialog for adding / editing procedures
Comments
A comment contains a human-readable description and a list of items on which the comment shows. Comments are used for additional descriptions out of specification.
Add a comment:
Click with the right mouse button ( context menu ) on the nodes Comments Menu " Add Item ... ", it opens a dialog box Enter your comment Confirm your entry with "OK" button . Link a Comment:
Click with the left mouse button on the comment and keep the mouse button pressed Pull the comment to the respective activity Repeat the process for other activities Alternative:
Click with the right mouse button ( context menu ) on a activity to which the link should be established. "Menu Add comment ... "select, it opens the dialog box described above Edit the properties:
Click with the right mouse button ( context menu ) to the element Menu " Properties ... Select ", it opens a dialog box Edit the properties, see above, and confirm your entry by pressing the "Ok" button . Alternative:
Click with the right mouse button ( context menu ) on the comment in the Workflow Designer You will see a menu for editing the comment Dialog for adding / editing free comments Dialog for adding / editing free comments
Parameters
Within the parameter -declaration block will be In, Out and In / Out parameters for procedures and signatures stored.
Add a signature:
Click with the right mouse button ( context menu ) on the node Signatures "Menu Add ... "and then the type of declaration select: In parameters, Out parameters, In / Out parameter or Term parameters (Only Screen Signa-tu-re ). This opens a dialog box. Enter a meaningful name in the Name field Select the data type of the Decla-ra-tion Optionally, enter a Ini ti-al value of Optionally, you can under description a specification specify Confirm your entry with "OK" button . Edit the self-sheep-th :
Click with the right mouse button ( context menu ) to the element Menu " Properties ... Select ", it opens a dialog box Edit the properties, see above, and confirm your entry by pressing the "Ok" button . Dialog for adding / editing parameters Dialog for adding / editing parameters
Throws (exceptions)
Here the caller can be displayed, which potential exceptions a procedure can trigger.
Adding an exception:
Click with the right mouse button ( context menu ) on the node Throws "Menu Add Item ... ", it opens a dialog box. Select the data type of the off-nah-me Confirm your entry with "OK" button . Edit the self-sheep-th :
Click with the right mouse button ( context menu ) to the element Menu " Properties ... Select ", it opens a dialog box Edit the properties, see above, and confirm your entry by pressing the "Ok" button . Dialog for adding / editing exceptions Dialog for adding / editing exceptions
Local Declarations
Local declarations for constants and variables are only valid in the respective procedur. You can not be used outside.
Adding a local Dekalartion:
Click with the right mouse button ( context menu ) on the Declarations "Menu Add ... "and then the type of declaration select: Local variables or Local constant This opens a dialog box. Enter a meaningful name in the Name field Select the data type of the Decla-ra-tion Optionally, enter a Ini ti-al value of Optionally, you can under description a specification specify Confirm your entry with "OK" button . Edit the self-sheep-th :
Click with the right mouse button ( context menu ) to the element Menu " Properties ... Select ", it opens a dialog box Edit the properties, see above, and confirm your entry by pressing the "Ok" button . Dialog for adding / editing of local declarations Dialog for adding / editing of local declarations
Flow
Under the flow node, the actual sequence of operations is presented. Each activity consists of a name and one or more implementations. Realizations are indented opposite the name of the activity to the right. To edit the activity, please use the workflow designer .
