корректировка ссылок на картинки, закрытие незакрытых тегов p, задание одной строки между заголовками
This commit is contained in:
parent
63deec9b8c
commit
ca7c89bdb9
|
|
@ -1,7 +1,9 @@
|
|||
|
||||
# <H1 align="center">«Break» Module</h1>
|
||||
|
||||
<p> For «Emergency» exit from a simple cycle, you can use the «Break» operation. For example, in a cycle, a specific image is searched, and if the image is found, the robot should click on it, read data from it and go to the next action, otherwise, exit the cycle and not run the next action. For this scenario you should create a cycle that contains «Condition» module, and in one of the sections there must be the module «Break»:</p>
|
||||
|
||||
##
|
||||
<H1 align="center"></h1>
|
||||
<p> Module «Break» Doesn't need configuration but should only be used inside the «Cycle» module.
|
||||
|
||||
|
||||
<p> Module «Break» Doesn't need configuration but should only be used inside the «Cycle» module.</p>
|
||||
|
|
@ -1,11 +1,13 @@
|
|||
|
||||
# <H1 align="center">«C# code» module»</h1>
|
||||
|
||||
<p> The «C# code» module is designed to use complex calculations that are not available in the Studio..</p>
|
||||
<p> The module allows the use of Studio variables</p>
|
||||
|
||||
## Module interface
|
||||
<p> This module consists of two fields: «Variable» and «Code».
|
||||
<H1 align="center"></h1>
|
||||
<p> The «Variable» field.The field indicates the variable in which the result will be entered in.
|
||||
<p> The «Code» field. It is necessary to enter part of the code in the field in accordance with the C # language syntax without describing the libraries used, as if it were a function inside an existing project, which has one main condition - it must return something, that is, have the word «return».
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> This module consists of two fields: «Variable» and «Code».</p>
|
||||
|
||||
<p> The «Variable» field.The field indicates the variable in which the result will be entered in.</p>
|
||||
<p> The «Code» field. It is necessary to enter part of the code in the field in accordance with the C # language syntax without describing the libraries used, as if it were a function inside an existing project, which has one main condition - it must return something, that is, have the word «return».</p>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,34 +1,36 @@
|
|||
|
||||
# <H1 align="center">Module «Calculation»</h1>
|
||||
|
||||
<p> The «Calculation» module is a connecting module or a module for pre- and post-processing data from other modules. This module is necessary for creating, calculating and changing values of variables.</p>
|
||||
|
||||
## Module interface
|
||||
<p> The module window is really simple and consists only of an entry field and the «Save» and «Cancel» buttons.
|
||||
<H1 align="center"></h1>
|
||||
<p> The «Expression» field. The operations that need to be done with variables are entered into this field. This can be addition, subtraction, multiplication or function calculation.
|
||||
<p> Supported operations
|
||||
<p> ● + (addition);
|
||||
<p> ● - (subtraction);
|
||||
<p> ● * (multiplication);
|
||||
<p> ● / (devision);
|
||||
<p> ● % (remainder of the division);
|
||||
<p> ● \ (integer from division);
|
||||
<p> ● ^ (exponentiation).
|
||||
<p> All lines should look like this «Variable = Operation;», operation can consist of a single number or a line, as well as several operands connected by the operators specified above, or it can be a function.
|
||||
<p> Each line should be separated by the «;» symbol.
|
||||
|
||||
<p> The module window is really simple and consists only of an entry field and the «Save» and «Cancel» buttons.</p>
|
||||
|
||||
<p> The «Expression» field. The operations that need to be done with variables are entered into this field. This can be addition, subtraction, multiplication or function calculation.</p>
|
||||
<p> Supported operations</p>
|
||||
<p> ● + (addition);</p>
|
||||
<p> ● - (subtraction);</p>
|
||||
<p> ● * (multiplication);</p>
|
||||
<p> ● / (devision);</p>
|
||||
<p> ● % (remainder of the division);</p>
|
||||
<p> ● \ (integer from division);</p>
|
||||
<p> ● ^ (exponentiation).</p>
|
||||
<p> All lines should look like this «Variable = Operation;», operation can consist of a single number or a line, as well as several operands connected by the operators specified above, or it can be a function.</p>
|
||||
<p> Each line should be separated by the «;» symbol.</p>
|
||||
|
||||
## Example of working with the module
|
||||
<p> Suppose you want to get the last day of the previous month. You can do this by entering the following code:
|
||||
<H1 align="center"></h1>
|
||||
<H1 align="center"></h1>
|
||||
<p> What are we doing here? Here, we're getting today's date, for example, today is 25th of march, subtract one day more from today’s date than it actually is, meaning that, 26 days and end up in the last day of the previous month - February 29 (if the year is a leap year). In more details:
|
||||
<p> 1st line – Using GetDate function which returns today's date and saves its result in a variable @now (@now = 25.03.2020);
|
||||
<p> 2nd line - the use of the GetDay function, which takes one parameter - the date, and returns only the day from the date supplied to it. Let's set today's parameter as the parameter, which lies in the @now variable. We enter the result of the function to the variable @day (@day = 25);
|
||||
<p> 3rd line – increasing the @day variable by one (@day = 26);
|
||||
<p> 4th line – using the DateAdd function, which takes three parameters: the first parameter - «day», «month» or «year» - is the component of the date that we are working with, the second parameter is the amount that is added to the selected component of the date, and the third parameter is the date with which the manipulation is performeed. Subtract 26 days from today's date - use DateAdd with parameters:
|
||||
<p> 1. day – subtracting date ;
|
||||
<p> 2. –@day – we add the minus because the function adds by default
|
||||
<p> 3. @now – today's date.
|
||||
<p> In result, we subtract 26 days from 25.03.2020 and end up on 29.02.2020.
|
||||
|
||||
|
||||
<p> Suppose you want to get the last day of the previous month. You can do this by entering the following code:</p>
|
||||
|
||||
|
||||
<p> What are we doing here? Here, we're getting today's date, for example, today is 25th of march, subtract one day more from today’s date than it actually is, meaning that, 26 days and end up in the last day of the previous month - February 29 (if the year is a leap year). In more details:</p>
|
||||
<p> 1st line – Using GetDate function which returns today's date and saves its result in a variable @now (@now = 25.03.2020);</p>
|
||||
<p> 2nd line - the use of the GetDay function, which takes one parameter - the date, and returns only the day from the date supplied to it. Let's set today's parameter as the parameter, which lies in the @now variable. We enter the result of the function to the variable @day (@day = 25);</p>
|
||||
<p> 3rd line – increasing the @day variable by one (@day = 26);</p>
|
||||
<p> 4th line – using the DateAdd function, which takes three parameters: the first parameter - «day», «month» or «year» - is the component of the date that we are working with, the second parameter is the amount that is added to the selected component of the date, and the third parameter is the date with which the manipulation is performeed. Subtract 26 days from today's date - use DateAdd with parameters:</p>
|
||||
<p> 1. day – subtracting date ;</p>
|
||||
<p> 2. –@day – we add the minus because the function adds by default</p>
|
||||
<p> 3. @now – today's date.</p>
|
||||
<p> In result, we subtract 26 days from 25.03.2020 and end up on 29.02.2020.</p>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,9 +1,12 @@
|
|||
|
||||
# <H1 align="center">Module «Close Excel-file»</h1>
|
||||
|
||||
<p> Excel module works with files in the following way – as soon as it starts working with a file, the robot opens it (in the background so the user can't notice it) and keeps it open until the robot finishes. This was implemented to speed up the work of the Excel module, for example if there are multiple modules working with a single file, you would have to open and save the file the amount of times it was used, which would slow down the process. Because of that the file opens at the start and saves only one time, at the end. But! Because the file is opened you can't do anything with it – changing the directory of the file, renaming, putting it to an archive, because it's in use. For these kinds of tasks there is a separate module «Close Excel file» - this module closes the specified files. If these files are going to be used again, they will be opened and next time will be closed with this module or in the end of the work of the robot.</p>
|
||||
|
||||
## Interface of the module
|
||||
|
||||
<p> Interface of the module consists of one field and the list of paths to the files which you need to close.</p>
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> Field «Path to the file» is filled with the path to the file you need to close. It can be in a variable or you can choose it manually by pressing the button with a folder on it.</p>
|
||||
<p> By clicking the «Add» button the path specified in the «Path to the file» field will be added in the «List of files».</p>
|
||||
<p> By clicking the «Delete» buttons you can delete the path from the «List of files».</p>
|
||||
|
|
@ -1,40 +1,54 @@
|
|||
|
||||
# <H1 align="center">Module «Condition»</h1>
|
||||
|
||||
<p> The modules described in this part do nothing by themselves, they should be used together with other modules. The described modules (except «Break»), in addition to the usual «Note» field, have a few more parameters that are required to fill out, but there is no separate settings window.
|
||||
<p> The modules described in this part do nothing by themselves, they should be used together with other modules. The described modules (except «Break»), in addition to the usual «Note» field, have a few more parameters that are required to fill out, but there is no separate settings window.</p>
|
||||
<p> Module «Condition» module allows you to perform certain actions depending on the specified condition. The condition itself doesn't matter as long as it comes down to «True» or «False».</p>
|
||||
|
||||
## Module interface
|
||||
<p> Module consists of the fields «Note» and «Condition». Actions that must be performed when the value of the condition is «True», are added to the «THEN» section, if the value is «False» - to the «ELSE» section. Actions are added to the module by dragging them from the menu or another place in the workspace.
|
||||
<H1 align="center"></h1>
|
||||
<p> The «Note» field is designed for robot creators to leave notes/comments.
|
||||
<p> The «Condition» field is filled according to the rules of the C# programming language. For users unfamiliar with this language, help is offered in the form of a «Constructor of conditions», accessible by clicking the button  to the right of the condition.
|
||||
|
||||
<p> Module consists of the fields «Note» and «Condition». Actions that must be performed when the value of the condition is «True», are added to the «THEN» section, if the value is «False» - to the «ELSE» section. Actions are added to the module by dragging them from the menu or another place in the workspace.</p>
|
||||
|
||||
<p> The «Note» field is designed for robot creators to leave notes/comments.</p>
|
||||
<p> The «Condition» field is filled according to the rules of the C# programming language. For users unfamiliar with this language, help is offered in the form of a «Constructor of conditions», accessible by clicking the button  to the right of the condition.</p>
|
||||
|
||||
## Constructor of conditions
|
||||
<p> Constructor of conditions allows creating conditions in accordance with the syntax of the C # language.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> Constructor of conditions allows creating conditions in accordance with the syntax of the C # language.</p>
|
||||
|
||||
|
||||
### Adding
|
||||
<p> In order to make a condition, it is necessary to fill in both operands, select the type of operands (rows or numbers), select the operator between them from the proposed one and click on the «Add» button:
|
||||
<H1 align="center"></h1>
|
||||
<H1 align="center"></h1>
|
||||
<p> The list of operations for rows and for numbers is different, so first select the type of operands, and only then the operation.
|
||||
|
||||
<p> In order to make a condition, it is necessary to fill in both operands, select the type of operands (rows or numbers), select the operator between them from the proposed one and click on the «Add» button:</p>
|
||||
|
||||
|
||||
<p> The list of operations for rows and for numbers is different, so first select the type of operands, and only then the operation.</p>
|
||||
|
||||
### Binding
|
||||
<p> You can bind multiple conditions with logical «AND» or logical «OR».
|
||||
<p> This is done as follows - holding the Shift key selects several conditions that must be connected by one operator, then the button with the corresponding logical operator is pressed:
|
||||
<H1 align="center"></h1>
|
||||
<H1 align="center"></h1>
|
||||
<p> The «||» symbol means logical OR, the «&&» symbol means logical AND.
|
||||
|
||||
<p> You can bind multiple conditions with logical «AND» or logical «OR».</p>
|
||||
<p> This is done as follows - holding the Shift key selects several conditions that must be connected by one operator, then the button with the corresponding logical operator is pressed:</p>
|
||||
|
||||
|
||||
<p> The «||» symbol means logical OR, the «&&» symbol means logical AND.</p>
|
||||
|
||||
### Unbinding
|
||||
<p> Conditions that consist of several simple conditions, meaning, those that use a logical AND or OR, can be disconnected by clicking on the «Unbind» button. Disconnection is done by logical operators.
|
||||
<H1 align="center"></h1>
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> Conditions that consist of several simple conditions, meaning, those that use a logical AND or OR, can be disconnected by clicking on the «Unbind» button. Disconnection is done by logical operators.</p>
|
||||
|
||||
|
||||
|
||||
### Saving
|
||||
<p> To save the condition, press the «Save» button. The final condition is inserted to the «Condition» field of the conditional module:
|
||||
<H1 align="center"></h1>
|
||||
<H1 align="center"></h1>
|
||||
<p> Finished module will look like this:
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> To save the condition, press the «Save» button. The final condition is inserted to the «Condition» field of the conditional module:</p>
|
||||
|
||||
|
||||
<p> Finished module will look like this:</p>
|
||||
|
||||
|
||||
### Minimize
|
||||
<p> To reduce occupied workspace you can click the «Minimize» button to minimize actions included in this module.
|
||||
<H1 align="center"></h1>
|
||||
<p> You can also change the size of sections «THEN» and «ELSE» up to completely minimizing one of them, for example, if one of them is not being used.
|
||||
<H1 align="center"></h1>
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> To reduce occupied workspace you can click the «Minimize» button to minimize actions included in this module.</p>
|
||||
|
||||
<p> You can also change the size of sections «THEN» and «ELSE» up to completely minimizing one of them, for example, if one of them is not being used.</p>
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,15 +1,17 @@
|
|||
|
||||
# <H1 align="center">«Cycle» module</h1>
|
||||
|
||||
<p> The «Cycle» module is used to repeatedly perform a set of actions. Actions added to the module will be performed until the number of iterations specified in the settings has passed. </p>
|
||||
|
||||
## Module interface
|
||||
<p> Module consists of the fields «Note», «Number of iterations» and «Variable». The actions to be performed in the cycle are added to the block located at the bottom of the module. Actions are added to the module by dragging them from the menu or other part of the workspace.
|
||||
<p> The module looks like this:
|
||||
<H1 align="center"></h1>
|
||||
<p> The «Note» field, as in other modules. This field is used for adding a comment from a robot's creator.
|
||||
<p> The «Number of iterations» field is intended to enter a number that indicates how many times it is necessary to perform the actions contained in the module.
|
||||
<p> The «Variable» field - the variable in which the number will be stored - the current step of the cycle. The cycle starts with one.
|
||||
<p> An example of a completed cycle is shown:
|
||||
<H1 align="center"></h1>
|
||||
<p> By clicking the «Minimize» button you can minimize the cycle actions to display the command more compactly.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> Module consists of the fields «Note», «Number of iterations» and «Variable». The actions to be performed in the cycle are added to the block located at the bottom of the module. Actions are added to the module by dragging them from the menu or other part of the workspace.</p>
|
||||
<p> The module looks like this:</p>
|
||||
|
||||
<p> The «Note» field, as in other modules. This field is used for adding a comment from a robot's creator.</p>
|
||||
<p> The «Number of iterations» field is intended to enter a number that indicates how many times it is necessary to perform the actions contained in the module.</p>
|
||||
<p> The «Variable» field - the variable in which the number will be stored - the current step of the cycle. The cycle starts with one.</p>
|
||||
<p> An example of a completed cycle is shown:</p>
|
||||
|
||||
<p> By clicking the «Minimize» button you can minimize the cycle actions to display the command more compactly.</p>
|
||||
|
||||
|
|
@ -1,8 +1,10 @@
|
|||
|
||||
# <H1 align="center">«Process completion» module</h1>
|
||||
|
||||
<p> The «Process completion» module is intended to finish already started processes by their name and id.</p>
|
||||
|
||||
## Module interface.
|
||||
<p> The window consists of two fields - the name and the id of the process.
|
||||
<H1 align="center"></h1>
|
||||
<p> If a process was launched through the «Process startup» module, then the variables specified in the fields with the same name in the process launch window are transferred to these fields. Otherwise if you only know the name of the process that you wanna complete, you can just enter it, (!) but in this case all processes with the similar name will be finished. For example, if you want to close an Excel file and just enter «Excel», then all opened excel files will be closed.
|
||||
|
||||
<p> The window consists of two fields - the name and the id of the process.</p>
|
||||
|
||||
<p> If a process was launched through the «Process startup» module, then the variables specified in the fields with the same name in the process launch window are transferred to these fields. Otherwise if you only know the name of the process that you wanna complete, you can just enter it, (!) but in this case all processes with the similar name will be finished. For example, if you want to close an Excel file and just enter «Excel», then all opened excel files will be closed.</p>
|
||||
|
|
|
|||
|
|
@ -1,18 +1,24 @@
|
|||
|
||||
# <H1 align="center">«ABYY Fine reader OCP» module </h1>
|
||||
|
||||
<p> The «ABYY fine reader OCP» works with PDF files. Unlike the previous module, it has higher accuracy and speed.</p>
|
||||
<p> The recognition result is recorded in an object variable, in which you can refer to a specific row, table, word.</p>
|
||||
|
||||
## Module interface
|
||||
<p> This module consists of two fields – «Pth to pdf file» and «Variable».
|
||||
<H1 align="center"></h1>
|
||||
<p> The «Path to pdf file» field. The path to the picture/file you wanna recognise is specified here.
|
||||
<p> The «Variable» field. The name of a variable is put into this field.
|
||||
<p> A PDF file may consist of several pages, so the variable will be a list of pages. For example, @text [0] is the first recognized page of a file.
|
||||
<p> All recognized text is divided into two parts - the main text and the tabular part
|
||||
|
||||
<p> This module consists of two fields – «Pth to pdf file» and «Variable».</p>
|
||||
|
||||
<p> The «Path to pdf file» field. The path to the picture/file you wanna recognise is specified here.</p>
|
||||
<p> The «Variable» field. The name of a variable is put into this field.</p>
|
||||
<p> A PDF file may consist of several pages, so the variable will be a list of pages. For example, @text [0] is the first recognized page of a file.</p>
|
||||
<p> All recognized text is divided into two parts - the main text and the tabular part</p>
|
||||
|
||||
## Main text
|
||||
|
||||
To access the text, you must refer to the rows_word [0] field (in this record, [0] means that the first text part is being accessed. In other versions of ABBYY, a larger text splitting is possible). Then it is indicated, as a separate field, the number of the line, and separated by a dot the word number in the line - @text[0].rows_word[0].2.4. Then, after selecting the right word, you can get its value, by referring to the value field - @text[0].rows_word[0].2.4.value – this line will return the value of the word, located on the first page of the recognised document, in the second line and is fourth on the left.
|
||||
|
||||
## The tabular part
|
||||
<p> To access the field you need to refer to the tables[0] field ([0] is needed for the proper work of the robot, its semantic part is embedded in the ABBYY product). Then, the number of the table is indicated as a separate field, because there can be several tables on one sheet - @text[0].tables[0].0. After that, the number of the cell in the table is entered as a single number. If you want to find a cell and know its column and row number, you can get the index of the cell in the variable in the form of "row, column" by referring to the the index field - @text [0].tables[0].0.5.index (5 - fifth cell in an array of recognized cells). To get a values from a cell, you need to refer to its value, and then either collect the entire string written to the cell, or refer to a specific word by its serial number - @text[0].tables[0].0.5.value.1.value - the value of the second word from the fifth cell of the first table from the first page of the recognized text.
|
||||
<p> To get the amount of cells in the table you can use this construction - @text[0].tables[0].0[%], specify the set of characters «[%]» after the field after which there is a field, the number of elements of which you need to find .
|
||||
<p> To get the amount of words in a cell you can use this construction - @text[0].tables[0].0.5[%].
|
||||
|
||||
<p> To access the field you need to refer to the tables[0] field ([0] is needed for the proper work of the robot, its semantic part is embedded in the ABBYY product). Then, the number of the table is indicated as a separate field, because there can be several tables on one sheet - @text[0].tables[0].0. After that, the number of the cell in the table is entered as a single number. If you want to find a cell and know its column and row number, you can get the index of the cell in the variable in the form of "row, column" by referring to the the index field - @text [0].tables[0].0.5.index (5 - fifth cell in an array of recognized cells). To get a values from a cell, you need to refer to its value, and then either collect the entire string written to the cell, or refer to a specific word by its serial number - @text[0].tables[0].0.5.value.1.value - the value of the second word from the fifth cell of the first table from the first page of the recognized text.</p>
|
||||
<p> To get the amount of cells in the table you can use this construction - @text[0].tables[0].0[%], specify the set of characters «[%]» after the field after which there is a field, the number of elements of which you need to find .</p>
|
||||
<p> To get the amount of words in a cell you can use this construction - @text[0].tables[0].0.5[%].</p>
|
||||
|
|
|
|||
|
|
@ -1,66 +1,108 @@
|
|||
|
||||
# <H1 align="center">Module «Work with files</h1>
|
||||
|
||||
<p> The «Work with files» module is designed for changing file directory, copying them, archiving them, making folders and transfer files to it, in general, to manipulate files and directories.</p>
|
||||
|
||||
## Module interface
|
||||
<p> Module widow has three groups of elements.
|
||||
<p> First group of elements is a number of fields and buttons for creating a command. Second group of elements is a list of commands. And the third group of elements is a preview area for viewing text files.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> Module widow has three groups of elements.</p>
|
||||
<p> First group of elements is a number of fields and buttons for creating a command. Second group of elements is a list of commands. And the third group of elements is a preview area for viewing text files.</p>
|
||||
|
||||
|
||||
## Module functionality
|
||||
|
||||
### Creating a command
|
||||
<p> To create a command you need to – select the desired action, fill out the remaining fields – click the «Add» button, and the command will be added to the «Command list».
|
||||
|
||||
<p> To create a command you need to – select the desired action, fill out the remaining fields – click the «Add» button, and the command will be added to the «Command list».</p>
|
||||
|
||||
### Editing a command
|
||||
<p> To edit a command you need to select it from the list of commands by left-clicking on it, after which all fields in the top left part of the «Work with files» window will be filled in accordance with the selected command. Change the fields you want to edit, making sure that the action you're editing is still selected in the command list.
|
||||
|
||||
<p> To edit a command you need to select it from the list of commands by left-clicking on it, after which all fields in the top left part of the «Work with files» window will be filled in accordance with the selected command. Change the fields you want to edit, making sure that the action you're editing is still selected in the command list.</p>
|
||||
|
||||
### Deleting a command
|
||||
<p> In order to delete a command select it in the command list and press the «Delete» button.
|
||||
|
||||
<p> In order to delete a command select it in the command list and press the «Delete» button.</p>
|
||||
|
||||
### Turning on/off a command
|
||||
<p> You can turn the commands on and off. Turned off commands won't run. You can do that by right-clicking on the command and pressing «Turn on/off».
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> You can turn the commands on and off. Turned off commands won't run. You can do that by right-clicking on the command and pressing «Turn on/off».</p>
|
||||
|
||||
|
||||
### Choosing file/folder
|
||||
<p> The button  in fill out fields opens up a standard dialog window for choosing a file or a folder, depending on a selected action.
|
||||
|
||||
<p> The button  in fill out fields opens up a standard dialog window for choosing a file or a folder, depending on a selected action.</p>
|
||||
|
||||
## List and description of actions
|
||||
|
||||
### Action «Save in file»
|
||||
<p> Action rewrites the existing file, by adding text entered in the «Value» field.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> Action rewrites the existing file, by adding text entered in the «Value» field.</p>
|
||||
|
||||
|
||||
### Action «Read file»
|
||||
<p> Action reads all text from the existing file and enters it to the specified variable.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> Action reads all text from the existing file and enters it to the specified variable.</p>
|
||||
|
||||
|
||||
### Action «Get list of file in folder»
|
||||
<p> The action creates a list-variable that contains paths to each file in the folder.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> The action creates a list-variable that contains paths to each file in the folder.</p>
|
||||
|
||||
|
||||
### Action «Move file»
|
||||
<p> Action moves the file into the specified folder.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> Action moves the file into the specified folder.</p>
|
||||
|
||||
|
||||
### Action «Move folder»
|
||||
<p> Action moves the folder, specified in the second field into the directory specified in the third field.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> Action moves the folder, specified in the second field into the directory specified in the third field.</p>
|
||||
|
||||
|
||||
### Action «Archive folder»
|
||||
<p> Action creates a ZIP archive with the specified name, adding the contents of the selected folder to it.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> Action creates a ZIP archive with the specified name, adding the contents of the selected folder to it.</p>
|
||||
|
||||
|
||||
### Action «Unzip archive»
|
||||
<p> Action unzips a ZIP archive into the specified folder.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> Action unzips a ZIP archive into the specified folder.</p>
|
||||
|
||||
|
||||
### Action «Create folder»
|
||||
<p> Action creates a folder with a specified name in the selected directory.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> Action creates a folder with a specified name in the selected directory.</p>
|
||||
|
||||
|
||||
### Action «Delete folder»
|
||||
<p> Action deletes the selected folder.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> Action deletes the selected folder.</p>
|
||||
|
||||
|
||||
### Action «Create .txt file»
|
||||
<p> Action creates a file with .txt extension.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> Action creates a file with .txt extension.</p>
|
||||
|
||||
|
||||
### Action «Delete file»
|
||||
<p> Action deletes the selected file.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> Action deletes the selected file.</p>
|
||||
|
||||
|
||||
### Action «Copy file»
|
||||
<p> Action copies the selected file to the specified directory.
|
||||
<p> In the «Path to the destination file» field enter the path to the folder into which the file should be copied, and its name with the extension as if the file already exists. The new name may differ from the original.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> Action copies the selected file to the specified directory.</p>
|
||||
<p> In the «Path to the destination file» field enter the path to the folder into which the file should be copied, and its name with the extension as if the file already exists. The new name may differ from the original.</p>
|
||||
|
||||
|
||||
### Action «Check file existence»
|
||||
<p> Action checks the existence of the specified file and projects the result to the variable.
|
||||
<p> «True» - if exists, «False» - if it doesn't.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> Action checks the existence of the specified file and projects the result to the variable.</p>
|
||||
<p> «True» - if exists, «False» - if it doesn't.</p>
|
||||
|
||||
|
||||
### Action «Check folder existence»
|
||||
<p> Action checks the existence of the specified folder and projects the result to the variable.
|
||||
<p> «True» - if exists, «False» - if it doesn't.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> Action checks the existence of the specified folder and projects the result to the variable.</p>
|
||||
<p> «True» - if exists, «False» - if it doesn't.</p>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,3 +1,4 @@
|
|||
|
||||
# <H1 align="center">«HTTP_GET» module</h1>
|
||||
|
||||
<p> Http-requests - requests for transferring information between sites (or servers) and clients (for example, us).</p>
|
||||
|
|
@ -5,8 +6,9 @@
|
|||
<p> To work with the received answers, you can use the «Parsing JSON» module (if, of course, the requested data format was the same).</p>
|
||||
|
||||
## Module interface
|
||||
<p> This module consists of the following fields: «Link», «Login», «Password» and «Variable».
|
||||
<H1 align="center"></h1>
|
||||
<p> The «Link» field . The required URL is entered into the field.
|
||||
<p> The «Variable» field. The name of the variable in which the response will be placed is entered in the field.
|
||||
<p> The «Login» and «Password» fields. Are intended for entering the login and password, because some sites use the protection of their information and request authorization.
|
||||
|
||||
<p> This module consists of the following fields: «Link», «Login», «Password» and «Variable».</p>
|
||||
|
||||
<p> The «Link» field . The required URL is entered into the field.</p>
|
||||
<p> The «Variable» field. The name of the variable in which the response will be placed is entered in the field.</p>
|
||||
<p> The «Login» and «Password» fields. Are intended for entering the login and password, because some sites use the protection of their information and request authorization.</p>
|
||||
|
|
|
|||
|
|
@ -1,12 +1,14 @@
|
|||
|
||||
# <H1 align="center">Module «HTTP_POST»</h1>
|
||||
|
||||
<p> The «HTTP_POST» module is designed to send Post-requests using the http protocol.</p>
|
||||
|
||||
## Module interface
|
||||
<p> The form for sending a Post-request is similar to the form for sending a Get-request, with only one difference - there is a field for entering the request itself.
|
||||
<H1 align="center"></h1>
|
||||
<p> The «Link» field. The desired URL address is entered into the field.
|
||||
<p> The «Variable» field. The name of the variable in which the response will be placed is entered in the field.
|
||||
<p> The «Login» and «Password» fields. Are intended for entering the login and password, because some sites use the protection of their information and request authorization.
|
||||
<p> The «Request» field. An HTTP message is entered in the field, according to the general rules of its structure.
|
||||
|
||||
<p> The form for sending a Post-request is similar to the form for sending a Get-request, with only one difference - there is a field for entering the request itself.</p>
|
||||
|
||||
<p> The «Link» field. The desired URL address is entered into the field.</p>
|
||||
<p> The «Variable» field. The name of the variable in which the response will be placed is entered in the field.</p>
|
||||
<p> The «Login» and «Password» fields. Are intended for entering the login and password, because some sites use the protection of their information and request authorization.</p>
|
||||
<p> The «Request» field. An HTTP message is entered in the field, according to the general rules of its structure.</p>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,16 +1,18 @@
|
|||
|
||||
# <H1 align="center">«Image search» module</h1>
|
||||
|
||||
<p> The «Image search» module is usually used with the «Clicker» module. The module is designed to determine whether the selected image is present on the screen, and if it is, return the coordinates of its location. </p>
|
||||
|
||||
## Module interface
|
||||
<p> Window of this module looks like this:
|
||||
<H1 align="center"></h1>
|
||||
<p> The «Pick image» and «Select image» buttons allow you to select an image to search.
|
||||
<p> The «x coordinate» field. In the field, a variable is entered into which the x coordinate of the searched image will be written.
|
||||
<p> The «y coordinate» field. Similar to the «x coordinate» field.
|
||||
<p> The «Result» field. The name of the variable is gonna be entered into the field. The final result of the image search will be entered into the variable. The resulting value will be presented as a string: «true» - found, «false» - not found.
|
||||
<p> The «Number of attempts», «Pause» and «Match rate» fields are similar to the fields of the «Clicker» module.
|
||||
<p> The «Number of attempts» field. The field indicates the number of attempts made for image search.
|
||||
<p> The «Pause» field. The field is designed for creating a pause after an executed command. The pause is specified in milliseconds.
|
||||
<p> The «Match rate» field - percentage of how much the image to be searched matches with the image fragment on the current screen. A number is entered from 0 to 100, the more, the more similarities between the images should be.
|
||||
|
||||
<p> Window of this module looks like this:</p>
|
||||
|
||||
<p> The «Pick image» and «Select image» buttons allow you to select an image to search.</p>
|
||||
<p> The «x coordinate» field. In the field, a variable is entered into which the x coordinate of the searched image will be written.</p>
|
||||
<p> The «y coordinate» field. Similar to the «x coordinate» field.</p>
|
||||
<p> The «Result» field. The name of the variable is gonna be entered into the field. The final result of the image search will be entered into the variable. The resulting value will be presented as a string: «true» - found, «false» - not found.</p>
|
||||
<p> The «Number of attempts», «Pause» and «Match rate» fields are similar to the fields of the «Clicker» module.</p>
|
||||
<p> The «Number of attempts» field. The field indicates the number of attempts made for image search.</p>
|
||||
<p> The «Pause» field. The field is designed for creating a pause after an executed command. The pause is specified in milliseconds.</p>
|
||||
<p> The «Match rate» field - percentage of how much the image to be searched matches with the image fragment on the current screen. A number is entered from 0 to 100, the more, the more similarities between the images should be.</p>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,15 +1,19 @@
|
|||
|
||||
# <H1 align="center">«Images search»</h1>
|
||||
|
||||
<p> This module is similar to the «Image search» module, the only difference that this module returns a list of all found images, not just one.</p>
|
||||
|
||||
## Module interface
|
||||
<p> Interface of this module is also similar to the «Image search», but instead of «x coordinate», «y coordinate» and «result» fields there is only one field – «Variable», and also the «Minimal distance» field has appeared.
|
||||
<H1 align="center"></h1>
|
||||
<p> In the «Variable» field the variable name is entered, in which the search result will be indicated.
|
||||
<p> The «Number of attempts» field is filled in with a number of attempts made for searching an image.
|
||||
<p> The «Pause» field is designed for creating a pause after an attempt for image search. The pause is specified in milliseconds.
|
||||
<p> The «Match rate» field - percentage of how much the image to be searched matches with the image fragment on the current screen. A number is entered from 0 to 100, the more, similarities between the images should be.
|
||||
<p> The «Minimal distance» field is filled with the number of pixels indicating how many pixels should be minimum between two identical images. If some image is too close to what was found first, then it will not be included in the list of found images. Please note that if this distance is set very small or equal to 0, then one image can be found several times!
|
||||
|
||||
<p> Interface of this module is also similar to the «Image search», but instead of «x coordinate», «y coordinate» and «result» fields there is only one field – «Variable», and also the «Minimal distance» field has appeared.</p>
|
||||
|
||||
<p> In the «Variable» field the variable name is entered, in which the search result will be indicated.</p>
|
||||
<p> The «Number of attempts» field is filled in with a number of attempts made for searching an image.</p>
|
||||
<p> The «Pause» field is designed for creating a pause after an attempt for image search. The pause is specified in milliseconds.</p>
|
||||
<p> The «Match rate» field - percentage of how much the image to be searched matches with the image fragment on the current screen. A number is entered from 0 to 100, the more, similarities between the images should be.</p>
|
||||
<p> The «Minimal distance» field is filled with the number of pixels indicating how many pixels should be minimum between two identical images. If some image is too close to what was found first, then it will not be included in the list of found images. Please note that if this distance is set very small or equal to 0, then one image can be found several times!</p>
|
||||
|
||||
## Output data
|
||||
<p> A list of objects will be written into the specified variable, the number of which will be equal to the number of images found on the screen. Every object matches the found image. To refer to a specific image of the list, it is necessary to indicate its number (numbering from 0) in square brackets after the variable name, for example @listImages[0].
|
||||
<p> Every object contains three fields: «x», «y» and «similarity». The «x» field contains the x coordinate of the selected image, the «y» field - y coordinate, and the «similarity» field - contains the percentage of similarity of the found image with the desired one.
|
||||
|
||||
<p> A list of objects will be written into the specified variable, the number of which will be equal to the number of images found on the screen. Every object matches the found image. To refer to a specific image of the list, it is necessary to indicate its number (numbering from 0) in square brackets after the variable name, for example @listImages[0].</p>
|
||||
<p> Every object contains three fields: «x», «y» and «similarity». The «x» field contains the x coordinate of the selected image, the «y» field - y coordinate, and the «similarity» field - contains the percentage of similarity of the found image with the desired one.</p>
|
||||
|
|
|
|||
164
docs/Iterface.md
164
docs/Iterface.md
|
|
@ -1,87 +1,103 @@
|
|||
|
||||
# <H1 align="center">MODULE «INTERFACE»</h1>
|
||||
|
||||
<p> This robot is designed for creating dialog windows for communicating with the user of the robot. It can be windows that allow you to attach a file, enter any data - date, names, mailing addresses, and other things that the robot will subsequently work with or vice versa windows that display the result of work.</p>
|
||||
<p> To create a window you need to add controls to it - interface elements such as labels, text fields, buttons, drop-down lists.</p>
|
||||
|
||||
## The main window
|
||||
<p> Module window consists of the following parts:
|
||||
<p> ● Window settings - general settings for the dialog window;
|
||||
<p> ● Interface Item Settings - Configure the item you need to add;
|
||||
<p> ● List of elements - a table that contains all the added elements;
|
||||
<p> ● A window with a preview of the current dialog window (right side of the window).
|
||||
<H1 align="center"></h1>
|
||||
<p> You should start working with a dialog window from the grid settings, which can be opened using the «Grid settings» button.
|
||||
|
||||
<p> Module window consists of the following parts:</p>
|
||||
<p> ● Window settings - general settings for the dialog window;</p>
|
||||
<p> ● Interface Item Settings - Configure the item you need to add;</p>
|
||||
<p> ● List of elements - a table that contains all the added elements;</p>
|
||||
<p> ● A window with a preview of the current dialog window (right side of the window).</p>
|
||||
|
||||
<p> You should start working with a dialog window from the grid settings, which can be opened using the «Grid settings» button.</p>
|
||||
|
||||
## Window settings
|
||||
<p> Window settings include the«Title», its width and height, and grid settings. By clicking the «Fullscreen» checkbox fields «Height» and «Width» won't be taken into account.
|
||||
<p> By clicking the «Grid settings» button a window for grid and column settings appears.
|
||||
<H1 align="center"></h1>
|
||||
<p> A grid is a conditional markup of interface elements, a table in which controls will be placed into. For example if you need to create a window in which the user would enter 2 parameters – the starting and the finishing date, between which you need to download emails, then you can configure dialog windows in several ways.
|
||||
<p> ● First method
|
||||
<p> - in two rows, 4 interface elements - on the first row a signature and a field for entering the start date, on the second row a signature and a field for entering the end date
|
||||
<H1 align="center"></h1>
|
||||
<p> For this grid setting, you need to specify two columns - the first for inscriptions, the second for input fields, and two rows - the first for the start date, the second for the end.
|
||||
<p> ● Second method
|
||||
<p> - in one row, 3 interface elements – signature, field for entering the first date, field for entering the second date.
|
||||
<H1 align="center"></h1>
|
||||
<p> In this case 3 columns and 1 row is used.
|
||||
<p> ● Third method
|
||||
<p> - In one row, 4 interface elements – two input fields and signatures to every one of them.
|
||||
<H1 align="center"></h1>
|
||||
<p> In this case 4 columns and 1 row is used
|
||||
<p> You can specify the width for every column, and the height for every row
|
||||
<H1 align="center"></h1>
|
||||
<p> The height and width are entered in pixels, but you can use the relative dimensions of the window, for example, if one column should be twice as large as the other and there are only two of them, then in the «Ширина» field you can enter «1*» for the first column, and «2*» for the second:
|
||||
<H1 align="center"></h1>
|
||||
<p> The result of this layout:
|
||||
<H1 align="center"></h1>
|
||||
<p> Row and column numbering starts at 0. You can delete the row or column you don't need with a «Delete» button, and you can change the height or the width with the «Edit» button.
|
||||
<p> After adjusting the grid, it will be displayed with a dashed line in the preview window on the right side of the main window, and then you can start adding controls.
|
||||
|
||||
<p> Window settings include the«Title», its width and height, and grid settings. By clicking the «Fullscreen» checkbox fields «Height» and «Width» won't be taken into account.</p>
|
||||
<p> By clicking the «Grid settings» button a window for grid and column settings appears.</p>
|
||||
|
||||
<p> A grid is a conditional markup of interface elements, a table in which controls will be placed into. For example if you need to create a window in which the user would enter 2 parameters – the starting and the finishing date, between which you need to download emails, then you can configure dialog windows in several ways.</p>
|
||||
<p> ● First method</p>
|
||||
<p> - in two rows, 4 interface elements - on the first row a signature and a field for entering the start date, on the second row a signature and a field for entering the end date</p>
|
||||
|
||||
<p> For this grid setting, you need to specify two columns - the first for inscriptions, the second for input fields, and two rows - the first for the start date, the second for the end.</p>
|
||||
<p> ● Second method</p>
|
||||
<p> - in one row, 3 interface elements – signature, field for entering the first date, field for entering the second date.</p>
|
||||
|
||||
<p> In this case 3 columns and 1 row is used.</p>
|
||||
<p> ● Third method</p>
|
||||
<p> - In one row, 4 interface elements – two input fields and signatures to every one of them.</p>
|
||||
|
||||
<p> In this case 4 columns and 1 row is used</p>
|
||||
<p> You can specify the width for every column, and the height for every row</p>
|
||||
|
||||
<p> The height and width are entered in pixels, but you can use the relative dimensions of the window, for example, if one column should be twice as large as the other and there are only two of them, then in the «Ширина» field you can enter «1*» for the first column, and «2*» for the second:</p>
|
||||
|
||||
<p> The result of this layout:</p>
|
||||
|
||||
<p> Row and column numbering starts at 0. You can delete the row or column you don't need with a «Delete» button, and you can change the height or the width with the «Edit» button.</p>
|
||||
<p> After adjusting the grid, it will be displayed with a dashed line in the preview window on the right side of the main window, and then you can start adding controls.</p>
|
||||
|
||||
## Adding an interface element
|
||||
<p> To add a new element you need to fill in the fields demonstrated on the Figure
|
||||
<H1 align="center"></h1>
|
||||
<p> All fields are necessary except «Merge rows/columns»..
|
||||
|
||||
<p> To add a new element you need to fill in the fields demonstrated on the Figure</p>
|
||||
|
||||
<p> All fields are necessary except «Merge rows/columns»..</p>
|
||||
|
||||
## Field «Type»
|
||||
<H1 align="center"></h1>
|
||||
<p> First, the type of the added interface element is selected from the ones proposed:
|
||||
<p> ● Input field - a field into which you can enter any line;
|
||||
<H1 align="center"></h1>
|
||||
<p> ● Caption - a static line of text that cannot be edited by the user;
|
||||
<H1 align="center"></h1>
|
||||
<p> ● Drop-down list - a field with an arrow on the side, by clicking on it a list of predefined values is going to be opened;
|
||||
<H1 align="center"></h1>
|
||||
<p> ● Table - a table view of a previously created variable. It is possible to edit table fields, but it is impossible to create new columns in it;
|
||||
<H1 align="center"></h1>
|
||||
<p> ● Date selection - a field with a calendar icon, by clicking on which the user will be asked to select a specific date. You can enter the date value manually; when entering other lines, the field will automatically select the most suitable date for the entered data. Date format DD.MM.YYYY;
|
||||
<H1 align="center"></h1>
|
||||
<p> ● File selection - a field with an icon in the form of three dots, by clicking on which the user will be asked to select a file. The path to the selected file is written to this field;
|
||||
<H1 align="center"></h1>
|
||||
<p> ● Selecting a folder – пa field with an icon in the form of three dots, by clicking on which the user will be asked to select a folder. The path to the selected folder is written to this field. Looks exactly like «File selection».
|
||||
|
||||
|
||||
<p> First, the type of the added interface element is selected from the ones proposed:</p>
|
||||
<p> ● Input field - a field into which you can enter any line;</p>
|
||||
|
||||
<p> ● Caption - a static line of text that cannot be edited by the user;</p>
|
||||
|
||||
<p> ● Drop-down list - a field with an arrow on the side, by clicking on it a list of predefined values is going to be opened;</p>
|
||||
|
||||
<p> ● Table - a table view of a previously created variable. It is possible to edit table fields, but it is impossible to create new columns in it;</p>
|
||||
|
||||
<p> ● Date selection - a field with a calendar icon, by clicking on which the user will be asked to select a specific date. You can enter the date value manually; when entering other lines, the field will automatically select the most suitable date for the entered data. Date format DD.MM.YYYY;</p>
|
||||
|
||||
<p> ● File selection - a field with an icon in the form of three dots, by clicking on which the user will be asked to select a file. The path to the selected file is written to this field;</p>
|
||||
|
||||
<p> ● Selecting a folder – пa field with an icon in the form of three dots, by clicking on which the user will be asked to select a folder. The path to the selected folder is written to this field. Looks exactly like «File selection».</p>
|
||||
|
||||
## Field «Data source»
|
||||
<p> Enter the name of the variable or a string on the basis of which the control will be filled in this field.Немного поподробнее о поле при выборе различных элементов интерфейса:
|
||||
<p> ● For the «Signature» element type a value is entered there, which should be showed in the displayed label;
|
||||
<p> ● For «Input field», «Date selection», «File selection» and «Folder selection» a value is entered that will be immediately indicated in the field, if necessary. If you want the field to be blank, you shouldn't fill «Data source»;
|
||||
<p> ● For «Table» you must submit a completed table variable to display it;
|
||||
<p> ● For the «Drop-down list» interface element it is necessary to transfer a set of values that the user will be offered to select. It is done through the «;» symbol. These can be rows, element variables, list variables, or table variables consisting of a single column. For example, the following value was entered in the following examples of filling in variables:
|
||||
<H1 align="center"></h1>
|
||||
<H1 align="center"></h1>
|
||||
<H1 align="center"></h1>
|
||||
<p> The result will look like this:
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> Enter the name of the variable or a string on the basis of which the control will be filled in this field.Немного поподробнее о поле при выборе различных элементов интерфейса:</p>
|
||||
<p> ● For the «Signature» element type a value is entered there, which should be showed in the displayed label;</p>
|
||||
<p> ● For «Input field», «Date selection», «File selection» and «Folder selection» a value is entered that will be immediately indicated in the field, if necessary. If you want the field to be blank, you shouldn't fill «Data source»;</p>
|
||||
<p> ● For «Table» you must submit a completed table variable to display it;</p>
|
||||
<p> ● For the «Drop-down list» interface element it is necessary to transfer a set of values that the user will be offered to select. It is done through the «;» symbol. These can be rows, element variables, list variables, or table variables consisting of a single column. For example, the following value was entered in the following examples of filling in variables:</p>
|
||||
|
||||
|
||||
|
||||
<p> The result will look like this:</p>
|
||||
|
||||
|
||||
## Fields «Column» and «Row»
|
||||
<p> In these fields, you must enter the column number and grid lines (tables) in which the added control should be located. For example, in the example with dates (Figure 9.25.2), the control «Label» - «Start date» is located in column 0 and row 0, and the signature «End date» - is in column 0 and row 1.
|
||||
|
||||
<p> In these fields, you must enter the column number and grid lines (tables) in which the added control should be located. For example, in the example with dates (Figure 9.25.2), the control «Label» - «Start date» is located in column 0 and row 0, and the signature «End date» - is in column 0 and row 1.</p>
|
||||
|
||||
## Fields «Merge columns» and «Merge rows»
|
||||
<p> In some cases, it is necessary to display fields not in a specific cell of the grid, but in a combination of cells. For example - you need to prompt the user to select an Excel file to write the results to and enter the start and the end date, according to which data will be collected. It would be nice to merge this in two rows, but to enter the date you need at least 2 fields, and to select a file - one.
|
||||
<H1 align="center"></h1>
|
||||
<p> In order to stretch the field for selecting a file along the length of the fields for entering the date, we need to place it not just in 1 column and 0 row, but also merge two columns for it so that it occupies both at once:
|
||||
<H1 align="center"></h1>
|
||||
<H1 align="center"></h1>
|
||||
<p> When filling out the «Merge columns» field, columns starting from the one indicated in the «Column» field, will be merged into one horizontally.
|
||||
<p> SImilar with the «Merge rows» field - specified amount of rows starting with the one that is specified in the «Row» field, will be merged into one:
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> In some cases, it is necessary to display fields not in a specific cell of the grid, but in a combination of cells. For example - you need to prompt the user to select an Excel file to write the results to and enter the start and the end date, according to which data will be collected. It would be nice to merge this in two rows, but to enter the date you need at least 2 fields, and to select a file - one.</p>
|
||||
|
||||
<p> In order to stretch the field for selecting a file along the length of the fields for entering the date, we need to place it not just in 1 column and 0 row, but also merge two columns for it so that it occupies both at once:</p>
|
||||
|
||||
|
||||
<p> When filling out the «Merge columns» field, columns starting from the one indicated in the «Column» field, will be merged into one horizontally.</p>
|
||||
<p> SImilar with the «Merge rows» field - specified amount of rows starting with the one that is specified in the «Row» field, will be merged into one:</p>
|
||||
|
||||
|
||||
## Field «Variable»
|
||||
<p> The name of the variable is entered into this field, into which the value entered (for the drop-down list - selected) by the user is written. It is a required field for all types of controls, except for the «Label».
|
||||
<p> After filling out all required fields press the «Add» button. After clicking on it, the element will immediately appear in the preview window on the right side of the window.
|
||||
<H1 align="center"></h1>
|
||||
<p> By clicking the «Preview» button a dialog window will be opened in the form in which it will be presented to the user.
|
||||
<p> You can delete or edit an element by first selecting it in the «List of items» area, and then clicking on the corresponding button located above the list with items.
|
||||
<p> After adding all the necessary controls, click the «Save» button in the lower right part of the window.
|
||||
|
||||
<p> The name of the variable is entered into this field, into which the value entered (for the drop-down list - selected) by the user is written. It is a required field for all types of controls, except for the «Label».</p>
|
||||
<p> After filling out all required fields press the «Add» button. After clicking on it, the element will immediately appear in the preview window on the right side of the window.</p>
|
||||
|
||||
<p> By clicking the «Preview» button a dialog window will be opened in the form in which it will be presented to the user.</p>
|
||||
<p> You can delete or edit an element by first selecting it in the «List of items» area, and then clicking on the corresponding button located above the list with items.</p>
|
||||
<p> After adding all the necessary controls, click the «Save» button in the lower right part of the window.</p>
|
||||
|
|
|
|||
22
docs/JSON.md
22
docs/JSON.md
|
|
@ -1,15 +1,19 @@
|
|||
|
||||
# <H1 align="center">«JSON parsing» module </h1>
|
||||
|
||||
<p> This module is designed to process data in the JSON format – parsing JSON-objects. </p>
|
||||
|
||||
## Module interface
|
||||
<p> In the module window three fields for entering values are located: «Variable» and «JSON», and the «Save» и «Cancel» buttons.
|
||||
<H1 align="center"></h1>
|
||||
<p> The «Variable» field. The name of the variable is entered into the «Variable» field, which will be converted into an object variable with the fields available in the JSON object.
|
||||
<p> The «JSON» field. In this field you need to describe the object using the JSON format, in the form of «key»: «value», in square brackets. A JSON object can be described directly by text in the «JSON» field or can be created in the process of executing other modules. If the JSON object is formed in other modules, then you must enter the name of the variable in which the necessary object lies in.
|
||||
|
||||
<p> In the module window three fields for entering values are located: «Variable» and «JSON», and the «Save» и «Cancel» buttons.</p>
|
||||
|
||||
<p> The «Variable» field. The name of the variable is entered into the «Variable» field, which will be converted into an object variable with the fields available in the JSON object.</p>
|
||||
<p> The «JSON» field. In this field you need to describe the object using the JSON format, in the form of «key»: «value», in square brackets. A JSON object can be described directly by text in the «JSON» field or can be created in the process of executing other modules. If the JSON object is formed in other modules, then you must enter the name of the variable in which the necessary object lies in.</p>
|
||||
|
||||
## EXAMPLE
|
||||
<p> Let's say we have text in the JSON format. Let's enter it in the field of the JSON module and the result will be entered into the «@a» variable.<p> Пусть у нас есть текст в формате JSON. Введем его в поле JSON модуля, а результат пусть запишется в переменную @a.
|
||||
<H1 align="center"></h1>
|
||||
<p> As a result, the variable @a will become an object with the fields «name» and «age». You can access the fields of an object by entering the name of the field separated by a dot after the variable. You can check it by using the «Find out the value of variable», feature available by clicking the buttons in the solution explorer.
|
||||
<H1 align="center"></h1>
|
||||
<p> We can see that a variable was created based on the text in the JSON format, with the fields specified in the variable and filled with values.
|
||||
|
||||
<p> Let's say we have text in the JSON format. Let's enter it in the field of the JSON module and the result will be entered into the «@a» variable.<p> Пусть у нас есть текст в формате JSON. Введем его в поле JSON модуля, а результат пусть запишется в переменную @a.</p>
|
||||
|
||||
<p> As a result, the variable @a will become an object with the fields «name» and «age». You can access the fields of an object by entering the name of the field separated by a dot after the variable. You can check it by using the «Find out the value of variable», feature available by clicking the buttons in the solution explorer.</p>
|
||||
|
||||
<p> We can see that a variable was created based on the text in the JSON format, with the fields specified in the variable and filled with values.</p>
|
||||
24
docs/OCR.md
24
docs/OCR.md
|
|
@ -1,16 +1,20 @@
|
|||
|
||||
# <H1 align="center">«Text recognition» module </h1>
|
||||
|
||||
<p> The «Recognition text» module is intended for reading text from a specified image and for representing the resulting text in XML format.</p>
|
||||
|
||||
## Module interface
|
||||
<p> The module consists of two fields – «File path» and «Variable», and the «Screenshot» checkbox.
|
||||
<H1 align="center"></h1>
|
||||
<p> The «File path» field. The field is filled with the direction to the file you need to recognise. This can be a picture or a pdf document.
|
||||
<p> The «Variable» field. The field is filled with the name of the variable starting with «@» in which the recognition result will be placed.
|
||||
<p> The «Screenshot» checkbox. The checkbox is checked when it is necessary to recognize a screenshot of the screen at the time of operation of this module during the execution of the robot. In this case you don't need to specify the «File path».
|
||||
|
||||
<p> The module consists of two fields – «File path» and «Variable», and the «Screenshot» checkbox.</p>
|
||||
|
||||
<p> The «File path» field. The field is filled with the direction to the file you need to recognise. This can be a picture or a pdf document.</p>
|
||||
<p> The «Variable» field. The field is filled with the name of the variable starting with «@» in which the recognition result will be placed.</p>
|
||||
<p> The «Screenshot» checkbox. The checkbox is checked when it is necessary to recognize a screenshot of the screen at the time of operation of this module during the execution of the robot. In this case you don't need to specify the «File path».</p>
|
||||
|
||||
## EXAMPLE
|
||||
<p> Let's say we have the following .jpeg image. We submit it to the text recognition module.
|
||||
<H1 align="center"></h1>
|
||||
<p> The result that is put into the variable:
|
||||
<H1 align="center"></h1>
|
||||
<p> The result contains information about the pages, the coordinate and the meaning of each word in the image.
|
||||
|
||||
<p> Let's say we have the following .jpeg image. We submit it to the text recognition module.</p>
|
||||
|
||||
<p> The result that is put into the variable:</p>
|
||||
|
||||
<p> The result contains information about the pages, the coordinate and the meaning of each word in the image.</p>
|
||||
|
|
|
|||
|
|
@ -1,35 +1,39 @@
|
|||
|
||||
# <H1 align="center">ORCHESTRATOR</h1>
|
||||
|
||||
## General information
|
||||
<p> Robot Orchestrator - a service for launching robots according to a schedule and / or some events. Access to the orchestrator is carried out by pressing a  button in the control panel of the main studio window. After clicking on the button, a window will open allowing you to publish a new robot and / or adjust the launch schedule of already published robots.</p>
|
||||
<H1 align="center"></h1>
|
||||
<p> Orchestrator consists of three parts and a button for publishing the current robot.
|
||||
<p> Parts of the orchestrator:
|
||||
<p> ● Tasks - the part that allows you to create a new task;
|
||||
<p> ● Robots - the list of all published robots by the user;
|
||||
<p> ● List of tasks - the list of all tasks published by the user.
|
||||
<p> The «Publish current robot» adds an already active robot to the list of published robots.
|
||||
<p> After creating all tasks you just need to close the orchestrator window.
|
||||
<p> For the orchestrator to work you need to install the Lexema-RPA Client software that scans all created tasks and launches them according to the schedule in the background. To download it you need to visit this - <a href="http://lexema.ru/solutions/lexema-rpa-programmnye-roboty/lexema-rpa-studio/"> website </a> and select «Download Lexema-RPA Client». User manual for the software is also there.
|
||||
|
||||
Robot Orchestrator - a service for launching robots according to a schedule and / or some events. Access to the orchestrator is carried out by pressing a  button in the control panel of the main studio window. After clicking on the button, a window will open allowing you to publish a new robot and / or adjust the launch schedule of already published robots.
|
||||
|
||||
<p> Orchestrator consists of three parts and a button for publishing the current robot.</p>
|
||||
<p> Parts of the orchestrator:</p>
|
||||
<p> ● Tasks - the part that allows you to create a new task;</p>
|
||||
<p> ● Robots - the list of all published robots by the user;</p>
|
||||
<p> ● List of tasks - the list of all tasks published by the user.</p>
|
||||
<p> The «Publish current robot» adds an already active robot to the list of published robots.</p>
|
||||
<p> After creating all tasks you just need to close the orchestrator window.</p>
|
||||
<p> For the orchestrator to work you need to install the Lexema-RPA Client software that scans all created tasks and launches them according to the schedule in the background. To download it you need to visit this - <a href="http://lexema.ru/solutions/lexema-rpa-programmnye-roboty/lexema-rpa-studio/"> website </a> and select «Download Lexema-RPA Client». User manual for the software is also there.</p>
|
||||
|
||||
## Creating a new task
|
||||
<p> To create a schedule for the robot execution you need to create a task. To configure a task you need to fill in 5 fields – this is the name of the task, choosing a robot from already published, launch time of the robot, amount of retries and launch interval.
|
||||
<H1 align="center"></h1>
|
||||
<p> Task name. The name of the task to run a specific robot, an identifier by which it will be more convenient to navigate among all your tasks.
|
||||
<p> Robot. Choosing a robot to which the task is gonna be applied to. The field is a drop down list with all your published robots
|
||||
<H1 align="center"></h1>
|
||||
<p> First launch. The time of the first launch of the robot after which it's going to be launched with an interval. The date and time is chosen.
|
||||
<p> Retries. Total number of robot retries. If you don't need to launch the robot more than one time you should put 0 in this field. If you need to launch the robot twice a day throughout the week then the amount of retries equals 2*7-1 = 13.
|
||||
<p> Launch time. Time after which the robot needs to be restarted (if there are retries (restarts). To configure this field press the arrow button on the right.
|
||||
<H1 align="center"></h1>
|
||||
<p> By clicking on it, an auxiliary window for selecting the interval will open.
|
||||
<H1 align="center"></h1>
|
||||
<p> If you need the robot to run on the 25th of every month, you need to set the closest 25th of the month, and in the interval settings set interval to «1» in the «Month» line, then the robot will restart every month.
|
||||
<p> The same interval is set between every restart (retry). If you need to run the robot with different intervals, then you need to create multiple tasks of robots execution, for example if you need to run the robot at 10:00 am and at 1:00 pm of the same day throughout the week, then you need to create two tasks, amount of retries of which equals 6 (every day not counting the day of the first start (run), interval of launch – 24 hours or 1 day, the only difference between these tasks is the time of launch – first one at 10:00 am, and the second one – at 13:00.
|
||||
<p> After filling in all fields in the interval window and pressing the «Save» button, in the «Interval» field a line like this will show up «year:month:day:hour:minutes:seconds», for example if you set the interval for 12 hours it will look like this: «0:0:0:12:0:0». The «Interval» field is a necessary field, if the amount of restarts differs from one.
|
||||
<p> An example of a completed task:
|
||||
<H1 align="center"></h1>
|
||||
<p> By clicking the «Add» button, that is located below the fields for configuring tasks, the task is gonna be added to the task list.
|
||||
<H1 align="center"></h1>
|
||||
<p> To edit an existing task you need to find it in the list and click on it (1). Then the fields for configuring the task will fill in with the appropriate fields. Then, after editing the fields (2), you need to press the «Edit» button and the changes will be saved (3).
|
||||
<H1 align="center"></h1>
|
||||
<p> To delete a task you need to find it from the list and then press the «Delete» button.
|
||||
|
||||
<p> To create a schedule for the robot execution you need to create a task. To configure a task you need to fill in 5 fields – this is the name of the task, choosing a robot from already published, launch time of the robot, amount of retries and launch interval.</p>
|
||||
|
||||
<p> Task name. The name of the task to run a specific robot, an identifier by which it will be more convenient to navigate among all your tasks.</p>
|
||||
<p> Robot. Choosing a robot to which the task is gonna be applied to. The field is a drop down list with all your published robots</p>
|
||||
|
||||
<p> First launch. The time of the first launch of the robot after which it's going to be launched with an interval. The date and time is chosen.</p>
|
||||
<p> Retries. Total number of robot retries. If you don't need to launch the robot more than one time you should put 0 in this field. If you need to launch the robot twice a day throughout the week then the amount of retries equals 2*7-1 = 13.</p>
|
||||
<p> Launch time. Time after which the robot needs to be restarted (if there are retries (restarts). To configure this field press the arrow button on the right.</p>
|
||||
|
||||
<p> By clicking on it, an auxiliary window for selecting the interval will open.</p>
|
||||
|
||||
<p> If you need the robot to run on the 25th of every month, you need to set the closest 25th of the month, and in the interval settings set interval to «1» in the «Month» line, then the robot will restart every month.</p>
|
||||
<p> The same interval is set between every restart (retry). If you need to run the robot with different intervals, then you need to create multiple tasks of robots execution, for example if you need to run the robot at 10:00 am and at 1:00 pm of the same day throughout the week, then you need to create two tasks, amount of retries of which equals 6 (every day not counting the day of the first start (run), interval of launch – 24 hours or 1 day, the only difference between these tasks is the time of launch – first one at 10:00 am, and the second one – at 13:00.</p>
|
||||
<p> After filling in all fields in the interval window and pressing the «Save» button, in the «Interval» field a line like this will show up «year:month:day:hour:minutes:seconds», for example if you set the interval for 12 hours it will look like this: «0:0:0:12:0:0». The «Interval» field is a necessary field, if the amount of restarts differs from one.</p>
|
||||
<p> An example of a completed task:</p>
|
||||
|
||||
<p> By clicking the «Add» button, that is located below the fields for configuring tasks, the task is gonna be added to the task list.</p>
|
||||
|
||||
<p> To edit an existing task you need to find it in the list and click on it (1). Then the fields for configuring the task will fill in with the appropriate fields. Then, after editing the fields (2), you need to press the «Edit» button and the changes will be saved (3).</p>
|
||||
|
||||
<p> To delete a task you need to find it from the list and then press the «Delete» button.</p>
|
||||
|
|
@ -1,6 +1,8 @@
|
|||
|
||||
# <H1 align="center">«Pause» module</h1>
|
||||
|
||||
<p> This module is designed for creating a pause between modules. All module configuration consists in filling in one field – «Pause» - the number of seconds you need to wait. The use of a variable is allowed.</p>
|
||||
|
||||
##
|
||||
<H1 align="center"></h1>
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,8 @@
|
|||
|
||||
# <H1 align="center">Модуль «Прокси»</h1>
|
||||
|
||||
<p> Модуль «Прокси» предназначен для создания подключения к прокси-серверу. Для использования модуля необходимо заполнить адрес прокси-сервера.</p>
|
||||
|
||||
##
|
||||
<H1 align="center"></h1>
|
||||
|
||||
|
||||
|
|
@ -1,35 +1,39 @@
|
|||
|
||||
# <H1 align="center">«Read emails» module </h1>
|
||||
|
||||
<p> The «Read emails» module is intended for getting a list of emails from a mail agent for further processing or just to download attachments. </p>
|
||||
|
||||
## Module interface
|
||||
<p> Module consists of two tabs: «Settings» and «Reading settings».
|
||||
<p> The «Settings» tab is similar to the tab with the same name in the «Send email» module, it has only one difference - this module provides the selection of sending protocols: IMAP or POP3. When you select the protocol the fields «Host», «Port» and «Use SSL» are filled automatically (except «User settings»).
|
||||
<H1 align="center"></h1>
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> Module consists of two tabs: «Settings» and «Reading settings».</p>
|
||||
<p> The «Settings» tab is similar to the tab with the same name in the «Send email» module, it has only one difference - this module provides the selection of sending protocols: IMAP or POP3. When you select the protocol the fields «Host», «Port» and «Use SSL» are filled automatically (except «User settings»).</p>
|
||||
|
||||
|
||||
|
||||
### Tab «Reading settings»
|
||||
<p> The «Reading settings» tab is a set of fields that is filled, depending on the type of emails the robot needs to read.
|
||||
<H1 align="center"></h1>
|
||||
<p> Field «Variable». The field is intended for entering the name of a variable, in which the information about the read emails is gonna be put in. In the program, this field will be represented by a list of objects that have four fields:
|
||||
<p> 1) Subject – the subject of the email;
|
||||
<p> 2) Body – the body of an email, its main text;
|
||||
<p> 3) Sender – the sender of a letter;
|
||||
<p> 4) Attachments – list of paths to the downloaded attachments.
|
||||
<p> Examples of working with variables
|
||||
<p> ● @mail[1].Attachments[0] – getting the path to the first attachment of the second email.
|
||||
<H1 align="center"></h1>
|
||||
<p> ● @mail[0].Subject – getting the subject of the first downloaded message :
|
||||
<H1 align="center"></h1>
|
||||
<p> The «Download attachments into the folder» field is intended to enter the path to the folder into which all attachments of the read emails will be loaded. If you leave the field empty, the files will be downloaded to the temporary directory of the computer.
|
||||
<p> The «Only unread» checkbox allows scanning only unread emails. Available only for IMAP protocol.
|
||||
<p> The «Mark as read» checkbox allows setting a note about reading an email. Available only for IMAP protocol.
|
||||
<p> The «Read from folder» field is intended for a specified folder in the inbox from which the emails should be read. By default the robot reads emails from the «Inbox» folder. Available only for IMAP protocol.
|
||||
<p> The «Message topic filter» field is used to configure the filter by message topic. If you need to download emails with a topic that does or does not contain a specific line, then you should select the operation of the same name in the drop-down list and enter the desired line in the field that appears:
|
||||
<H1 align="center"></h1>
|
||||
<p> The «Date filter» field is used to configure filtering of reading messages by date. When specifying a value in this field, the robot will read only those messages that satisfy the specified condition.
|
||||
<p> The following filtering methods are available:
|
||||
<p> ● for a certain date – «On data»;
|
||||
<p> ● starting with some data, including it – «With data»;
|
||||
<p> ● all letter up to some date, including it – «To data»;
|
||||
<p> ● «Between date».
|
||||
<p> After selecting a filtering method, one or two fields will appear under the «Filter by date» field to enter the desired values in the format DD.MM.YYYY.
|
||||
|
||||
<p> The «Reading settings» tab is a set of fields that is filled, depending on the type of emails the robot needs to read.</p>
|
||||
|
||||
<p> Field «Variable». The field is intended for entering the name of a variable, in which the information about the read emails is gonna be put in. In the program, this field will be represented by a list of objects that have four fields:</p>
|
||||
<p> 1) Subject – the subject of the email;</p>
|
||||
<p> 2) Body – the body of an email, its main text;</p>
|
||||
<p> 3) Sender – the sender of a letter;</p>
|
||||
<p> 4) Attachments – list of paths to the downloaded attachments.</p>
|
||||
<p> Examples of working with variables</p>
|
||||
<p> ● @mail[1].Attachments[0] – getting the path to the first attachment of the second email.</p>
|
||||
|
||||
<p> ● @mail[0].Subject – getting the subject of the first downloaded message :</p>
|
||||
|
||||
<p> The «Download attachments into the folder» field is intended to enter the path to the folder into which all attachments of the read emails will be loaded. If you leave the field empty, the files will be downloaded to the temporary directory of the computer.</p>
|
||||
<p> The «Only unread» checkbox allows scanning only unread emails. Available only for IMAP protocol.</p>
|
||||
<p> The «Mark as read» checkbox allows setting a note about reading an email. Available only for IMAP protocol.</p>
|
||||
<p> The «Read from folder» field is intended for a specified folder in the inbox from which the emails should be read. By default the robot reads emails from the «Inbox» folder. Available only for IMAP protocol.</p>
|
||||
<p> The «Message topic filter» field is used to configure the filter by message topic. If you need to download emails with a topic that does or does not contain a specific line, then you should select the operation of the same name in the drop-down list and enter the desired line in the field that appears:</p>
|
||||
|
||||
<p> The «Date filter» field is used to configure filtering of reading messages by date. When specifying a value in this field, the robot will read only those messages that satisfy the specified condition.</p>
|
||||
<p> The following filtering methods are available:</p>
|
||||
<p> ● for a certain date – «On data»;</p>
|
||||
<p> ● starting with some data, including it – «With data»;</p>
|
||||
<p> ● all letter up to some date, including it – «To data»;</p>
|
||||
<p> ● «Between date».</p>
|
||||
<p> After selecting a filtering method, one or two fields will appear under the «Filter by date» field to enter the desired values in the format DD.MM.YYYY.</p>
|
||||
|
|
|
|||
|
|
@ -1,11 +1,15 @@
|
|||
|
||||
# <H1 align="center">«Return» module</h1>
|
||||
|
||||
<p> There are situations when, under some condition, it is necessary to finish the work of the robot, for example, you need to process an email that should be sent, but it did not come. For such purposes there is a «Return» module.</p>
|
||||
|
||||
##
|
||||
<H1 align="center"></h1>
|
||||
<p> This module finishes the work of the whole robot and doesn't require configuration. It can be used anywhere.
|
||||
|
||||
|
||||
<p> This module finishes the work of the whole robot and doesn't require configuration. It can be used anywhere.</p>
|
||||
|
||||
## Example
|
||||
<p> Below you can see an example of using this module: with the help of the «Read emails» module you can make the robot read all emails for a certain period of time.All subjects of the email and their contents must be entered into an Excel file. But what if you don't have the emails? To do this, let's check for emails, and if they're not there, the robot will stop working, but if they are, it will continue.
|
||||
<H1 align="center"></h1>
|
||||
<p> Thanks to this module, you can write robots in the general workspace, and not in the branches of the «Condition» module. This way the robot looks more accurate and intuitive.
|
||||
|
||||
<p> Below you can see an example of using this module: with the help of the «Read emails» module you can make the robot read all emails for a certain period of time.All subjects of the email and their contents must be entered into an Excel file. But what if you don't have the emails? To do this, let's check for emails, and if they're not there, the robot will stop working, but if they are, it will continue.</p>
|
||||
|
||||
<p> Thanks to this module, you can write robots in the general workspace, and not in the branches of the «Condition» module. This way the robot looks more accurate and intuitive.</p>
|
||||
|
|
@ -1,10 +1,12 @@
|
|||
|
||||
# <H1 align="center">Section - «Robots»</h1>
|
||||
|
||||
##
|
||||
|
||||
<p> This section consists of a search field by robots name and a list of published robots. When publishing, the robot is assigned a unique identifier, so the names of robots can be repeated.</p>
|
||||
<H1 align="center"></h1>
|
||||
<p> To load, debug or edit an existing robot, you must open it as a project in the studio. To do this, click on the Lexema-RPA icon of the corresponding robot.
|
||||
<H1 align="center"></h1>
|
||||
<p> After editing the robot click the «Publish current robot» button, after which the changes will be saved.
|
||||
<p> To delete the robot you need to click on the red cross in its box.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> To load, debug or edit an existing robot, you must open it as a project in the studio. To do this, click on the Lexema-RPA icon of the corresponding robot.</p>
|
||||
|
||||
<p> After editing the robot click the «Publish current robot» button, after which the changes will be saved.</p>
|
||||
<p> To delete the robot you need to click on the red cross in its box.</p>
|
||||
|
||||
14
docs/SQL.md
14
docs/SQL.md
|
|
@ -1,11 +1,13 @@
|
|||
|
||||
# <H1 align="center">«SQL» module</h1>
|
||||
|
||||
<p> The «SQL» module provides work with databases. Supported DBMSs: MS SQL and PostgreSQL. </p>
|
||||
|
||||
## Module interface
|
||||
<p> This module provides work with databases. The following DBMSs are supported: MS SQL and PostgreSQL. To work with a database you need to fill out all the fields in the «SQL» module window.
|
||||
<p> The window consists of the following fields: «DBMS», «Data source», «Data base», «Login», «Password», «SQL-script» and «Variable».
|
||||
<H1 align="center"></h1>
|
||||
<p> The fields «Data source», «Database», «Login» and «Password» provide a connection to the database.
|
||||
<p> The «SQL-script» field. The script in SQL language is entered into this field, entering variables of the Studio is supported.
|
||||
<p> The «Variable» field. The name of the variable is entered in the field into which the response from the database will be entered in the form of a table. Only one table can be returned in one SQL module, subsequent ones will be ignored.
|
||||
|
||||
<p> This module provides work with databases. The following DBMSs are supported: MS SQL and PostgreSQL. To work with a database you need to fill out all the fields in the «SQL» module window.</p>
|
||||
<p> The window consists of the following fields: «DBMS», «Data source», «Data base», «Login», «Password», «SQL-script» and «Variable».</p>
|
||||
|
||||
<p> The fields «Data source», «Database», «Login» and «Password» provide a connection to the database.</p>
|
||||
<p> The «SQL-script» field. The script in SQL language is entered into this field, entering variables of the Studio is supported.</p>
|
||||
<p> The «Variable» field. The name of the variable is entered in the field into which the response from the database will be entered in the form of a table. Only one table can be returned in one SQL module, subsequent ones will be ignored.</p>
|
||||
|
|
|
|||
|
|
@ -1,33 +1,41 @@
|
|||
|
||||
# <H1 align="center">Module «Send email»</h1>
|
||||
|
||||
<p> Module «Send email» is designed for sending emails to one or multiple addresses.</p>
|
||||
|
||||
## Module interface
|
||||
<p> Module consists of multiple tabs: «Settings», «Receiver», «Email». Рассмотрим по порядку все вкладки. Начнем знакомство с рассмотрения вкладки «Настройки».
|
||||
### «Settings» tab
|
||||
<H1 align="center"></h1>
|
||||
<p> The «Settings» field – is a drop-down list where you can choose between multiple mail agents. When choosing a mail agent the host and the port will be filled and the «Use SSL» checkbox will be checked according to its settings.The "Custom" item provides the ability to independently configure access settings for the mail service.
|
||||
<H1 align="center"></h1>
|
||||
<p> Fields «Host», «Port» and «Use SSL» are required to be filled out only when configuring user settings.. They are a set of required fields for connecting to mail agents.
|
||||
<p> The «E-mail» fields are intended for specifying the email address, from which the messages are going to be sent name@mail.ru.
|
||||
<p> The «Password» field is intended for entering a password from the mail agent, specified in the «E-mail» field.
|
||||
<H1 align="center"></h1>
|
||||
### «Recipient» tab
|
||||
<p> On this tab the information about the email recipients should be filled.
|
||||
<p> Module offers different methods of specifying recipients:
|
||||
<p> ● manually entering a list of recipients (names and email addresses);
|
||||
<p> ● from an element variable, in the form of one email;
|
||||
<p> ● from a list variable, in the form of several emails.
|
||||
<H1 align="center"></h1>
|
||||
<p> If the «List» switch is selected, then «Variable» field is available for input, otherwise «Variable» field is not available, but all other fields are.
|
||||
<p> To enter recipients using the «List» method, it is necessary to fill in the «Recipient's name» and «Recipient's E-mail» fields, then click on the button under the «Add» fields. After that, you will see the values you entered in the table in the center of the window. If you need to remove any recipient from the table, you must select a row with it and click on the «Delete» button.
|
||||
<H1 align="center"></h1>
|
||||
<p> If the method of selecting recipients through a variable is used, then the fields «Recipient's name»,«Recipient's E-mail» and the table become unavailable. In the «Variable» field, you must enter the name of the variable starting with «@», from which the email’s of the recipients will be taken.
|
||||
<H1 align="center"></h1>
|
||||
### «Email» tab
|
||||
<p> On this tab the email itself is configured. All fields are required to fill out.
|
||||
<H1 align="center"></h1>
|
||||
<p> To attach a file you need to click the «Select file» button and select the file in the opened window.
|
||||
<p> To attach multiple files you need to click the «Choose folder» and choose the folder you need in the opened window.
|
||||
<p> Any of these fields can be filled with a variable.
|
||||
|
||||
<p> Module consists of multiple tabs: «Settings», «Receiver», «Email». Рассмотрим по порядку все вкладки. Начнем знакомство с рассмотрения вкладки «Настройки».</p>
|
||||
|
||||
### «Settings» tab
|
||||
|
||||
|
||||
<p> The «Settings» field – is a drop-down list where you can choose between multiple mail agents. When choosing a mail agent the host and the port will be filled and the «Use SSL» checkbox will be checked according to its settings.The "Custom" item provides the ability to independently configure access settings for the mail service.</p>
|
||||
|
||||
<p> Fields «Host», «Port» and «Use SSL» are required to be filled out only when configuring user settings.. They are a set of required fields for connecting to mail agents.</p>
|
||||
<p> The «E-mail» fields are intended for specifying the email address, from which the messages are going to be sent name@mail.ru.</p>
|
||||
<p> The «Password» field is intended for entering a password from the mail agent, specified in the «E-mail» field.</p>
|
||||
|
||||
|
||||
### «Recipient» tab
|
||||
|
||||
<p> On this tab the information about the email recipients should be filled.</p>
|
||||
<p> Module offers different methods of specifying recipients:</p>
|
||||
<p> ● manually entering a list of recipients (names and email addresses);</p>
|
||||
<p> ● from an element variable, in the form of one email;</p>
|
||||
<p> ● from a list variable, in the form of several emails.</p>
|
||||
|
||||
<p> If the «List» switch is selected, then «Variable» field is available for input, otherwise «Variable» field is not available, but all other fields are.</p>
|
||||
<p> To enter recipients using the «List» method, it is necessary to fill in the «Recipient's name» and «Recipient's E-mail» fields, then click on the button under the «Add» fields. After that, you will see the values you entered in the table in the center of the window. If you need to remove any recipient from the table, you must select a row with it and click on the «Delete» button.</p>
|
||||
|
||||
<p> If the method of selecting recipients through a variable is used, then the fields «Recipient's name»,«Recipient's E-mail» and the table become unavailable. In the «Variable» field, you must enter the name of the variable starting with «@», from which the email’s of the recipients will be taken.</p>
|
||||
|
||||
|
||||
### «Email» tab
|
||||
|
||||
<p> On this tab the email itself is configured. All fields are required to fill out.</p>
|
||||
|
||||
<p> To attach a file you need to click the «Select file» button and select the file in the opened window.</p>
|
||||
<p> To attach multiple files you need to click the «Choose folder» and choose the folder you need in the opened window.</p>
|
||||
<p> Any of these fields can be filled with a variable.</p>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,13 +1,15 @@
|
|||
|
||||
# <H1 align="center">Module «Process startup»</h1>
|
||||
|
||||
<p> The «Process startup» module is intended to launch different applications. This can be the browser, MS Word, 1С and more. </p>
|
||||
|
||||
## Module interface
|
||||
<p> Module window consists of the following fields: «File path», «Parameters», «As administrator» checkbox, «Pause», «Variable with process name» and «Variable with process id», and also the «Save» and «Cancel» buttons.
|
||||
<H1 align="center"></h1>
|
||||
<p> The «File path» field. The name of the standard process in Windows is entered into this field (for example notepad), or the root directory of the application, for example, standard path to the Google Chrome browser - C:\Program Files (x86)\Google\Chrome\Application\chrome.exe.
|
||||
<p> The «Parameters» field is an optional field, arguments of the launched up are entered into it. For example, to open a new notepad window or a blank sheet, Excel arguments are not needed, but if you need to open a specific file, the name of the file is passed to the arguments. And if you need to open a browser the link to the website can be an argument.
|
||||
<H1 align="center"></h1>
|
||||
<p> The «As administrator» checkbox launches the process with the right to change the system files. If you don't trust an application, don't check this checkbox.
|
||||
<p> The «Pause» field sets the wait time after the start of the process.
|
||||
<p> The «Variable with process name/id». In this field the name and the id of the process you are launching are going to be put in. These parameters are needed to end (close) the specified processes. If you only need to start processes, you can leave these fields empty.
|
||||
|
||||
<p> Module window consists of the following fields: «File path», «Parameters», «As administrator» checkbox, «Pause», «Variable with process name» and «Variable with process id», and also the «Save» and «Cancel» buttons.</p>
|
||||
|
||||
<p> The «File path» field. The name of the standard process in Windows is entered into this field (for example notepad), or the root directory of the application, for example, standard path to the Google Chrome browser - C:\Program Files (x86)\Google\Chrome\Application\chrome.exe.</p>
|
||||
<p> The «Parameters» field is an optional field, arguments of the launched up are entered into it. For example, to open a new notepad window or a blank sheet, Excel arguments are not needed, but if you need to open a specific file, the name of the file is passed to the arguments. And if you need to open a browser the link to the website can be an argument.</p>
|
||||
|
||||
<p> The «As administrator» checkbox launches the process with the right to change the system files. If you don't trust an application, don't check this checkbox.</p>
|
||||
<p> The «Pause» field sets the wait time after the start of the process.</p>
|
||||
<p> The «Variable with process name/id». In this field the name and the id of the process you are launching are going to be put in. These parameters are needed to end (close) the specified processes. If you only need to start processes, you can leave these fields empty.</p>
|
||||
|
|
|
|||
|
|
@ -1,13 +1,17 @@
|
|||
|
||||
# <H1 align="center">«Text processing»</h1>
|
||||
|
||||
<p> The «Text processing» module offers several methods of processing the text/ Some tasks require knowledge of how much the text is different between the standard and the specified text. These are tasks related to computer linguistics and artificial intelligence.</p>
|
||||
|
||||
## Module interface
|
||||
<p> The module window consists of the part of compiling a command, command control buttons and a list of commands in the form of a table. The part of creating a command consists of 4 main fields: «Action» - drop-down list with methods for text processing, 2 fields «Line 1/2», are intended to enter two lines of text, or variables with text, and the last field is «Variable» - for the name of the variable in which the result of the module will be put.
|
||||
<H1 align="center"></h1>
|
||||
<p> By clicking the «Add» button the created command will be put into the «Command list» section. To edit a command you need to select it from the list, make all desired changes and then click the «Edit» button. To delete a command, select it from the list and click the «Delete» button. You can change the position of commands by clicking the arrow keys, as in Excel module (part 2)..
|
||||
|
||||
<p> The module window consists of the part of compiling a command, command control buttons and a list of commands in the form of a table. The part of creating a command consists of 4 main fields: «Action» - drop-down list with methods for text processing, 2 fields «Line 1/2», are intended to enter two lines of text, or variables with text, and the last field is «Variable» - for the name of the variable in which the result of the module will be put.</p>
|
||||
|
||||
<p> By clicking the «Add» button the created command will be put into the «Command list» section. To edit a command you need to select it from the list, make all desired changes and then click the «Edit» button. To delete a command, select it from the list and click the «Delete» button. You can change the position of commands by clicking the arrow keys, as in Excel module (part 2)..</p>
|
||||
|
||||
## Text processing methods
|
||||
<p> The following text processing methods are offered in this module:
|
||||
<p> 1. Levenshtein distance – calculates the difference between two lines. For example – «Lexema RPA» and «Lexema SR» differ by 3 characters – the words «Lexema» stay the same, and the rest of the characters are different, so the result that will be put into the variable is 3;
|
||||
<p> 2. 3-граммы – - a method based on working with n-grams, in our case n = 3 - the similarity of every 3 characters is estimated. The larger the number (up to 1), the greater the similarity of the lines. In the «Lexema RPA» and «Lexema SR» example the result is gonna be the 0,52 number.
|
||||
<p> 3. Jaro winkler similarity is a measure of line similarity for measuring the distance between two sequences of characters. The smaller the Jaro-Winkler distance for two lines, the more similar these lines are. For the «Lexema RPA» and «Lexema SR» example the result is 0,5.
|
||||
|
||||
<p> The following text processing methods are offered in this module:</p>
|
||||
<p> 1. Levenshtein distance – calculates the difference between two lines. For example – «Lexema RPA» and «Lexema SR» differ by 3 characters – the words «Lexema» stay the same, and the rest of the characters are different, so the result that will be put into the variable is 3;</p>
|
||||
<p> 2. 3-граммы – - a method based on working with n-grams, in our case n = 3 - the similarity of every 3 characters is estimated. The larger the number (up to 1), the greater the similarity of the lines. In the «Lexema RPA» and «Lexema SR» example the result is gonna be the 0,52 number.</p>
|
||||
<p> 3. Jaro winkler similarity is a measure of line similarity for measuring the distance between two sequences of characters. The smaller the Jaro-Winkler distance for two lines, the more similar these lines are. For the «Lexema RPA» and «Lexema SR» example the result is 0,5.</p>
|
||||
|
|
|
|||
|
|
@ -1,15 +1,19 @@
|
|||
|
||||
# <H1 align="center">Module «Try/Catch»</h1>
|
||||
|
||||
<p> This module allows you to handle errors that may occur during the execution of modules.</p>
|
||||
|
||||
##
|
||||
<H1 align="center"></h1>
|
||||
<p> Module consists of two blocks – TRY and CATCH. Block TRY contains a set of modules or the whole robot execution of which is needed, CATCH block contains a set of modules in case an error occurs in the execution of the modules of the TRY block.
|
||||
<p> The module has two text fields, the first is the “Note” field, into which you can enter a description of the module for more convenient navigation around the robot, and the second field is designed to save errors that occurred in the TRY module. Since it is possible to find out what error occurred, each possible error can be correctly processed in the CATCH block.
|
||||
|
||||
|
||||
<p> Module consists of two blocks – TRY and CATCH. Block TRY contains a set of modules or the whole robot execution of which is needed, CATCH block contains a set of modules in case an error occurs in the execution of the modules of the TRY block.</p>
|
||||
<p> The module has two text fields, the first is the “Note” field, into which you can enter a description of the module for more convenient navigation around the robot, and the second field is designed to save errors that occurred in the TRY module. Since it is possible to find out what error occurred, each possible error can be correctly processed in the CATCH block.</p>
|
||||
|
||||
## EXAMPLE.
|
||||
<p> The task is to download a letter from the mail with a specific name of an attachment to a predetermined folder and process this attachment with the Excel module, and in the Excel module the path to the file will always be the same. For example the attachment is called «Daily report», path to the folder «C:\Reports», then this file will always be opened «C:\Reports\Report for the fay.xlsx», and attachments from the inbox will always be downloaded to the folder above.
|
||||
<p> If the email with the necessary attachment has not arrived yet, then the Excel module will generate an error “Could not open document C:\Reports\Report for the day.xlsx”.In this case, you need to somehow handle this error, prompt the user to start the robot later, or tell him to wait and try again.
|
||||
<p> To process the error with displaying the information window, you must add the «Try/Catch», where the TRY block will contain the email and Excel scanning modules, and the CATCH block the module Interface for displaying the user window.
|
||||
<H1 align="center"></h1>
|
||||
<p> In result you will get this default message «The script worked successfully!» if the email was in inbox or with the «The email hasn't arrived yet» message if the email isn't there yet. The @error variable will contain the text «Could not open document C:\Reports\daily report for the day.xlsx».
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> The task is to download a letter from the mail with a specific name of an attachment to a predetermined folder and process this attachment with the Excel module, and in the Excel module the path to the file will always be the same. For example the attachment is called «Daily report», path to the folder «C:\Reports», then this file will always be opened «C:\Reports\Report for the fay.xlsx», and attachments from the inbox will always be downloaded to the folder above.</p>
|
||||
<p> If the email with the necessary attachment has not arrived yet, then the Excel module will generate an error “Could not open document C:\Reports\Report for the day.xlsx”.In this case, you need to somehow handle this error, prompt the user to start the robot later, or tell him to wait and try again.</p>
|
||||
<p> To process the error with displaying the information window, you must add the «Try/Catch», where the TRY block will contain the email and Excel scanning modules, and the CATCH block the module Interface for displaying the user window.</p>
|
||||
|
||||
<p> In result you will get this default message «The script worked successfully!» if the email was in inbox or with the «The email hasn't arrived yet» message if the email isn't there yet. The @error variable will contain the text «Could not open document C:\Reports\daily report for the day.xlsx».</p>
|
||||
|
||||
|
|
@ -1,12 +1,14 @@
|
|||
|
||||
# <H1 align="center">«While» module </h1>
|
||||
|
||||
<p> The «While» module (conditional cycle) performs the added actions until the specified condition returns «True». </p>
|
||||
|
||||
## Module interface
|
||||
<p> The following fields are located in the module window «Note» and «Condition». The block located at the bottom of the module should contain the actions that need to be performed in a cycle.
|
||||
<H1 align="center"></h1>
|
||||
<p> The «Condition» field. A condition is entered into the field as in «Condition» module, which must be written in accordance with the C# syntax, but if you don't know this programming language you can press the «Constructor of conditions» button (see module «Condition»).
|
||||
<p> Adding actions to the module is done by dragging them from the menu or any other part of the workspace.
|
||||
<H1 align="center"></h1>
|
||||
<p> By clicking the «Minimize» button, actions in the cycle minimize for the more compact view of the command.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> The following fields are located in the module window «Note» and «Condition». The block located at the bottom of the module should contain the actions that need to be performed in a cycle.</p>
|
||||
|
||||
<p> The «Condition» field. A condition is entered into the field as in «Condition» module, which must be written in accordance with the C# syntax, but if you don't know this programming language you can press the «Constructor of conditions» button (see module «Condition»).</p>
|
||||
<p> Adding actions to the module is done by dragging them from the menu or any other part of the workspace.</p>
|
||||
|
||||
<p> By clicking the «Minimize» button, actions in the cycle minimize for the more compact view of the command.</p>
|
||||
|
||||
81
docs/Word.md
81
docs/Word.md
|
|
@ -1,46 +1,63 @@
|
|||
|
||||
# <H1 align="center">МODULE «WORD» </h1>
|
||||
|
||||
<p> Module Work can work with Microsoft Word documents. With this module you can create and edit documents with popular extensions as .doc, .docx, .html.</p>
|
||||
|
||||
## Window interface
|
||||
|
||||
<p> The module window consists of three main parts, the first is the part containing the fields for creating commands and their control buttons, the second one is the table «List of commands», which will contain all added actions for working with the file, and the first part is the part where you can see the preview of the file. </p>
|
||||
<H1 align="center"></h1>
|
||||
<p> The preview window allows you to view the entire loaded document in the same form as it is visible in Microsoft Word itself
|
||||
<p> The settings section consists of multiple fields the availability of which varies from the actions necessary for the operation. First three fields are most important and are always available but only two of them are necessary:
|
||||
<p> • «Path to the file» - a field with a button that opens a dialog of choosing a file. This field is designed for choosing an existing file with which you will be working with, or for entering a directory to which a new file is going to be added to. This field is necessary;
|
||||
<p> • «Action» - a drop down list with actions that you can apply to the loaded file or create a new one by specifying the directory in the «Path to the file» field. This field is also necessary;
|
||||
<H1 align="center"></h1>
|
||||
<p> • ● «Description» - This field is designed for convenient navigation through actions, this field should be filled with a note from the developer about the action itself. This field is not necessary.
|
||||
<p> All possible actions will be described in the next chapter.
|
||||
<p> To add an action into the «List of commands» table you need to use the «Add» button under the settings section.
|
||||
<H1 align="center"></h1>
|
||||
<p> After pressing the button the created action will be added to the «List of commands». To edit or delete an existing command you must select the line with the command in the command table and click «Delete» to delete or «Edit» to edit.
|
||||
<p> To change the order of actions, you need to select the action and then click «Raise» or «Lower» buttons, that are located in the right corner above the table.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> The preview window allows you to view the entire loaded document in the same form as it is visible in Microsoft Word itself</p>
|
||||
<p> The settings section consists of multiple fields the availability of which varies from the actions necessary for the operation. First three fields are most important and are always available but only two of them are necessary:</p>
|
||||
<p> • «Path to the file» - a field with a button that opens a dialog of choosing a file. This field is designed for choosing an existing file with which you will be working with, or for entering a directory to which a new file is going to be added to. This field is necessary;</p>
|
||||
<p> • «Action» - a drop down list with actions that you can apply to the loaded file or create a new one by specifying the directory in the «Path to the file» field. This field is also necessary;</p>
|
||||
|
||||
<p> • ● «Description» - This field is designed for convenient navigation through actions, this field should be filled with a note from the developer about the action itself. This field is not necessary.</p>
|
||||
<p> All possible actions will be described in the next chapter.</p>
|
||||
<p> To add an action into the «List of commands» table you need to use the «Add» button under the settings section.</p>
|
||||
|
||||
<p> After pressing the button the created action will be added to the «List of commands». To edit or delete an existing command you must select the line with the command in the command table and click «Delete» to delete or «Edit» to edit.</p>
|
||||
<p> To change the order of actions, you need to select the action and then click «Raise» or «Lower» buttons, that are located in the right corner above the table.</p>
|
||||
|
||||
|
||||
## Module actions
|
||||
|
||||
### Create file
|
||||
<p> This action creates a file with the specified directory, name, and extension. To configure this action you need to fill the «Path to the file» field with the line of the following type «Path to the file/name of the file.extension», for example «C:/Reports/Documents/Test.docx».
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> This action creates a file with the specified directory, name, and extension. To configure this action you need to fill the «Path to the file» field with the line of the following type «Path to the file/name of the file.extension», for example «C:/Reports/Documents/Test.docx».</p>
|
||||
|
||||
|
||||
### Get text
|
||||
<p> The «Get text» action allows you to scan all text from the loaded file to the variable. For configuring the action one more field appears besides the standard three – «Variable», in which the name of the variable is put (starting with the «@» symbol), in which the scanned text is going to be put in.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> The «Get text» action allows you to scan all text from the loaded file to the variable. For configuring the action one more field appears besides the standard three – «Variable», in which the name of the variable is put (starting with the «@» symbol), in which the scanned text is going to be put in.</p>
|
||||
|
||||
|
||||
### Write text
|
||||
<p> Using an action, you can write existing text, for example, read from another text file, into the currently loaded file. For configuration it is necessary to fill out the «Value» field, where either a variable (starting with the "@" symbol) containing text or the text itself is entered.Please keep in mind that the text entered by this action will completely erase the existing text in the file.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> Using an action, you can write existing text, for example, read from another text file, into the currently loaded file. For configuration it is necessary to fill out the «Value» field, where either a variable (starting with the "@" symbol) containing text or the text itself is entered.Please keep in mind that the text entered by this action will completely erase the existing text in the file.</p>
|
||||
|
||||
|
||||
### Add text
|
||||
<p> This action allows you to add text to the existing one using the necessary formatting.. All fields of the modules are open for editing. Every field is going to be described below.
|
||||
<p> «After the № symbol» - this field expects the input of an integer indicating after which character the text should be inserted (considering the space and the line break or page break characters).
|
||||
<H1 align="center"></h1>
|
||||
<p> «Text size» - similar to the «Font size» in Microsoft Word – sets the size of the added text. You should enter an integer or a decimal number.
|
||||
<p> «Font» - a drop down list that includes all default fonts from Microsoft Word – sets the font of the added text.
|
||||
<p> «Font color» and «Background color» – fields with a palette icon on the side, by clicking on which a color selection dialog window opens up - sets the color of the added text and its background. It is entered in the HEX color format - the hexadecimal representation of RGB (without the # symbol at the beginning).
|
||||
<p> «Теxt» - here you should put the text you want to add.
|
||||
|
||||
<p> This action allows you to add text to the existing one using the necessary formatting.. All fields of the modules are open for editing. Every field is going to be described below.</p>
|
||||
<p> «After the № symbol» - this field expects the input of an integer indicating after which character the text should be inserted (considering the space and the line break or page break characters).</p>
|
||||
|
||||
<p> «Text size» - similar to the «Font size» in Microsoft Word – sets the size of the added text. You should enter an integer or a decimal number.</p>
|
||||
<p> «Font» - a drop down list that includes all default fonts from Microsoft Word – sets the font of the added text.</p>
|
||||
<p> «Font color» and «Background color» – fields with a palette icon on the side, by clicking on which a color selection dialog window opens up - sets the color of the added text and its background. It is entered in the HEX color format - the hexadecimal representation of RGB (without the # symbol at the beginning).</p>
|
||||
<p> «Теxt» - here you should put the text you want to add.</p>
|
||||
|
||||
### Add line break
|
||||
<p> This action adds a line break character to the file. You don't need to fill in additional fields.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> This action adds a line break character to the file. You don't need to fill in additional fields.</p>
|
||||
|
||||
|
||||
### Delete text
|
||||
<p> With this action you can delete text if you know the amount of characters and its location. For configuration you need to enter 2 integer numbers separated by a comma into the «After symbol №., quantity» field where the first number is a number of a character after which you need to delete text, and the second number is the amount of characters you need to delete.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> With this action you can delete text if you know the amount of characters and its location. For configuration you need to enter 2 integer numbers separated by a comma into the «After symbol №., quantity» field where the first number is a number of a character after which you need to delete text, and the second number is the amount of characters you need to delete.</p>
|
||||
|
||||
|
||||
### Export
|
||||
<p> You can change the extension of the file using this action. To configure the action, you need to select the type of file to export from the "Type" drop-down list and specify the path with the name and extension of the file in the “Output file path” field.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> You can change the extension of the file using this action. To configure the action, you need to select the type of file to export from the "Type" drop-down list and specify the path with the name and extension of the file in the “Output file path” field.</p>
|
||||
|
||||
|
|
@ -1,74 +1,92 @@
|
|||
|
||||
# <H1 align="center">WORK WITH THE BROWSER</h1>
|
||||
|
||||
<p> The «Work with the browser» module is based on the Selenium WebDriver and allows implementing basic elements with working with a browser page – open tab, пgo to the tab, find the element on the page by its key and process it.</p>
|
||||
|
||||
## Module interface
|
||||
<p> The module window is divided into the part of creating a command for working with a browser, a group of action control buttons and a table containing a list of created commands. Part of creating a command consists of several fields to fill out, and the number of these fields varies depending on the selected action in the «Action» field. The group of buttons consists of the following buttons – «Add», «Edit» and «Delete».
|
||||
<H1 align="center"></h1>
|
||||
<p> Creating a command starts with selecting an action. After selecting it, the list of available fields in the window may change. You need to fill out the fields that are required for the action to work and click «Add». The created action is gonna be listed in the «Action list» table. To edit a command you need to select it in the list, edit the desired fields and then press the «Edit» button. But if you press the «Add» button, a new action is gonna be added but with the changes you made while editing. You can simply not change anything and click «Add», then the command is gonna be copied.
|
||||
<p> To delete actions you need to select it in the list and press the «Delete» button.
|
||||
<p> You can change the order of the commands by pressing the arrow keys that are located in the top right corner. It's really simple to do, first select the row tje position of which you wanna change, then click the arrow keys to move it.
|
||||
<H1 align="center"></h1>
|
||||
<p> For all actions these three fields never change «Driver», «Action» and «Note».
|
||||
<p> The «Driver» field is currently unavailable for editing and the default driver for the Chrome browser is selected in it, but in the future it is planned to supplement this list with other browsers.
|
||||
<p> The «Action» field — is a drop-down list with all possible actions for this module. More detailed review of them is gonna be in the next chapter.
|
||||
<p> The «Note» field — a row with a note for the command.
|
||||
## Description of actions
|
||||
<p> Module offers 7 main actions – go to the page, reload the page, go back and forward, work with the page, work with tabs, and close the browser. Each action requires filling in some kind of fields
|
||||
<p> Please note that it is advisable to close the browser opened using this module, too, otherwise, if you close the browser yourself and then try to continue working with it using this module, an error will occur and you will have to restart the program.
|
||||
### Go to
|
||||
<p> Action goes to the specified page. The «URL» field is added.
|
||||
<H1 align="center"></h1>
|
||||
<p> If any page is already open, then it will go from it to the specified one, meaning that the original page will be replaced with a new one. If the browser has not yet been launched, it will be opened with this page.
|
||||
### Reload the page
|
||||
<p> Action reloads the already opened page, before using the action make sure the page is opened.
|
||||
### Go back
|
||||
<p> Goes to the page that was open before the current one.
|
||||
### Go forward
|
||||
<p> Goes to the page that was opened after the current one.
|
||||
### Working with a page
|
||||
<p> This action provides the ability to work with a specific item of the page. The following fields will appear when configuring the action – «Item search type», «Search line», «Page action», «Variable», «Waiting (sec)» и «Item number».
|
||||
<H1 align="center"></h1>
|
||||
<p> The «Item search type» field is a drop-down list with a list of search methods for the element on the page, it is used in conjunction with the «Search line» field. Below will be listed all types of searches for an element with examples of filling the «Search line» field:
|
||||
<p> • GetElementsByName – search for elements by their name property.
|
||||
<H1 align="center"></h1>
|
||||
<p> • GetElementsById – search for elements by their id property.
|
||||
<H1 align="center"></h1>
|
||||
<p> • GetElementsByClass – search for elements by their class property.
|
||||
<H1 align="center"></h1>
|
||||
<p> • GetElementsByCssSelector – search for elements by their css property.
|
||||
<H1 align="center"></h1>
|
||||
<p> • GetElementByLinkText – search for link elements in text. Only items with a complete match are searched.
|
||||
<H1 align="center"></h1>
|
||||
<p> • GetElementsByPartialLinkText - search for link elements by their text. All items containing the given line are searched.
|
||||
<H1 align="center"></h1>
|
||||
<p> • GetElementsByTagName – search for elements by their tag.
|
||||
<H1 align="center"></h1>
|
||||
<p> • GetElementsByXPath – search for elements by HTML – xpath query language.
|
||||
<H1 align="center"></h1>
|
||||
<p> The «Page action» field offers a selection of an action from the drop-down list that must be performed on the found elements. The following actions are suggested:
|
||||
<p> ● Record – enters specified text into the «Variable» field (for example, after clicking on a specific element to enter text);
|
||||
<p> ● Get text - gets the value of the text properties of all found or specifically selected elements and returns the result as a list to the variable;
|
||||
<p> ● Send - press ENTER - use the recorded data (for example, any text can be entered with actions «Record», and then «Send» it);
|
||||
<p> ● Click – left-click on a specified element (filling out the «Item number» field is required);
|
||||
<p> ● Hover over a cursor – hovers over a specific element(filling out the «Item number» field is required);
|
||||
<p> ● Get Property – when choosing an action the «Property name» field appears - returns the value of the specified in the «Property name» field property of all found elements or the specified as a list into the variable;
|
||||
<p> ● Get CSS property – when choosing an action the «CSS property» field appears - returns the value of the specified in the «CSS property» field property of all found elements or the specified as a list into the variable;
|
||||
<p> ● Get Attribute – when choosing an action the «Attribute property» field appears - returns the value of the specified in the «Attribute property» field property of all found elements or the specified as a list into the variable;
|
||||
<p> In the «Variable» field the name of a variable is entered starting with «@», in which the result of the executed command is gonna be put in, or otherwise from which the values for executing a command are gonna be taken from.
|
||||
<p> The «Waiting (sec)» field – the amount of seconds robot needs to wait after executing a command.
|
||||
<p> The «Item number» field – one index of the found item to which the action must be applied
|
||||
<p> An example of the filled out action:
|
||||
<H1 align="center"></h1>
|
||||
<p> Here, the element with the name «q» is searched and the text «search» is put in it.
|
||||
### Work with tabs
|
||||
<p> This action allows manipulating with tabs in the browser window. For configuring at least one field is added – «Action», and other fields appear after you select the action.
|
||||
<H1 align="center"></h1>
|
||||
<p> Available actions for working with tabs - add, close, go to the tab and get tab amount. More detailed description of them:
|
||||
<p> ● Add tab - adds a new tab, the tab automatically becomes active;
|
||||
<p> ● Close tab - closes the active tab;
|
||||
<p> ● Go to the tab – when choosing this action the «Tab number» field will appear - goes to the tab the number of which is specified in the «Tab number» field (starting with 0);
|
||||
<p> ● Get tab amount –when choosing this action the «Variable» field will appear - returns the amount of tabs into the specified variable.
|
||||
### Close browser
|
||||
<p> Closes the browser.
|
||||
|
||||
<p> The module window is divided into the part of creating a command for working with a browser, a group of action control buttons and a table containing a list of created commands. Part of creating a command consists of several fields to fill out, and the number of these fields varies depending on the selected action in the «Action» field. The group of buttons consists of the following buttons – «Add», «Edit» and «Delete».</p>
|
||||
|
||||
<p> Creating a command starts with selecting an action. After selecting it, the list of available fields in the window may change. You need to fill out the fields that are required for the action to work and click «Add». The created action is gonna be listed in the «Action list» table. To edit a command you need to select it in the list, edit the desired fields and then press the «Edit» button. But if you press the «Add» button, a new action is gonna be added but with the changes you made while editing. You can simply not change anything and click «Add», then the command is gonna be copied.</p>
|
||||
<p> To delete actions you need to select it in the list and press the «Delete» button.</p>
|
||||
<p> You can change the order of the commands by pressing the arrow keys that are located in the top right corner. It's really simple to do, first select the row tje position of which you wanna change, then click the arrow keys to move it.</p>
|
||||
|
||||
<p> For all actions these three fields never change «Driver», «Action» and «Note».</p>
|
||||
<p> The «Driver» field is currently unavailable for editing and the default driver for the Chrome browser is selected in it, but in the future it is planned to supplement this list with other browsers.</p>
|
||||
<p> The «Action» field — is a drop-down list with all possible actions for this module. More detailed review of them is gonna be in the next chapter.</p>
|
||||
<p> The «Note» field — a row with a note for the command.</p>
|
||||
|
||||
## Description of actions
|
||||
|
||||
<p> Module offers 7 main actions – go to the page, reload the page, go back and forward, work with the page, work with tabs, and close the browser. Each action requires filling in some kind of fields</p>
|
||||
<p> Please note that it is advisable to close the browser opened using this module, too, otherwise, if you close the browser yourself and then try to continue working with it using this module, an error will occur and you will have to restart the program.</p>
|
||||
|
||||
### Go to
|
||||
|
||||
<p> Action goes to the specified page. The «URL» field is added.</p>
|
||||
|
||||
<p> If any page is already open, then it will go from it to the specified one, meaning that the original page will be replaced with a new one. If the browser has not yet been launched, it will be opened with this page.</p>
|
||||
|
||||
### Reload the page
|
||||
|
||||
<p> Action reloads the already opened page, before using the action make sure the page is opened.</p>
|
||||
|
||||
### Go back
|
||||
|
||||
<p> Goes to the page that was open before the current one.</p>
|
||||
|
||||
### Go forward
|
||||
|
||||
<p> Goes to the page that was opened after the current one.</p>
|
||||
|
||||
### Working with a page
|
||||
|
||||
<p> This action provides the ability to work with a specific item of the page. The following fields will appear when configuring the action – «Item search type», «Search line», «Page action», «Variable», «Waiting (sec)» и «Item number».</p>
|
||||
|
||||
<p> The «Item search type» field is a drop-down list with a list of search methods for the element on the page, it is used in conjunction with the «Search line» field. Below will be listed all types of searches for an element with examples of filling the «Search line» field:</p>
|
||||
<p> • GetElementsByName – search for elements by their name property.</p>
|
||||
|
||||
<p> • GetElementsById – search for elements by their id property.</p>
|
||||
|
||||
<p> • GetElementsByClass – search for elements by their class property.</p>
|
||||
|
||||
<p> • GetElementsByCssSelector – search for elements by their css property.</p>
|
||||
|
||||
<p> • GetElementByLinkText – search for link elements in text. Only items with a complete match are searched.</p>
|
||||
|
||||
<p> • GetElementsByPartialLinkText - search for link elements by their text. All items containing the given line are searched.</p>
|
||||
|
||||
<p> • GetElementsByTagName – search for elements by their tag.</p>
|
||||
|
||||
<p> • GetElementsByXPath – search for elements by HTML – xpath query language.</p>
|
||||
|
||||
<p> The «Page action» field offers a selection of an action from the drop-down list that must be performed on the found elements. The following actions are suggested:</p>
|
||||
<p> ● Record – enters specified text into the «Variable» field (for example, after clicking on a specific element to enter text);</p>
|
||||
<p> ● Get text - gets the value of the text properties of all found or specifically selected elements and returns the result as a list to the variable;</p>
|
||||
<p> ● Send - press ENTER - use the recorded data (for example, any text can be entered with actions «Record», and then «Send» it);</p>
|
||||
<p> ● Click – left-click on a specified element (filling out the «Item number» field is required);</p>
|
||||
<p> ● Hover over a cursor – hovers over a specific element(filling out the «Item number» field is required);</p>
|
||||
<p> ● Get Property – when choosing an action the «Property name» field appears - returns the value of the specified in the «Property name» field property of all found elements or the specified as a list into the variable;</p>
|
||||
<p> ● Get CSS property – when choosing an action the «CSS property» field appears - returns the value of the specified in the «CSS property» field property of all found elements or the specified as a list into the variable;</p>
|
||||
<p> ● Get Attribute – when choosing an action the «Attribute property» field appears - returns the value of the specified in the «Attribute property» field property of all found elements or the specified as a list into the variable;</p>
|
||||
<p> In the «Variable» field the name of a variable is entered starting with «@», in which the result of the executed command is gonna be put in, or otherwise from which the values for executing a command are gonna be taken from.</p>
|
||||
<p> The «Waiting (sec)» field – the amount of seconds robot needs to wait after executing a command.</p>
|
||||
<p> The «Item number» field – one index of the found item to which the action must be applied</p>
|
||||
<p> An example of the filled out action:</p>
|
||||
|
||||
<p> Here, the element with the name «q» is searched and the text «search» is put in it.</p>
|
||||
|
||||
### Work with tabs
|
||||
|
||||
<p> This action allows manipulating with tabs in the browser window. For configuring at least one field is added – «Action», and other fields appear after you select the action.</p>
|
||||
|
||||
<p> Available actions for working with tabs - add, close, go to the tab and get tab amount. More detailed description of them:</p>
|
||||
<p> ● Add tab - adds a new tab, the tab automatically becomes active;</p>
|
||||
<p> ● Close tab - closes the active tab;</p>
|
||||
<p> ● Go to the tab – when choosing this action the «Tab number» field will appear - goes to the tab the number of which is specified in the «Tab number» field (starting with 0);</p>
|
||||
<p> ● Get tab amount –when choosing this action the «Variable» field will appear - returns the amount of tabs into the specified variable.</p>
|
||||
|
||||
### Close browser
|
||||
|
||||
<p> Closes the browser.</p>
|
||||
|
||||
|
|
|
|||
|
|
@ -1,70 +1,107 @@
|
|||
|
||||
# <H1 align="center">«Clicker» module</h1>
|
||||
|
||||
<p> The «Clicker» is used to record a sequence of actions, performed by a user, those actions include mouse button clicks and typing on a keyboard. With the help of this module you can interact with any software, because this module mimics the actions of a user, meaning that if you can do this «Clicker» can too.</p>
|
||||
<p> The use of clicker robots is recommended on monitors with the same resolution as the one a robot was written on.</p>
|
||||
|
||||
## Creating a macros
|
||||
|
||||
<p>When you open the «Clicker» module the «Record macros actions» dialog window will open up. The dialog window consists of three elements – the «Start recording» button, the area in which the recorded actions will be displayed, and the «Save» button.</p>
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p>By clicking the «Start recording» button, software will wait for you to press «TAB», after you press «TAB» the dialog window for making a new command (action) will open up. </p>
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p>In this dialog window you can configure the command (detailed description of all actions is gonna be listed below). After you create a command and press the save button, a new action will be added to the macros.</p>
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p>You can change the position of an action in the list of commands using the arrow buttons located on the right side of the block.</p>
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p>A button with a cross on it is used to remove an action from the list of commands.</p>
|
||||
<p>To save the macros press the «Save» button.</p>
|
||||
|
||||
## Creating a command
|
||||
|
||||
<p>Window for creating a command consists of static and non static fields. «Action», «Pause» and «Note» are static fields.</p>
|
||||
|
||||
## Static fields
|
||||
|
||||
### Action
|
||||
|
||||
<p>The «Action» field consists of a list of available actions for recording a macros – typing and clicking, most common hotkeys (copy, paste). All of the available actions in this module will be listed below.</p>
|
||||
|
||||
### Pause
|
||||
|
||||
<p>The «Pause» field is designed for creating a pause after an executed command. The pause is specified in milliseconds.</p>
|
||||
<p>For example, after clicking the browser icon robot needs to wait until the browser will launch – in this example, in the command for opening a browser (left click on its icon) you should enter 5000 (5 seconds) in the «Pause» field.</p>
|
||||
|
||||
### Note
|
||||
|
||||
<p>The «Note» field allows you to write comments so you don’t get confused in the commands.</p>
|
||||
|
||||
## Fields that appear only with certain actions
|
||||
|
||||
### Coordinates or image
|
||||
<p>When creating actions associated with a mouse click, you are asked to choose where to click - according to certain coordinates or by image. If a software you’re working with has a static interface, meaning the button locations don’t change, then you can use coordinates. Then the question comes up, “How to calculate coordinates?”. It’s really simple – when you press «TAB» you need to locate your cursor to the place you wanna click. The coordinates will be entered automatically to the dialog window.
|
||||
<p>But if a software doesn’t have a static interface we highly recommend using the click on image feature. To do that just click the «Image» switch in the dialog window.
|
||||
<H1 align="center"></h1>
|
||||
<p>Depending on a switch selected the bottom part of the window will change – the «Select image», «Highlight image» buttons and «Match rate» input field will appear.
|
||||
<p>The image that you need to click on to run the action can be configured in two ways:
|
||||
<p>1) load an existing image by clicking the «Select image» button
|
||||
<p>2) Use the «HIghlight image» button to select a fragment of the window snapshot. After clicking the button Studio will take a screenshot and will offer you to select a fragment of a resulting image.
|
||||
<p>Keep in mind that if you use the “click on image” feature, that if there are multiple images on the screen the robot will apply the action to the first image found.
|
||||
<p>The «Match rate» field is necessary for the cases, where the selected image slightly differs from the reality (for example, if on the image you highlighted the button in some way. but in reality the button is unhighlighted). In these kinds of cases you need to lower the match rate to the point when the robot will be able to find the image. But if you make the match rate really low, the robot might find the thing you weren’t looking for.
|
||||
<p>Fields «Number of attempts» and «Pause between errors» are designed for when robot fails to find the image. You can specify how many times the robot should try to search for the desired image and how many seconds to wait between attempts. For example, after launching the browser, robot needs to press the «Plus» button to create a new tab. If browser launch time is gonna be longer than 5 seconds (this time is specified in the pause between actions field), then Studio will try to look for the «Plus», that’s not there yet. In that case the Studio will wait the number of seconds you specified between attempts and try again. As soon as the image is found, the program will wait the number of seconds you specified in the «Pause» field of the command, and proceed to the next.
|
||||
|
||||
<p>When creating actions associated with a mouse click, you are asked to choose where to click - according to certain coordinates or by image. If a software you’re working with has a static interface, meaning the button locations don’t change, then you can use coordinates. Then the question comes up, “How to calculate coordinates?”. It’s really simple – when you press «TAB» you need to locate your cursor to the place you wanna click. The coordinates will be entered automatically to the dialog window.</p>
|
||||
<p>But if a software doesn’t have a static interface we highly recommend using the click on image feature. To do that just click the «Image» switch in the dialog window.</p>
|
||||
|
||||
<p>Depending on a switch selected the bottom part of the window will change – the «Select image», «Highlight image» buttons and «Match rate» input field will appear.</p>
|
||||
<p>The image that you need to click on to run the action can be configured in two ways:</p>
|
||||
<p>1) load an existing image by clicking the «Select image» button</p>
|
||||
<p>2) Use the «HIghlight image» button to select a fragment of the window snapshot. After clicking the button Studio will take a screenshot and will offer you to select a fragment of a resulting image.</p>
|
||||
<p>Keep in mind that if you use the “click on image” feature, that if there are multiple images on the screen the robot will apply the action to the first image found.</p>
|
||||
<p>The «Match rate» field is necessary for the cases, where the selected image slightly differs from the reality (for example, if on the image you highlighted the button in some way. but in reality the button is unhighlighted). In these kinds of cases you need to lower the match rate to the point when the robot will be able to find the image. But if you make the match rate really low, the robot might find the thing you weren’t looking for.</p>
|
||||
<p>Fields «Number of attempts» and «Pause between errors» are designed for when robot fails to find the image. You can specify how many times the robot should try to search for the desired image and how many seconds to wait between attempts. For example, after launching the browser, robot needs to press the «Plus» button to create a new tab. If browser launch time is gonna be longer than 5 seconds (this time is specified in the pause between actions field), then Studio will try to look for the «Plus», that’s not there yet. In that case the Studio will wait the number of seconds you specified between attempts and try again. As soon as the image is found, the program will wait the number of seconds you specified in the «Pause» field of the command, and proceed to the next.</p>
|
||||
|
||||
### Scrolling
|
||||
<p>This field appears when the action «Scrolling» is applied. The amount of pixels you need to scroll down for is entered to the field. If you need to scroll up, the number of pixels should be positive, but if you need to scroll down, the number of pixels should be negative.
|
||||
<p>The use of variables in all command creation dialog windows is possible.
|
||||
|
||||
<p>This field appears when the action «Scrolling» is applied. The amount of pixels you need to scroll down for is entered to the field. If you need to scroll up, the number of pixels should be positive, but if you need to scroll down, the number of pixels should be negative.</p>
|
||||
<p>The use of variables in all command creation dialog windows is possible.</p>
|
||||
|
||||
## Description of all actions available in the module
|
||||
|
||||
### Action «Click the mouse»
|
||||
|
||||
The main purpose of this module is pressing the left or right mouse button.
|
||||
|
||||
### Action «Double-click the mouse»
|
||||
|
||||
Double-clicks on the specified coordinates or image, for example, to open applications from the desktop.
|
||||
|
||||
### Action «Click the right mouse button»
|
||||
|
||||
Clicks the right mouse button, for example, to open a context menu.
|
||||
|
||||
### Action «Click the scroll wheel»
|
||||
|
||||
In some applications mouse wheel is used not only to scroll, but, for example to close the tabs. Action clicks the scroll wheel.
|
||||
|
||||
### Action «Scrolling»
|
||||
|
||||
The action scrolls the page up or down. Since there might be multiple scrolling sliders on the screen you need to position your cursor to the one you need. To scroll down you need to put in a negative number of pixels in the «Scrolling» field (-150), to scroll up you need to put in a positive number (150).
|
||||
|
||||
### Action «Enter text»
|
||||
<p>This action enters text that is written in the «Text» field. The field where the text is entered should be selected (there should be focus).
|
||||
<p>Some applications require specific text input (in the specific encoding). In these cases you should pick one of the encoders from the “Use encoder” drop-down list or enter the name of the desired encoder yourself. The text can be in a variable and be copied from any program that uses the specified encoding. In this case, when pasting copied text into another program, you must first scan it in the encoding of the original program. The encoding of the source program is entered or selected in the «Initial coding» field. Filling these fields is optional.
|
||||
<p>The «Use WinInput» checkbox allows you to enable more correct and faster text input, but it may not be supported by some applications. The use of this checkbox is optional.
|
||||
<p>Example of filling in an action:
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p>This action enters text that is written in the «Text» field. The field where the text is entered should be selected (there should be focus).</p>
|
||||
<p>Some applications require specific text input (in the specific encoding). In these cases you should pick one of the encoders from the “Use encoder” drop-down list or enter the name of the desired encoder yourself. The text can be in a variable and be copied from any program that uses the specified encoding. In this case, when pasting copied text into another program, you must first scan it in the encoding of the original program. The encoding of the source program is entered or selected in the «Initial coding» field. Filling these fields is optional.</p>
|
||||
<p>The «Use WinInput» checkbox allows you to enable more correct and faster text input, but it may not be supported by some applications. The use of this checkbox is optional.</p>
|
||||
<p>Example of filling in an action:</p>
|
||||
|
||||
|
||||
### Action «Press key»
|
||||
|
||||
Imitates the key presses of a keyboard. Choose the desired key in the «Key» drop-down list. All possible keys are available on the list, keys that might be present on some extended keyboards are present too (changing the volume, start/stop playback, etc.).
|
||||
<H1 align="center"></h1>
|
||||
|
||||
|
||||
### Action «Press two keys»
|
||||
|
||||
Imitates double key presses, for example CTRL+A – selection of all text in the field. All required keys are selected in the «Кнопка» drop-down list. The list is the same as in the «Press key» action.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
|
||||
### Action «Copy»
|
||||
|
||||
Imitates the CTRL+C hotkey. It copies the selected value to the clipboard and inserts it, if necessary, to the variable specified in the «Write to» field. This field is optional. Variables always start with the «@» symbol.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
|
||||
### Action «Paste»
|
||||
|
||||
Imitates the CTRL+V hotkey. Inserts the value from the clipboard into the selected field.
|
||||
|
||||
|
|
|
|||
373
docs/excel.md
373
docs/excel.md
|
|
@ -1,206 +1,325 @@
|
|||
|
||||
# <H1 align="center">«EXCEL» MODULE</h1>
|
||||
|
||||
<p> «Excel» module is the biggest module in the application. This module is made for processing Excel files in the background, not visible for the user. The module will sequentially run the list of commands given to it.</p>
|
||||
|
||||
## Module interface
|
||||
<p> The module window consists of several sections: «Add command», «General settings», «Command list» and a file preview window.
|
||||
<H1 align="center"></h1>
|
||||
<p> The preview window allows you to view all sheets of the downloaded file using tabs with sheet names and scroll bar. It is also possible to enter your values into the cells, apply different formatting, but these changes will not be saved, that is, this feature is available only for «fitting».
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> The module window consists of several sections: «Add command», «General settings», «Command list» and a file preview window.</p>
|
||||
|
||||
<p> The preview window allows you to view all sheets of the downloaded file using tabs with sheet names and scroll bar. It is also possible to enter your values into the cells, apply different formatting, but these changes will not be saved, that is, this feature is available only for «fitting».</p>
|
||||
|
||||
|
||||
## «General settings» section
|
||||
|
||||
### Upload file
|
||||
<p> «General settings» section consists of the «File name» field and «Upload file» and «Select cell» buttons.
|
||||
<p> We recommend starting work with the Excel module by selecting a work file. After that, After that, as the file is selected by the “Download file” button, you need to wait a few seconds and the specified file will be displayed in the preview window.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> «General settings» section consists of the «File name» field and «Upload file» and «Select cell» buttons.</p>
|
||||
<p> We recommend starting work with the Excel module by selecting a work file. After that, After that, as the file is selected by the “Download file” button, you need to wait a few seconds and the specified file will be displayed in the preview window.</p>
|
||||
|
||||
|
||||
## «Add command» and «Command list» section
|
||||
<p> «Add command» section is the main section of the module. It creates actions that mimic the work of the user, for example, such as reading a certain range of cells, then transfer it to another sheet, delete duplicates and build a pie chart. It this case 4 actions were described. These 4 actions must be sequentially selected and added to the «Command list» section - a table showing all the actions that will be performed by this module. The number of fields in this section is not always the same, it depends on a selected action in the first field.
|
||||
|
||||
<p> «Add command» section is the main section of the module. It creates actions that mimic the work of the user, for example, such as reading a certain range of cells, then transfer it to another sheet, delete duplicates and build a pie chart. It this case 4 actions were described. These 4 actions must be sequentially selected and added to the «Command list» section - a table showing all the actions that will be performed by this module. The number of fields in this section is not always the same, it depends on a selected action in the first field.</p>
|
||||
<p> «Add», «Edit» and «Delete» buttons are designed to work with the «Add command» and «Command list» sections.</p>
|
||||
|
||||
### Adding a command
|
||||
<p> To add a command click the «Add» button. It puts the created action into the “Command list” table.
|
||||
<H1 align="center"></h1>
|
||||
<p> When choosing a row from the list of commands, information about the selected action will show up in the «Add command» section.
|
||||
<p> In addition to the specified functionality, the “Add” button is used to copy existing actions from the list of commands. To do that you need to select a row from the list of commands and click the «Add» button. Thus, if you need to perform an action several times, just copy it other than creating it again.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> To add a command click the «Add» button. It puts the created action into the “Command list” table.</p>
|
||||
|
||||
<p> When choosing a row from the list of commands, information about the selected action will show up in the «Add command» section.</p>
|
||||
<p> In addition to the specified functionality, the “Add” button is used to copy existing actions from the list of commands. To do that you need to select a row from the list of commands and click the «Add» button. Thus, if you need to perform an action several times, just copy it other than creating it again.</p>
|
||||
|
||||
|
||||
### Editing a command
|
||||
|
||||
<p> The «Edit» button is designed for editing commands. To change a command, select it from the list of commands, make all changes in the «Add command» section, then click «Edit» to save the changes.</p>
|
||||
|
||||
### Changing the order of actions
|
||||
|
||||
<p> «Up» and «Down» buttons are designed to change the order of actions. Buttons are located to the right side of the list of commands.</p>
|
||||
<p> Changing the order of actions is necessary when it is necessary to add an action that was not foreseen immediately and was not included in the list of commands. In this case you can add an action using the normal way, then just move it wherever you want.</p>
|
||||
<H1 align="center"></h1>
|
||||
<H1 align="center"></h1>
|
||||
|
||||
|
||||
|
||||
### Deleting a command
|
||||
|
||||
<p> The «Delete» button deletes the selected row from the list of commands. </p>
|
||||
|
||||
### Turning off a command
|
||||
|
||||
<p> If you don’t wanna delete a command, because for example you wanted to see how the robot works without it, but then add it back to work, you can disable a command by right-clicking on the corresponding line and turn it off or, conversely, turn it on.</p>
|
||||
<H1 align="center"></h1>
|
||||
|
||||
|
||||
### Selecting a cell
|
||||
|
||||
<p> The button «Select cell» works for each action in its own way, but it has one meaning - it fills the «Cells» or «Range" fields (depending on which one is used in the selected action) with the name of the cell/range selected in the preview window and enters in the «Sheet» field the name of the sheet on which the selected cells are located.In some actions, only one cell is filled by clicking the button, although a range has been selected - this means that in this action the use of a range is impossible.</p>
|
||||
<H1 align="center"></h1>
|
||||
<H1 align="center"></h1>
|
||||
|
||||
|
||||
<p> In some actions, the “Select Cell” button fills in the numbers of columns, rows. When working with files, it is recommended to use it to minimize the occurrence of syntax errors.</p>
|
||||
|
||||
### Saving a command
|
||||
|
||||
<p> To save a command in the Excel module press the «Save» button in the bottom right corner.</p>
|
||||
<H1 align="center"></h1>
|
||||
|
||||
|
||||
## Actions available in the module
|
||||
<p> Actions are divided into groups for more comfortable navigation through the drop-down list. If you know the name of an action, you can enter it into the «Action» field, and the software will try to give you the action you need.
|
||||
|
||||
<p> Actions are divided into groups for more comfortable navigation through the drop-down list. If you know the name of an action, you can enter it into the «Action» field, and the software will try to give you the action you need.</p>
|
||||
|
||||
### «Work with data» group
|
||||
|
||||
#### Action «Read data»
|
||||
<p> This action allows the robot to read from one specific cell or from a range of cells. If only one cell is specified then the «Element» type variable will be made, but if a range of cells is specified then the «Table» type variable will be made.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> This action allows the robot to read from one specific cell or from a range of cells. If only one cell is specified then the «Element» type variable will be made, but if a range of cells is specified then the «Table» type variable will be made.</p>
|
||||
|
||||
|
||||
#### Action «Record data»
|
||||
<p> This action allows you to record the specified value in one or in a range of cells.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> This action allows you to record the specified value in one or in a range of cells.</p>
|
||||
|
||||
|
||||
#### Action «Formula»
|
||||
<p> This action makes the robot write a formula in a specified cell (or a range of cells) and return the result to the specified variable. The «Variable» field can be left blank, if the result of a formula is not important.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> This action makes the robot write a formula in a specified cell (or a range of cells) and return the result to the specified variable. The «Variable» field can be left blank, if the result of a formula is not important.</p>
|
||||
|
||||
|
||||
#### Action «Get formula»
|
||||
<p> The action returns the formula from the cell to the specified variable.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> The action returns the formula from the cell to the specified variable.</p>
|
||||
|
||||
|
||||
#### Action «Replace the formula with its value»
|
||||
<p> This action replaces the formula in the cell or range of cells with its result.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> This action replaces the formula in the cell or range of cells with its result.</p>
|
||||
|
||||
|
||||
### «Work with rows» group
|
||||
|
||||
#### Action «Add row»
|
||||
<p> Action adds a row to the specified location.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> Action adds a row to the specified location.</p>
|
||||
|
||||
|
||||
#### Action «Delete row»
|
||||
<p> Action deletes the specified row.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> Action deletes the specified row.</p>
|
||||
|
||||
|
||||
#### Action «Get row count»
|
||||
<p> The action returns the number of the last used row in the sheet to the specified variable.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> The action returns the number of the last used row in the sheet to the specified variable.</p>
|
||||
|
||||
|
||||
#### Action «Get the number of filtered rows»
|
||||
<p> Action returns the number of visible rows with the applied filter to the specified variable.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> Action returns the number of visible rows with the applied filter to the specified variable.</p>
|
||||
|
||||
|
||||
### «Work with columns» group
|
||||
|
||||
#### Action «Add column»
|
||||
<p> Action adds a new column into the specified location.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> Action adds a new column into the specified location.</p>
|
||||
|
||||
|
||||
#### Action «Delete column»
|
||||
<p> Action deletes the specified column.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> Action deletes the specified column.</p>
|
||||
|
||||
|
||||
#### Action «Get the column count»
|
||||
<p> The action returns the number of the last used column in the sheet.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> The action returns the number of the last used column in the sheet.</p>
|
||||
|
||||
|
||||
### «Work with sheets and files» group
|
||||
|
||||
#### Action «Create a new sheet»
|
||||
<p> The action creates a new sheet with a specified name.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> The action creates a new sheet with a specified name.</p>
|
||||
|
||||
|
||||
#### Action «Delete sheet»
|
||||
<p> Action deletes a sheet with a specified name.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> Action deletes a sheet with a specified name.</p>
|
||||
|
||||
|
||||
#### Action «Clear sheet»
|
||||
<p> Action clears data from the cells. Action doesn’t clear the formatting!
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> Action clears data from the cells. Action doesn’t clear the formatting!</p>
|
||||
|
||||
|
||||
#### Action «Create a new file»
|
||||
<p> Action creates a new file in the specified folder with specified name and filename extension (if the filename extension is not specified, .xlsx file will be created.) If the «Sheet» field is filled, then the first sheet of the file will be named as specified in the «Sheet» field, if not it will leave it by default.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> Action creates a new file in the specified folder with specified name and filename extension (if the filename extension is not specified, .xlsx file will be created.) If the «Sheet» field is filled, then the first sheet of the file will be named as specified in the «Sheet» field, if not it will leave it by default.</p>
|
||||
|
||||
|
||||
#### Action «Fill in a sheet, based on an Excel file»
|
||||
<p> This action fills the sheet of the current file by analogy with the sheet of some other file. In the «Sheet» field the sheet of the current file is specified.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> This action fills the sheet of the current file by analogy with the sheet of some other file. In the «Sheet» field the sheet of the current file is specified.</p>
|
||||
|
||||
|
||||
#### Exporting to PDF
|
||||
<p> Action allows to save excel files in the PDF format using standard WIndows methods, meaning that the division of the sheet of the Excel file into sheets in the PDF document will be performed according to the standard settings specified in the Excel file (the default is A4 sheet size, with normal fields).
|
||||
<H1 align="center"></h1>
|
||||
<p> The name of the file and its directory will coincide with the exported file.
|
||||
|
||||
<p> Action allows to save excel files in the PDF format using standard WIndows methods, meaning that the division of the sheet of the Excel file into sheets in the PDF document will be performed according to the standard settings specified in the Excel file (the default is A4 sheet size, with normal fields).</p>
|
||||
|
||||
<p> The name of the file and its directory will coincide with the exported file.</p>
|
||||
|
||||
### «Search» group
|
||||
|
||||
#### Action «Find data»
|
||||
<p> Searches for the specified row in the specified sheet and returns the address of the first cell found.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> Searches for the specified row in the specified sheet and returns the address of the first cell found.</p>
|
||||
|
||||
|
||||
#### Action «Search for a row by column values»
|
||||
<p> This action searches and returns the number of the first row found, in the specified columns of which the specified values are written.
|
||||
<H1 align="center"></h1>
|
||||
<p> In this case, a row will be searched, in column A - 03/23/2020, and in column B - Ufa.
|
||||
|
||||
<p> This action searches and returns the number of the first row found, in the specified columns of which the specified values are written.</p>
|
||||
|
||||
<p> In this case, a row will be searched, in column A - 03/23/2020, and in column B - Ufa.</p>
|
||||
|
||||
#### Action «Find sheet»
|
||||
<p> Searches for a sheet in which there is a cell with the value specified in the «Row» field and returns its name to the specified variable.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> Searches for a sheet in which there is a cell with the value specified in the «Row» field and returns its name to the specified variable.</p>
|
||||
|
||||
|
||||
### Group «Other functions»
|
||||
|
||||
#### Action «Shift cell»
|
||||
<p> Moves a cell on the specified number of rows and columns, and then returns the result to the variable (in this case, the result is D13).
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> Moves a cell on the specified number of rows and columns, and then returns the result to the variable (in this case, the result is D13).</p>
|
||||
|
||||
|
||||
#### Action «Apply filter»
|
||||
<p> This action adds a filter to the table specified on a sheet, the cell from which is specified in the «A cell from the range of values» field. The column which you want to apply a filter to is written in the «Column» field. You can only filter a single column. If you need to apply several filters to one table, then you need to add an action to each filter within the same Excel module. The function by which the comparison should take place is selected from the drop-down list in the «Function» field, the value with which the comparison will be performed during filtering is indicated in the «Value» field.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> This action adds a filter to the table specified on a sheet, the cell from which is specified in the «A cell from the range of values» field. The column which you want to apply a filter to is written in the «Column» field. You can only filter a single column. If you need to apply several filters to one table, then you need to add an action to each filter within the same Excel module. The function by which the comparison should take place is selected from the drop-down list in the «Function» field, the value with which the comparison will be performed during filtering is indicated in the «Value» field.</p>
|
||||
|
||||
|
||||
#### Action «Delete filter»
|
||||
<p> The action deletes all filters from the sheet.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> The action deletes all filters from the sheet.</p>
|
||||
|
||||
|
||||
#### Action «Add sorting»
|
||||
<p> The action adds sorting to the specified range by the selected column. Depending on the checkbox, it is determined whether the column is sorted in descending or ascending order. You can only sort a single column.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> The action adds sorting to the specified range by the selected column. Depending on the checkbox, it is determined whether the column is sorted in descending or ascending order. You can only sort a single column.</p>
|
||||
|
||||
|
||||
#### Action «Clear the range»
|
||||
<p> The action deletes all cell values and formatting in the specified range.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> The action deletes all cell values and formatting in the specified range.</p>
|
||||
|
||||
|
||||
#### Action «Get unique column values»
|
||||
<p> Similar to the «Delete duplicates» action in Excel, this action returns only the unique values of the specified columns from the range. The finished table can be inserted both into the same sheet and into another sheet, but in the same range. Depending on the presence of duplicates, the number of rows may be reduced.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> Similar to the «Delete duplicates» action in Excel, this action returns only the unique values of the specified columns from the range. The finished table can be inserted both into the same sheet and into another sheet, but in the same range. Depending on the presence of duplicates, the number of rows may be reduced.</p>
|
||||
|
||||
|
||||
#### Action «Subtotal»
|
||||
<p> The action adds an Excel «Subtotals» operation to the specified sheet to the specified range.
|
||||
<H1 align="center"></h1>
|
||||
<p> The «For columns» field matches the «Add totals by» field in Excel (Marked green), the «Each time a column changes» field matches the similar field in Excel, but must be filled in with the name of the Excel column (A, B , ... or 1, 2, ...) (highlighted in red), the «Functions» field is filled with the operation that should be applied to all of the selected columns (highlighted in blue).
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> The action adds an Excel «Subtotals» operation to the specified sheet to the specified range.</p>
|
||||
|
||||
<p> The «For columns» field matches the «Add totals by» field in Excel (Marked green), the «Each time a column changes» field matches the similar field in Excel, but must be filled in with the name of the Excel column (A, B , ... or 1, 2, ...) (highlighted in red), the «Functions» field is filled with the operation that should be applied to all of the selected columns (highlighted in blue).</p>
|
||||
|
||||
|
||||
#### Action «Pivot table»
|
||||
<p> Adds a summary table to the specified sheet and range (the «Sheet, range for insertion» field) based on the table data from the «Sheet, source range» field.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> Adds a summary table to the specified sheet and range (the «Sheet, range for insertion» field) based on the table data from the «Sheet, source range» field.</p>
|
||||
|
||||
In the «Fields in columns», «Fields in values» and «Fields in rows» fields the column names of the source table (and not the Excel table) are entered, as in Excel:
|
||||
<p> «Fields in columns» match the names of the columns of the table whose values should be located in the columns of the pivot table (highlighted in green);
|
||||
<p> «Fields in values» сmatch the names of the columns of the table whose values should be located in the values of the pivot table (highlighted in red);
|
||||
<p> «Fields in rows» match the names of the columns of the table whose values should be located in the rows of the pivot table (highlighted in blue);
|
||||
<H1 align="center"></h1>
|
||||
<p> «Fields in columns» match the names of the columns of the table whose values should be located in the columns of the pivot table (highlighted in green);</p>
|
||||
<p> «Fields in values» сmatch the names of the columns of the table whose values should be located in the values of the pivot table (highlighted in red);</p>
|
||||
<p> «Fields in rows» match the names of the columns of the table whose values should be located in the rows of the pivot table (highlighted in blue);</p>
|
||||
|
||||
|
||||
#### Action «Copy and paste cell/range»
|
||||
<p> This action copies files and formatting from one file and inserts it to another. You can «stretch» formulas using this action (see. «Action «Formula»).
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> This action copies files and formatting from one file and inserts it to another. You can «stretch» formulas using this action (see. «Action «Formula»).</p>
|
||||
|
||||
|
||||
#### Action «Show as percentage»
|
||||
<p> Action converts the selected range into percentage.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> Action converts the selected range into percentage.</p>
|
||||
|
||||
|
||||
#### Action «Pie chart»
|
||||
<p> Action creates a pie chart on a specified sheet. Values of the chart are taken from the range specified in the «Cells» field, a range with value names is indicated in the «range of names» field. In the «Location» field the borders of the location of the pie chart are indicated, especially the upper left corner and the lower right corner, separated by commas.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> Action creates a pie chart on a specified sheet. Values of the chart are taken from the range specified in the «Cells» field, a range with value names is indicated in the «range of names» field. In the «Location» field the borders of the location of the pie chart are indicated, especially the upper left corner and the lower right corner, separated by commas.</p>
|
||||
|
||||
|
||||
#### Action «Graph»
|
||||
<p> The action creates a line graph with one or more rows.A row must be indicated in the «Range of values» field as a one-dimensional range (one column or one row). If there are more than one row, then following rows must be indicated through «;», as indicated in Figure. 2.5.35. There should be a single range of arguments, and must be indicated through «;». «Cells with row names» are filled with cell names through «;», their number should be equal to the number of rows, the first cell displays the name of the first row, etc. The cell in which the upper left corner of the graph will be located is recorded in the insertion cell.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> The action creates a line graph with one or more rows.A row must be indicated in the «Range of values» field as a one-dimensional range (one column or one row). If there are more than one row, then following rows must be indicated through «;», as indicated in Figure. 2.5.35. There should be a single range of arguments, and must be indicated through «;». «Cells with row names» are filled with cell names through «;», their number should be equal to the number of rows, the first cell displays the name of the first row, etc. The cell in which the upper left corner of the graph will be located is recorded in the insertion cell.</p>
|
||||
|
||||
|
||||
#### Action «Value check»
|
||||
<p> The action restricts the types of data that can be entered into selected cells by selecting the proposed rules. In the «Sheet» field, a sheet is entered, the cells of which you wanna restrict, in the «Cells» field, a range of cells is entered on which the values will be checked when entering. In the «Data type» field one of the offered data types is chosen – integer or real number, list, date, text length, time. «Operation» field consists of the list of available functions for creating a checking rule – equal, not equal, greater, less, greater or equal, less or equal, between and out. When using the «List» data type filling in the «Operation» field is not required, therefore you can’t edit it.
|
||||
<p> Last field changes depending on the data type – for the «List» data type - «Data source», for all others – «Criterias (through ;)». The «Data source» field is filled with one-dimensional range of values (range within a single column or single row), which will be specified in the list (if the list is static, then specify an absolute link). The «Criteria (through ;)» field is filled with values against which the verification rule will apply.
|
||||
<p> The «Error message» field is filled with the error text that will be displayed, if a value is entered in the cell that does not satisfy the rule set for it. This field is optional. If you leave it blank, then the following error message will appear: «The entered value is incorrect. The set of values that can be entered in a cell is limited».
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> The action restricts the types of data that can be entered into selected cells by selecting the proposed rules. In the «Sheet» field, a sheet is entered, the cells of which you wanna restrict, in the «Cells» field, a range of cells is entered on which the values will be checked when entering. In the «Data type» field one of the offered data types is chosen – integer or real number, list, date, text length, time. «Operation» field consists of the list of available functions for creating a checking rule – equal, not equal, greater, less, greater or equal, less or equal, between and out. When using the «List» data type filling in the «Operation» field is not required, therefore you can’t edit it.</p>
|
||||
<p> Last field changes depending on the data type – for the «List» data type - «Data source», for all others – «Criterias (through ;)». The «Data source» field is filled with one-dimensional range of values (range within a single column or single row), which will be specified in the list (if the list is static, then specify an absolute link). The «Criteria (through ;)» field is filled with values against which the verification rule will apply.</p>
|
||||
<p> The «Error message» field is filled with the error text that will be displayed, if a value is entered in the cell that does not satisfy the rule set for it. This field is optional. If you leave it blank, then the following error message will appear: «The entered value is incorrect. The set of values that can be entered in a cell is limited».</p>
|
||||
|
||||
|
||||
### «Formatting» group
|
||||
|
||||
#### Action «Conditional formatting»
|
||||
<p> The action formats the specified cells on the selected sheet, depending on whether they satisfy the specified condition. In the «Sheet, range» field, a sheet and range or a single cell from the sheet are entered, separated by commas, to which conditional formatting will be applied. The «Filling color» and «Text color» indicate the colors with which the cell will be filled and the text in it will be colored, if it satisfies the condition. The condition is made of the function selection and the indication of a value, for comparison. Available functions - equal, not equal, greater, less, greater or equal, less or equal, formula. If the «formula» function is chosen, then you need to enter a formula in Excel format (starting with an «=» symbol) in the «Comparison value» field.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> The action formats the specified cells on the selected sheet, depending on whether they satisfy the specified condition. In the «Sheet, range» field, a sheet and range or a single cell from the sheet are entered, separated by commas, to which conditional formatting will be applied. The «Filling color» and «Text color» indicate the colors with which the cell will be filled and the text in it will be colored, if it satisfies the condition. The condition is made of the function selection and the indication of a value, for comparison. Available functions - equal, not equal, greater, less, greater or equal, less or equal, formula. If the «formula» function is chosen, then you need to enter a formula in Excel format (starting with an «=» symbol) in the «Comparison value» field.</p>
|
||||
|
||||
|
||||
#### Action «Color of the cell/range»
|
||||
<p> The action changes the fill color of the text in the specified range/cell.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> The action changes the fill color of the text in the specified range/cell.</p>
|
||||
|
||||
|
||||
#### Action «Width of column(s)»
|
||||
<p> Action changes the width of the specified columns. Columns can be separated by a comma, you can put in their numbers instead of their names (starting from 1). Width is specified using the same unit of measure as in Excel.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> Action changes the width of the specified columns. Columns can be separated by a comma, you can put in their numbers instead of their names (starting from 1). Width is specified using the same unit of measure as in Excel.</p>
|
||||
|
||||
|
||||
#### Action «Height of row(s)»
|
||||
<p> Action changes the length of rows. Length is specified using the same unit of measure as in Excel.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> Action changes the length of rows. Length is specified using the same unit of measure as in Excel.</p>
|
||||
|
||||
|
||||
#### Action «Merging cells»
|
||||
<p> Action merges cells on the selected sheet. Module has 3 types of merging:
|
||||
<p> ● simple merging – merges columns as well as range columns;
|
||||
<p> ● row merging;
|
||||
<p> ● column merging.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> Action merges cells on the selected sheet. Module has 3 types of merging:</p>
|
||||
<p> ● simple merging – merges columns as well as range columns;</p>
|
||||
<p> ● row merging;</p>
|
||||
<p> ● column merging.</p>
|
||||
|
||||
|
||||
#### Action «Clear formatting»
|
||||
<p> Action clears the formatting in the specified range of the selected sheet.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> Action clears the formatting in the specified range of the selected sheet.</p>
|
||||
|
||||
|
||||
#### Action «Cell format»
|
||||
<p> Action changes the format of the specified cell. By default, all values entered in Excel by the studio have a string format, therefore, for the correct calculation of formulas or sorting, it is necessary to change the format of the data to your desired one.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> Action changes the format of the specified cell. By default, all values entered in Excel by the studio have a string format, therefore, for the correct calculation of formulas or sorting, it is necessary to change the format of the data to your desired one.</p>
|
||||
|
||||
|
||||
#### Action «Number format»
|
||||
<p> The action displays the number according to certain rules of the Excel number format.
|
||||
<H1 align="center"></h1>
|
||||
<p> You can view all formats in Excel, just right click on a cell – «Cell format» – tab «Number» - (all formats):
|
||||
<H1 align="center"></h1>
|
||||
<p> The most commonly used formats are suggested if you hover your cursor over the field to enter a format.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> The action displays the number according to certain rules of the Excel number format.</p>
|
||||
|
||||
<p> You can view all formats in Excel, just right click on a cell – «Cell format» – tab «Number» - (all formats):</p>
|
||||
|
||||
<p> The most commonly used formats are suggested if you hover your cursor over the field to enter a format.</p>
|
||||
|
||||
|
||||
#### Action «Alignment»
|
||||
<p> The action applies the specified alignment in the specified cells. You can choose one of two things in the «General position» field - apply alignment vertically or horizontally. You can select the alignment in the «Align content» field. Three types of alignment are offered: by left/right edge, by the top/bottom edge and by the center.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> The action applies the specified alignment in the specified cells. You can choose one of two things in the «General position» field - apply alignment vertically or horizontally. You can select the alignment in the «Align content» field. Three types of alignment are offered: by left/right edge, by the top/bottom edge and by the center.</p>
|
||||
|
||||
|
||||
#### Action «Font»
|
||||
<p> Action changes the font, the style or the size of selected cells on the specified sheet. Module offers all default Microsoft Office fonts.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> Action changes the font, the style or the size of selected cells on the specified sheet. Module offers all default Microsoft Office fonts.</p>
|
||||
|
||||
|
||||
#### Action «Borders»
|
||||
<p> Action adds or changes the cell borders of the selected cells on the specified sheet. This action involves configuring the borders - external, internal; only the right one, etc., the color of the borders and their style - thick, thin, dashed line, etc.
|
||||
<H1 align="center"></h1>
|
||||
|
||||
<p> Action adds or changes the cell borders of the selected cells on the specified sheet. This action involves configuring the borders - external, internal; only the right one, etc., the color of the borders and their style - thick, thin, dashed line, etc.</p>
|
||||
|
||||
|
|
@ -1,41 +1,59 @@
|
|||
|
||||
# <H1 align="center">INTRODUCTION</h1>
|
||||
|
||||
<p> The manual is made for people who want to learn how to make robots in Lexema-RPA Studio software. You will be introduced to all of the instruments and modules of the Studio. Instruments and modules are used to make robots.
|
||||
<p> The manual is made for people who want to learn how to make robots in Lexema-RPA Studio software. You will be introduced to all of the instruments and modules of the Studio. Instruments and modules are used to make robots.</p>
|
||||
<p> Lexema-RPA Studio, hereinafter referred to as Studio, allows users to configure the sequence of interactions with different softwares. The interaction is configured with help of the programming modules, which are a part of the Studio. Every module is a separate number of features, necessary to perform a specific action, and mechanisms for its configuration.</p>
|
||||
|
||||
## PURPOSE OF SOFTWARE
|
||||
<p> Lexema-RPA Studio is designed to develop software robots.
|
||||
|
||||
<p> Lexema-RPA Studio is designed to develop software robots.</p>
|
||||
|
||||
## What is RPA?
|
||||
<p> Robotic process automation (or RPA) — is a form of business process automation technology (sometimes referred to as software robotics; not to be confused with robot software) based on metaphorical software robots (bots) or artificial intelligence (AI)/digital workers.
|
||||
<p> Simplified, RPAs — are software robots that emulate human actions performed by them on a computer.
|
||||
|
||||
<p> Robotic process automation (or RPA) — is a form of business process automation technology (sometimes referred to as software robotics; not to be confused with robot software) based on metaphorical software robots (bots) or artificial intelligence (AI)/digital workers.</p>
|
||||
<p> Simplified, RPAs — are software robots that emulate human actions performed by them on a computer.</p>
|
||||
|
||||
## What can robots do?
|
||||
<p> Robots can perform routine operations on a computer instead of humans:
|
||||
<p> ● enter data from the keyboard, use a mouse, read information from a computer screen, receive and process email, interact with office software.
|
||||
<p> ● integrate data from one system to another without the use of additional tools.
|
||||
|
||||
<p> Robots can perform routine operations on a computer instead of humans:</p>
|
||||
<p> ● enter data from the keyboard, use a mouse, read information from a computer screen, receive and process email, interact with office software.</p>
|
||||
<p> ● integrate data from one system to another without the use of additional tools.</p>
|
||||
|
||||
## How long does it take to create robots?
|
||||
<p> Robots are made in a simple graphic interface, and the time spent on a robot depends on its complexity. You can make a simple robot within a few hours, for labor-intensive ones it can take a few days.
|
||||
|
||||
<p> Robots are made in a simple graphic interface, and the time spent on a robot depends on its complexity. You can make a simple robot within a few hours, for labor-intensive ones it can take a few days.</p>
|
||||
|
||||
## Areas of use of robots
|
||||
|
||||
### Back up robots (integrators)
|
||||
<p> ● Transferring information from one system to another;
|
||||
<p> ● Data overflow.
|
||||
|
||||
<p> ● Transferring information from one system to another;</p>
|
||||
<p> ● Data overflow.</p>
|
||||
|
||||
### HR-robots
|
||||
<p> ● Search for vacancies by specific criteria.
|
||||
|
||||
<p> ● Search for vacancies by specific criteria.</p>
|
||||
|
||||
### Operator-robots
|
||||
<p> ● Reading and entering data from scanned copies of documents.
|
||||
|
||||
<p> ● Reading and entering data from scanned copies of documents.</p>
|
||||
|
||||
### Consolidator robots
|
||||
<p> ● Consolidation of data into a report;
|
||||
<p> ● Bulk sending or printing of documents.
|
||||
|
||||
<p> ● Consolidation of data into a report;</p>
|
||||
<p> ● Bulk sending or printing of documents.</p>
|
||||
|
||||
### Buying robots
|
||||
<p> ● Monitoring marketplaces;
|
||||
<p> ● Uploading tender information;
|
||||
<p> ● Selection of suppliers based on specific conditions
|
||||
|
||||
<p> ● Monitoring marketplaces;</p>
|
||||
<p> ● Uploading tender information;</p>
|
||||
<p> ● Selection of suppliers based on specific conditions</p>
|
||||
|
||||
### Robot-salesman
|
||||
<p> ● Counterparty Reliability Check;
|
||||
<p> ● Formation of commercial offers
|
||||
|
||||
<p> ● Counterparty Reliability Check;</p>
|
||||
<p> ● Formation of commercial offers</p>
|
||||
|
||||
## Where to begin?
|
||||
<p> To get started, you need to download Lexema-RPA Studio from the following website <a href="http://lexema.ru/lexemarpastudio/registratsiya/">website</a>. Before the download begins you will be offered to make an account. The signup is necessary to log into the Studio. After you sign up, the installer will begin downloading.
|
||||
|
||||
<p> To get started, you need to download Lexema-RPA Studio from the following website <a href="http://lexema.ru/lexemarpastudio/registratsiya/">website</a>. Before the download begins you will be offered to make an account. The signup is necessary to log into the Studio. After you sign up, the installer will begin downloading.</p>
|
||||
|
|
|
|||
|
|
@ -0,0 +1,128 @@
|
|||
#
|
||||
# This file is autogenerated by pip-compile with Python 3.10
|
||||
# by the following command:
|
||||
#
|
||||
# pip-compile
|
||||
#
|
||||
attrs==23.1.0
|
||||
# via igittigitt
|
||||
babel==2.13.1
|
||||
# via mkdocs-material
|
||||
bracex==2.4
|
||||
# via wcmatch
|
||||
build==1.0.3
|
||||
# via pip-tools
|
||||
certifi==2023.7.22
|
||||
# via requests
|
||||
charset-normalizer==3.3.1
|
||||
# via requests
|
||||
cli-exit-tools==1.2.6
|
||||
# via igittigitt
|
||||
click==8.1.7
|
||||
# via
|
||||
# cli-exit-tools
|
||||
# igittigitt
|
||||
# mkdocs
|
||||
# pip-tools
|
||||
colorama==0.4.6
|
||||
# via mkdocs-material
|
||||
contextlib2==21.6.0
|
||||
# via schema
|
||||
ghp-import==2.1.0
|
||||
# via mkdocs
|
||||
idna==3.4
|
||||
# via requests
|
||||
igittigitt==2.1.4
|
||||
# via mkdocs-file-filter-plugin
|
||||
jinja2==3.1.2
|
||||
# via
|
||||
# mkdocs
|
||||
# mkdocs-material
|
||||
lib-detect-testenv==2.0.8
|
||||
# via
|
||||
# cli-exit-tools
|
||||
# igittigitt
|
||||
markdown==3.5
|
||||
# via
|
||||
# mkdocs
|
||||
# mkdocs-material
|
||||
# pymdown-extensions
|
||||
markupsafe==2.1.3
|
||||
# via
|
||||
# jinja2
|
||||
# mkdocs
|
||||
mergedeep==1.3.4
|
||||
# via mkdocs
|
||||
mkdocs==1.5.3
|
||||
# via
|
||||
# lexema8-doc (pyproject.toml)
|
||||
# mkdocs-file-filter-plugin
|
||||
# mkdocs-literate-nav
|
||||
# mkdocs-material
|
||||
mkdocs-file-filter-plugin==0.1.0
|
||||
# via lexema8-doc (pyproject.toml)
|
||||
mkdocs-glightbox==0.3.4
|
||||
# via lexema8-doc (pyproject.toml)
|
||||
mkdocs-literate-nav==0.6.1
|
||||
# via lexema8-doc (pyproject.toml)
|
||||
mkdocs-material==9.4.8
|
||||
# via lexema8-doc (pyproject.toml)
|
||||
mkdocs-material-extensions==1.3
|
||||
# via mkdocs-material
|
||||
packaging==23.2
|
||||
# via
|
||||
# build
|
||||
# mkdocs
|
||||
paginate==0.5.6
|
||||
# via mkdocs-material
|
||||
pathspec==0.11.2
|
||||
# via mkdocs
|
||||
pip-tools==7.3.0
|
||||
# via lexema8-doc (pyproject.toml)
|
||||
platformdirs==3.11.0
|
||||
# via mkdocs
|
||||
pygments==2.16.1
|
||||
# via mkdocs-material
|
||||
pymdown-extensions==10.3.1
|
||||
# via
|
||||
# lexema8-doc (pyproject.toml)
|
||||
# mkdocs-material
|
||||
pyproject-hooks==1.0.0
|
||||
# via build
|
||||
python-dateutil==2.8.2
|
||||
# via ghp-import
|
||||
pyyaml==6.0.1
|
||||
# via
|
||||
# mkdocs
|
||||
# mkdocs-file-filter-plugin
|
||||
# pymdown-extensions
|
||||
# pyyaml-env-tag
|
||||
pyyaml-env-tag==0.1
|
||||
# via
|
||||
# mkdocs
|
||||
# mkdocs-file-filter-plugin
|
||||
regex==2023.10.3
|
||||
# via mkdocs-material
|
||||
requests==2.31.0
|
||||
# via mkdocs-material
|
||||
schema==0.7.5
|
||||
# via mkdocs-file-filter-plugin
|
||||
six==1.16.0
|
||||
# via python-dateutil
|
||||
tomli==2.0.1
|
||||
# via
|
||||
# build
|
||||
# pip-tools
|
||||
# pyproject-hooks
|
||||
urllib3==2.0.7
|
||||
# via requests
|
||||
watchdog==3.0.0
|
||||
# via mkdocs
|
||||
wcmatch==8.5
|
||||
# via igittigitt
|
||||
wheel==0.41.3
|
||||
# via pip-tools
|
||||
|
||||
# The following packages are considered to be unsafe in a requirements file:
|
||||
# pip
|
||||
# setuptools
|
||||
Loading…
Reference in New Issue