OtfSolutionExplorer
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 starting 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
- AdminData
- 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 name of a solution can be arbitrary but it must comply with the restrictions of the operating system.
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 Category | Handles Subversion tasks on the solution scope (See Subversion section for more information) |
| Open Folder in Windows Explorer | Opens the solution folder in a new window with Windows Explorer |
| 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 the OTX extension libraries used in the project??? 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 a project node shall conform the OTX Naming conventions!
You can add a new project or add an existing project by using the context menu of the solution. Note that every new project added, a new package and a new document with the procedure "main" will be automatically created in the new project. The name of the new package will be derived from the name of the new project. Beside adding a project by the context menu of the solution, you can use the related functions in the Start Page or in the menu File of the Ribbon menu bar. The name of an OTX project should only contain letters, numbers, underscores and dashes, and the total length of the path to the project should be less than 128 characters (e.g. D:\Solution1\Project1\Project1.otfPrj < 128 characters).
The project node has a context menu, right-click on the project 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 project for any warnings or errors |
| Build | Builds the dll files (also the executable files or setup files i) of the project |
| Ptx Export... | Export the project to a Ptx library |
| Add >> New Package | Adds a new package to the project |
| Add >> Existing Package | Adds an existing package to the project |
| Add >> Add PTX library reference | Adds a reference to a Ptx library |
| Paste | Pastes a copied or cut package to the project |
| Delete | Deletes the reference of the solution to the project |
| Rename | Renames the project |
| Set as Startup Project | Sets the project as the Startup Project of the solution |
| Subversion Category | Handles Subversion tasks on the project scope (See Subversion section for more information) |
| Open Folder in Windows Explorer | Opens the project folder in a new window with Windows Explorer |
| Properties | Opens the project setting dialog |
References
When a project references to one or many Ptx libraries with relative paths or absolute path, these Ptx libraries will be displayed as Ptx nodes below the "References" node of the project. To add a reference to a Ptx library for a project, you can use the context menu of the project. To manage the references to the Ptx libraries such as adding, deleting, including into project folder or converting references path, you can open the library manager in the tab "Libraries (PDX References)" of the project setting, or using the command on the tab "Test Step Libraries" in the Toolbox.
Right-click on the reference node, there will be a context menu with the following entries:
| Menu entry | Description |
| Add >> Add PDX library reference | Adds a reference to a Ptx library in the project |
| Manage PDX references | Open the library manager in the tab Libraries (PDX References) of the project setting |
Right-click on the Ptx node in the reference node, there will be a context menu with the following entries:
| Menu entry | Description |
| Delete | Deletes the reference to the Ptx library in the project |
| Open Folder in Windows Explorer | Opens the folder containing the Ptx in a new window with Windows Explorer |
Packages
For the structural storage of OTX documents in the file system, the OTX packages are used. A package is simply a folder in the file system whose name corresponds to the OTX Naming conventions. The packages are displayed as package nodes below the project node. Each package can contain other packages (at any depth) or documents, it can also be empty. You can add a new package or an existing package, or paste a copied or cut package to a project by using the context menu of the project. You can also do the same tasks on a package by using the context menu of that package.
The package node has a context menu, right-click on the package 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 package for any warnings or errors |
| Add >> New Document | Adds a new document to the package |
| Add >> Existing Document | Adds an existing document to the package |
| Add >> Unallocated Document | Adds a document from the Unallocated Files section to the package |
| Add >> All unallocated Documents | Adds all documents from the Unallocated Files section to the package |
| Add >> New Package | Adds a new document to the package |
| Add >> Existing Package | Adds an existing document to the package |
| Cut | Cuts the package |
| Copy | Copies the package |
| Paste | Pastes a package or a document to the package |
| Delete | Deletes the package |
| Rename | Renames the package |
| Open Folder in Windows Explorer | Opens the package folder in a new window with Windows Explorer |
Documents
An OTX document is an XML file that describes all the data required for a sequence. An OTX document can refer to other OTX documents, see Imports. The content of the documents are not automatically loaded with the solution (except that if a procedure in a document is automatically loaded). To load the content of a document, double click on the document or use menu Open/View in the context menu of the document. You can add a new document or an existing document, or paste a copied or cut document to a package by using the context menu of the package.
The document node has a context menu, right-click on the package node to show this context menu. The functions of each entry of the context menu are described below:
| Menu entry | Description |
| Open/View | Loads the content of the document |
| Validate | Checks for any warnings or errors in the document |
| Debug | Executes the procedure main of the document in debug mode |
| Save | Saves all the changes in the document |
| Add >> Import/Reference | Adds a reference to a document |
| Add >> Global Declaration >> New Global Constant | Adds a new global constant to the document |
| Add >> Global Declaration >> New Context Variable | Adds a new context variable to the document |
| Add >> Global Declaration >> New Global Variable | Adds a new global variable (document variable) to the document |
| Add >> AdminData | Adds administration data (versioning data) to the document |
| Add >> Validity | Adds a new validity to the document |
| Add >> Signtures >> New Procedure Signature | Adds a new procedure signature to the document |
| Add >> Signtures >> New Screen Signature | Adds a new screen signature to the document |
| Add >> Signtures >> New Device Signature | Adds a new device signature to the document |
| Add >> Signtures >> New SingleEcuJob Signature | Adds a new procedure signature with some supported parameters to the document |
| Add >> Signtures >> New FlashJob Signature | Adds a new procedure signature with some supported parameters to the document |
| Add >> Signtures >> New SecurityAccessJob Signature | Adds a new procedure signature with some supported parameters to the document |
| Cut | Cuts the document |
| Copy | Copies the document |
| Paste | Pastes a global element (valiadity, global declataion, signature) to the document |
| Delete | Deletes the document |
| Rename | Renames the document |
| Set as Startup Document | Sets the document as the Startup Document of the project |
| Open Folder in Windows Explorer | Opens the package folder containing the document in a new window with Windows Explorer |
| Properties | Opens the properties dialog of the document |
Admin Data
Some OTX documents have a very long lifetime. They may be used or modified by many people, or even they may be exchanged between the process partners. At a result, the document should store the information about the change history, the person who responsible for the changes ect. This kind of data is called "Admin-Data". This data can be stored within the document or in a seperate file (*.adminData). The storage method may be set by the menu "File\Option" in the Ribbon menu bar. The "Admin-Data" is displayed as the AdminData node below the document node. You can use the context menu of a document to add the "Admin-Data" to that document.
Right-click on the AdminData node, there will be a context menu with the following entries:
| Menu entry | Description |
| Delete | Deletes the "Admin-Data" |
| Properties | Open the AdminData editor dialog??? |
Imports
With the import element, references can be made to other documents. The references are displayed as import nodes below the Imports node of the document. When a document references to another document, it imports the global names defined in the referenced document and it can use these global names. However, not all the imported global names are accessible because their visibility attributes are not sufficient to the document which references to the other one.
You can add a reference for a document to another document by using the menu context of the referencing document or the context menu of the Imports node (see below). When you click on the corresponding menu entry, a dialog of adding reference will occur. Here you can enter the prefix for the reference, note that the prefix must conform to the OTX Naming conventions. Through the import prefix, a global name from an imported document can be accessed and can be distinguished from the global names from the other imported documents (e.g. Variable1 = ImportPrefix1:GlobalConstant1 + ImportPrefix1:GlobalConstant2). Besides, you have to select the document you want to reference to. The list of the available documents will be displayed in the dialog according to the current project and all the referenced projects or Ptx libraries. In each project or Ptx libraries, the documents will be displayed by the containing package names and the document names (e.g. "Package1.Package12.Package121:NewDocument1"). After you enter a prefix and select a document to reference, click "OK" button to finish the process and then you can access all the global names with sufficient visibility in the referencing document.
Right-click on the Imports node, there will be a context menu with the following entries:
| Menu entry | Description |
| Add Item | Adds a new reference to a document |
Right-click on the import node, there will be a context menu with the following entries:
| Menu entry | Description |
| Delete | Deletes the reference |
| Properties | Opens a dialog to modidfy the reference |
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 .
