Difference between revisions of "OtfSolutionExplorer"

From emotive
Jump to navigation Jump to search
Line 28: Line 28:
  
  
=={{Anchor|Prj|Projects}}==
+
=={{Anchor|SL|}}Solution (root node)==
 +
 
 +
=={{Anchor|Prj|}}Projects==
  
 
A OTX project is a standard folder in the file system. This folder is a root node called. Below the root node are the packages arranged. A package contains the OTX documents (Documents)  or turn Packages. The documents are the actual  OTX files , they must always be in a package. That is below the root node, there is no OTX documents.
 
A OTX project is a standard folder in the file system. This folder is a root node called. Below the root node are the packages arranged. A package contains the OTX documents (Documents)  or turn Packages. The documents are the actual  OTX files , they must always be in a package. That is below the root node, there is no OTX documents.
Line 36: Line 38:
 
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==
  
 
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.
 
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.
Line 53: Line 55:
 
Dialog for adding a OTX Packages
 
Dialog for adding a OTX Packages
  
=={{Anchor|Doc|Documents}}==
+
=={{Anchor|Doc|}}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 .
 
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 .
Line 74: Line 76:
 
Dialog for adding a OTX document
 
Dialog for adding a OTX document
  
=={{Anchor|Imp|Imports}}==
+
=={{Anchor|Imp|}}Imports==
  
 
With the import element references can be made ​​to other documents. Global names are then according to their  visibility imported.
 
With the import element references can be made ​​to other documents. Global names are then according to their  visibility imported.
Line 97: Line 99:
 
examples: "MyImport1: MyProcedure1", "MyImport1: MyProcedureSignature1", "MyImport1: MyGlobalContextVariable1"
 
examples: "MyImport1: MyProcedure1", "MyImport1: MyProcedureSignature1", "MyImport1: MyGlobalContextVariable1"
  
=={{Anchor|Val|Validities}}==
+
=={{Anchor|Val|}}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.
 
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.
Line 118: Line 120:
 
Dialog for adding / editing a Validity
 
Dialog for adding / editing a Validity
  
=={{Anchor|Sig|Signatures}}==
+
=={{Anchor|Sig|}}Signatures==
  
 
A signature is the description of the interface of a procedure or a screen .
 
A signature is the description of the interface of a procedure or a screen .
Line 140: Line 142:
 
Edit the properties, see above, and confirm your entry by pressing the  "Ok" button .
 
Edit the properties, see above, and confirm your entry by pressing the  "Ok" button .
  
=={{Anchor|GD|Global Declarations}}==
+
=={{Anchor|GD|}}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.
 
Global declarations  for constants and variables are valid in the whole document and can according to their visibility  also be used in external documents.
Line 166: Line 168:
 
Dialog to add / edit global declarations
 
Dialog to add / edit global declarations
  
=={{Anchor|Prc|Procedures}}==
+
=={{Anchor|Prc|}}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.
 
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.
Line 193: Line 195:
 
Dialog for adding / editing procedures
 
Dialog for adding / editing procedures
  
=={{Anchor|Com|Comments}}==
+
=={{Anchor|Com|}}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.
 
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.
Line 224: Line 226:
 
Dialog for adding / editing free comments
 
Dialog for adding / editing free comments
  
=={{Anchor|Prm|Parameters}}==
+
=={{Anchor|Prm|}}Parameters==
  
 
Within the parameter -declaration block will be In, Out and In / Out parameters for procedures and signatures stored.
 
Within the parameter -declaration block will be In, Out and In / Out parameters for procedures and signatures stored.
Line 250: Line 252:
 
Dialog for adding / editing parameters
 
Dialog for adding / editing parameters
  
=={{Anchor|Thr|Throws (exceptions)}}==
+
=={{Anchor|Thr|}}Throws (exceptions)==
  
 
Here the caller can be displayed, which potential exceptions a procedure  can trigger.
 
Here the caller can be displayed, which potential exceptions a procedure  can trigger.
Line 268: Line 270:
 
Dialog for adding / editing exceptions
 
Dialog for adding / editing exceptions
  
=={{Anchor|LD|Local Declarations}}==
+
=={{Anchor|LD|}}Local Declarations==
  
 
Local declarations for constants and variables are only valid in the respective procedur. You can not be used outside.
 
Local declarations for constants and variables are only valid in the respective procedur. You can not be used outside.
Line 292: Line 294:
 
Dialog for adding / editing of local declarations
 
Dialog for adding / editing of local declarations
  
=={{Anchor|Flw|Flow}}==
+
=={{Anchor|Flw|}}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 .
 
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 .

Revision as of 07:12, 16 July 2014

EDITING ...

The Solution Explorer presents the whole OTX Solution in a clear tree form. All elements are started here by the package up to the realization Action mapped hierarchically. At each node can be context sensitive elements added, copied, cut, pasted and deleted??? .


The most important aspects, features and commands are briefly described:


The Solution Explorer shows the project structure OTX


Solution (root node)

Projects

A OTX project is a standard folder in the file system. This folder is a root node called. Below the root node are the packages arranged. A package contains the OTX documents (Documents) or turn Packages. The documents are the actual OTX files , they must always be in a package. That is below the root node, there is no OTX documents.

NoteImportant: For all name below the root nodes that apply 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 .