TAST DokuWiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Modeling ======


This option of the TAST tool allows the user to manage UML diagrams and Test Set Data.\\ \\  

===== UML Diagram =====

This option of the TAST tool allows the user ** to manage all the treatments associated with the UML diagrams. **\\ 
===== How to create an UML diagram =====

UML diagrams are completely necessary for the creation of the test cases. That is because every message of the diagram represents an action that will be carried on in the test (click or type, for instance).

In the next paragraphs, it is explained how can an UML diagram be created:

When logged in the tool, the user can see a menu in the left side (see [[First steps in TAST]] for further info). In this menu, the user will click on the button "Modeling". After this, there will open a window where the user will select the domain and project where the test case will be included in.

**IMPORTANT**: The projects and domains need to be created before the creation of the test case and, also, the user needs to be assigned to the domain and project. Otherwise, the user will not be able to see neither the project-domain, nor the test cases that might have already been created.

For more info about the creation of the Domain and user, please check [[customize._domains_and_Projects]] page.

Once in the Modeling page, the user can proceed in three ways:

  * Selecting and modifying one of the test cases already created.
  * Creating a new test case.
  * Importing a test case created with any other UML Design tool.

{{ :en:modeling_1.png?link&600 |}}\\ \\ 

If the user chooses to modify an existing UML diagram (left side of the upper screenshot), there will be 4 different colors for the test cases: green for the cases where the mapping has been completed and validated, yellow for the cases where the mapping has been completed but not validated, red for the cases where the mapping has not been done, and grey for the cases that are empty.

{{ :en:modeling_2.png?link&200 |}}

When choosing to create a new UML diagram, it is needed to click on "New" button. After this, a new window will open as shown below.

{{ :crear_diagrama_eng.png?nolink&350  |}}

 In it, can be selected:
  * Domain: this is the domain which the test case will belong to.
  * Project: select the project where the test case will be linked to.
  * Folder:  folder of the system where the test case will be stored.
  * Diagram name.
  * Diagram description.
  * Use diagram template.
  * Copy validation mapping.
  * Visibility as a template:
    * Public.
    * Domain.
    * Project.
    * Private.
    * None. 

 ===== Edit diagram =====

This option of the TAST tool allows ** create / modify a diagram.**

Below, **the screen to edit a diagram**:\\ \\ 

{{ :en:modeling_3.png?link&700 |}}\\ \\ 

This screen allows:

    * Increase the size of the elements of the diagram, using the 'magnifying glass +' icon.
    * Decrease the size of the elements of the diagram, with the 'magnifying glass -' icon.
    * Delete the diagram that we have selected using the bin icon.
    * Download an image of the diagram on the screen with the download icon.
    * Validate the mappings included in the diagram using the 'validate mapping icon'.
    * Execute the validation of the diagram with the play icon.
    * Select the elements to be included in the diagram through the + icon:
      * //Pointer// (complete information of the selected element).
      * //Object//.
      * //Message//.
      * //Reply message //.
      * //Gates//.
      * //Bifurcations//.
      * //Loops//.



==== Checks in message properties tab ====
In a message, by double click over it, is possible to indicate the type of action when the step is executed based on the following checkbox.

{{ :breakpoint.png?600 |}}

  - **Locking step:** If this message fails, the test execution will stop and the test will end.\\  
  - **Optional step:** The result of this step will not impact the test result.\\ 
  - **Comment out:** If this check is marked, the message will not be executed.
  - **Breakpoint:** The breakpoint check is used to stop the execution of the test in this step. It is helpfull during the creation of the diagram.  

   


==== Guards ====

A guard is a logical condition that can be included in a UML message. The behavior is as follow, when the logical condition is true, the message is executed, when the logical condition is false, the message is NOT executed.

A guard is really useful when an action must or must not be executed, based on the result of a condition.


{{:en:edit_diagram:guards_example.png?800|}}


The conditions inside a guard can be of two types:

  * **Simple**, by using logical operators like, < (less than), > (greater than), == (equal to), != (different than), <= (less or equal to), >= (greater or equal to).

  * **Complex**, by concatenating the use of simple operators through  logical operators as: AND (and), OR (or), && (exclusive and), || (exclusive or)

Following some examples about simple and complex conditions in a Guard:

  * **#numCol < 25**\\ The message will be executed when, the variable numCol is less than 25.
   
  * **#myFavoriteApp == “TAST”**\\ The message will be executed when the variable  myFavoriteApp is equal to the string “TAST”. To be considered that the strings must be compared using “” (double coutes).
   
  * **#fahrzeugtypTestData =="Gebrauchtwagen"||#fahrzeugtypTestData=="Vorführwagen" || #fahrzeugtypTestData=="Tageszulassung"**\\ The message will be executed when the variable  fahrzeugtypTestData, is equal to one of the following values: Gebrauchtwagen, Vorführwagen, Tageszulassung.
   
  * **#str1 =="TAST" AND #str2=="TaaS" AND #str3=="SIPSA"**\\ The message will be executed when the variable string str1 is equal to TAST and when the variable str2 is equal to TaaS and when the variable str3 is equal to SIPSA.



==== Multiple line text ====

In the mapping of a message, is possible to include a value with line skipping.
For this, there is a checkbox 'Multiline Text':

{{:Multiple_line_text.png?nolink&1600|}}

If the checkbox is selected, an editor will appear to include the text:

{{:Multiple_line_text_1.png?nolink&1600|}}
{{:Multiple_line_text_2.png?nolink&1600|}}


==== Reply message ====

This message has to be tied to another message between two objects and is painted in the opposite direction. The two messages form a set and are not treated separately.\\ \\ 

{{ :Reply message_1.png?nolink&500 |}}
\\             
                * The only function allowed in the reply message is //assertion//, that has as input parameters //stepResult// (result of the previous message), and can have more parameters. The output parameter is also //stepResult//.

                * This message allows us is to vary the result of the previous step by checking some conditions. This process is done using a javascript.\\ \\ {{ :Reply message_4_def.png?nolink&500 |}}DATA MANAGEMENT: It allows modifying the javascript of each one of the diagrams.\\ 
 
{{:Reply message DM.png?nolink&700|}}



==== Gates ====

This option of the TAST tool allows the user to pass information between sequence diagrams. Gates can be an easy way to model the passing of information between a sequence diagram and its context. A gate is merely a message that is illustrated with one end connected to the sequence diagram's frame's edge and the other end connected to a lifeline  and represents another diagram.

About Gates, please consider the following important topics:

  * The **position of the adaptor inside the gate is very important for the correct behavior** because the Gate is also related to the Adaptor you plan to instantiate. Thus, you should put the Gate not only in the number step, but also in the same lifeline where you can continue the test execution. For example, if you want to use a Gate to a HTML GUI Adaptor, you should put the Gate in a Lifeline of a GUI HTML Adaptor into the parent diagram.
  * The **Isolated** behavior always instantiates all adaptors.
  * The **Non-isolated** behavior: maps the messages of the first adaptor of the Gate that has the same type as the adaptor of the parent where it is drawn; the rest of the adaptors will be instantiated.
  * The **concept of Isolated / Non-Isolated** is internally configured in TAST. Currently, that concept **only applies for these adaptors**: **GUI Adaptor** and **Web Services Adaptor**.
  * For the User's Gates: all the Gates in lifelines belonging to User objects are mapping to the User object of the Father diagram. 

