|
The Solution Explorer provides all the OTX project in a clear tree dar. You'll find all elements starting from the package to the action depicted hierarchical realization. At each node, context-sensitive elements can be added, copied, cut, insert and delete.
Here are the basic elements, functions and commands are described briefly below:
|
The Solution Explorer shows the project structure is OTX |
Project filing structure (root node)
OTX, a project is a normal folder in the file system. This folder is used as Root node denotes. Are below the root node, the Packages arranged. A package containing the OTX documents (Documents)packages or in turn. The documents are the actualOTX filesThey must always lie in one package. Ie are below the root node, there is no OTX documents.
Important: For all the names are below the root node of the OTX-naming conventions!
OTX documents as well as all global entities are uniquely identified by the full package name plus its own name.
Packages
For the structured storage of OTX documents in a file system to be used so-called packages. A package is simply a folder in the file system, which theOTX-naming conventionscorresponds.
|
Add a package:
- Clicking the right mouse button (Context Menu) On the Root node or Package
- Menu "Add"-"New Package ..."Select, which opens a dialog window
- Enter ameaningful name a
- Confirm your entry using the"Ok" button.
Edit the properties:
Important: Currently, the name of a package can not be changed! Solution: Create a new package to move the documents and cut and paste there.
|
Dialog for adding a OTX Packages |
Documents
OTX-A Document is an XML file that describes all the necessary data for a sequence. OTX within a document can be made to other OTX documents, see Imports.
Documents are not automatically loaded with the project. Download a document a Double with the left mouse button on the document.
|
Add one Document:
- Clicking the right mouse button (Context Menu) To a Package
- Menu "Add"-"New Document ..."Select, which opens a dialog window
- Enter ameaningful name a
- Confirm your entry using the"Ok" button.
Edit the properties:
- Select the item
- Clicking with the left Mouse button on theElement(Create this not double click!)
- The name of the element is directly editable in the Tree.
- Exit the edit mode using either the "Return"Button or by selecting a different item with the mouse
|
Dialog for adding a document OTX |
Imports
With the ImportElement can be made references to other documents. Global names are then according to theirVisibility imported.
|
Importing a document:
- Clicking the right mouse button (Context Menu) To a Document (If a reference is already added, you can also click the Node import button).
- Menu "Add"-"Reference ..."Select, which opens a dialog window
- Type in "Name (Prefix) "Ameaningful name one with which you can access within the document to visible elements of the imported document.
- Choose from the list below the respectiveDocument out. It will be shown the full package name and the name of the OTX document, such as: "Package1.Package12.Package122: Document".
- Confirm your entry using the"Ok" button.
Edit the properties:
- Clicking the right mouse button (Context Menu) On theElement
- Menu "Properties ..."Select, which opens a dialog window
- Edit The properties, see above, and confirm your entry with the"Ok" button.
|
Dialog for importing external documents |
You can now access within the current document to visible elements of the imported document. The items are offered in the form of context-sensitive choices:
Prefix: ElementName
Examples: "MyImport1: MyProcedure1", "MyImport1: MyProcedureSignature1", "MyImport1: MyGlobalContextVariable1"
Validities
Validities serve the processes of adaptation to different environmental conditions. Validity is one which any logical expression usually consists of one or more context variables.
|
Add a Validity:
- Clicking the right mouse button (Context Menu) On the Nodes Validities
- Menu "Add Item ..."Select, which opens a dialog window
- Enter ameaningful nameIn the Name field
- Optionally, you can Description a Specification specify
- Then select the Visibilityoff (default: private)
- In the box Condition a logical expression, either manually or via the Expression Builder ("..."- Button) one. This usually consists of Context variables.
- Confirm your entry using the"Ok" button.
Edit the properties:
- Clicking the right mouse button (Context Menu) On the Element
- Menu "Properties ..."Select, which opens a dialog window
- Edit The properties, see above, and confirm your entry with the"Ok" button.
|
Dialog for adding / editing a Validity |
Signatures
A Signature is to describe the interface of a Procedure or Screens.
|
Add a signature:
- Clicking the right mouse button (Context Menu) On the Nodes Signatures
- Menu "Add Item ..."Select, which opens a dialog window
- Enter ameaningful nameIn the Name field
- Optionally, you can Description a Specification specify
- Then select the Visibilityoff (default: private)
- Select the type of signature (realization). Please note that the type of implementation can not later be changed!
- Confirm your entry using the"Ok" button.
Edit the properties:
- Clicking the right mouse button (Context Menu) On the Element
- Menu "Properties ..."Select, which opens a dialog window
- Edit The properties, see above, and confirm your entry with the"Ok" button.
|
Dialog to add / edit a signature
|
Global Declarations
Global Declarationsfor constants and variables are valid throughout the document and according to their Visibilityalso be used in external documents.
|
Adding a global declaration:
- Clicking the right mouse button (Context Menu) On the Node Declarations
- Menu "Add ..."And then select the type of declaration:
- Global constant,
- Context variable or
- Global variable.
This opens a dialog window.
- Enter ameaningful nameIn the Name field
- Select the Data Type the declaration
- Optionally, enter a Initialwert to
- Then select the Visibilityoff (default: private)
- Optionally, you canDescription aSpecification specify
- Confirm your entry using the"Ok" button.
Edit the properties:
- Clicking the right mouse button (Context Menu) On the Element
- Menu "Properties ..."Select, which opens a dialog window
- Edit The properties, see above, and confirm your entry with the"Ok" button.
|
Dialog to add / edit global declarations
|
Procedures
A ProcedureOTX is the executable part of a document. It describes the actual processes / sequences. They can be used as the entry point of a flow system ("main" procedure with the name) or be called by other procedures outside the OTX document.
|
Adding a Procedure:
- Clicking the right mouse button (Context Menu) On the Procedures node
- Menu "Add Item ..."It opens a dialog window.
- Enter ameaningful nameIn the Name field
- Optionally, you canDescription aSpecification specify
- Then select theVisibility off (default: private)
- Optionally, you can ValidFor a Validity , enter see Basic concepts.
- You can continue in the next field aProcedure Signatureselect which implements the procedure. In this case, all parameters of the procedure are taken from the signature.
- You can still decide whether the procedure is to have a realization or not, seeBasic concepts.
- Confirm your entry using the"Ok" button.
Edit the properties:
- Clicking the right mouse button (Context Menu) On the Element
- Menu "Properties ..."Select, which opens a dialog window
- Edit The properties, see above, and confirm your entry with the"Ok" button.
Performing a procedure:
- Clicking the right mouse button (Context Menu) On the Procedure
- Menu "End run"Select. The sequence is started.
|
Dialog for adding / editing procedures
|
Comments
A Comment contains a human-readable description and a list of elements pointed to by the comment. Comments may be used for additional descriptions outside of the specification.
|
Add a comment:
- Clicking the right mouse button (Context Menu) On the Nodes Comments
- Menu "Add Item ..."It opens a dialog window
- Type your comment
- Confirm your entry using the"Ok" button.
Link of a comment:
- Click with the the left mouse button to theComment and hold down the mouse button
- Pull The comment on the specific Area of activities
- Repeat the process for other activities
Alternative:
- Clicking the right mouse button (Context Menu) To a Area of activitiesTo which the link should be established.
- Menu "Add a comment ..."Select, it opens the above dialog box
Edit the properties:
- Clicking the right mouse button (Context Menu) On the Element
- Menu "Properties ..."Select, which opens a dialog window
- Edit The properties, see above, and confirm your entry with the"Ok" button.
Alternative:
- Clicking the right mouse button (Context Menu) On theComment in the workflow designer
- It appears one Menu editing of the comment
|
Dialog for adding / editing of free comments
|
Parameters
Within the ParameterDeclaration block are In, Out and In / Out parameters for Procedures and Signatures is stored.
|
Add a signature:
- Clicking the right mouse button (Context Menu) On the Nodes Signatures
- Menu "Add ..."And then select the type of declaration:
- In parameters,
- Out parameters,
- In / out parameters or
- Term parameters (only Screen Signature).
This opens a dialog window.
- Enter ameaningful nameIn the Name field
- Select the Data Type the declaration
- Optionally, enter a Initialwert to
- Optionally, you can Description a Specification specify
- Confirm your entry using the"Ok" button.
Edit the properties:
- Clicking the right mouse button (Context Menu) On the Element
- Menu "Properties ..."Select, which opens a dialog window
- Edit The properties, see above, and confirm your entry with the"Ok" button.
|
Dialog for adding / editing parameters
|
Throws (exceptions)
Here, the caller will be shown that one potential exceptions Procedurecan trigger.
|
Adding an exception:
- Clicking the right mouse button (Context Menu) On the Node Throws
- Menu "Add Item ..."It opens a dialog window.
- Select the Data Type the exception
- Confirm your entry using the"Ok" button.
Edit the properties:
- Clicking the right mouse button (Context Menu) On the Element
- Menu "Properties ..."Select, which opens a dialog window
- Edit The properties, see above, and confirm your entry with the"Ok" button.
|
Dialog for adding / editing of exceptions
|
Local Declarations
Local declarations for constants and variables are only valid in the respective procedure. You can not be used outside.
|
Add a local Dekalartion:
- Clicking the right mouse button (Context Menu) On the Declarations
- Menu "Add ..."And then select the type of declaration:
- Local variable or
- Local constant
This opens a dialog window.
- Enter ameaningful nameIn the Name field
- Select the Data Type the declaration
- Optionally, enter a Initialwert to
- Optionally, you can Description a Specification specify
- Confirm your entry using the"Ok" button.
Edit the properties:
- Clicking the right mouse button (Context Menu) On the Element
- Menu "Properties ..."Select, which opens a dialog window
- Edit The properties, see above, and confirm your entry with the"Ok" button.
|
Dialog to add / edit local declarations
|
Flow
Under the flow-node, the actual sequence of activities is presented. Each activity consists of a name and one or more realizations. Realizations are shown indented from the name of the activity to the right. To edit the activities please use the Workflow Designer.
The Solution Explorer shows the project structure is OTX
Dialog for adding a OTX Packages
Dialog for adding a document OTX
Dialog for importing external documents
Dialog for adding / editing a Validity
Dialog to add / edit a signature
Dialog to add / edit global declarations
Dialog for adding / editing procedures
Dialog for adding / editing of free comments
Dialog for adding / editing parameters
Dialog for adding / editing of exceptions
Dialog to add / edit local declarations