modeling_2.0
Differences
This shows you the differences between two versions of the page.
|
modeling_2.0 [2024/11/06 07:37] montse [Changes in modeling] |
modeling_2.0 [2024/12/12 15:42] (current) montse [Edit diagram] |
||
|---|---|---|---|
| Line 49: | Line 49: | ||
| * **Delete elements**: allows you to delete the selected diagram object(s) using the 'trash can' icon. | * **Delete elements**: allows you to delete the selected diagram object(s) using the 'trash can' icon. | ||
| * **Diagram actions**: groups a series of actions that can be performed at the diagram level:\\ \\ {{ :acciones_de_diagramaen.png?direct&300 |}}\\ | * **Diagram actions**: groups a series of actions that can be performed at the diagram level:\\ \\ {{ :acciones_de_diagramaen.png?direct&300 |}}\\ | ||
| - | * **Assistants**: displays a list of available assistants:\\ \\ {{ :asistentesen.png?direct&300 |}}\\ \\ | + | * **Assistants**: displays a list of available assistants:\\ \\ {{ :en:edit_diagram:newassistants.png?direct&300 |}}\\ \\ |
| * **View diagram map**: by clicking this button, a thumbnail of the current diagram (at a scale of 4:1) is displayed in a box at the top right of the Canvas. | * **View diagram map**: by clicking this button, a thumbnail of the current diagram (at a scale of 4:1) is displayed in a box at the top right of the Canvas. | ||
| * **Magnifying glass**: allows you to perform free text searches on all diagram elements, and also allows you to narrow the searches on those elements that interest you at a given moment. | * **Magnifying glass**: allows you to perform free text searches on all diagram elements, and also allows you to narrow the searches on those elements that interest you at a given moment. | ||
| Line 882: | Line 882: | ||
| ====Introduction==== | ====Introduction==== | ||
| - | Library Management provides TAST, and specifically the diagram modeling part, with a library management tool to store, organize and query javascript functions or Sql queries that the user considers useful, for example to be reused in the messages of other diagrams.\\ \\ Predefined functions such **executeJavascript** or **dbGetQueryData**, are examples of messages that include a //javascript code// or a //sql query//:\\ \\ {{ :en:librarymanagement1.png?direct&400 |}}\\ \\ {{ :en:librarymanagement2.png?direct&400 |}} | + | Library Management provides TAST, and specifically the diagram modeling part, with a library management tool to store, organize and query javascript functions or Sql queries that the user considers useful, for example to be reused in the messages of other diagrams.\\ \\ Predefined functions such **executeJavascript** or **dbGetQueryData**, are examples of messages that include a //javascript code// or a //sql query//:\\ \\ {{ :en:librarymanagement1.png?direct&500 |}}\\ \\ {{ :en:librarymanagement2.png?direct&500 |}}\\ \\ |
| - | |||
| - | |||
| - | |||
| - | |||
| - | |||
| - | |||
| ====Library Management Page==== | ====Library Management Page==== | ||
| ===Library Management Menu=== | ===Library Management Menu=== | ||
| - | Since this is a tool to support diagram modeling, we find Library Management as a submenu within the main Modeling menu: | + | Since this is a tool to support diagram modeling, we find Library Management as a submenu within the main **Modeling** menu:\\ \\ {{ :en:librarymanagement3.png?direct&200 |}}\\ \\ |
| + | |||
| + | ===Library Management Screen=== | ||
| + | In this screen we can create, catalogue, edit and browse library elements:\\ \\ {{ :en:librarymanagement4.png?direct&600 |}}\\ \\ | ||
| + | In the following we will see each of the different functionalities of the screen. | ||
| - | ===Library Management Screen=== | + | ==Create a New library item== |
| + | {{:en:librarymanagementicono_mas.png?direct&20|}} By clicking this button at the top right of the screen, a form appears where the user fills in the fields to register the new library item:\\ \\ {{ :en:librarymanagement5.png?direct&400 |}}\\ \\ | ||
| + | |||
| + | All these fields are mandatories and cannot be empty.\\ \\ These fields are listed below:\\ \\ 1.**Domain & Project**\\ \\ The user has to select a domain and a Project inside it where to save the new item. All users belonging to that domain have access to any of its library items.\\ \\ 2.**Type**\\ \\ Select the type of element you are creating, being one of these: | ||
| + | * Javascript function | ||
| + | * Sql Query | ||
| + | 3.**Name**\\ \\ Text field to enter a sufficiently descriptive name that identifies the item and subsequently facilitates searches. It cannot contain spaces.\\ \\ 4.**Tags**\\ \\ Text field to enter one or more tags (separated by commas) sufficiently descriptive to facilitate cataloguing and searching.\\ \\ 5.**Description**\\ \\ Text field to enter a sufficiently descriptive description to facilitate the understanding of the content. For example, in the case of a javascript function, you can briefly describe what the function does, what parameters it receives and what result it returns.\\ \\ 6.**Content**\\ \\ By **clicking** on this field, it expands and takes us to a modal window with the special code editor for entering Javascript or Sql code.\\ \\ This editor supports copy/paste events from any other editor.\\ \\ {{ :en:librarymanagement6.png?direct&600 |}}\\ \\ | ||
| - | In this screen we can create, catalogue, edit and browse library elements: | + | |
| + | ==Select Domain== | ||
| + | {{ :en:librarymanagement7.png?direct&800 |}}\\ \\ The //Library Management// page initially lists those items belonging to the current domain. All users who can access this domain can have access to all library items stored in it.\\ \\ | ||
| + | ==Filters: searching for items in libraries== | ||
| - | + | {{ :en:librarymanagement8.png?direct&600 |}}\\ \\ As mentioned above, all items belonging to the current domain will initially appear in the list.\\ \\ Later, the user can then refine their search using any of the filters provided, either **individually** or **in combination**.\\ \\ 1.**Project**\\ \\ You can filter the results according to your project, by default all items within the domain will be displayed.\\ \\ 2.**Type**\\ \\ The items are listed by their type: Javascript code or Sql query.\\ \\ 3.**Name**\\ \\ If you want to filter results by item name, type a string in this field and press ENTER to accept. The list will show the items whose name is equal to or contains the string entered in this field.\\ \\ 4.**Tags**\\ \\ If you want to filter results by item tags, type one or more tags in this field (separated by commas) and press ENTER to accept. The list will show the items whose tags are the same or contain any of the tags entered in this field.\\ \\ 5.**Description**\\ \\ If you want to filter results by item description, type a string in this field and press ENTER to accept. The list will display items whose description is equal to or contains the string entered in this field.\\ \\ | |
| - | Create a New library item | + | |
| - | By clicking this button at the top right of the screen, a form appears where the user fills in the fields to register the new library item: | + | |
| - | + | ||
| - | All these fields are mandatories and cannot be empty. | + | |
| - | These fields are listed below: | + | |
| - | 1. Domain & Project | + | |
| - | The user has to select a domain and a Project inside it where to save the new item. All users belonging to that domain have access to any of its library items. | + | |
| - | 2. Type | + | |
| - | Select the type of element you are creating, being one of these: | + | |
| - | • Javascript function | + | |
| - | • Sql Query | + | |
| - | 3. Name | + | |
| - | Text field to enter a sufficiently descriptive name that identifies the item and subsequently facilitates searches. It cannot contain spaces. | + | |
| - | + | ||
| - | 4. Tags | + | |
| - | Text field to enter one or more tags (separated by commas) sufficiently descriptive to facilitate cataloguing and searching. | + | |
| - | 5. Descripción | + | |
| - | Text field to enter a sufficiently descriptive description to facilitate the understanding of the content. For example, in the case of a javascript function, you can briefly describe what the function does, what parameters it receives and what result it returns. | + | |
| - | 6. Content | + | |
| - | By clicking on this field, it expands and takes us to a modal window with the special code editor for entering Javascript or Sql code. | + | |
| - | This editor supports copy/paste events from any other editor. | + | |
| - | + | ||
| - | Select Domain | + | {{:en:librarymanagementicono_limpar_filtros.png?direct&20|}} Click on the "Clear filters" button when you want to clear the fields and reset them to their initial state.\\ \\ |
| - | + | ||
| - | The Library Management page initially lists those items belonging to the current domain. All users who can access this domain can have access to all library items stored in it. | + | |
| - | Filters: searching for ítems in libraries | + | ==Table or Results list== |
| - | + | ||
| - | As mentioned above, all items belonging to the current domain will initially appear in the list. | + | |
| - | Later, the user can then refine their search using any of the filters provided, either individually or in combination. | + | |
| - | 1. Project | + | |
| - | You can filter the results according to your project, by default all items within the domain will be displayed. | + | |
| - | 2. Type | + | |
| - | The items are listed by their type: Javascript code or Sql query. | + | |
| - | 3. Name | + | |
| - | If you want to filter results by item name, type a string in this field and press ENTER to accept. The list will show the items whose name is equal to or contains the string entered in this field. | + | |
| - | 4. Tags | + | |
| - | If you want to filter results by item tags, type one or more tags in this field (separated by commas) and press ENTER to accept. The list will show the items whose tags are the same or contain any of the tags entered in this field. | + | |
| - | 5. Description | + | |
| - | If you want to filter results by item description, type a string in this field and press ENTER to accept. The list will display items whose description is equal to or contains the string entered in this field. | + | |
| - | Click on the "Clear filters" button when you want to clear the fields and reset them to their initial state. | + | {{ :en:librarymanagement9.png?direct&800 |}}\\ \\ |
| - | + | ||
| - | Table or Results list | + | |
| - | The list or table of results shows the library items found according to the search criteria at any given time. | + | The list or table of results shows the library items found according to the search criteria at any given time.\\ \\ 1.The **Name**, **Tags** and **Description** columns show the respective fields and can be sorted alphabetically.\\ \\ \\ 2.**Content preview** column:\\ |
| - | 1. The Name, Tags and Description columns show the respective fields and can be sorted alphabetically. | + | {{:en:librarymagementicono_content_preview.png?direct&40|}} By clicking on the "eye" icon, it expands a preview of the item's content, as well as the last user who edited it:\\ \\ |
| - | 2. Content preview column: | + | {{ :en:librarymanagement10.png?direct&400 |}}\\ \\ |
| - | By clicking on the "eye" icon, it expands a preview of the item's content, as well as the last user who edited it: | + | {{:en:librarymanagementicono_content_preview2.png?direct&40|}} Click on the icon again to collapse the preview.\\ \\ 3. **Actions** column:\\ \\ |
| - | + | {{ :en:librarymanagement11.png?direct&100 |}}\\ \\ | |
| - | Click on the icon again to collapse the preview. | + | |
| - | 3. Actions column: | + | |
| It contains a number of buttons to perform actions on each library item: edit, edit content, copy and delete. | It contains a number of buttons to perform actions on each library item: edit, edit content, copy and delete. | ||
| - | Edit a library item | + | |
| - | Clicking the Edit library item button in the Actions column displays a form where the user can modify any of the fields and save it again. This action also checks that no other user is editing the item at the same time. | + | ==Edit a library item== |
| + | {{:en:librarymanagement12a.png?direct&40|}} Clicking the **Edit library item** button in the Actions column displays a form where the user can modify any of the fields and save it again. This action also checks that no other user is editing the item at the same time.\\ \\ {{ :en:librarymanagement13.png?direct&400 |}} | ||
| - | Edit the content of a library item | + | ==Edit the content of a library item== |
| - | Clicking on the Edit content button in the Actions column takes you directly to the code editor, where the user can modify the javascript or sql code of the item and save it again. This action also checks that no other user is editing the content of the item at the same time. | + | {{:en:librarymanagement14.png?direct&40|}} Clicking on the **Edit content** button in the Actions column takes you directly to the code editor, where the user can modify the javascript or sql code of the item and save it again. This action also checks that no other user is editing the content of the item at the same time.\\ \\ {{ :en:librarymanagement15.png?direct&600 |}}\\ \\ |
| - | Copy a library item | + | ==Copy a library item== |
| - | Clicking the Copy library item button in the Actions column displays a form to copy this item, for example to another domain or project, and allows you to modify certain fields such as Name, Tags or Description. | + | {{:en:librarymanagement16.png?direct&40|}} Clicking the **Copy library item** button in the Actions column displays a form to copy this item, for example to another domain or project, and allows you to modify certain fields such as Name, Tags or Description.\\ \\ {{ :en:librarymanagement17.png?direct&400 |}}\\ \\ |
| - | Remove a library item | + | ==Remove a library item== |
| - | clicking on the Delete library item button in the Actions column, a confirmation dialog appears to permanently delete this item. | + | {{:en:librarymanagement18.png?direct&40|}} Clicking on the **Delete library item** button in the Actions column, a confirmation dialog appears to permanently delete this item.\\ \\ {{ :en:librarymanagement19.png?direct&400 |}}\\ \\ |
| Line 986: | Line 953: | ||
| ===Accessing Library Management from Modeling=== | ===Accessing Library Management from Modeling=== | ||
| - | If you are modeling a diagram and need to browse the Javascript/Sql code in the libraries, you can do it in two ways: | + | If you are modeling a diagram and need to browse the Javascript/Sql code in the libraries, you can do it in two ways:\\ |
| - | Manually | + | |
| - | By opening a new TAST tab in your browser, where you will open the Library Management screen. | + | |
| - | Automatically | + | |
| - | + | ||
| - | Clicking the Open Library Management button from the Modeling Javascript/Sql code editing window will automatically launch the Library Management page in a new tab of your browser. | + | |
| - | + | ||
| - | + | ==Manually== | |
| - | + | By opening a new TAST tab in your browser, where you will open the **Library Management** screen.\\ | |
| + | |||
| + | ==Automatically== | ||
| + | {{:en:librarymanagement20.png?direct&100|}} Clicking the **Open Library Management** button from the //Modeling Javascript/Sql code editing window// will automatically launch the Library Management page in a new tab of your browser.\\ \\ {{ :en:librarymanagement21.png?direct&500 |}}{{ :en:librarymanagementflecha.png?direct&40 |}} {{ :en:librarymanagement22.png?direct&500 |}}\\ \\ Note: Remember that the Javascript/Sql code editing window appears in Modeling when editing code in messages such as **executeJavascript**, or **dbGetQueryData**, for example.\\ \\ | ||
| - | Note: Remember that the Javascript/Sql code editing window appears in Modeling when editing code in messages such as executeJavascript, or dbGetQueryData, for example. | ||
| ===Saving Javascript/ Sql code from Modeling in a library=== | ===Saving Javascript/ Sql code from Modeling in a library=== | ||
| - | If you are modeling a diagram and want to save in a library the javascript/query sql code used in a given message, you can do it in two ways: | + | If you are modeling a diagram and want to save in a library the javascript/query sql code used in a given message, you can do it in two ways:\\ |
| - | Manually | + | |
| - | In the Library Management screen the user will create a new item, then copy the Modeling code and finally paste it into the Contents field of the new library item. | + | |
| - | Automatically | + | |
| - | + | ||
| - | Clicking the Create new library item button from the Modeling Javascript/Sql code editing window, which will automatically launch the Library Management page in a new tab of your browser, with the Create new library item form open and with the Domain, Project, Type and Content fields already filled in. | + | |
| - | + | ||
| + | ==Manually== | ||
| + | In the //Library Management// screen the user will create a new item, then copy the Modeling code and finally **paste** it into the Contents field of the new library item.\\ | ||
| + | |||
| + | ==Automatically== | ||
| + | {{:en:librarymanagement23.png?direct&100|}} Clicking the **Create new library item** button from the //Modeling Javascript/Sql code editing window//, which will automatically launch the Library Management page in a new tab of your browser, with the **Create new library item** form open and with the Domain, Project, Type and Content fields already filled in.\\ \\ {{ :en:librarymanagement24.png?direct&500 |}}\\ {{ :en:librarymanagementflecha.png?direct&40 |}}\\ {{ :en:librarymanagement25.png?direct&500 |}}\\ \\ | ||
| - | |||
| - | |||
| ===Retrieve Javascript/Sql code from a library for use in Modeling=== | ===Retrieve Javascript/Sql code from a library for use in Modeling=== | ||
| - | When a user is modeling a diagram and editing the javascript or sql code of a message, and would like to bring the code from one of the libraries, this is the way: | + | When a user is modeling a diagram and editing the javascript or sql code of a message, and would like to bring the code from one of the libraries, this is the way:\\ |
| - | 1. Open the Library Management screen in a new tab of your browser and locate the desired code, then copy the code, | + | |
| - | 2. and simply paste the code into the Modeling Javascript/Sql code editing window. | + | 1. Open the //Library Management// screen in a new tab of your browser and locate the desired code, then **copy** the code,\\ \\ 2. and simply **paste** the code into the //Modeling Javascript/Sql// code editing window.\\ \\ {{ :en:librarymanagement26.png?direct&500 |}}\\ {{ :en:librarymanagementflecha.png?direct&40 |}}\\ {{ :en:librarymanagement27.png?direct&500 |}} |
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
modeling_2.0.1730878652.txt.gz · Last modified: 2024/11/06 07:37 by montse
Page Tools
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Noncommercial-Share Alike 3.0 Unported