How to Create a Gate:
 
In the toolbar, select the Gate and draw on the lifeline. Double click and open the Gate properties, where you choose the domain, the project and the diagram you want to copy.
 
{{:Gate propertiespng.png?nolink&700|}}

The selected diagram can be visualized by clicking on the icon of the image.
 
{{:Gate propertiespng image 2.png?nolink&700|}}

By clicking on the message map, it is displayed.
 
{{:Mapeo del gate .png?nolink&700|}}



DATA MANAGEMENT:
Allows to assign test case data to each Gate included in the diagrams.
 
{{:Data management gate.png?nolink&700|}}



EXECUTION OF TEST SET WITH GATES:
A Test Set containing Gates is created and executed.
 

{{:Ejecución de TS con Gate.png?nolink&700|}}\\ \\ 




==== Combined Fragments ====

This option of the TAST tool allows the user to handle //bifurcations// and //loops//.

TAST allows the following types of combined fragment:

  * To handle bifurcations: 
    * **CF ALT**: if the condition indicated in the Guard of the Combined Fragment is true, the steps of the first part of the ALT will be executed; otherwise, the steps executed will be those of the 'else' part:\\ {{ :CF_Alt_eng_1.png?nolink&1100 |}}\\ {{ :CF_Alt_eng_2.png?nolink&500 |}}\\ 

  * To handle loops:
    * **CF Loop do while**: while the condition indicated in the Guard of the Combined Fragment is true, the steps of the Combined Fragment will be executed. The condition is check after the steps are executed, so //do while loop// guarantees the loop execution at least once:\\ {{ :CF_Do_While_eng_1.png?nolink&1100 |}}\\ {{ :CF_Do_While_eng_2.png?nolink&500 |}}\\ 

   * **CF Loop while**:  this loop is similar to //do while loop//. The difference is when the exit condition of the cycle is evaluated. In the //while loop// this evaluation is done before entering the cycle, which means that the loop may not get executed:\\ {{ :CF_while_eng_1.png?nolink&1100 |}}\\ {{ :CF_while_eng_2.png?nolink&500 |}}\\ 

   * **CF Loop for**: All the steps included in this loop will be executed a number of times, according to the parameters indicated in the fragment properties tab:\\ \\ //Guard:// this field indicates the condition that the specified variable must meet to execute the steps of the For loop. This variable will appear in the section 'Variable for iteration'.\\ \\ //Case start:// contains the initial value that the variable will take for the iteration inside the loop.\\ \\ //Type increment:// type of increment of the variable. It can be incremental (+) or decremental (-).\\ \\ {{:CF_for_eng_1.png?nolink&1600|}}\\ \\ {{ :CF_for_eng_2.png?nolink&300 |}}\\    
        
   * **CF Loop for each**: It enables to iterate one by one (from 1 ... n) the selected row or column of a table introduced as variable. It makes possible to handle one by one the information selected in a Vertical or Horizontal way.\\ \\ {{ :CF_for each_eng_1.png?nolink&1700 |}}\\ {{ :CF_for each_eng_2.png?nolink&700 |}}\\ \\ To get data from the object, use the name of the table, followed by the word "Row", using the method getCellValue(n).\\ \\ {{ :foreachfilasenglish.png?600 |}}\\ \\ For the column, use the table name, followed by the word "Column", using the method getCellValue(n).\\ \\ {{ :foreachcolumnasenglish.png?600 |}}\\ \\ Where (n) is the position of the cell in the row or the position of the cell in the column.\\ \\ 

==== SubTestCases ====

Subtestcases are test cases that can be drawn inside a diagram. The reason to implement the subtestcases consists in having a visual option to create test cases in a diagram instead of only in Data Management. Also, to obtain a result (or/and log) with an isolated portion of a diagram (test case) apart of the main result or log.

=== How to use it in a diagram ===

To use a subtest case in a diagram you have to go to drawing tools and click in subtestcase, then to draw it in the canvas click wherever you want to put it. You can also click ALT+S to select the subtestcase (as a shortcut).


{{ :en:stcing1.png?400 |}}


Once it is drawn you can resize it with the little grey square in the bottom right of the sub test case (clicking holding and dragging it) and you can replace it the same way as the combined fragments.


{{ :en:stcei2.png?400 |}}


To open the subtestcases properties, double click in the subtestcase and it will appear, here you can change the name of the sub test case (up to 100 characters) and add/edit a guard.
Also you can set a name with a variable like: ‘name of the subtestcase‘ + #Variable


{{ :en:stcing3.png?600 |}}


=== SubTestCases specs ===

There are some things to keep in mind using subtestcases:\\  
  - All the messages inside the subtestcase will work as usual in the diagram but will generate a different result and log. So, in the end, we will have one global and another with the content of the subtestcase. If you want to retrieve the logs from the client it will look like the following image, inside the folder is the subtestcase log. It will generate a folder for every subtestcase in the diagram.\\ \\ \\ {{:en:stcei4.png?600|}}\\ \\ \\  
  - You cannot nest subtestcases, it will only register one of the subtestcases nested it must be avoided.
  - Inside a subtestcase can be placed steps and fragments, those fragments can be nested.
  - Inside a fragment can be placed a subtestcase and that subtestcase can be like the point 3.
  - The subtestcases can be deleted but not copy-pasted.
  - Various subtestcases can be placed in the same diagram (but not nested).


=== SubTestCases in Data Management ===

In Data Management once you have a diagram with a subtestcase (or various) the SubTestCase will appear as a red rectangle.

{{ :en:stcing5.png?600 |}}

Data Management can be used as usually with the addition of subtestcases appearing there.


=== SubTestCases in Results Page ===

In results page a new functionality has been added, with the symbol of  “+” you can click to deploy a new table with all the subtestcases an execution has. For example, in the following image:

{{ :en:stcei5.png?600 |}}

We can see the result as always. But with the new addition:

{{ :en:stcei6.png?600 |}}


You can now see the subtestcases results. Here you can download the evidences and the result document of the subtestcase.

In the result document:

{{ :en:stcei7.png?500 |}}

In test case data description, you can see the name of the subtestcase, in case that the test case data had a description it will show you “testcasedatadescription_subtestcasename”.


=== SubTestCase in ALM ===

In ALM it will show the full evidences of the execution, and all the subtestcases in the execution separatedly (also if you have gates with subtestcases those will be registered aswell).


{{ :en:stcei8.png?600 |}}\\ 


{{ :en:stcei9.png?600 |}}



==== Delete a message ====

When you want to delete a message from a diagram, the following window appears:

