Macros

From IRON Test Suite
Jump to navigation Jump to search

Macros List

The Macros window displays the list of existing macros with several configurable columns.

  • ID : Unique Identification number of the test in the system
  • Name : Test Name must be unique
  • Comment : Field for free comment
  • Author : Automaticaly filled with the User Name
  • Status: displays if the macro is currently running in one of the scheduler tasks.
  • Last Run : Date of the last execution
  • Run OK :Number of macros run with success
  • Run KO : Number of macros run with errors
  • Last result : Result of the last execution


Macros.png


In order to manage macros, 5 buttons are available: Add, Edit, Delete, Import & Export

  • The Add button is always available.
  • The Edit button is disabled if the macro is currently edited by another user or running within a scheduler task.
  • The Delete button is disabled if the macro is under use in a scheduler task or edited by another user.
  • The Import button allows to import a csv file which contains a macro.
  • The Export button allows to export the macro into a csv file.

Macros Edition

The New and Edit buttons give access to the edit macro dialog box. This dialog box is divided in 4 parts: Naming & Comments fields, R2D2 Command box, Command List box & Run Macro box.

Macros Edition.png


The Macro Name must be unique and the Save As button can be used to duplicate an entire macro and save it under a different name. The Description field can be used to enter any useful information, it is an optional field.

R2D2 Command

This box is used to edit any of the existing R2D2 commands prior adding it to the macro.
The user has to select the commands Category first, then to select the proper Command among of one of given category, and finally to enter the command parameters.
When a command is selected and set, the user has to click on the button Arrow droite.png to add this command at the end of Command List. If one parameter value is missing or is invalid, the action is canceled with an error message displayed. The up and down buttons can be used to change the order of the commands within the list, the ‘Delete’ button can be used to remove a command from the list.
The categories of commands and every single command available are described in detail into this Web site in the part R2D2 Commands. When a command is selected, a click on this button Interrogation.png open the correspondant page on the online documentation (this Wiki).


An additional category named INTERNAL is available in the test manager. It is system function not executed by the robot. It offers 2 new functions:

  • WAIT function allows to generate a pause of DelayTime in millisecond
  • PRINT function allows to display MessageText in the Scheduler test result

Command List

The Command List displays the entire macro with commands and its parameters in execution order. Each line can be selected individually. When a line (command) is selected, it is possible to:

  • Change its execution order by using the up and down arrow buttons.
  • Delete the command with the Delete button.
  • Edit the command using the button Arrow gauche.png, and then the button Arrow droite.png to replace the command after edition.
  • Add a new command at the end of the macro with the button Arrow droite.png.
  • Insert a command before the command line selected in the Command list and if the button Arrow between.png is pressed.

Run Macro

The Run Macro feature can be used to run a macro immediately, for a quick test or for debugging purpose.
The results are collected into the Results tab like any other macros run by the scheduler: they can be quickly identify from the flow of results because the task name is then replaced by the string '$$ RUN $$'.
If the macro includes variables, the user has to select a predefined Data Collection the list in order to load input values for this macro iteration.
Then, the user has to select a Robot from the list and the Port of this iQsim Robot to run the test from: the list of robots and the list of ports both displays the resources immediately available to run the given macro.
Finally, the user has to click on the Run Macro button to start the macro execution. Saving the macro is mandatory before execution, so if the macro is not saved in advance, a dialog box is display to propose to save the macro first.
During the macro execution, the complete dialog box is disabled except the Cancel button to permit to edit another macro or to go to check the results.
When a macro runs, the generated task is visible during the whole task job in the task scheduler list, and is automatically deleted when the task is completed: only macro results remain at the end. This process permits to delete a macro that has been executed by pressing the 'Run Macro' button if it is not used by a task.