Trace:
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
|
visionx:documentation [2018/03/29 13:49] robot |
visionx:documentation [2020/06/10 10:06] cduncan Edited for English grammar (capitalization, punctuation, correct verb conjugation) |
||
|---|---|---|---|
| Line 2: | Line 2: | ||
| ~~Title: VisionX Documentation~~ | ~~Title: VisionX Documentation~~ | ||
| - | Version: 5.0 / 2018-03-29 | + | Version: 5.0 / 2019-11-27 |
| ====== Introduction ====== | ====== Introduction ====== | ||
| - | VisionX is a tool for the efficient development of web-, mobile- and desktop applications. It focuses on database driven applications for businesses that facilitate data management and support processes. The resulting applications are based on open source frameworks such as JVx, Vaadin, Apache POI, iText and others. | + | VisionX is a tool for the efficient development of web, mobile, and desktop applications. It focuses on database-driven applications for businesses that facilitate data management and support processes. The resulting applications are based on open-source frameworks, such as JVx, Vaadin, Apache POI, iText and others. |
| - | VisionX covers the entire application development process, which includes the data model design, the user interfaces, the business logic, the creation of reports, the import and export of data (EXCEL, CSV, XML), the access via web services and much more. | + | VisionX covers the entire application development process, which includes the data model design, the user interfaces, the business logic, the creation of reports, the import and export of data (EXCEL, CSV, XML), the access via web services, and much more. |
| This manual is divided into the following sections: | This manual is divided into the following sections: | ||
| Line 33: | Line 33: | ||
| * VisionX Installation Instructions.pdf | * VisionX Installation Instructions.pdf | ||
| - | ====== Create/edit Applications ====== | + | ====== Create/Edit Applications ====== |
| This chapter describes the main VisionX functions that are used to create and edit applications. It provides an overview of VisionX and shows how to develop a first application. | This chapter describes the main VisionX functions that are used to create and edit applications. It provides an overview of VisionX and shows how to develop a first application. | ||
| Line 39: | Line 39: | ||
| ===== Create an Application ===== | ===== Create an Application ===== | ||
| - | After starting VisionX, the user is taken to the application overview, in which all applications are shown. Depending on the user license, VisionX is delivered with a number of different sample applications. They can be used to understand the use of VisionX functions, or as a basis for new applications. | + | After starting VisionX, the user is taken to the application overview in which all applications are shown. Depending on the user license, VisionX is delivered with a number of different sample applications. They can be used to understand the use of VisionX functions or as a basis for new applications. |
| {{:visionx:documentation:new-application-step1.png?nolink|The main window of VisionX}} | {{:visionx:documentation:new-application-step1.png?nolink|The main window of VisionX}} | ||
| Line 45: | Line 45: | ||
| The small red "Delete" button on the bottom right is used to delete applications. | The small red "Delete" button on the bottom right is used to delete applications. | ||
| - | Clicking the green "Play" button opens an existing application for editing. All application related functions can be found there. They are explained in Chapter 2 - Create/Edit Applications. | + | Clicking the green "Play" button opens an existing application for editing. All application-related functions can be found there. They are explained in Chapter 2 - Create/Edit Applications. |
| The green "Plus" button in the application list and the button "New Application" are used to create a new application. | The green "Plus" button in the application list and the button "New Application" are used to create a new application. | ||
| - | The following screen shots demonstrate the creation of a new application. | + | The following screenshots demonstrate the creation of a new application. |
| {{:visionx:documentation:new-application-step2.png?nolink|Create an Application - Step 2 - Title}} | {{:visionx:documentation:new-application-step2.png?nolink|Create an Application - Step 2 - Title}} | ||
| - | VisionX offers wizards for all functions, which allow for the step-by-step creation of applications, workscreens, etc. . Most wizards can be completed by clicking the "Finish" button without changing any additional settings, in which VisionX will use the default settings. | + | VisionX offers wizards for all functions, which allows for the step-by-step creation of applications, workscreens, etc.. Most wizards can be completed by clicking the "Finish" button without changing any additional settings in which VisionX will use the default settings. |
| - | In Step 2, the title, folder and description of the new application are added. It should be noted that the application description is entered as text in the specification document as well as the Java source code documentation. This is true for all description fields in VisionX. The description fields should therefore be completed carefully, to create adequate documentation for the application and to maintain a specification document for software providers. | + | In Step 2, the title, folder, and description of the new application are added. It should be noted that the application description is entered as text in the specification document as well as the Java source code documentation. This is true for all description fields in VisionX. The description fields should therefore be completed carefully, to create adequate documentation for the application and to maintain a specification document for software providers. |
| See: [[#create_specificationsdata_model_report|Create Specifications / Data Model Report]] | See: [[#create_specificationsdata_model_report|Create Specifications / Data Model Report]] | ||
| Line 61: | Line 61: | ||
| {{:visionx:documentation:new-application-step3.png?nolink|Create an Application - Step 3 - Database}} | {{:visionx:documentation:new-application-step3.png?nolink|Create an Application - Step 3 - Database}} | ||
| - | In Step 3, the database user (=Schema) is entered, which is used by VisionX to store tables and data. Either a new or an existing database user can be selected. The default setting is a new user with the name of the application as user name. A new database connection (=new entry in the list of available databases) can be created using the "New" button, so that additional databases can be used with VisionX. | + | In Step 3, the database user (Schema) is entered, which is used by VisionX to store tables and data. Either a new or an existing database user can be selected. The default setting is a new user with the name of the application as the user name. A new database connection (new entry in the list of available databases) can be created using the "New" button, so that additional databases can be used with VisionX. |
| See: [[#visionx_administration|VisionX Administration]] | See: [[#visionx_administration|VisionX Administration]] | ||
| Line 67: | Line 67: | ||
| {{:visionx:documentation:new-application-step4.png?nolink|Create an Application - Step 4 - Administrator User}} | {{:visionx:documentation:new-application-step4.png?nolink|Create an Application - Step 4 - Administrator User}} | ||
| - | In Step 4, the administrator user is defined. This user is used to log in to the newly created application. Additional users for the new application can then be entered in VisionX. It should be noted that since the administrator user has all rights in the application, a secure password should be selected for this user. The default setting is admin/admin. | + | In Step 4, the administrator user is defined. This user is used to log in to the newly created application. Additional users for the new application can then be entered in VisionX. It should be noted that because the administrator user has all rights in the application, a secure password should be selected for this user. The default setting is admin/admin. |
| See: [[#userrole_management|User / Role Management]] | See: [[#userrole_management|User / Role Management]] | ||
| - | Clicking "Finish" creates the new application and opens it in the application editor, where additional actions and functions are available to customize the application. | + | Clicking "Finish" creates the new application and opens it in the application editor where additional actions and functions are available to customize the application. |
| {{:visionx:documentation:new-application-step5.png?nolink|Create an Application - Next Steps}} | {{:visionx:documentation:new-application-step5.png?nolink|Create an Application - Next Steps}} | ||
| Line 111: | Line 111: | ||
| {{:visionx:documentation:new-workscreen-step4a1.png?nolink|Create Workscreen - Step 4a - Existing EXCEL /CSV File - Data Definition}} | {{:visionx:documentation:new-workscreen-step4a1.png?nolink|Create Workscreen - Step 4a - Existing EXCEL /CSV File - Data Definition}} | ||
| - | It should be noted that only structured tables can be transferred. The transfer of a collection of data with varying amounts of columns per row cannot be guaranteed. Therefore, every table should consist of a fixed number of columns, with appropriate values in every row and column. Columns can also remain empty. | + | It should be noted that only structured tables can be transferred. The transfer of a collection of data with varying amounts of columns per row cannot be guaranteed. Therefore, every table should consist of a fixed number of columns with appropriate values in every row and column. Columns can also remain empty. |
| The next step shows how VisionX transfers the table. The data format can be chosen, just as it would in the CSV import function in excel. VisionX attempts to recognize the format automatically as much as possible. | The next step shows how VisionX transfers the table. The data format can be chosen, just as it would in the CSV import function in excel. VisionX attempts to recognize the format automatically as much as possible. | ||
| - | The "Yes/No detection" option can be used to attempt to recognize Yes/No fields (= checkboxes). If this option is selected, columns containing Yes/No or true/false values are recognized as checkboxes. | + | The "Yes/No detection" option can be used to attempt to recognize Yes/No fields ( checkboxes). If this option is selected, columns containing Yes/No or true/false values are recognized as checkboxes. |
| - | The "Dropdown detection" option is used to define columns as drop-down lists (combo boxes) if they contain multiple entries of the same value. E.g. Mr., Mrs. The "Dropdown value threshold" defines how many times the same value has to appear before the column is recognize as a drop-down list. "Dropdown grouping" attempts to group similar drop-down lists (in the entire EXCEL/CSV table) into a single list (e.g.: if multiple columns contain salutations). | + | The "Dropdown detection" option is used to define columns as dropdown lists (combo boxes) if they contain multiple entries of the same value, e.g., Mr., Mrs.. The "Dropdown value threshold" defines how many times the same value has to appear before the column is recognize as a dropdown list. "Dropdown grouping" attempts to group similar dropdown lists (in the entire EXCEL/CSV table) into a single list (e.g., if multiple columns contain salutations). |
| {{:visionx:documentation:new-workscreen-step4a2.png?nolink|Create Workscreen - Step 4a - Existing EXCEL /CSV File - Preview}} | {{:visionx:documentation:new-workscreen-step4a2.png?nolink|Create Workscreen - Step 4a - Existing EXCEL /CSV File - Preview}} | ||
| - | The next step shows the table structure for the database table. On this screen, the description, content, view can be edited, fields can be added/deleted, and the order of the fields can be changed. The functionality here is the same as in section [[#create_new_database_table(s)|Create New Database Table(s)]]. | + | The next step shows the table structure for the database table. On this screen, the description, content,and view can be edited, fields can be added/deleted, and the order of the fields can be changed. The functionality here is the same as in section [[#create_new_database_table(s)|Create New Database Table(s)]]. |
| {{:visionx:documentation:new-workscreen-step4a3.png?nolink|Create Workscreen - Step 4a - Existing EXCEL /CSV File - Data}} | {{:visionx:documentation:new-workscreen-step4a3.png?nolink|Create Workscreen - Step 4a - Existing EXCEL /CSV File - Data}} | ||
| Line 131: | Line 131: | ||
| {{:visionx:documentation:new-workscreen-step4b1.png?nolink|Create Workscreen - Step 4b - Existing Database(s) - Select Database}} | {{:visionx:documentation:new-workscreen-step4b1.png?nolink|Create Workscreen - Step 4b - Existing Database(s) - Select Database}} | ||
| - | In the next step a table can be selected. VisionX analyzes the data model and includes up to 5 detail tables with the selected master table. | + | In the next step, a table can be selected. VisionX analyzes the data model and includes up to five detail tables with the selected master table. |
| {{:visionx:documentation:new-workscreen-step4b2.png?nolink|Create Workscreen - Step 4b - Existing Database Tables(s) - Data/Information}} | {{:visionx:documentation:new-workscreen-step4b2.png?nolink|Create Workscreen - Step 4b - Existing Database Tables(s) - Data/Information}} | ||
| Line 143: | Line 143: | ||
| New database tables can easily be created at any time. In the next wizard step, the structure is defined in a table. | New database tables can easily be created at any time. In the next wizard step, the structure is defined in a table. | ||
| - | To do this, simply enter the column names in the first column (= labels). E.g.: | + | To do this, simply enter the column names in the first column (= labels). Example: |
| * Name | * Name | ||
| Line 163: | Line 163: | ||
| The "Mandatory" check box defines whether a value is required for the column. | The "Mandatory" check box defines whether a value is required for the column. | ||
| - | When a new column is added, it has the type of an Input Field by default. The column can be transformed into two other types: | + | When a new column is added, it has the type of an input field by default. The column can be transformed into two other types: |
| <HTML><ul></HTML> | <HTML><ul></HTML> | ||
| <HTML><li></HTML><HTML><p></HTML>Combobox<HTML></p></HTML> | <HTML><li></HTML><HTML><p></HTML>Combobox<HTML></p></HTML> | ||
| - | <HTML><p></HTML>The column is displayed as a drop-down list (= combo box). Only values from the drop-down list can be entered. This list is created by adding a master data list with one column (same name as the combo box), which is used to manage the possible values. The "Existing database table(s)" option in the "New Workscreen" wizard can be used to create a master data list for this purpose. In the "Label" column, the master data list's name can be changed, or an existing master data list can be utilized (e.g. User).<HTML></p></HTML> | + | <HTML><p></HTML>The column is displayed as a drop-down list (combo box). Only values from the dropdown list can be entered. This list is created by adding a master data list with one column (same name as the combo box) that is used to manage the possible values. The "Existing database table(s)" option in the "New Workscreen" wizard can be used to create a master data list for this purpose. In the "Label" column, the master data list's name can be changed, or an existing master data list can be utilized (e.g., User).<HTML></p></HTML> |
| From a technical perspective, a foreign key and a foreign key table column are created in the master table with reference to the master data table. The master data list also receives a unique key via the value column (same name as the combo box), as well as a numerical primary key with the name "ID".<HTML></li></HTML> | From a technical perspective, a foreign key and a foreign key table column are created in the master table with reference to the master data table. The master data list also receives a unique key via the value column (same name as the combo box), as well as a numerical primary key with the name "ID".<HTML></li></HTML> | ||
| <HTML><li></HTML><HTML><p></HTML>Subtable<HTML></p></HTML> | <HTML><li></HTML><HTML><p></HTML>Subtable<HTML></p></HTML> | ||
| - | <HTML><p></HTML>With the "Table" option, a detail table is created instead of a table column. In this detail table, any number of detail records can be stored for each record in the master table (e.g.: a list of ToDo items for each project). See Create Workscreen - Step 4c - Create New Database Table(s) - Data/.<HTML></p></HTML><HTML></li></HTML><HTML></ul></HTML> | + | <HTML><p></HTML>With the "Table" option, a detail table is created instead of a table column. In this detail table, any number of detail records can be stored for each record in the master table (e.g., a list of to-do items for each project). See Create Workscreen - Step 4c - Create New Database Table(s) - Data/.<HTML></p></HTML><HTML></li></HTML><HTML></ul></HTML> |
| Additional columns can be added to the detail table. They are shown indented below the detail table name. | Additional columns can be added to the detail table. They are shown indented below the detail table name. | ||
| - | From a technical perspective a foreign key and a foreign key table column are added to the detail table with reference to the master table. The detail table receives a numerical primary key with the name "ID". | + | From a technical perspective, a foreign key and a foreign key table column are added to the detail table with reference to the master table. The detail table receives a numerical primary key with the name "ID". |
| From a technical perspective, the master table also receives a numerical primary key. | From a technical perspective, the master table also receives a numerical primary key. | ||
| - | To keep VisionX simple, "ID" and "*_ID" are not shown on the workscreens. However, they can be accessed via actions or via the Java Source Code in a Java IDE. | + | To keep VisionX simple, "ID" and "*_ID" are not shown on the workscreens. However, they can be accessed via actions or via the Java source code in a Java IDE. |
| In Step 5, options for the workscreen layout can be defined. | In Step 5, options for the workscreen layout can be defined. | ||
| Line 184: | Line 184: | ||
| {{:visionx:documentation:new-workscreen-step5.png?nolink|Create Workscreen - Step 5 - Layout Options}} | {{:visionx:documentation:new-workscreen-step5.png?nolink|Create Workscreen - Step 5 - Layout Options}} | ||
| - | Depending on the selected layout, the number of columns for the input fields/drop-down lists on the form can be selected. The default setting is 2 columns of input fields. Detail tables can be arranged using group panels or tab sets. In addition, for the table layout or the combined table/form layout the split orientation (horizontal or vertical) can be selected. | + | Depending on the selected layout, the number of columns for the input fields/dropdown lists on the form can be selected. The default setting is two columns of input fields. Detail tables can be arranged using group panels or tab sets. In addition, for the table layout or the combined table/form layout, the split orientation (horizontal or vertical) can be selected. |
| ===== GUI Designer ===== | ===== GUI Designer ===== | ||
| - | Design mode is activated using the "Design" button in the application's menu. In design mode, all open workscreens can be edited. If no workscreen is open when design mode is activated, the GUI Designer opens a list of all available workscreens. | + | Design mode is activated using the "Design" button and deactivated using the "Finish" button in the application's menu. The button is always the same but the text is different. In design mode, all open workscreens can be edited. If no workscreen is open when design mode is activated, the GUI Designer opens a list of all available workscreens. |
| - | Design mode is closed using the "Finished" button in the application's menu. | + | The "Finish" button only is available in design mode. |
| {{:visionx:documentation:gui-designer-design-mode.png?nolink|GUI Designer - Design Mode}} | {{:visionx:documentation:gui-designer-design-mode.png?nolink|GUI Designer - Design Mode}} | ||
| - | GUI elements can be moved onto the workscreen from the panel on the left side of the screen via drag & drop. | + | GUI elements can be moved onto the workscreen from the panel on the left side of the screen via drag and drop. |
| - | Actions can be reversed and redone using the "Undo" and "Redo" buttons on the toolbar. It should be noted that changes in the GUI Designer are always saved immediately and are executed after the "Finish" button is clicked in a wizard. | + | Actions can be reversed and redone using the "Undo" and "Redo" buttons on the toolbar. It should be noted that changes in the GUI designer are always saved immediately and are executed after the "Finish" button is clicked in a wizard. |
| - | The lower panel shows the data model that is currently used. It includes all tables that are used in the workscreen. This panel is used to create or integrate additional tables, edit existing tables, and to move data related elements such as input fields, drop-down lists or tables onto the workscreen via drag & drop. | + | The lower panel shows the data model that is currently used. It includes all tables that are used in the workscreen. This panel is used to create or integrate additional tables, edit existing tables, and to move data related elements, such as input fields, dropdown lists, or tables onto the workscreen via drag and drop. |
| - | The center panel is used to edit the layout of the workscreen. Elements can be moved via drag & drop, or adjusted in size. Individual elements or entire areas can be copied by holding the <html><Ctrl></html> key while an element is dragged. | + | The center panel is used to edit the layout of the workscreen. Elements can be moved via drag and drop or adjusted in size. Individual elements or entire areas can be copied by holding the <html><Ctrl></html> key while an element is dragged. |
| - | When a GUI element is selected, two small icons appear on the upper left corner of the element. The first is a trash bin, to delete the element, and the second is a pencil, to edit the element. Depending on the GUI element type, various properties can be edited (e.g.: font, color, orientation, picture, table column labels (F2/Pencil), etc). | + | When a GUI element is selected, two small icons appear on the upper left corner of the element. The first is a trash bin to delete the element, and the second is a pencil to edit the element. Depending on the GUI element type, various properties can be edited (e.g., font, color, orientation, picture, table column labels (F2/Pencil), etc). |
| See: [[#gui_elements/properties|GUI Elements/Properties]] | See: [[#gui_elements/properties|GUI Elements/Properties]] | ||
| Line 212: | Line 212: | ||
| {{:visionx:documentation:gui-designer-properties.png?nolink|GUI Designer - Properties}} | {{:visionx:documentation:gui-designer-properties.png?nolink|GUI Designer - Properties}} | ||
| - | When an element is selected, its name, type and position in the GUI element hierarchy is displayed above the workscreen. In addition, all of the element's anchors are displayed, which can be moved using the triangular handles (top/bottom). | + | When an element is selected, its name, type, and position in the GUI element hierarchy are displayed above the workscreen. In addition, all of the element's anchors are displayed, which can be moved using the triangular handles (top/bottom). |
| - | VisionX forms are arranged in the commonly used form layout. All elements are positioned on a grid of rows and columns. An element does not have to be placed exactly in a row or column, it can also stretch across multiple rows, columns, or both. This is done by selecting the element and pulling one of the edges until it is close to the next anchor line. After the element is released, it is spread across two or more columns. In addition, GUI elements can be attached to the edges of the workscreen by pulling the selected edge of the element close to the end of the workscreen and releasing. As a result, these elements are automatically re-sized when the workscreen size is increased or decreased. This layout mechanism ensures that workscreens are adjusted to the client's resolution, which is extremely beneficial in the case of differing screen resolutions or GUI technologies (web, mobile, desktop). | + | VisionX forms are arranged in the commonly used form layout. All elements are positioned on a grid of rows and columns. An element does not have to be placed exactly in a row or column; it can also stretch across multiple rows, columns, or both. This is done by selecting the element and pulling one of the edges until it is close to the next anchor line. After the element is released, it is spread across two or more columns. In addition, GUI elements can be attached to the edges of the workscreen by pulling the selected edge of the element close to the end of the workscreen and releasing. As a result, these elements are automatically resized when the workscreen size is increased or decreased. This layout mechanism ensures that workscreens are adjusted to the client's resolution, which is extremely beneficial in the case of differing screen resolutions or GUI technologies (web, mobile, desktop). |
| {{:visionx:documentation:formlayout-anchors.png?nolink|Attaching GUI Element to Workscreen Edge using Anchors}} | {{:visionx:documentation:formlayout-anchors.png?nolink|Attaching GUI Element to Workscreen Edge using Anchors}} | ||
| - | A clipboard is located in the lower left corner of the screen. It contains all deleted or copied elements. They can be pulled into any workscreen via drag & drop, which allows for simple and quick restructuring of workscreens. For example: In a first step all elements are deleted panel by panel to create space. Then the new group elements (e.g. tab sets) are placed on the workscreen and the original panels are replaced step by step. VisionX prevents the deletion of any elements that are used in an action. This ensures that none of the logic is lost. To delete such an element, first the business logic has to be adjusted and the references have to be deleted. | + | A clipboard is located in the lower left corner of the screen. It contains all deleted or copied elements. They can be pulled into any workscreen via drag and drop, which allows for simple and quick restructuring of workscreens. For example, in the first step all elements are deleted panel by panel to create space. Then the new group elements (e.g., tab sets) are placed on the workscreen, and the original panels are replaced step by step. VisionX prevents the deletion of any elements that are used in an action. This ensures that none of the logic is lost. To delete such an element, first the business logic has to be adjusted and the references have to be deleted. |
| This method can also be used to copy parts of workscreens into other workscreens. | This method can also be used to copy parts of workscreens into other workscreens. | ||
| Line 226: | Line 226: | ||
| The lower panel shows all the tables that are used in the workscreen. | The lower panel shows all the tables that are used in the workscreen. | ||
| - | For each table, the following data related elements (highlighted in green) can be placed on the workscreen via drag & drop if they are not already used on the screen: | + | For each table, the following data related elements (highlighted in green) can be placed on the workscreen via drag and drop if they are not already used on the screen: |
| * Table View | * Table View | ||
| - | * Form A group box with all of the table's input fields and drop-down lists. | + | * Form A group box with all of the table's input fields and dropdown lists. |
| - | * Search Box (= Filter Editor) Search boxes can limit the amount of data displayed in a table. They allow the user to limit data in either all or selected table columns e.g.: full text search, smaller/greater/similar/... filter by project number, name/... | + | * Search box (filter editor): search boxes can limit the amount of data displayed in a table. They allow the user to limit data in either all or selected table columns, e.g., full text search, smaller/greater/similar/... filter by project number, name/... |
| - | * All input fields/drop-down lists (= editors) not currently in use on the workscreen. The toolbar on the left of the lower panel also includes a button for the table documentation, where descriptions can be added for the table and each of its columns. The descriptions are stored in the database as table and column comments and are used for the specification and for the data model documentation. | + | * All input fields/dropdown lists (editors) not currently in use on the workscreen. The toolbar on the left of the lower panel also includes a button for the table documentation, where descriptions can be added for the table and each of its columns. The descriptions are stored in the database as table and column comments and are used for the specification and for the data model documentation. |
| - | The "Pencil" symbol is used to edit the data structure of the table and its detail tables. | + | The pencil symbol is used to edit the data structure of the table and its detail tables. |
| {{:visionx:documentation:gui-designer-edit-model.png?nolink|GUI Designer - Edit Data Model}} | {{:visionx:documentation:gui-designer-edit-model.png?nolink|GUI Designer - Edit Data Model}} | ||
| - | The "Edit Data Object" wizard allows the user to add, delete or edit tables/table columns. Changes made in this wizard are not effective until the "Finish" button is clicked, and can be discarded using the "Cancel" button. | + | The "Edit Data Object" wizard allows the user to add, delete, or edit tables/table columns. Changes made in this wizard are not effective until the "Finish" button is clicked and can be discarded using the "Cancel" button. |
| If the description is changed, the respective table column is renamed. | If the description is changed, the respective table column is renamed. | ||
| Line 243: | Line 243: | ||
| If the data type (content) is changed, VisionX attempts to change the data type in the database. | If the data type (content) is changed, VisionX attempts to change the data type in the database. | ||
| - | Depending on the data type and the database provider this is only possible to a limited extent. E.g.: a conversion from "text short" to "text long" is possible, but a change from "text short" to "number" is only allowed if the column only contains valid numbers or no values at all. | + | Depending on the data type and the database provider this is only possible to a limited extent. For example, a conversion from "text short" to "text long" is possible, but a change from "text short" to "number" is only allowed if the column only contains valid numbers or no values at all. |
| - | In addition, a table column can be changed to be a required field and conversely. Limitations similar to those for data type changes apply - the change to a required field is only possible if all columns contain values. | + | In addition, a table column can be changed to be a required field and conversely. Limitations similar to those for data type changes apply: the change to a required field is only possible if all columns contain values. |
| Deleting a table or table column means that the data in the table or column is also deleted! | Deleting a table or table column means that the data in the table or column is also deleted! | ||
| - | When columns are added, it should be noted that all existing records a populated with blank values. | + | When columns are added, it should be noted that all existing records are populated with blank values. |
| - | Therefore a newly added column can initially not be a required field. The column can be changed to a required field only after values are added in the column for all rows. | + | Therefore, a newly added column can initially not be a required field. The column can be changed to a required field only after values are added in the column for all rows. |
| All changes to the data model are made step by step. In case a database change is not possible, the remaining changes are not made. All data model transformations are completed in multiple steps. | All changes to the data model are made step by step. In case a database change is not possible, the remaining changes are not made. All data model transformations are completed in multiple steps. | ||
| - | The original data is not deleted until all steps are successfully completed. The drop-down lists' original master data tables remain in the data model! If a column's data type cannot be changed, the original data type including all data is preserved. | + | The original data is not deleted until all steps are successfully completed. The dropdown lists' original master data tables remain in the data model! If a column's data type cannot be changed, the original data type including all data is preserved. |
| - | For tables or columns that are already used in actions, data-related GUI elements or other workscreens, please note that the references are NOT corrected automatically. If such references exist, they are displayed in the GUI Designer (design mode) in red. The "Edit Data Object" wizard for the respective table can be used to attempt to delete these references to maintain an error free workscreen. | + | For tables or columns that are already used in actions, data-related GUI elements, or other workscreens, please note that the references are NOT corrected automatically. If such references exist, they are displayed in the GUI designer (design mode) in red. The "Edit Data Object" wizard for the respective table can be used to attempt to delete these references to maintain an error-free workscreen. |
| ==== GUI Elements/Properties ==== | ==== GUI Elements/Properties ==== | ||
| - | The following table shows all GUI elements and their properties that require explanation. In addition, all GUI element properties can be edit via Java code in a Java IDE, such as Eclipse. Additional information can be found in the documentation for the JVx Open Source framework on the internet. | + | The following table shows all GUI elements and their properties that require an explanation. In addition, all GUI element properties can be edit via Java code in a Java IDE, such as Eclipse. Additional information can be found in the documentation for the JVx Open Source framework on the internet. |
| - | ^GUI Element ^Description ^ | + | ^GUI Element ^Description ^ |
| - | |Label |Label for input fields, etc. | | + | |Label |Label for input fields, etc. | |
| - | |Picture |Pictures can be added to the application using the picture library. A selection of images is included in VisionX. | | + | |Picture |Pictures can be added to the application using the picture library. A selection of images is included in VisionX. | |
| - | |Button\\ Toggle Button |Buttons usually trigger certain actions and can be used to display images and text. A Toggle Button is a button with two states (clicked, not clicked). | | + | |Button\\ Toggle Button |Buttons usually trigger certain actions and can be used to display images and text. A toggle button is a button with two states (clicked, not clicked). | |
| - | |Radio Button\\ Check Box |Option button and check box for the selection of one or more values. | | + | |Radio Button\\ Check Box |Option button and checkbox for the selection of one or more values. | |
| - | |Option Chooser |This element is a panel containing radio buttons. This GUI element has to be associated with a combo box table column. A radio button is created on the panel for each possible value on the drop-down list. Only one value can be selected. This element allows for the effortless creation of data-related radio groups. | | + | |Option Chooser |This element is a panel containing radio buttons. This GUI element has to be associated with a combo box table column. A radio button is created on the panel for each possible value on the dropdown list. Only one value can be selected. This element allows for the effortless creation of data-related radio groups. | |
| - | |Field Validator |Field validators are status fields that show whether the field validation for an associated table column was successful or not (green checkmark or red "X").\\ \\ This GUI element has to be associated with a table column; the validation related to the column has to be created using the action editor.\\ \\ The "Automatic validation" option immediately performs the validation VisionX Documentation 23 when the field is exited (this is the default setting). Otherwise the validation has to be initiated using the "Are Validations Ok" condition in an action (e.g. upon click of a "Save" button on the form).\\ \\ When the "Hide until first validate" option is selected, the validation field's status is not displayed until the validation has been performed. Otherwise it is displayed at all times. | | + | |Field Validator |Field validators are status fields that show whether the field validation for an associated table column was successful or not (green checkmark or red "X").\\ \\ This GUI element has to be associated with a table column; the validation related to the column has to be created using the action editor.\\ \\ The "Automatic validation" option immediately performs the validation VisionX Documentation 23 when the field is exited (this is the default setting). Otherwise, the validation has to be initiated using the "Are Validations Ok" condition in an action (e.g., upon click of a "Save" button on the form).\\ \\ When the "Hide until first validate" option is selected, the validation field's status is not displayed until the validation has been performed. Otherwise, it is displayed at all times. | |
| - | |Validation Result |This element displays validation errors that resulted from failed field validations. The associated GUI element determines which field validations are considered. All field validations on the same Panel/Split or tab are considered. | | + | |Validation Result |This element displays validation errors that resulted from failed field validations. The associated GUI element determines which field validations are considered. All field validations on the same Panel/Split or tab are considered. | |
| - | |Panel |A panel can contain other GUI elements or sub elements. Sub elements are arranged form oriented by rows and columns.\\ See: [[#gui_designer|GUI Designer]] | | + | |Panel |A panel can contain other GUI elements or subelements. Subelements are arranged form oriented by rows and columns.\\ See: [[#gui_designer|GUI Designer]] | |
| - | |Group Panel |A group panel can contain other elements as sub elements. In addition, this element has a frame and a title. Sub elements are arranged form oriented by rows and columns.\\ See: [[#gui_designer|GUI Designer]] | | + | |Group Panel |A group panel can contain other elements as subelements. In addition, this element has a frame and a title. Subelements are arranged by rows and columns.\\ See: [[#gui_designer|GUI Designer]] | |
| - | |Horizontal Split\\ Vertical Split |A split can contain exactly two elements as sub elements. The sub elements are separated horizontally or vertically by a moveable bar. | | + | |Horizontal Split\\ Vertical Split |A split can contain exactly two elements as subelements. The subelements are separated horizontally or vertically by a movable bar. | |
| - | |Tabset |A tab set can contain other elements as sub elements. Each sub element is displayed as a tab with a label. | | + | |Tabset |A tab set can contain other elements as subelements. Each subelement is displayed as a tab with a label. | |
| - | |Tree |One or more tables are displayed as trees. The used columns can be choosen. | | + | |Tree |One or more tables are displayed as trees. The used columns can be chosen. | |
| - | |Table |View A database table is displayed as a table including navigation containing New/Edit/Delete/CSV Export options.\\ \\ The column order, labels, and visible columns can be specified. An alternate column order and visibility can be specified for the display on mobile devices.\\ \\ In addition, the default sort setting can be determined via click (and Ctrl Shift + click) on the column headers. | | + | |Table |View A database table is displayed as a table including navigation containing New/Edit/Delete/CSV Export options.\\ \\ The column order, labels, and visible columns can be specified. An alternate column order and visibility can be specified for the display on mobile devices.\\ \\ In addition, the default sort setting can be determined via click (and Ctrl Shift + click) on the column headers. | |
| - | |Input Field\\ Dropdown List\\ Editor |A data-related table column is displayed as input field or drop-down list. | | + | |Input Field\\ Dropdown List\\ Editor |A data-related table column is displayed as an input field or dropdown list. | |
| - | |Search\\ (Filter Editor) |Search boxes can limit the number of results in a table. Either all columns or a selected number of columns can be restricted using the selected search criteria. e.g.: full text search, smaller/greater/similar/... e.g. search for project number, name, ... | | + | |Search\\ (Filter Editor) |Search boxes can limit the number of results in a table. Either all columns or a selected number of columns can be restricted using the selected search criteria, e.g., full text search, smaller/greater/similar, search for project number, name, etc. | |
| ===== Menu Management ===== | ===== Menu Management ===== | ||
| Line 286: | Line 286: | ||
| {{:visionx:documentation:menu-management.png?nolink|Menu Management}} | {{:visionx:documentation:menu-management.png?nolink|Menu Management}} | ||
| - | The menu management wizard is used to create new menus or sub-menus and to edit existing menus. Menu entries (workscreens) can be sorted or moved to different menus using the arrow buttons. | + | The menu management wizard is used to create new menus or submenus and to edit existing menus. Menu entries (workscreens) can be sorted or moved to different menus using the arrow buttons. |
| The menu title, and with it the name of the workscreen, can be changed in the panel on the right. If a toolbar title and picture are added, the menu entry is also displayed in the application's toolbar. A hot key can be defined to quickly open the menu entry. | The menu title, and with it the name of the workscreen, can be changed in the panel on the right. If a toolbar title and picture are added, the menu entry is also displayed in the application's toolbar. A hot key can be defined to quickly open the menu entry. | ||
| Line 298: | Line 298: | ||
| By default, the user management tool is located in the "Admin" menu. | By default, the user management tool is located in the "Admin" menu. | ||
| - | In addition to user name and password, additional information can be recorded for each user. The "Active" checkbox determines whether the user is currently active and is able to log in to the application. Checking the box "Password expired" forces the user to change passwords at the next login. | + | In addition to username and password, additional information can be recorded for each user. The "Active" checkbox determines if the user is currently active and able to log into the application. Checking the box "Password expired" forces the user to change passwords at the next login. |
| - | Roles can be defined for each user by checking the respective boxes in the "Roles" table. The roles itself are managed using the application's menu. | + | Roles can be defined for each user by checking the respective boxes in the "Roles" table. The roles themselves are managed using the application's menu. |
| See: [[#userrole_management|User / Role Management]] | See: [[#userrole_management|User / Role Management]] | ||
| Line 306: | Line 306: | ||
| ===== Application Settings ===== | ===== Application Settings ===== | ||
| - | A number of application settings can be edited in the "Application Settings" menu of the application's menu. | + | A number of application settings can be edited in the "Application Settings" menu. |
| {{:visionx:documentation:application-settings-details.png?nolink|Application Settings - Details}} | {{:visionx:documentation:application-settings-details.png?nolink|Application Settings - Details}} | ||
| - | On the "Details" tab, the application's title, version, language and additional information can be entered and edited. | + | On the "Details" tab, the application's title, version, language, and additional information can be entered and edited. |
| - | The default setting for the language is "Automatic". This means that the application is opened using the client PC's language. Instead, a specific language can be selected in which the application is to be run (e.g. English). | + | The default setting for the language is "Automatic". This means that the application is opened using the client PC's language. If desired, a specific language can be selected in which the application is to run (e.g., English). |
| - | If not translation is available for the selected/determined language, the respective text is not translated and remains unchanged. | + | If no translation is available for the selected/determined language, the respective text is not translated and remains unchanged. |
| On the "Start" tab, a standard user can be defined for automatic authentication. This can be used for public applications without registered users. | On the "Start" tab, a standard user can be defined for automatic authentication. This can be used for public applications without registered users. | ||
| Line 328: | Line 328: | ||
| {{:visionx:documentation:application-settings-roles.png?nolink|Application Settings - Manage Roles}} | {{:visionx:documentation:application-settings-roles.png?nolink|Application Settings - Manage Roles}} | ||
| - | On the "Roles" tab, new roles can be created, and roles are assigned to the available workscreens. Role-specific functionality can also be managed on the workscreens directly, e.g. actions can be used to show/hide certain fields or buttons. | + | On the "Roles" tab, new roles can be created, and assigned to the available workscreens. Role-specific functionality can also be managed on the workscreens directly, e.g., actions can be used to show/hide certain fields or buttons. |
| Additional information can be found in the VisionX Actions Documentation. | Additional information can be found in the VisionX Actions Documentation. | ||
| Line 342: | Line 342: | ||
| On the "Translation" tab, the application's languages and the corresponding translations are edited. | On the "Translation" tab, the application's languages and the corresponding translations are edited. | ||
| - | When the application is created, all workscreens, menus, etc. should be in the same language (= default language). This can be English, German, etc. Additional languages and their translations can be created and managed on this tab. The "Not translated" button is used to transfer all recognized text for which no translation exists to the translation list. On this list, a translation can be entered for each message. This allows the user to add missing translations for new workscreens or functions at any time. | + | When the application is created, all workscreens, menus, etc. should be in the same language (default language). This can be English, German, etc.. Additional languages and their translations can be created and managed on this tab. The "Not translated" button is used to transfer all recognized text for which no translation exists to the translation list. On this list, a translation can be entered for each message. This allows the user to add missing translations for new workscreens or functions at any time. |
| - | For VisionX to recognize the text, all workscreens first have to be opened and all functions executed. Irrespective thereof, further text and translations can always be added. | + | For VisionX to recognize the text, all workscreens first have to be opened and all functions executed. Further text and translations can always be added. |
| {{:visionx:documentation:application-settings-translation.png?nolink|Application Settings - Translation}} | {{:visionx:documentation:application-settings-translation.png?nolink|Application Settings - Translation}} | ||
| - | In addition to simple text, placeholders can be used for error messages. This is particularly helpful for error message that refer to fields, etc. | + | In addition to simple text, placeholders can be used for error messages. This is particularly helpful for error message that refer to fields and so forth. |
| |Text |The field "*1" in Tab "*2" cannot be empty! | | |Text |The field "*1" in Tab "*2" cannot be empty! | | ||
| Line 355: | Line 355: | ||
| * can be used to define placeholders. | * can be used to define placeholders. | ||
| - | The translation can include a reference to the placeholder themselves. That's done with the * followed by a number. e.g.: *1 for the first placeholder. | + | The translation can include a reference to the placeholder themselves. This is done with the * followed by a number,. e.g., *1 for the first placeholder. |
| ===== Create Specifications / Data Model Report ===== | ===== Create Specifications / Data Model Report ===== | ||
| Line 365: | Line 365: | ||
| In the first step, the user can choose between a specification document for the application's workscreens or the documentation for the database. | In the first step, the user can choose between a specification document for the application's workscreens or the documentation for the database. | ||
| - | For the application screen documentation, a word document is created containing a description of the application, of the workscreens (including a screen shot), and of all fields and their respective actions. | + | For the application screen documentation, a Word document is created containing a description of the application, workscreens (including a screen shot), and all fields with their respective actions. |
| - | For the database documentation, a word document is created showing all database tables including all columns, primary keys, foreign keys and unique keys. | + | For the database documentation, a Word document is created showing all database tables including columns, primary keys, foreign-, and unique keys. |
| Both options are created based on a template, which is downloaded in the next wizard step and edited using Microsoft Word. The template system is the same as the one used for the VisionX reports. | Both options are created based on a template, which is downloaded in the next wizard step and edited using Microsoft Word. The template system is the same as the one used for the VisionX reports. | ||
| Line 385: | Line 385: | ||
| In this step, the user can create new help pages or add additional workscreens to existing sections. In addition, the application image in the help pages can be edited. | In this step, the user can create new help pages or add additional workscreens to existing sections. In addition, the application image in the help pages can be edited. | ||
| - | In both cases the help pages can easily be edited in any HTML editor, to add more details or examples. | + | In both cases, the help pages can easily be edited in any HTML editor to add more details or examples. |
| - | The help function in VisionX is HTML based, including indexed full text search. | + | The help function in VisionX is HTML based including indexed full-text search. |
| In the next step, the user can select the workscreens for which the help documents are to be created. | In the next step, the user can select the workscreens for which the help documents are to be created. | ||
| Line 395: | Line 395: | ||
| ===== Create / Edit Reports ===== | ===== Create / Edit Reports ===== | ||
| - | The "Reports" wizard in the application's Funktionsmenü is used to create a new report or to edit an existing report. | + | The "Reports" wizard in the application's functions menu is used to create a new report or to edit an existing report. |
| {{:visionx:documentation:reports-step2.png?nolink|Create Reports - Step 2 - New or Existing Report}} | {{:visionx:documentation:reports-step2.png?nolink|Create Reports - Step 2 - New or Existing Report}} | ||
| - | Since reports are managed by workscreen, the first step in the wizard is the selection of a workscreen. | + | As reports are managed by workscreen, the first step in the wizard is the selection of a workscreen. |
| In the second step, creating a new report or editing an existing report can be chosen. | In the second step, creating a new report or editing an existing report can be chosen. | ||
| Line 413: | Line 413: | ||
| In addition, one of the following report layouts can be chosen: | In addition, one of the following report layouts can be chosen: | ||
| - | * Simple List A table is displayed as a simple list. The current data filter is applied. | + | * Simple List: A table is displayed as a simple list. The current data filter is applied. |
| - | * List with Details A table is displayed as a list, in which for each master record a list of all detail records is shown. The current data filter is applied. | + | * List With Details: A table is displayed as a list in which for each master record, a list of all detail records is shown. The current data filter is applied. |
| - | * Form (with Details) The currently selected master record is displayed as a form, below which detail tables can be shown. | + | * Form (With Details): The currently selected master record is displayed as a form below which detail tables can be shown. |
| {{:visionx:documentation:reports-step3.png?nolink|Create Report - Step 3 - Select Layout}} | {{:visionx:documentation:reports-step3.png?nolink|Create Report - Step 3 - Select Layout}} | ||
| Line 423: | Line 423: | ||
| {{:visionx:documentation:reports-step4.png?nolink|Create Report - Step 4 - Select Data/Master Table}} | {{:visionx:documentation:reports-step4.png?nolink|Create Report - Step 4 - Select Data/Master Table}} | ||
| - | Depending on the layout, a number of options can be selected. This is particularly relevant for the "List with Details" format. The following options are available: | + | Depending on the layout, a number of options can be selected. This is particularly relevant for the "List With Details" format. The following options are available: |
| - | * Checkbox "Show records only for selected master" If this option is checked, only the selected master record and the respective detail records are displayed in the report. | + | * Checkbox "Show records only for selected master": If this option is checked, only the selected master record and the respective detail records are displayed in the report. |
| - | * Checkbox "Show master records only for its selected master" If this option is checked, all detail records are displayed for all visible master records. | + | * Checkbox "Show master records only for its selected master": If this option is checked, all detail records are displayed for all visible master records. |
| - | * None of the two options are checked If there is another level above the master record, no restrictions apply to this additional level. E.g.: For the report, State (master) and City (detail) are selected; the table State has a master table Country In this case, the report shows all states (for all countries!) and every city for each state | + | * None of the two options are checked: If there is another level above the master record, no restrictions apply to this additional level. For example, for the report, State (master) and City (detail) are selected; the table State has a master table Country. In this case, the report shows all states (for all countries!) and every city for each state. |
| {{:visionx:documentation:reports-step5a.png?nolink|Create Report - Step 5a - Select Master Columns}} | {{:visionx:documentation:reports-step5a.png?nolink|Create Report - Step 5a - Select Master Columns}} | ||
| Line 433: | Line 433: | ||
| {{:visionx:documentation:reports-step5b.png?nolink|Create Report - Step 5b - Select Detail Columns}} | {{:visionx:documentation:reports-step5b.png?nolink|Create Report - Step 5b - Select Detail Columns}} | ||
| - | In the last step, the columns that are to be displayed in the report can be chosen for each table. As an option, the detail columnscan be selected for the report in addition to the master columns. | + | In the last step, the columns that are to be displayed in the report can be chosen for each table. As an option, the detail columns can be selected for the report in addition to the master columns. |
| {{:visionx:documentation:reports-action.png?nolink|Create Report - Assign "Show Report" Action to a Button}} | {{:visionx:documentation:reports-action.png?nolink|Create Report - Assign "Show Report" Action to a Button}} | ||
| - | In this step, the newly created report can be assigned to a button. An action is automatically created, or an existing action is edited, to show the report. | + | In this step, the newly created report can be assigned to a button. An action is automatically created -- or an existing action is edited -- to show the report. |
| The "Reports" wizard can also be used to edit existing reports. | The "Reports" wizard can also be used to edit existing reports. | ||
| Line 451: | Line 451: | ||
| ===== Actions ===== | ===== Actions ===== | ||
| - | Actions are created, edited and deleted via VisionX's GUI designer. They can be used for a number of events, such as, for example, the click of a button. When the selected event occurs during the use of a workscreen, the respective action is performed. | + | Actions are created, edited, and deleted via VisionX's GUI designer. They can be used for a number of events, such as the click of a button. When the selected event occurs during the use of a workscreen, the respective action is performed. |
| Example: | Example: | ||
| - | When the event "button click" occurs, the specified action is executed. For example, the action can show a a report. | + | When the event "button click" occurs, the specified action is executed. For example, the action can show a report. |
| The following steps show how a report is displayed after the click of a button labeled "Report". | The following steps show how a report is displayed after the click of a button labeled "Report". | ||
| Line 468: | Line 468: | ||
| <HTML><ul></HTML> | <HTML><ul></HTML> | ||
| - | <HTML><li></HTML>Step 1 - Open a workscreen in the GUI Designer - e.g.: the "Contacts" workscreen<HTML></li></HTML> | + | <HTML><li></HTML>Step 1 - Open a workscreen in the GUI designer - for example, the "Contacts" workscreen.<HTML></li></HTML> |
| - | <HTML><li></HTML><HTML><p></HTML>Step 2 - Select the "Report" button in the GUI Designer and click on the pencil icon<HTML></p></HTML> | + | <HTML><li></HTML><HTML><p></HTML>Step 2 - Select the "Report" button in the GUI designer and click on the pencil icon.<HTML></p></HTML> |
| <HTML><p></HTML>{{:visionx:documentation:actions-step2.png?nolink|Edit Actions - Step 2}}<HTML></p></HTML><HTML></li></HTML> | <HTML><p></HTML>{{:visionx:documentation:actions-step2.png?nolink|Edit Actions - Step 2}}<HTML></p></HTML><HTML></li></HTML> | ||
| - | <HTML><li></HTML><HTML><p></HTML>Step 3 - Click on the button "Create/Edit Action" to create/edit an action<HTML></p></HTML> | + | <HTML><li></HTML><HTML><p></HTML>Step 3 - Click on the button "Create/Edit Action" to create/edit an action.<HTML></p></HTML> |
| <HTML><p></HTML>{{:visionx:documentation:actions-step3.png?nolink|Edit Actions - Step 3}}<HTML></p></HTML><HTML></li></HTML> | <HTML><p></HTML>{{:visionx:documentation:actions-step3.png?nolink|Edit Actions - Step 3}}<HTML></p></HTML><HTML></li></HTML> | ||
| - | <HTML><li></HTML>Step 4 - Enter a description of the action on the "Description" tab<HTML></li></HTML> | + | <HTML><li></HTML>Step 4 - Enter a description of the action on the "Description" tab.<HTML></li></HTML> |
| - | <HTML><li></HTML><HTML><p></HTML>Step 5 - Click on the "Action" tab and select "Show Report"<HTML></p></HTML> | + | <HTML><li></HTML><HTML><p></HTML>Step 5 - Click on the "Action" tab and select "Show Report".<HTML></p></HTML> |
| <HTML><p></HTML>{{:visionx:documentation:actions-step5.png?nolink|Edit Actions - Step 5}}<HTML></p></HTML><HTML></li></HTML> | <HTML><p></HTML>{{:visionx:documentation:actions-step5.png?nolink|Edit Actions - Step 5}}<HTML></p></HTML><HTML></li></HTML> | ||
| - | <HTML><li></HTML><HTML><p></HTML>Step 6 - Select the desired report as parameter<HTML></p></HTML> | + | <HTML><li></HTML><HTML><p></HTML>Step 6 - Select the desired report as parameter.<HTML></p></HTML> |
| <HTML><p></HTML>{{:visionx:documentation:actions-step6.png?nolink|Edit Actions - Step 6}}<HTML></p></HTML><HTML></li></HTML> | <HTML><p></HTML>{{:visionx:documentation:actions-step6.png?nolink|Edit Actions - Step 6}}<HTML></p></HTML><HTML></li></HTML> | ||
| - | <HTML><li></HTML><HTML><p></HTML>Step 7 - Click the "Verify" button and then "OK" to verify and save<HTML></p></HTML><HTML></li></HTML><HTML></ul></HTML> | + | <HTML><li></HTML><HTML><p></HTML>Step 7 - Click the "Verify" button and then "OK" to verify and save.<HTML></p></HTML><HTML></li></HTML><HTML></ul></HTML> |
| - | This completes the action. It can be tested by closing the GUI Designer and changing to runtime mode. Clicking the "Report" button opens the "Contacts" report. | + | This completes the action. It can be tested by closing the GUI designer and changing to runtime mode. Clicking the "Report" button opens the "Contacts" report. |
| Additional information about actions can be found in the VisionX Actions Documentation. | Additional information about actions can be found in the VisionX Actions Documentation. | ||
| Line 488: | Line 488: | ||
| The following table summarizes all events that can be defined in VisionX. The availability of these depends on the GUI element to which they are applied. Furthermore, additional events can be defined using Java code in a Java IDE, such as Eclipse. Additional information can be found in the documentation for the Open Source Framework JVx on the internet. | The following table summarizes all events that can be defined in VisionX. The availability of these depends on the GUI element to which they are applied. Furthermore, additional events can be defined using Java code in a Java IDE, such as Eclipse. Additional information can be found in the documentation for the Open Source Framework JVx on the internet. | ||
| - | ^Event ^Description ^ | + | ^Event ^Description ^ |
| - | |On Load |This event occurs when a workscreen is opened. It it used to configure the data and elements that are to be displayed.\\ For example, user or role dependent views can be defined here.\\ At the time of the event, the workscreen is not yet visible.\\ GUI Elements: Workscreen | | + | |On Load |This event occurs when a workscreen is opened. It it used to configure the data and elements that are to be displayed.\\ For example, user- or-role dependent views can be defined here.\\ At the time of the event, the workscreen is not yet visible.\\ GUI Elements: Workscreen | |
| - | |On Show |This event occurs immediately after a workscreen is opened. It is used to configure the data and elements that are to be displayed.\\ At the time of the event, the workscreen is visible.\\ GUI Elements: Workscreen | | + | |On Show |This event occurs immediately after a workscreen is opened. It is used to configure the data and elements that are to be displayed.\\ At the time of the event, the workscreen is visible.\\ GUI Elements: Workscreen | |
| - | |On Activate |This event occurs each the a workscreen is activated using the "Open Screen" action, irrespective of whether the workscreen is opened or a previously opened workscreen is brought back to the foreground.\\ It can be used, for example, to evaluate parameters transferred from the called workscreen and to display the resulting values.\\ At the time of the event, the workscreen is not yet visible.\\ GUI Elements: Workscreen | | + | |On Activate |This event occurs each time a workscreen is activated using the "Open Screen" action, regardless of whether the workscreen is opened or a previously opened workscreen is brought back to the foreground.\\ It can be used, for example, to evaluate parameters transferred from the called workscreen and to display the resulting values.\\ At the time of the event, the workscreen is not yet visible.\\ GUI Elements: Workscreen | |
| - | |On Close |This event occurs before a workscreen is closed. It is used to save data or to prevent closing the workscreen.\\ \\ GUI Elements: Workscreen | | + | |On Close |This event occurs before a workscreen is closed. It is used to save data or to prevent closing the workscreen.\\ \\ GUI Elements: Workscreen | |
| - | |Tab Activated |This event occurs when a tab is activated. It can be used to perform calculations or validations.\\ \\ GUI Elements: Workscreen | | + | |Tab Activated |This event occurs when a tab is activated. It can be used to perform calculations or validations.\\ \\ GUI Elements: Workscreen | |
| - | |Action |This event occurs at the click of a button.\\ It is used to start processes, execute logic, manipulate data, display reports or import data.\\ \\ GUI Elements: Button, Toggle Button, Radio Button Check Box | | + | |Action |This event occurs at the click of a button.\\ It is used to start processes, execute logic, manipulate data, display reports, or import data.\\ \\ GUI Elements: Button, Toggle Button, Radio Button Check Box | |
| - | |Row Value Changed |This event occurs upon the change of a value in a row. There is only one value change event per table. Irrespective of which GUI element is used to open the wizard, the event is always the same.\\ The condition "Is Column Changed" is used to determine which value has changed.\\ This event can be used to calculated dependent values.\\ \\ GUI Elements: Table, Editor | | + | |Row Value Changed |This event occurs upon the change of a value in a row. There is only one value change event per table. Irrespective of which GUI element is used to open the wizard, the event is always the same.\\ The condition "Is Column Changed" is used to determine which value has changed.\\ This event can be used to calculate dependent values.\\ \\ GUI Elements: Table, Editor | |
| - | |After Row Selected |This event occurs after a row is selected in a table. There is only one "After Row Selected" event per table. Irrespective of which GUI element is used to open the wizard, the event is always the same.\\ This event can be used to show/hide components, calculate values, or activate/deactivate buttons dependent on the data in the selected row.\\ GUI Elements: Table, Editor | | + | |After Row Selected |This event occurs after a row is selected in a table. There is only one "After Row Selected" event per table. Irrespective of which GUI element is used to open the wizard, the event is always the same.\\ This event can be used to show/hide components, calculate values, or activate/deactivate buttons dependent on the data in the selected row.\\ GUI Elements: Table, Editor | |
| - | |After Inserting Row |This event occurs after a row is inserted in a table. There is only one "After Inserting Row" event per table. Irrespective of which GUI element is used to open the wizard, the event is always the same.\\ This event can be used, for example, to fill a newly inserted row with standard values. | | + | |After Inserting Row |This event occurs after a row is inserted in a table. There is only one "After Inserting Row" event per table. Irrespective of which GUI element is used to open the wizard, the event is always the same.\\ This event can be used, for example, to fill a newly inserted row with standard values. | |
| ====== Application - Live Preview ====== | ====== Application - Live Preview ====== | ||
| Line 509: | Line 509: | ||
| Depending on the VisionX license, the following options are available: | Depending on the VisionX license, the following options are available: | ||
| - | * Desktop The application is run as a desktop Java application (just like any other Windows/Linux/MacOS application). | + | * Desktop: The application is run as a desktop Java application (just like any other Windows/Linux/MacOS application). |
| - | * Java in a Browser The application is run as an Applet/Webstart Java program in a web browser. For this to work, Java (including the Java plugin) has to be installed on the client. | + | * Java in a Browser: The application is run as an Applet/Webstart Java program in a web browser. For this to work, Java (including the Java plugin) has to be installed on the client. |
| - | * HTML5 in a Browser The application is run as an HTML5 application in a web browser. | + | * HTML5 in a Browser: The application is run as an HTML5 application in a web browser. |
| - | * Mobile Device The application can be used as a native iPhone/iPad or Android App on a smartphone or tablet. For this to work, the VisionX Preview App has to be installed on the mobile device. | + | * Mobile Device: The application can be used as a native iPhone/iPad or Android App on a smartphone or tablet. For this to work, the VisionX Preview App has to be installed on the mobile device. |
| - | The user interfaces of the VisionX application are similar, although certain technology specific variations will occur depending on the respective GUI Platform and Open Source Framework. | + | The user interfaces of the VisionX application are similar, although certain technology-specific variations will occur depending on the respective GUI platform and open-source framework. |
| {{:visionx:documentation:live-preview-start-mode.png?nolink|Live Preview - Select Mode/Platform}} | {{:visionx:documentation:live-preview-start-mode.png?nolink|Live Preview - Select Mode/Platform}} | ||
| Line 524: | Line 524: | ||
| ====== VisionX Administration ====== | ====== VisionX Administration ====== | ||
| - | The data sources (=database connections) for VisionX are managed on the "Administration" tab. | + | The data sources (database connections) for VisionX are managed on the "Administration" tab. |
| - | Here the data source name, the desired database (Oracle, MySQL, DB2, MS SQL, PostgreSQL), as well all the the relevant database connection parameters are specified. These parameters include the server (name or IP), port, as well as the database name (or SID in Oracle). | + | Here the data source name, the desired database (Oracle, MySQL, DB2, MS SQL, PostgreSQL), as well as all the relevant database connection parameters are specified. These parameters include the server (name or IP), port, and database name (or SID in Oracle). |
| - | In addition, a valid database user name and password have to be entered. | + | In addition, a valid database username and password have to be entered. |
| The "Test Connection" button is used to test the connection to the database. | The "Test Connection" button is used to test the connection to the database. | ||
| Line 538: | Line 538: | ||
| For admin data sources, a user with administrator rights is required, so that VisionX can create new database users with this user. This is used in the "New Application" wizard to create a new database user for the new application. | For admin data sources, a user with administrator rights is required, so that VisionX can create new database users with this user. This is used in the "New Application" wizard to create a new database user for the new application. | ||
| - | During the installation of VisionX, one admin data source with the name VisionX is configured. It is used by VisionX to manage its own data. In the desktop edition, an embedded database is used for this purpose, whereas in the enterprise edition a database can be selected during the installation process. This database is used to save data such as the VisionX users, admin data sources, user- defined data sources, etc. User-defined data sources only require the usual database user rights. They are used to integrate external databases into VisionX applications, e.g. to use certain master data in the application. They can also be used to work with a user prepared by the database administrator when a new application is created. | + | During the installation of VisionX, one admin data source with the name VisionX is configured. It is used by VisionX to manage its own data. In the desktop edition, an embedded database is used for this purpose, whereas in the enterprise edition, a database can be selected during the installation process. This database is used to save data, such as the VisionX users, admin data sources, user-defined data sources, etc.. User-defined data sources only require the usual database user rights. They are used to integrate external databases into VisionX applications, e.g., to use certain master data in the application. They can also be used to work with a user prepared by the database administrator when a new application is created. |
| {{:visionx:documentation:new-application-step3.png?nolink|New Application - Select Database}} | {{:visionx:documentation:new-application-step3.png?nolink|New Application - Select Database}} | ||
| - | As mentioned in Chapter [[#create_an_application|Create an Application]], either a new or an existing database user can be selected for a new application. The default setting is the "VisionX" admin data source. If a new database user is selected, VisionX creates a new user using the selected admin data source. For this reason, only admin data sources can be selected for this option. | + | As mentioned in the chapter [[#create_an_application|Create an Application]], either a new or an existing database user can be selected for a new application. The default setting is the "VisionX" admin data source. If a new database user is selected, VisionX creates a new user using the selected admin data source. For this reason, only admin data sources can be selected for this option. |
| - | Under the second option - "Reuse an existing Database User", a user can be selected from the list of available database users for the chosen admin data source. This user is then utilized for the new application. | + | Under the second option "Reuse an existing Database User", a user can be selected from the list of available database users for the chosen admin data source. This user is then utilized for the new application. |
| Under the third option, a user-defined data source can be selected, which is then used by VisionX for the new application. | Under the third option, a user-defined data source can be selected, which is then used by VisionX for the new application. | ||
| - | New data sources (= database connections) can be created using the "New" button. For options 1 and 2 the admin data source workscreen is opened in this case, whereas the "New" button next to the third option opens the workscreen for user-defined data sources. | + | New data sources (database connections) can be created using the "New" button. For options one and two, the admin data source workscreen is opened, whereas the "New" button next to the third option opens the workscreen for user-defined data sources. |
| When a new workscreen is created, or when a new table is integrated into a workscreen, a similar screen is available for the selection of a database. It includes the option "Use Application Database User" to make tables available from the application's database connection. This is the default data source shown under the "Datasources" tab of the "Application Settings" menu (see [[#application_settings|Application Settings]]). | When a new workscreen is created, or when a new table is integrated into a workscreen, a similar screen is available for the selection of a database. It includes the option "Use Application Database User" to make tables available from the application's database connection. This is the default data source shown under the "Datasources" tab of the "Application Settings" menu (see [[#application_settings|Application Settings]]). | ||
| Line 556: | Line 556: | ||
| {{:visionx:documentation:visionx-administration-users.png?nolink|VisionX Users}} | {{:visionx:documentation:visionx-administration-users.png?nolink|VisionX Users}} | ||
| - | The users shown in this workscreen are the VisionX users and NOT the users of the individual applications. This workscreen is relevant when the VisionX Enterprise Edition is run on an application server. In this case all VisionX users have to be defined on this workscreen. | + | The users shown in this workscreen are the VisionX users and NOT the users of the individual applications. This workscreen is relevant when the VisionX Enterprise Edition is run on an application server. In this case, all VisionX users have to be defined on this workscreen. |
| - | VisionX hat three roles: | + | VisionX has three roles: |
| - | * Administrator - to manage the VisionX users | + | * Administrator -- to manage the VisionX users |
| - | * User - for the regular use of VisionX | + | * User -- for the regular use of VisionX |
| - | * Developer - to display the Java source code editor in the VisionX actions editor | + | * Developer -- to display the Java source code editor in the VisionX actions editor |
| ====== Application Export / Import ====== | ====== Application Export / Import ====== | ||
| - | Applications can be exportet and imported using the "Export" and "Import" functions on the "Tools" tab. | + | Applications can be exported and imported using the "Export" and "Import" functions on the "Tools" tab. |
| This feature is used to create backups of applications or to send an application to a software developer for further advancement. | This feature is used to create backups of applications or to send an application to a software developer for further advancement. | ||
| Line 580: | Line 580: | ||
| To export, the application and export type are selected. The following options are available: | To export, the application and export type are selected. The following options are available: | ||
| - | - Complete The database and the application, including all libraries, are exported. | + | - Complete: The database and the application, including all libraries, are exported. |
| - | - Update Only the application is exported, with libraries (smaller file size). | + | - Update: Only the application is exported with libraries (smaller file size). |
| - | - Database Only the database is exported. | + | - Database: Only the database is exported. |
| For the export types "Complete" and "Database", the option "Export Database Records" determines whether the tables' data is also exported. Also for the export types "Complete" and "Database", the option "Export Database Objects" determines if the tables and views are exported. | For the export types "Complete" and "Database", the option "Export Database Records" determines whether the tables' data is also exported. Also for the export types "Complete" and "Database", the option "Export Database Objects" determines if the tables and views are exported. | ||
| Line 588: | Line 588: | ||
| In general, it should be noted that during the database export, VisionX only exports the tables and views. An accurate export/import of the views is only provided for simple ANSI SQL conform views. | In general, it should be noted that during the database export, VisionX only exports the tables and views. An accurate export/import of the views is only provided for simple ANSI SQL conform views. | ||
| - | Database system specific and proprietary objects are not considered during the export/import. | + | Database system-specific and proprietary objects are not considered during the export/import. |
| The application export is provided as a .ZIP file. | The application export is provided as a .ZIP file. | ||
| Line 594: | Line 594: | ||
| {{:visionx:documentation:import-application-step1.png?nolink|Import Application - Step 1 - Configuration}} | {{:visionx:documentation:import-application-step1.png?nolink|Import Application - Step 1 - Configuration}} | ||
| - | For the import, a valid VisionX export file and an application name are required. | + | For import, a valid VisionX export file and an application name are required. |
| The application can be imported as a new application or over an existing application. The latter option overwrites the existing application! | The application can be imported as a new application or over an existing application. The latter option overwrites the existing application! | ||
| - | In the second step, a selection is made as to which content from the export file is imported. If the "Database" option is unchecked, the database - if it is included in the export file - is not imported into VisionX. | + | In the second step, a selection is made as to which content from the export file is imported. If the "Database" option is unchecked, the database -- if included in the export file -- is not imported into VisionX. |
| - | The third step shows the application's data sources based on the information in the export file. They can be edited by the user. Data can be imported for either a new or an existing database user. It should be noted that if an existing database user is selected, the existing tables and data are overwritten! | + | The third step shows the application's data sources based on the information in the export file. They can be edited by the user. Data can be imported for either a new or existing database user. It should be noted that if an existing database user is selected, the existing tables and data are overwritten! |
| See: [[#visionx_administration|VisionX Administration]] | See: [[#visionx_administration|VisionX Administration]] | ||
| Line 620: | Line 620: | ||
| In the first step, a selection is made whether only the application, the database, or both should be installed. | In the first step, a selection is made whether only the application, the database, or both should be installed. | ||
| - | Each VisionX application consists of an application and a database. The application contains workscreens, actions, reports and functions. The database contains the tables, views, and data. | + | Each VisionX application consists of an application and a database. The application contains workscreens, actions, reports, and functions. The database contains the tables, views, and data. |
| The application is installed on an application server, while the database is installed on a database server. | The application is installed on an application server, while the database is installed on a database server. | ||
| - | The users can run the installed application with their PCs. This can be done, for example, by entering the application's URL in a browser. After the application is started, the user enters log-in credentials and is then able to access the relevant workscreens via the application menu. | + | The users can run the installed application with their PCs. This can be done by entering the application's URL in a browser. After the application is started, the user enters login credentials to access the relevant workscreens via the application menu. |
| The following figure shows an overview of the application's system architecture. | The following figure shows an overview of the application's system architecture. | ||
| Line 639: | Line 639: | ||
| * Oracle Glassfish | * Oracle Glassfish | ||
| - | If the required application server is not on this list, a "Web Application Archive" (= WAR file) can be created instead. This file can then be installed manually via the application server's configuration interface. Depending on the VisionX license, it is possible to create a .WAR file for the installation of Liferay Portlets and/or webservices. | + | If the required application server is not on this list, a "Web Application Archive" ( WAR file) can be created instead. This file can then be installed manually via the application server's configuration interface. Depending on the VisionX license, it is possible to create a .WAR file for the installation of Liferay Portlets and/or webservices. |
| {{:visionx:documentation:install-application-step2.png?nolink|Application Installation - Step 2 - Select Application Server/Installation Type}} | {{:visionx:documentation:install-application-step2.png?nolink|Application Installation - Step 2 - Select Application Server/Installation Type}} | ||
| - | If an application server is selected, the relevant parameters are entered in the next step. In addition to a name, the version, server (name/IP), port, user name, password and manager path need to be entered. The application path can also be edited. | + | If an application server is selected, the relevant parameters are entered in the next step. In addition to a name, the version, server (name/IP), port, user name, password, and manager path need to be entered. The application path can also be edited. |
| {{:visionx:documentation:install-application-step3.png?nolink|Application Installation - Step 3 - Application Server Settings}} | {{:visionx:documentation:install-application-step3.png?nolink|Application Installation - Step 3 - Application Server Settings}} | ||
| - | The database is installed in the next step, where either a new or an existing database user is selected. | + | The database is installed in the next step, where either a new or existing database user is selected. |
| See: [[#visionx_administration|VisionX Administration]] | See: [[#visionx_administration|VisionX Administration]] | ||