{{:delete_message_eng.png?nolink&3000|}}              

   * //No//: the message is not deleted. The delete confirmation window is closed.
   * //Delete message and variables//: the message and the references of the variables declared by that message are deleted. The delete confirmation window is closed.
   * //Delete only the message//: only the message is deleted, remaining the references of the variables declared by that message. The delete confirmation window is closed.



 ===== Information about the management of UML diagrams =====

Below, ** the screen to manage the UML diagrams **:\\ \\ 

{{ :en:manage_uml_diagrama.png?link&800 |}}\\ \\ 

We can see the diagram information by clicking on the 'More info' icon.\\ You can page the diagrams using the page numbers at the bottom of the screen.\\ \\ This screen allows:

  - [[en: New_diagram: Create a new diagram (// New diagram // option)]].\\ 
  - [[en: Import XMI: Import a XMI file from a directory (// Import XMI // option)]].\\ 
  - [[en: Save a diagram: Save the information of the active diagram on screen (diskette icon)]].\\ 
  - [[en: Delete diagram: Delete a diagram, using the bin icon]].\\ 
  - [[en: Create New Folder: Create a new folder (// + Folder // option)]].\\ 
  - [[en: Filter diagrams: Select diagrams using user filters and mappings, clicking the filter icon]].\\ 
  - [[en: Delete filters: Deactivate the filters used, using the cross icon]].\\ 
  - [[en: Edit diagram: Edit a diagram for its update, double click ]].\\ 

===== Message Properties Tab =====

In the mapping Tab you set the information at the message level:
  * Name: Message Name.
  * Description: Message Desscription.
  * Predefined Function: Selected Prefdefined Function (form a combo list).
  * Input Parameters: Depending of having or not parameters the selected PF.

For  the Input Parameters there are two important points to take in care:
  * Sensible: In case is checked, it means that the parameter is character's sensible. That is you cannot see the chraracters when you are setting the value for it (later, in the Mapping Tab). E.g, this is very useful for passwords, to hide the entered values.
  * Variable: In case is checked, it means that the parameter could be used later in the diagram as a variable. One the checkbox is checked, the symbol # appears to indicate that this name will be a variable since that moment. 

{{:en:canvas10.jpg?nolink|}}  

{{:en:canvas11.jpg?nolink|}}

{{:en:canvas12.jpg?nolink|}}


===== Message Mapping Tab =====

In the mapping Tab you set the information of the parameters of the message. So, the “SearchBy” is the way to find an element in the parameter section (using tags) and the “Element” is the path you obtain from the real element to interact with.\\   
  * Element: HTML element Identifier (related to the Attribute selected in the Search By field). E.g. XPath Identifier or CssSelector Identifier.
  * Search By: Attribute by which you wonder to find an HTML element. In the search by field you choose one of the following options: ClassName, CssSelector, Id, LinkText, Name, PartialLinkText,TagName or Xpath and those options are tags that the user can obtain for example in the html of a webpage in certain elements. The best way to obtain this information is using the F12 and search for the element we want or using the “selective mapping” we have developed.\\ \\ A visual example of this is: we want to click the yellow button.\\ \\ {{ :en:pulsarboton.png?500 |}}\\ \\ To do that with F12, you search the button html and pick the id in this case:\\ \\ {{ :en:botonid.png?500 |}}\\ \\ On the other hand, using selective mapping you could pick the class or css…\\ 

{{ :en:botonidssm.png?300 |}}\\ 

And to finish this, the user have to put the information in the diagram.\\ 
  * Value (optional): Input Value to enter into the control.






===== Message documentation Tab =====

In a TAST diagram, the messages (steps) non-reply can be documented using the "Message documentation" tab in the properties of the same.

In this tab it will be possible to document everything that should be stored in the evidence repository tools such as ALM, Confluence, etc.

{{:message_documentation_tab_eng.png?2600|}}
 
This new tab contains the following elements:

  * **Documenting evidences:** This check is going to tell us if we should get the evidences (screenshot, files, etc) and if we should register the step in the documentation tool (alm, confluence, etc). Only one screenshot is going to be taken at the end of the execution of all the parameters of the message.

  * **Step description:** By default, the same description that has been included in the Message Properties, but there will be the possibility to write and change it.

  * **Step expected result:** By default is just empty or with OK, but you can write whatever you want.

  * **Step execution result:** At the moment is going to be empty.

  * **Attachments:** To paste the files into the Documentation tab using you can either use the "Control + V" shortcut and dragging the mouse (mouse down + mouse up).

  * **Screenshots:** To add an image in the screenshot zone from the clipboard, press "Ctrl + V"; a modal screen will open with the screenshot preview and a field to give it a name. It´s not necessary to be over any element, the paste event works anywhere in the modeling page as long as there is an image in the clipboard.\\ \\ **IMPORTANT:**\\ This feature is not supported on Internet Explorer due to IE limitations, so it needs to be performed using Chrome.


===== How to Move diagram =====

MOVE DIAGRAMS TO A FOLDER

This option of the Tast tool allows the user to move a diagram to another folder of any domain and project to which they have access.
To be able to use it you have to:
Go to Model, click on UML Diagrams. The table is shown, where you have to click on the arrow icon located in the Actions column (fourth element). A pop-up appears, in which you select the domain, the project and the folder where you want to move the diagram. Click on "yes". The diagram has been moved to that folder.
 

{{:move1.png?nolink&700|}}


{{:move2.png?nolink&700|}}

===== Global Variables =====

In a diagram, it is possible to use a set of global variables in all the parts where the help of variables is allowed (object mapping, message mapping, ...).

The dropdown of variables (including global ones) will appear when typing the character '#':

{{:Global Variables_eng_1.png?nolink&1800|}}

In TAST, there are currently these global variables:

  * **#caseResult:** boolean variable that contains the result of the test case execution:
      * true: when the result of all steps execution of the test case has been correct.
      * false: otherwise; that is, at least the execution of a step of the test case has been failed.
  * **#global_password:** Contains the client access password.
  * **#global_user:** Contains the client access user
  * **#pathLog:** contains the path to the folder, which contains the screenshots, log file and other files generated during the execution.
  * **#stepNumber:** It contains a four-character number (e.g. '0001') and represents the number by which the next step marked to be documented in ALM will be recorded. When a step is recorded in ALM, this number will be incremented for the next step.
  * **#stepNumberTast:** Contains the old numbering for documenting steps in ALM before the 'stepNumber' variable was available. This format is "Step X.Y...Z Loop I.J...K" where X...Z is the step position, where Y...Z are positions within Gates, and I...K are the loop iteration number, where J...K are the iteration number of nested loops.
  * **#stepResult:** boolean variable that contains the result of the last step execution in the test case: 
      * true: when the result of the last step execution has been correct.
      * false: otherwise; that is, the result of the last step execution has been failed.\\ \\ 


===== Predefined Functions - Generation of evidences =====

Below, the list of predefined functions and the indication of whether they generate evidences or not:

^Predefined Function ^Adaptor^Generates evidences^
|connect|Database|  NO  |
|connect_DB|Database|  NO  |
|dBExecuteStatement|Database|  NO  |
|dBGetQueryData|Database|  YES  |
|disconnect_DB|Database|  NO  |
|getNumColumns|Database|  NO  |
|getNumRows|Database|  NO  |
|getTableValue|Database|  NO  |
|tableRecordCount|Database|  NO  |
|addSheet|Excel File|  NO  |
|deleteSheet|Excel File|  NO  |
|generateFileAsEvidence|Excel File|  YES  |
|getCellValue|Excel File|  NO  |
|getColumnByRowSearch|Excel File|  YES  |
|getExcelSheet|Excel File|  NO  |
|getNumColumns|Excel File|  NO  |
|getNumRows|Excel File|  NO  |
|getNumValueSearchOnColumn|Excel File|  NO  |
|getRowByColumnSearch|Excel File|  YES  |
|getTableValue|Excel File|  NO  |
|getTableValueByColumnName|Excel File|  NO  |
|getValuesByPosition|Excel File|  NO  |
|newFile|Excel File|  NO  |
|setCellValueOneParameter|Ecxel File|  NO  |
|setColumnValues|Excel File|  NO  |
|setHeader|Excel File|  NO  |
|setRowValues|Excel File|  NO  |
|setTableValue|Excel File|  NO  |
|setSheet|Excel File|  NO  |
|vTableLookUp|Excel File|  YES  |
|vTableLookupArray|Excel File|  YES  |
|allOptionsAreSelected|GUI HTML|  YES  |
|clear|GUI HTML|  YES  |
|clearAndType|GUI HTML|  YES  |
|click|GUI HTML|  YES  |
|clickByJavaScript|GUI HTML|  YES  |
|clickLink|GUI HTML|  YES  |
|clickPrint|GUI HTML|  NO  |
|closeAllWindows|GUI HTML|  YES  |
|closeOthersWindows|GUI HTML|  NO  |
|closeWindow|GUI HTML|  NO  |
|countElements|GUI HTML|  NO  |
|checkbox|GUI HTML|  YES  |
|checkRadio|GUI HTML|  NO  |
|doubleClick|GUI HTML|  YES  |
|deleteAllCookies|GUI HTML|  NO  |
|deselectAllOptions|GUI HTML|  YES  |
|fileDownload|GUI HTML|  YES  |
|fileDownloadDialog|GUI HTML|  YES  |
|fileUpload|GUI HTML|  NO  |
|getAttribute|GUI HTML|  YES  |
|isCurrentUrlContains|GUI HTML|  YES  |
|isCurrentUrlEquals|GUI HTML|  YES  |
|isCurrentUrlMatches|GUI HTML|  YES  |
|isDisplayed|GUI HTML|  YES  |
|isExist|GUI HTML|  YES  |
|isSelected|GUI HTML|  YES  |
|isTitleEquals|GUI HTML|  YES  |
|isTitleMatches|GUI HTML|  YES  |
|hasOptionWithValue|GUI HTML|  YES  |
|javascriptAlertAccept|GUI HTML|  NO  |
|javascriptAlertCancel|GUI HTML|  NO  |
|javascriptExecute|GUI HTML|  NO  |
|login|GUI HTML|  YES  |
|openUrl|GUI HTML|  YES  |
|optionWithValueIsEnabled|GUI HTML|  YES  |
|optionWithValueIsSelected|GUI HTML|  YES  |
|pressEnter|GUI HTML|  YES  |
|select|GUI HTML|  YES  |
|selectAllOptions|GUI HTML|  YES  |
|selectOption|GUI HTML|  NO  |
|submit|GUI HTML|  YES  |
|tableCellValue|GUI HTML|  NO  |
|tableCellXPathByPosition|GUI HTML|  NO  |
|tableColumnsNum|GUI HTML|  NO  |
|tableHLookUpXPath|GUI HTML|  NO  |
|tableHtml|GUI HTML|  YES  |
|tableRowsNum|GUI HTML|  NO  |
|tableVLookUpValue|GUI HTML|  NO  |
|tableVLookUpXPath|GUI HTML|  NO  |
|takeScreenshot|GUI HTML|  YES  |
|type|GUI HTML|  YES  |
|typeAction|GUI HTML|  NO  |
|typeKeys|GUI HTML|  NO  |
|uncheckbox|GUI HTML|  YES  |
|validateAttribute|GUI HTML|  YES  |
|waitFor|GUI HTML|  NO  |
|waitForElement|GUI HTML|  NO  |
|waitForPageLoad|GUI HTML|  NO  |
|newConnect_Script|Script Generic|  NO  |
|execute_Script|Script Generic|  YES  |
|disconnect_Script|Script Generic|  NO  |
|connect_Script|Script Generic|  NO  |
|closeFile|Text Files|  NO  |
|containsText|Text Files|  NO  |
|countFileLine|Text Files|  NO  |
|countTextFile| Text Files|  NO  |
|deleteFtpFile|Text Files|  NO  |
|deleteSftpFile|Text Files|  NO  |
|generateFileAsEvidence|Text Files|  YES  |
|getFileText|Text Files|  NO  |
|getFtpFile|Text Files|  NO  |
|getLineLength|Text Files|  NO  |
|getNumColumns|Text Files|  NO  |
|getOwner|Text Files|  NO  |
|getReadLine|Text Files|  NO  |
|getSize|Text Files|  NO  |
|getSftpFile|Text Files|  NO  |
|getTableValue|Text Files|  NO  |
|getTextFileData|Text Files|  YES  |
|lineContainsText|Text Files|  NO  |
|loadCsvData|Text Files|  YES  |
|newFile|Text Files|  NO  |
|openFile|Text Files|  NO  |
|openNewFile|Text Files|  NO  |
|putFtpFile|Text Files|  NO  |
|putSftpFile|Text Files|  NO  |
|replaceText|Text Files|  NO  |
|writeEnter|Text Files|  NO  |
|writeTo|Text Files|  NO  |
|assertion|User Object|  NO  |
|compareParameters|User Object|  NO  |
|compareVariables|User Object|  NO  |
|copyFile|User Object|  NO  |
|dateAddition|User Object|  NO  |
|dateDifference|User Object|  NO  |
|dateWeekDay|User Object|  NO  |
|executeCommand|User Object|  NO  |
|executeJavaScript|User Object|  NO  |
|failTest|User Object|  NO  |
|getCurrentDate|User Object|  NO  |
|getCurrentDateAsDate|User Object|  NO  |
|getCurrentDateAsString|User Object|  NO  |
|isExistVariable|User Object|  NO  |
|manualTast|User Object|  YES  |
|removeVariable|User Object|  NO  |
|replaceAll|User Object|  NO  |
|saveRepositoryAsEvidence|User Object|  YES  |
|sendKeys|User Object|  NO  |
|sendKeysCombination|User Object|  NO  |
|sendKeysPaste|User Object|  NO  |
|setArrayVariable|User Object|  NO  |
|setVariable|User Object|  NO  |
|systemCloseProgram|User Object|  NO  |
|takeScreenshot|User Object|  YES  |
|waitFor:|User Object|  YES  |
|deleteRest|API/WebService|  YES  |
|getALLXMLElementValueByTagName|API/WebService|  YES  |
|getCookieValue|API/WebService|  NO  |
|getHeaderValue|API/WebService|  NO  |
|getHTMLElementValueByXPath|API/WebService|  NO  |
|getJSONElementValueByJsonPath|API/WebService|  NO  |
|getJSONElementValueByTagName|API/WebService|  NO  | 
|getRest|API/WebService|  YES  |
|getResponseStatus|API/WebService|  NO  |
|getResponseTime|API/WebService|  NO  |
|getXMLElementValueByXPath|API/WebService|  NO  |
|getXMLElementValueByTagName|API/WebService|  NO  |
|patchRest|API/WebService|  YES  |
|postRest|API/WebService|  YES  |
|putRest|API/WebService|  YES  |
|responseBodyContainsText|API/WebService|  NO  |
|setNoneAuthentication|API/WebService|  NO  |
|setBasicAuthentication|API/WebService|  NO  |
|setBearerTokenAuthentication|API/WebService|  NO  |
|setDigestAuthentication|API/WebService|  NO  |
|clearAndWriteField|Host 3270|  YES  |
|clearField|Host 3270|  YES  |
|containsText|Host 3270|  YES  |
|getLenghField|Host 3270|  NO  |
|nextScreen|Host 3270|  YES  |
|previousScreen|Host 3270|  YES  |
|readField|Host 3270|  YES  |
|readRow|Host 3270|  YES  |
|readScreen|Host 3270|  YES  |
|readScreenByRows|Host 3270|  YES  |
|rowContainsText|Host 3270|  YES  |
|waitCRC|Host 3270|  NO  |
|waitFor|Host 3270|  NO  |
|waitForChange|Host 3270|  YES  |
|waitForText|Host 3270|  YES  |
|writeAfterLabel|Host 3270|  YES  |
|writeBeforeLabel|Host 3270|  YES  |
|writeField|Host 3270|  YES  |
|writeKey|Host 3270|  YES  |
|writeKeyUntilFind|Host 3270|  YES  |
|writeText|Host 3270|  YES  |
|checkTextInSlide|PDF|  NO  |
|checkTextOnDocument|PDF|  NO  |
|checkTextOnPage|PDF|  NO  |
|checkTextOnPageArea|PDF|  NO  |
|generateFileAsEvidence|PDF|  YES  |
|getGetTextByPageArea|PDF|  YES  |
|getNumPages|PDF|  NO  |
|getNumWhitePages|PDF|  NO  |
|getPageAsImage|PDF|  YES  |
|getPageText|PDF|  YES  |
|getTextCountOnDocument|PDF|  NO  |
|getTextCountOnPage|PDF|  NO  |
|isPageWhite|PDF|  NO  |
|generateFileAsEvidence|XML|  YES  |
|getElementAttrTextByXPath|XML|  NO  |
|getElementsCountByTagName|XML|  NO  |
|getElementsCountByXPath|XML|  NO  |
|getElementsTextByTagName|XML|  YES  |
|getElementsTextByXPath|XML|  YES  |
|getElementTextByTagName|XML|  NO  |
|getElementTextByXPath|XML|  NO  |
|replaceElementAttrTextByXPath|XML|  NO  |
|replaceElementTextByTagName|XML|  NO  |
|replaceElementTextByXPath|XML|  NO  |
|saveAs|XML|  NO  |
|saveXml|XML|  NO  |
|xmlToString|XML|  NO  |
|executeAllServiceOperations|SOAP UI|  YES  |
|executeAllTestSuite|SOAP UI|  YES  |
|executeServiceOperation|SOAP UI|  YES  |
|executeTestCase|SOAP UI|  YES  |
|executeTestStep|SOAP UI|  YES  |
|executeTestSuite|SOAP UI|  YES  |
|executePostmanCollection|Postman Collection|  YES  |
|getResponseBody|Postman Collection|  YES  |
|getResponseStatusCode|Postman Collection|  YES  |
\\ \\ 









===== Shortcuts =====

You can use the following keyboard shortcuts in the canvas: 

^   Shortcut	^Description^
|ESC  | Close menus and selects the pointer.|
|Alt + 9 | DUnlocks diagrama for editing.|
|Alt + P | Selects the pointer tool.|
|Alt + O | Selects the "Object" tool.|
|Alt + M | Selects the "Message" tool.|
|Alt + R | Selects the "Reply message tool".|
|Alt + G | Selects the "Gate" tool.|
|Alt + A | Selects the "Combined Fragment: ALT" tool.|
|Alt + D | Selects the "Combined Fragment: DO WHILE" tool.|
|Alt + W | Selects the "Combined Fragment: WHILE" tool.|
|Alt + F | Selects the "Combined Fragment: FOR" tool.|
|Alt + E | Selects the "Combined Fragment: FOR EACH" tool.|
|Alt + S | Selects the "Subtestcase" tool.|
|Ctrl + C| Copy selected elements.|
|Ctrl + V| Paste copied elements.|
|Ctrl + Z| Undoes some actions such as: Delete elements, Redistribute diagram, etc...|
|Double click | Edit element: double click on a diagram element to edit its properties.|
|Right button | Context menu: by right-clicking on an element, you can access the dynamic context menu. The options of this menu vary and can appear active/not active, depending on the currently selected elements.|
|Mouse Wheel  | Zoom in/Zoom out: Roll the mouse wheel forward or backward to zoom in or zoom out the canvas respectively.|
|Shift + click| Multiple selection: hold down the shift key and click on different elements to select them.|
|Shift + drag | Multiple scrolling: hold down the shift key while scrolling the selected elements.|
|Click + drag | Move diagram: click on an empty area of the diagram while dragging in any direction to move the diagram.| 
\\ \\ 


=====  Multiple Selection of Messages =====

This tool option allows the user to select one or more messages one by one, in block or alternate.

SELECT MULTIPLE MESSAGES INDIVIDUALLY.\\ We can select several messages, one by one, it is done with the 'M' key pressed.

1. SELECT MESSAGES.
1.1. If we click on a message with the 'M' key pressed, a message is selected.
(In the image message 1 is selected).

{{en:image1.png?nolink&700|}}
 
1.2. If we press the 'M' key and click on different messages, each one will be added to the selection. (Messages 3, 6 and 9 have been added to the selection in the image).
 

{{en:image2.png?nolink&700|}}

UNCHECK MESSAGES.\\ With the 'M' key pressed, if we click on a message already marked, it will be unmarked.
If we do this without pressing the 'M' key, the multiple selection will be lost and only the selected message will be marked.

SELECT MESSAGES BETWEEN TWO UNIQUE SELECTIONS.\\ We can select a message line by pressing the 'L' key and clicking on two unique
messages, this will mark all the messages between those two selected.

1. SELECT MESSAGES.\\ 1.1. To select the first message we can:
- Click on the first message WITHOUT PRESSING the 'L' key.
- Click on the first message by pressing the 'L' key.
(In the image the first message marked is message 3).
 
{{en:image3.png?nolink&700|}}\\ \\ 1.2. To select the second message:
-We have to do it by ALWAYS PUSHING the 'L' key.\\ 1.2.1. If the message of the second click is above the first one, the messages between those two are selected. (In the image on the next page, the first message selected was 3 and the second message marked was the message: message 1, all messages from 1 to 3 being marked). (In the image the first message marked is message 3).
 

{{en:image4.png?nolink&700|}}\\ \\ 1.2.2. If the message of the second click is below the first one, the messages between the two are selected.
(In the next image the first selected message was 3 and the second message marked was the message: message 10, all messages from 3 to 10 being selected).
 

{{en:image5.png?nolink&700|}}\\ \\ 2. DESELECT MESSAGES.\\ If we want to unmark an intermediate message, we can do it by pressing ONLY the 'M' key and clicking on the messages that we want to unmark. (In the image, the unmarked messages are 5 and 9).

{{en:image6.png?nolink&700|}}\\ \\ 3. INTERCHANGE BLOCKS.\\ Example of use to be able to interleave selections of several groups.\\ 3.1. We select a message line by holding down the 'L' key. (A block of household items 1 to 6 has been selected in the picture).
 
{{en:image7.png?nolink&700|}}\\ \\ 3.2. We could deselect one or several messages to personalize the group of messages and eliminate some of them. (In this picture the message 4 has been deselected).
 
{{en:image8.png?nolink&700|}}\\ \\ 3.3. If, for example, we want to add the block of messages 9, 10 and 11 to this selection, we would have to follow the following steps:\\ 3.3.1. To select the first message of this sub-block we would do it by pressing the 'M' key. To add that unique message to the selection. The first message could be 9.\\ 3.3.2. To select the second message of the sub-block we would do it by pressing the 'L' key and we would add all the messages between those two selections. The second selected message would be 11.
The result is this serious selection that we have marked alternate message blocks. The messages "1, 2, 3" are selected in the image; "5, 6"; "9, 10, 11").
 
{{en:image9.png?nolink&700|}}\\ \\ COPY AND STICK MULTIPLE MESSAGES IN A DIAGRAM.\\ 1. We select the messages that interest us with the different selection options offered by the application.\\ 2. Copy and paste messages:
You can copy and paste the selected messages with the key combination: "ctrl + sifth + c" and to paste them it would be with the key combination "ctrl + sifth + v".\\ 3. You do NOT have to be able to paste messages from one diagram into another diagram:
If you copy and paste a single message or several, they can only be pasted on the diagram where they are drawn.\\ 4. Reply Messages:
- If we select only a reply message, it does not allow copying.
- If we select the source message to which a reply is associated, both are copied.

DISPLACING MULTIPLE MESSAGES IN A DIAGRAM.\\ 1. We select the messages that interest us with the different selection options offered by the application.\\ 2. Move a group of messages:
When we have selected the last message of the selection, do not raise the left mouse button, leave it pressed and when moving the mouse upwards or downwards the block will follow the movement.

DELETE MULTIPLE MESSAGES FROM A DIAGRAM.\\ 1. We select the messages that interest us with the different selection options offered by the application.\\ 2. Delete a group of messages:
We can delete a group of messages with the 'DELETE' key or with the 'Delete item' button of the diagram tools.


===== Selective Mapping =====

TAST has an important help when mapping objects and messages in a diagram: Selective Mapping.

The configuration, how to use the functionality, and some considerations are explained in the document below:

{{:TAST Selective Mapping_v1.0.doc|tast_selective_mapping_v1.0.doc}}

 
===== Tast Table Data Management =====

In an UML diagram, TAST allows the use of variables of a specific type of table, called **TASTTABLEDATA**.\\ \\ These variables can be used with practically all the adaptors available in TAST (HTML GUI, Excel Files, Database, …). They can be used in the "Value" box of a Predefined Function or in Javascript.\\ \\ Once the TASTTABLEDATA variables have been created (as output variables), they can be used as input variables in subsequent messages. The way to use them in a "Value box" is:\\ #TasTableDataVariableName.functionName(params…). 
From javascript, you will use the syntax functionName(params…)\\ \\ The functions currently available are:

^ Output ^ Function ^ Description^
|int|**getNumColumns()**|Returns an integer with the number of columns.|
|int| **getNumRows()** |Returns an integer with the number of rows.|
|String| **getStringValue()** |Returns a string containing the content of the table separating cells with <nowiki>|</nowiki> and rows with <nowiki>||</nowiki>.|
|TastRowTableData| **getTheRow(int index)**|Returns a row.|
|N/A|**addRowData(TastRowTableData rowData)**|Adds a row at the end of the table.|
|TastRowTableData| **getTheColumn(int index)**|Returns a column (as a row).|
|TastDataGeneric| **getCellValue(int row,int column)** | Returns the value of a specific cell.|
|TastDataGeneric| **getTableValueByColumnName(int rowNum, String columnName)** |Returns the value of a cell identified by row number and Column name.|
|N/A|**setTableValue(int row, int column, String value)**|Allows to add a value to a specific cell. The value can be a string, Float or Boolean value, either contained in a variable or hardcoded:|

{{ :tasttabledata_1_eng.png?nolink |}}

{{ :tasttabledata_2_eng.png?nolink |}}

{{ :tasttabledata_3_eng.png?nolink |}}

{{ :tasttabledata_4_eng.png?nolink |}}

===== TAST Row Data Management=====
TAST allows the use of variables of a specific type of row, called **TASTROWVALUES**.\\ \\ These variables can be used with practically all the adaptors available in TAST (HTML GUI, Excel Files, Database, …). They can be used in the "Value" box of a Predefined Function or in Javascript.\\ \\ Once the TASTROWVALUES variables have been created (as output variables), they can be used as input variables in subsequent messages.\\ \\ The way to use them in a "Value box" is: #TastRowDataVariableName.functionName(params…) 
From javascript, you will use the syntax functionName(params…)\\ \\ The functions currently available are:\\ 

^ **Output** ^ **Function** ^ **Description**^
|N/A|**addCellValue(String value)**|Allows to add a cell at the end of the TastRowValues.|\\ 
|String| **getCellValue(int index)**|Returns the content of a specific cell.|
|int| **getLength()**|Returns the number of cells of the TastRowValues.|
|String|**getStringValue()** |Returns the content of the row separating cells with <nowiki>|</nowiki>|.

For more information about Variables Management, see the topic [[“Variable Management”]].

====== The TAST Canvas ======
  
TAST has an important feature: the Canvas, which is a place where the user can paint the UML diagrams.
Actually, the Using TAST workflow starts from its Canvas.

You can launch the Canvas from several places:
  * Creation of a new UML Diagram.
  * Editing an existing Diagram.
  * Navigation from several places of TAST to consult a diagram.


{{:en:01lauchingthecanvas.jpg|}}
==== Top toolbox ====
The toolbox on top has the following options:
  * Create a New Diagram: for creating a UML diagram.
  * Import a Selenium IDE Record: for importing an IDE record from Selenium.
  * Import a Diagram: for importing an existing diagram, but from another environment to our current environment. 
  * Export a Diagram: for exporting a diagram to be used on another environment, but also into TAST.  

==== Bottom toolbox ====  
{{:en:canvas.png?2600|}}\\ \\ 
Once editing a Diagram, a second toolbar will be shown to make interaction with the diagram easier. The following options are available:
  * Zoom in: Increases the size of the diagram.
  * Zoom out: Reduces the size of the diagram.
  * Move diagram: Allows to navigate the diagram either by click-and-drag or by the different Generic Positions (Home, Top, Bottom, Right, Left)
  * Delete an item: Deletes the selected item in the diagram. 
  * Download image diagram: Generates an image of the diagram and downloads it to your computer.    
  * Selective Mapping (GUI HTML Assistant): Launches the GUI HTML Assistant to help in the mapping step.
  * Selective Mapping (Web Service Assistant): Launches the Web Service Assistant to help in the mapping step.
  * Validate Mapping: Validates if a diagram is correct and the mandatory data has been provided. This makes the diagram available for execution in the Client.
  * Launch Validation: Makes the diagram available for execution in the Client with the Validation Test Case Data.
  * Drawing Tools: Expands the toolbox for the UML items you can use in diagrams (Object, Message, Gate, Combined Fragment). 



==== UML items toolbox ====  

In this toolbox, you have all the items you can use for painting your UML diagrams. 
The list of UML elements you can use is the following:
  * Pointer: Returns to the pointer mouse, instead of a selector.
  * Object: Makes a zoom out into the diagram.
  * Message: delete the currently selected item in a diagram. 
  * Reply Message: Generates an image of the diagram and download it to your filesystem.    
  * Gate: Launches de GUI HTML Assistant for helping in the mapping step.
  * Combined Fragment (ALT): Paints a Combined Fragment of the ALT type.
  * Combined Fragment (Loop do while): Paints a Combined Fragment of the do while loop type.
  * Combined Fragment (Loop while): Paints a Combined Fragment of the while loop type. 
  * Combined Fragment (Loop for): Paints a Combined Fragment of the for type.
  * Combined Fragment (Loop for each): Paints a Combined Fragment of the for each type.

GATES

Gates could be regarded as being a simple way to model the passing of data between a sequence diagram and its context. A Gate is a message that is highlighted with one end connected to the sequence diagram’s frame’s edge and the other end connected to a lifeline.

{{:en:canvas00.png?nolink|}}
When you choose a Gate for being used, firstly, you should provide a name and a path to the diagram you are referencing as a gate. The second step is to decide the execution way:
  * Isolated: it creates a new instance of the object where the gate is placed.
  * No Isolated: it reuses the same instance of the object where the gate is placed.

{{:en:canvas01.png?nolink|}}

====== Data Management ======


With this option it will be possible to manage the data sets with which the tests corresponding to a specific diagram will be launched.

The DATA MANAGEMENT option has three tabs:
  * Test Sets Data.
  * Test Set Data.
  * Test Sets Data Info.

==== Test Sets Data window ====
{{:es:tsetsdata_eng.png?2600|}}
Displays the list of diagrams for a specific domain and project, with information about their test case data sets and test case sets.
In general, we can filter by:
  * Domain.
  * Project.
  * Diagram.
  * User.
It will also allow you to modify and delete a folder.

In the main window of DATA MANAGEMENT, the list of diagrams for the filters used will be displayed, with the following information:
  * Creation date.
  * Number of data sets of test cases.
  * Number of sets of test cases.
  * Action: with the following indicators:
     * Uploaded to ALM.
     * Owner.
     * More information: when you click on this option, the Test Set Data Info window appears.

==== Test Set Data Window ====
{{:en:tsdata_eng.png?2600|}}
In this window the data of the test cases of a diagram will be created.
Is accessed by clicking on any diagram of the //Test Sets Data// window.

There will be a set of validation data and 1 to n data sets of values.
It will be possible to indicate:
  * The description of the Test case data.
  * The type of test (positive or negative).
  * The values for the parameters of the objects.
  * The values for the parameters of the messages.

You can also view the diagram.

There will be the option to copy the data of the test cases, which can be modified later.

==== Test Set Data Info Window ==== 
{{:en:tsdatainfo_eng.png?2600|}}
It can be accessed on two ways:
  *	Selecting the corresponding tab.
  *	Clicking on the icon //More info// of a diagram.

This screen shows the following information:
  *	Owner user.
  *	Diagram´s path.
  *	Creation Date.
  *	Name of the diagram.
  *	Number of Test case Data.
  *	Number of Test case Set and it´s path.

====Delete Functionality====
Back in the Test Set Data Window, we have another functionality to delete massively the Test Case Data (TCD) created for that Test Set (TS).\\ 
A new icon with a trash bin inside is located in the upper icon bar.

{{:en:deltcd1.png?200|}}

Once this button is clicked a modal window with all the TCD list will appear.\\ \\  
{{:en:deltcd3.png?700|}}\\ \\ 

Different features in this modal window:
  * Every TCD have a checkbox.
  * Those checkboxes can be selected by clicking on them, and they will remain clicked instead you click them again.
  * Also, you can multiselect TCDs while holding shift and clicking two of them. (You can select segments that are separated each other, just selecting the first one without holding shift and then holding it).
  * There is a “select all” checkbox, that selects and deselects all the TCD.
  * To close the modal window without doing any changes, you can either click the cross in the top right or click in the “No” Button.
  * Finally, to delete all the selected TCD, click “Delete” button. It will close when the changes are done. If you want to save definitively the changes, you have to save the TS.

==== Import TCD from an Excel file ====

In this page you can also to import data from an Excel file. 
You just need to click in the Import icon to show the Import TC file page. 

{{:en:datamanagement00.jpg?nolink|}}

Then, 
  - You should provide an Excel file with the right order of data. 
  - To set in the page, the correspondence betwen the column in the Excel file (A, B, etc.) with the related field Description, Test Type, etc.

After you select the file and set the correspondence, you should click the button Import to perfom the import process.

{{:en:datamanagement01.jpg?nolink|}}\\ \\ 

===== How to search an UML diagram in Modeling=====

This TAST option allows the user to do a search of a diagram among all the domains of the application (TAST also allows the filtering of Test Set in TS Management in all domains).\\ \\ 
There are two types of searches:
  * by diagram ID.
  * by name (partial or total) of the diagram.

To use the search of an UML diagram, follow these steps:

 {{:Screenshot1.png?nolink&1600|}}

Click on the filter button of all domains and projects.

** Search by diagram ID **

 {{:Search_diagram_eng.png?nolink&475|}}

In the //search// field you type the diagram ID of the search you want to perform, and click on the magnifying glass button. The application shows the diagram with the specified ID in the search.

If you click on the file icon, the diagram will open directly:

 {{:Search_diagram_eng_1.png?nolink&1600|}}

** Search by diagram name **

 {{:Search_diagram_eng_2.png?nolink&500|}}

In the //search// field you type the characters of the search you want to perform, and click on the magnifying glass button. The application shows all the diagrams of all the domains that contain the characters entered in the search.
 
If you click on the list icon, the application will switch to the selected Diagram, Domain and Project:

 {{:Search_diagram_eng_3.png?nolink&900|}}

===== How to search an UML diagram in Data Management=====

This TAST option allows the user to do a search of a diagram (and its Test Case Data) among all the domains of the application (TAST also allows the filtering of Test Set in TS Management in all domains).\\ \\ There are two types of searches:
  * by diagram ID.
  * by name (partial or total) of the diagram.

To use the search of an UML diagram in Data Management, follow these steps:

In Modeling, select the Data Management Option.

 {{:Search_DM_eng_1.png?nolink&1600|}}

Click on the filter button of all domains and projects.

 {{:Search_DM_eng_2.png?nolink&700|}}
 
** Search by diagram ID **

 {{:Search_diagram_eng.png?nolink&475|}}

In the //search// field you type the diagram ID of the search you want to perform, and click on the magnifying glass button. The application shows the Test Set Data corresponding to the diagram with the specified ID in the search.
 
If you click on the file icon, the Test Set Data will open directly:

 {{:Search_diagram_eng_4.png?}}

** Search by diagram name **

 {{:Search_diagram_eng_5.png?nolink&500|}}

In the //search// field you type the characters of the search you want to perform, and click on the magnifying glass button. The application shows all the diagrams of all the domains that contain the characters entered in the search.

If you click on the list icon, the application will switch to the selected Test Case Data, Domain and Project:

 {{:Search_diagram_eng_6.png?nolink&900|}}

Clicking on the diagram, you can see the Test Case Data of the selected diagram.

 {{:Search_diagram_eng_4.png?}}









======Repository Management======

In this tab, all the repositories that the users are going to use in the diagrams will be stored
The repositories are TXT or YML files (they must have YML /YAML format) that we create and upload to this tab and contains information that we can use in a diagram. 

====Glossary====
To evade confusions with the functionality, and to briefly explain how to create repositories we have to know the details about the elements used here. Next we have a detailed example:

  * **Files:** they can be Text files or YML/YAML there the user insert the code to use the repository. Mention that if we don’t have an environment (like Notepad++ or others) with transformation between tab spacing or normal spaces. The file won’t work if you use the tab for spacing instead normal spaces because the indentation with tabs don’t work in YML.\\  
  * **Keys:** They are every word that comes before “ : ”\\ 
  * **Value:** Value is what comes after “ : ”\\ 
  * **Properties:** Is the entire path that includes the keys until the “ : ” using “ _ ” to separate them.\\ 
Example:{{ :en:xpath1en.png?600  |}}\\ Also, you can do subkeys: {{ :en:xpath2en.png?600  |}}
So in the end, the variable will have all the properties separated by “_” in this example should be: #wiki_url1.\\ 

The first key will always be one of the following words:\\ {{ :en:repo11esp.png?200 |}}


====Features====
In the repository management we have different “features”:

  * Import repositories with a TXT and YML extension. The repositories are defined by keys. These repositories must have a first level key that will be a “searchBy” option listed in a diagram message. Then it will have a second key that will be a name to identify the property and finally the value that is the path of the searchBy we are using. (those keys are not “case sensitive”, nevertheless, when you put it in the element box in the message, it has to be exactly as the repository property.\\ \\  Example:\\ {{ :en:xpath3.png?800 |}}\\ 
  * Export repositories as YML files saved in repository management.
  * Open, edit, delete, and save repositories.
  * Create, edit and delete the folders in which those repositories will be kept. A folder with a repository saved in, can´t be deleted. You have to delete the repository before. (default folder can´t be deleted)
  * Clone a repository already imported into a new one.
  * Watch information about repositories such as creation date and diagrams that use it, works like more information tab in modeling.
  * Locate where a repository is being used.


====Import repositories====

In the repository management tab, we have to click the import button in the top right side, then a modal window will appear.

{{ :en:repo8en.png?400 |}}\\ 

In this modal window, we choose the name of the repository, domain and project also the name and where to save it.\\   

{{ :en:repo9en.png?400 |}}\\  

Once it is ready, we click import, if the TXT/YML file is ok, the importation will be perfect. But if the file has some kind of error, this message will appear:\\ 

{{ :en:repo10en.png?250 |}}\\ 

This could happen if: the TXT format is not YML/YAML, or because there are some kind of error in the file also could be because the syntaxis of the yml in the repository is wrong like inserting spaces with tab instead spacebar or using a key as subkey of another when the value is already defined.\\ \\ 


====Changes in modeling====

In modeling are some changes about repositories as well.
  * The properties tab in the diagram has been updated to show from now on, information about repositories in the right side. 
  * From here the user can add a repository clicking the edit button.\\ \\ {{ :en:repo1en.png?1200  |}}\\  

  * Using this button will deploy a modal window, here we can use a filter to find the repositories we want.

{{ :en:repo2en.png?600  |}}


  * We can add or delete all the repositories we want. Once accepted it is saved and the diagram is updated with the repositories in the “selected repositories” list box, also this can delete old repositories from the diagram in case there was any and add new ones. Although the repositories are enabled immediately after selecting them, the relation repository-diagram can´t be confirmed until the diagram is saved. 

{{ :en:repo3en.png?600  |}}


{{ :en:repo4en.png?600  |}}\\ 

  * To delete a repository from the diagram properties, just click the thrash can icon in the repository´s row and the repository will be deleted with all the connections that could have with the diagram messages. 
  * To go to the repository, click in the repository name and it will act as shortcut going to repository management exactly where the repository is. 

{{ :en:repo5en.png?600  |}}\\ \\ 

  * In the messages there are also upgrades. As the image shows, a “Repository” field has been added from here the user can choose which repository is going to be used. In the “Element” field repository keys (properties) can be used as variable, writing first “#” and having a repository and searchBy selected. In the repository Tab you have to choose the repository you want and then in searchby you have to choose repository, then you can write the element with the repository properties.
  * Also you can choose not to put searchby repository and do it as a normal searchby, instead you can use the repository in this case to put the value. In the second screen you can see that a repository is used in the value, you can search the properties in the repository the same way as the element does but it will automatically add the prefix “Repo:” to differentiate it.
  * As an important note, avoid the use of “_” to create a property in the repository, that is because TAST concatenates the repository variables with the underscore, so it will lead to some problems if the properties have underscores in them.\\ \\ {{ :en:repoeng1.png?800  |}}\\ \\ {{ :en:repoeng2.png?800  |}}

  * Once you put the “#” it´s possible to autocomplete with keys the repository, as shown in the upper image. To use this keys, the variables are generated concatenating the levels of the keys with “_” (underscore),  until reach the value, so all the keys have to be separated by “_” as shown in the example in glossary.
TAST DokuWiki

User Tools

Site Tools

Page Tools
