forked from open-rpa/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
3.3.configuring_openrpa.html
445 lines (337 loc) · 46.3 KB
/
3.3.configuring_openrpa.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Configuring OpenRPA — BPA/OpenIAP Docs 1.0.2 documentation</title>
<script type="text/javascript" src="static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="static/documentation_options.js"></script>
<script src="static/jquery.js"></script>
<script src="static/underscore.js"></script>
<script src="static/doctools.js"></script>
<script src="static/language_data.js"></script>
<script type="text/javascript" src="static/js/theme.js"></script>
<link rel="stylesheet" href="static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="static/pygments.css" type="text/css" />
<link rel="stylesheet" href="static/styles.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> BPA/OpenIAP Docs
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="rpa.html">1. <strong>Introduction to RPA</strong></a></li>
<li class="toctree-l1"><a class="reference internal" href="openflow.html">2. <strong>OpenFlow</strong></a></li>
<li class="toctree-l1"><a class="reference internal" href="openrpa.html">3. <strong>OpenRPA</strong></a></li>
<li class="toctree-l1"><a class="reference internal" href="node_red.html">4. <strong>Node-RED</strong></a></li>
<li class="toctree-l1"><a class="reference internal" href="appendix_a.html">5. <strong>Appendix A</strong></a></li>
<li class="toctree-l1"><a class="reference internal" href="appendix_b.html">6. <strong>Appendix B</strong></a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="license.html">1. License</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">BPA/OpenIAP Docs</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li><strong>Configuring OpenRPA</strong></li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="configuring-openrpa">
<h1><strong>Configuring OpenRPA</strong><a class="headerlink" href="#configuring-openrpa" title="Permalink to this headline">¶</a></h1>
<p><strong>OpenRPA</strong> settings are saved locally in a file named <code class="docutils literal notranslate"><span class="pre">settings.json</span></code> and it is always ¹ located in user’s <code class="docutils literal notranslate"><span class="pre">Documents\OpenRPA</span></code> folder (or full path <code class="docutils literal notranslate"><span class="pre">C:\Users\{YOUR_USER}\Documents\OpenRPA</span></code>). This file contains all configuration parameters for <strong>OpenRPA</strong>, including some which are not accessible through the GUI.</p>
<p><strong>OpenRPA</strong> GUI layout settings, however, are saved in another file: <code class="docutils literal notranslate"><span class="pre">layout.config</span></code>. Deleting <code class="docutils literal notranslate"><span class="pre">layout.config</span></code> bears no trouble, since it will only lose the user’s layout preferences (panel sizes, order, location etc).</p>
<p>Editing either file (<code class="docutils literal notranslate"><span class="pre">settings.json</span></code> / <code class="docutils literal notranslate"><span class="pre">layout.config</span></code>) while <strong>OpenRPA</strong> is running will have no effect and, when the application is closed, any value changed will be lost/overwritten. Hence, if you desire to edit any setting, always make sure that <strong>OpenRPA</strong> is not running.</p>
<p>Further on this section, readers will find documentation for all the parameters from <code class="docutils literal notranslate"><span class="pre">settings.json</span></code> and their possible values.</p>
<p><em>¹ - Currently, it is not possible to specify the directory where OpenRPA local temporary files (workflows, settings) will be saved.</em></p>
<img alt="images/openrpa_settings_json.png" class="align-center" src="images/openrpa_settings_json.png" />
<div class="section" id="parameters">
<h2>Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2>
<div class="section" id="wsurl-openrpa-online-offline-local">
<h3>wsurl (<strong>OpenRPA</strong> online/offline[local])<a class="headerlink" href="#wsurl-openrpa-online-offline-local" title="Permalink to this headline">¶</a></h3>
<p>This parameter dictates to which <strong>OpenFlow</strong> enviroment <strong>OpenRPA</strong> should connect.</p>
<p>The expected value is a valid websocket URL.</p>
<p>Default value is <strong>OpenIAP</strong> demo enviroment: <code class="docutils literal notranslate"><span class="pre">wss://app.openiap.io/</span></code>.</p>
<p>If the value is set as blank <code class="docutils literal notranslate"><span class="pre">""</span></code> (empty string), <strong>OpenRPA</strong> will run locally, that is, without being connected to an <strong>OpenFlow</strong> (and consequently, <strong>NodeRED</strong>) and will no longer benefit from the cloud features of the <strong>OON</strong> stack, such as <strong>MongoDB</strong> or <code class="docutils literal notranslate"><span class="pre">Workflows</span></code> remote invoking (as well as many others features).</p>
<p>Examples of valid websockets URL:</p>
<div class="highlight-json-object notranslate"><div class="highlight"><pre><span></span><span class="nt">"wsurl"</span><span class="p">:</span> <span class="s2">"wss://app.openiap.io/"</span><span class="p">,</span>
<span class="nt">"wsurl"</span><span class="p">:</span> <span class="s2">"ws://localhost.openiap.io"</span><span class="p">,</span>
<span class="nt">"wsurl"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
</pre></div>
</div>
<p>Notice that <code class="docutils literal notranslate"><span class="pre">wss</span></code> indicates that the websocket URL is secured, whereas URLs starting with <code class="docutils literal notranslate"><span class="pre">ws</span></code> are not (same principles as <code class="docutils literal notranslate"><span class="pre">http</span></code> vs <code class="docutils literal notranslate"><span class="pre">https</span></code> for webpages). Therefore, users should make use of the respective protocol that matches with their <strong>OpenFlow</strong> enviroment.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>User that were once connected to an <strong>OpenFlow</strong> websocket, but changed this parameter to blank and are now running <strong>OpenRPA</strong> locally, will still have access to the <code class="docutils literal notranslate"><span class="pre">Workflows</span></code> (and <code class="docutils literal notranslate"><span class="pre">Detectors</span></code>) that were cached in the last access to the repository. However, they must be careful. Next time they connect to the environment, they will NOT commit their changes to the cloud repository and these changes will be overwritten (by latest version available on the cloud repository) and lost, unless properly exported.</p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Users are always welcome to use <code class="docutils literal notranslate"><span class="pre">wss://app.openiap.io/</span></code> demo enviroment for experimentation purposes. However, running production processes in this demo enviroment is NOT recommended.</p>
</div>
</div>
<div class="section" id="username-jwt-password-entropy">
<h3>username / jwt / password / entropy<a class="headerlink" href="#username-jwt-password-entropy" title="Permalink to this headline">¶</a></h3>
<p>These four parameters work somewhat together and are used by <strong>OpenRPA</strong> to keep track of the last logged user, besides allowing automatic logins, provided that the saved <code class="docutils literal notranslate"><span class="pre">jwt</span></code> is still valid.</p>
<p>Default value for <code class="docutils literal notranslate"><span class="pre">username</span></code> is empty string <code class="docutils literal notranslate"><span class="pre">""</span></code>.</p>
<p>Default values for <code class="docutils literal notranslate"><span class="pre">jwt</span></code> and <code class="docutils literal notranslate"><span class="pre">password</span></code> are <code class="docutils literal notranslate"><span class="pre">null</span></code>.</p>
<p>Default value for <code class="docutils literal notranslate"><span class="pre">entropy</span></code> is a randomly generated key created by the user’s Windows (example <code class="docutils literal notranslate"><span class="pre">"JungBLhauG+JvQipkQPIp9sLwJw="</span></code>).</p>
<p>After an user logs in to <strong>OpenRPA</strong>, the application will automatically generate a JSON Web Token <code class="docutils literal notranslate"><span class="pre">jwt</span></code> from the combination of <code class="docutils literal notranslate"><span class="pre">username</span></code> and <code class="docutils literal notranslate"><span class="pre">password</span></code> ¹, with a given secret <code class="docutils literal notranslate"><span class="pre">entropy</span></code>. After the user logs out (or the application is closed), this <code class="docutils literal notranslate"><span class="pre">jwt</span></code> is then saved and, from there, the same user may log back in without the need of typing the credentials again.</p>
<p>¹ - <code class="docutils literal notranslate"><span class="pre">username</span></code> and <code class="docutils literal notranslate"><span class="pre">password</span></code> that were typed in the login screen, not from the <code class="docutils literal notranslate"><span class="pre">settings.json</span></code> file.</p>
<p>If, for any reason, the login is not possible (<code class="docutils literal notranslate"><span class="pre">password</span></code> has been changed, user no longer exists or <code class="docutils literal notranslate"><span class="pre">jwt</span></code> is invalid), <strong>OpenRPA</strong> will erase the values of both <code class="docutils literal notranslate"><span class="pre">username</span></code> and <code class="docutils literal notranslate"><span class="pre">password</span></code> and will prompt the user with the login screen.</p>
</div>
<div class="section" id="isagent">
<h3>isagent<a class="headerlink" href="#isagent" title="Permalink to this headline">¶</a></h3>
<p>This parameter modifies <strong>OpenRPA</strong> GUI. It should be used when it is desirable to hide <code class="docutils literal notranslate"><span class="pre">Workflows</span></code> logic or if user wants to prevent other users from making changes to <code class="docutils literal notranslate"><span class="pre">Workflows</span></code>.
Expected values are either <code class="docutils literal notranslate"><span class="pre">true</span></code> or <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p>
<p>Default value is <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p>
<p>If this parameter is set to <code class="docutils literal notranslate"><span class="pre">true</span></code>, <strong>OpenRPA</strong> client will no longer show the UI elements that allow users to view or edit <code class="docutils literal notranslate"><span class="pre">Workflows</span></code>, but it will still be possible to invoke them (both manually/locally or remotely).</p>
<div class="figure align-center">
<a class="reference internal image-reference" href="images/openrpa_running_workflows_running_as_agent.png"><img alt="images/openrpa_running_workflows_running_as_agent.png" src="images/openrpa_running_workflows_running_as_agent.png" style="width: 592.0px; height: 353.5px;" /></a>
</div>
</div>
<div class="section" id="cancelkey">
<h3>cancelkey<a class="headerlink" href="#cancelkey" title="Permalink to this headline">¶</a></h3>
<p>This parameter refers to which key button is responsible for stopping the <code class="docutils literal notranslate"><span class="pre">Recorder</span></code> when the user wants to cease recording.</p>
<p>Default value is <code class="docutils literal notranslate"><span class="pre">{ESCAPE}</span></code>.</p>
</div>
<div class="section" id="showloadingscreen">
<h3>showloadingscreen<a class="headerlink" href="#showloadingscreen" title="Permalink to this headline">¶</a></h3>
<p>This parameter defines whether <strong>OpenRPA</strong> loadscreen should show up or not (i.e, the splashscreen with the gears in grey scale when the application is initialized).</p>
<p>Default value is <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p>
<p>There are no pro/cons performance-wise in disabling the loadscreen. In some cases, it might be desirable to turn it off, especially when the robot is running on someone’s computer who is not (and does not need to be) aware of the robot.</p>
</div>
<div class="section" id="culture">
<h3>culture<a class="headerlink" href="#culture" title="Permalink to this headline">¶</a></h3>
<p>This parameter defines the language used in most elements (tooltips, buttons etc.) in the <strong>OpenRPA</strong> GUI. Notice that the list of all possible values will not be shown here, since this list is still expanding (thanks to our contributors).
The most intuitive way to set this parameter is by choosing the language through <code class="docutils literal notranslate"><span class="pre">UI</span> <span class="pre">Language</span></code>, on the upper ribbon of the the <strong>OpenRPA</strong> GUI, in the <code class="docutils literal notranslate"><span class="pre">Settings</span> <span class="pre">tab</span></code>.</p>
<p>Default value is <code class="docutils literal notranslate"><span class="pre">en</span></code> (which stands for “English”).</p>
</div>
<div class="section" id="ocrlanguage">
<h3>ocrlanguage<a class="headerlink" href="#ocrlanguage" title="Permalink to this headline">¶</a></h3>
<p>This parameter sets the language OCR will use to interpret text on images. The full list of supported languages can be found on <strong>OpenRPA</strong> GUI ribbon in the <code class="docutils literal notranslate"><span class="pre">Settings</span> <span class="pre">tab</span></code> under the name <code class="docutils literal notranslate"><span class="pre">Tesseract</span></code> (next to <code class="docutils literal notranslate"><span class="pre">UI</span> <span class="pre">Language</span></code>).</p>
<p>Default value is <code class="docutils literal notranslate"><span class="pre">eng</span></code> (which stands for “English”).</p>
</div>
<div class="section" id="openworkflows">
<h3>openworkflows<a class="headerlink" href="#openworkflows" title="Permalink to this headline">¶</a></h3>
<p>A list of IDs of the <code class="docutils literal notranslate"><span class="pre">Workflows</span></code> that were open the last time <strong>OpenRPA</strong> was closed. This parameter exists so that <strong>OpenRPA</strong> can keep track of the <code class="docutils literal notranslate"><span class="pre">Workflow</span></code> tabs and automatically open them next time the application is initialized.</p>
<p>Default value is an empty list <code class="docutils literal notranslate"><span class="pre">[]</span></code>.</p>
</div>
<div class="section" id="mainwindow-position">
<h3>mainwindow_position<a class="headerlink" href="#mainwindow-position" title="Permalink to this headline">¶</a></h3>
<p>This parameter stores information about size and position of the <strong>OpenRPA</strong> GUI on the screen, so that it will be displayed in the same way next time the application is initialized.</p>
<p>The four values refer to the Windows Coordinate System. The first two represent the X and Y coordinates of the upper-left corner of the window, whereas the second pair of values represent the coordinates of the bottom-left corner of the windown.</p>
<p>Default value is “0, 0, 0, 0”.</p>
</div>
<div class="section" id="designerlayout">
<h3>designerlayout<a class="headerlink" href="#designerlayout" title="Permalink to this headline">¶</a></h3>
<p><cite>[DEPRECATED] This is no longer needed as it was replaced by ``layout.config`</cite> file.`</p>
<p>This parameter sets the default <strong>OpenRPA</strong> UI elements, such as the size and position of <code class="docutils literal notranslate"><span class="pre">Toolbox</span></code>, <code class="docutils literal notranslate"><span class="pre">Design</span></code> and <code class="docutils literal notranslate"><span class="pre">Properties</span></code>.</p>
<p>Default value is an empty string <code class="docutils literal notranslate"><span class="pre">""</span></code> and it means that these elements were never adjusted and are on their original spot.</p>
</div>
<div class="section" id="properties">
<h3>properties<a class="headerlink" href="#properties" title="Permalink to this headline">¶</a></h3>
<p>This parameter is a set of inherited classes settings. This is a dynamically created list of the add-ons settings that are loaded when <strong>OpenRPA</strong> is executed. In the case of new plugins, their settings can be added to the global settings in this list. Note that the first word of each parameter is the name of the plugin being setted.</p>
<p>This is an important parameter, since it allows users to configurate their own plugins.</p>
<p>These settings can also be accessed through <strong>OpenRPA</strong> GUI, in <code class="docutils literal notranslate"><span class="pre">Recorder</span> <span class="pre">plugins</span></code> in the <code class="docutils literal notranslate"><span class="pre">Settings</span></code> tab.</p>
<p><code class="docutils literal notranslate"><span class="pre">IE_enable_xpath_support</span></code> - It enables experimental XPath support in <strong>IE</strong>. Default value is <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p>
<p><code class="docutils literal notranslate"><span class="pre">NM_unique_xpath_ids</span></code> - A list of unique IDs for creating XPath selectors.</p>
<p><code class="docutils literal notranslate"><span class="pre">NM_debug_console_output</span></code> - It writes debug information to browser console. Default value is <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p>
<p><code class="docutils literal notranslate"><span class="pre">NM_wait_for_tab_after_set_value</span></code> - It waits for tab status to be in ready state after setting a value. Default value is <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p>
<p><code class="docutils literal notranslate"><span class="pre">NM_wait_for_tab_click</span></code> - It waits for tab status to be in ready state after clicking a button. Default value is <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p>
<p><code class="docutils literal notranslate"><span class="pre">NM_compensate_for_old_addon</span></code> - It adds pixel compensation for old add-ons. Default value is <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p>
<p><code class="docutils literal notranslate"><span class="pre">Script_csharp_intellisense</span></code> - It activates Intellisense for C# scripts. Default value is <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p>
<p><code class="docutils literal notranslate"><span class="pre">Script_vb_intellisense</span></code> - It activates Intellisense for Visual Basic scripts. Default value is <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p>
<p><code class="docutils literal notranslate"><span class="pre">Script_use_embedded_python</span></code> - <strong>OpenRPA</strong> comes with Python embedded, but will use default system Python if disabled. Default value is <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p>
<p><code class="docutils literal notranslate"><span class="pre">Script_py_create_no_window</span></code> - It states whether the Python script should be started in a new window or not. Default value is <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p>
<p><code class="docutils literal notranslate"><span class="pre">Windows_allow_child_searching</span></code> - If an Element in a Selector is not found, automatically search all children for match. Default value is <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p>
<p><code class="docutils literal notranslate"><span class="pre">Windows_allow_multiple_hits_mid_selector</span></code> - It allows an Element Selector in a Selector to find more than one children. Default value is <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p>
<p><code class="docutils literal notranslate"><span class="pre">Windows_enum_selector_properties</span></code> - It tests each Selector Element for the minimum required amount of properties needed. Default value is <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p>
<p><code class="docutils literal notranslate"><span class="pre">Windows_get_elements_in_different_thread</span></code> - <code class="docutils literal notranslate"><span class="pre">GetElement</span></code> uses another thread while searching in order to avoid locks if selector finds robot. Default value is <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p>
<p><code class="docutils literal notranslate"><span class="pre">Windows_traverse_selector_both_ways</span></code> - It traverses UI tree both ways to filter out ghost Selector Elements. Default value is <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p>
<p><code class="docutils literal notranslate"><span class="pre">Windows_cache_timeout":</span> <span class="pre">"00:05:00</span></code> - Timeout for caching of Elements. Default value is <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p>
<p><code class="docutils literal notranslate"><span class="pre">Windows_enable_cache</span></code> - It enables caching of Elements for faster automation at the expense of RAM. Default value is <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p>
<p><code class="docutils literal notranslate"><span class="pre">Windows_search_descendants</span></code> - It searches all descendants. Please note that this makes the robot slower, so it is recommended to use this option for more simple Selectors. Default value is <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p>
</div>
<div class="section" id="record-overlay">
<h3>record_overlay<a class="headerlink" href="#record-overlay" title="Permalink to this headline">¶</a></h3>
<p>The <code class="docutils literal notranslate"><span class="pre">Recording</span> <span class="pre">Overlay</span></code> checkbox (which can also be set inside <strong>OpenRPA</strong> ribbon in the <strong>Settings tab</strong>) is used to highlight the Elements as they are moused over while recording. Be aware that CPU performance may be affected when this parameter is set to <code class="docutils literal notranslate"><span class="pre">true</span></code>, hence it is recommended to keep it to <code class="docutils literal notranslate"><span class="pre">false</span></code> and change it only during debugging/presentations purposes.</p>
<p>Default value is <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p>
</div>
<div class="section" id="querypagesize">
<h3>querypagesize<a class="headerlink" href="#querypagesize" title="Permalink to this headline">¶</a></h3>
<p>This parameter sets the maximum number of results per MongoDB query when Activities in <strong>OpenRPA</strong> are using <strong>OpenFlow</strong>’s API to communicate with the MondoDB.</p>
<p>Each query has a cost of its own and then the data transfer (querypagesize) also has a cost. A high value for <code class="docutils literal notranslate"><span class="pre">querypagesize</span></code> means that MongoDB will be queried less often, but the load of each query will be higher.</p>
<p>There is no perfect value for this parameter, but knowing the differences may optimize specific scenarios for an <strong>OpenRPA</strong> <code class="docutils literal notranslate"><span class="pre">Workflow</span></code> needs.</p>
<p>Default value is 50.</p>
</div>
<div class="section" id="lastupdatecheck-updatecheckinterval-doupdatecheck">
<h3>lastupdatecheck / updatecheckinterval / doupdatecheck<a class="headerlink" href="#lastupdatecheck-updatecheckinterval-doupdatecheck" title="Permalink to this headline">¶</a></h3>
<p>These parameters refer to update checking done by the robot when it is started. If a new update is found, a message will be displayed to the user for him to decide if the updates should be installed or not.</p>
<p><code class="docutils literal notranslate"><span class="pre">lastupdatecheck</span></code> is a log of the last time the robot checked for updates.</p>
<p><code class="docutils literal notranslate"><span class="pre">updatecheckinterval</span></code> sets the interval between update checks. Default value is “1.00:00:00” (i.e., one day).</p>
<p><code class="docutils literal notranslate"><span class="pre">doupdatecheck</span></code> is a boolean value that states if the robot should look for updates or not. Default value is <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p>
</div>
<div class="section" id="autoupdateupdater">
<h3>autoupdateupdater<a class="headerlink" href="#autoupdateupdater" title="Permalink to this headline">¶</a></h3>
<p>This parameter sets if the Updater should auto update itself or not. If <code class="docutils literal notranslate"><span class="pre">true</span></code>, it will proceed with the updating without displaying any message to the user.</p>
<p>Default value is <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p>
</div>
<div class="section" id="log-12-parameters">
<h3>log (12 parameters)<a class="headerlink" href="#log-12-parameters" title="Permalink to this headline">¶</a></h3>
<p>The following parameters refer to the log file created to store all the outputs of the <code class="docutils literal notranslate"><span class="pre">Workflows</span></code>, as well as error or exception messages. There will be more information in this file than in the <code class="docutils literal notranslate"><span class="pre">Logging</span></code> section of the Output bar, since showing too much information in this section slows down the robot. Some of these parameters can be set through the upper ribbon of the GUI, in the <code class="docutils literal notranslate"><span class="pre">Settings</span></code> tab.</p>
<p>The “Level” refers to the type of information user wants to get. Lower numbers mean more critical information, whereas higher numbers mean less critical information. In other words, if user sets minimum and maximum values to, e.g., 1 and 2, only the most important information will be logged. if, on the other hand, the user sets the values to 1 and 7, less critical information will be added to the log file.</p>
<p>The broader the range between the lowest to the highest level, the more information will be retrieved. Please note that this operation slows the robot down, since more processing is required.</p>
<p><code class="docutils literal notranslate"><span class="pre">log_to_file</span></code> - If user enables logs, the robot will create a .txt log file and save it in the root folder of the robot. Default value is <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p>
<p><code class="docutils literal notranslate"><span class="pre">log_file_level_minimum</span></code> - Default value is “2”.</p>
<p><code class="docutils literal notranslate"><span class="pre">log_file_level_maximum</span></code> - Default value is “5”.</p>
<p><code class="docutils literal notranslate"><span class="pre">log_verbose</span></code> - This parameter habilitates the verbose mode, that is, more words are added to log file in order to make it more readable to humans. Default value is <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p>
<p><code class="docutils literal notranslate"><span class="pre">log_activity</span></code> - When set to <code class="docutils literal notranslate"><span class="pre">true</span></code>, this parameter adds logs of the activities performed by user during execution of <strong>OpenRPA</strong>, such as changes to <code class="docutils literal notranslate"><span class="pre">Designer</span></code>. Default value is <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p>
<p><code class="docutils literal notranslate"><span class="pre">log_debug</span></code> - It adds information about debugging to log file. Default value is <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p>
<p><code class="docutils literal notranslate"><span class="pre">log_selector</span></code> - It adds logs of <code class="docutils literal notranslate"><span class="pre">Selectors</span></code> activities. Default value is <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p>
<p><code class="docutils literal notranslate"><span class="pre">log_selector_verbose</span></code> - This parameter habilitates verbose mode for selector logs. Default value is <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p>
<p><code class="docutils literal notranslate"><span class="pre">log_information</span></code> - This parameter enables logging information that is not fundamental to the operation of the robot, but is important for humans to be aware of or keep record of. Default value is <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p>
<p><code class="docutils literal notranslate"><span class="pre">log_output</span></code> - It adds messages that were displayed in the <code class="docutils literal notranslate"><span class="pre">Output</span></code> tab, as well as messages from <code class="docutils literal notranslate"><span class="pre">Writeline</span></code> Activity. Default value is <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p>
<p><code class="docutils literal notranslate"><span class="pre">log_warning</span></code> - It adds warning messages to the log file, that is, issues that had an effect on the platform or robot, but did not prevent it from running. Default value is <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p>
<p><code class="docutils literal notranslate"><span class="pre">log_error</span></code> - It adds error messages to the log file, that is, issues that could not be handled by the robot and prevented it from running. Default value is <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p>
</div>
<div class="section" id="use-sendkeys">
<h3>use_sendkeys<a class="headerlink" href="#use-sendkeys" title="Permalink to this headline">¶</a></h3>
<p>When set to <code class="docutils literal notranslate"><span class="pre">true</span></code> while recording, this parameter mimics an user typing one key at the time. When set to <code class="docutils literal notranslate"><span class="pre">false</span></code>, the Recorder will try to directly change the control on the selected application and apply the whole text at once. Each application/control may react in a different way, hence the reason why this parameter might be useful.</p>
<p>This parameter can also be accessed through <strong>OpenRPA</strong> ribbon, in the <code class="docutils literal notranslate"><span class="pre">Settings</span></code> tab.</p>
<p>Default value is <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p>
</div>
<div class="section" id="use-virtual-click">
<h3>use_virtual_click<a class="headerlink" href="#use-virtual-click" title="Permalink to this headline">¶</a></h3>
<p><strong>OpenRPA</strong> tries to do a Virtual Click instead of actually clicking with the mouse. See more at <a class="reference internal" href="appendix_b.html#virtual-click"><span class="std std-ref">Virtual Click</span></a>.</p>
<p>Default value is <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p>
</div>
<div class="section" id="use-animate-mouse">
<h3>use_animate_mouse<a class="headerlink" href="#use-animate-mouse" title="Permalink to this headline">¶</a></h3>
<p>When playing a recorded Sequence, the cursor will appear changing its position throughout execution. It becomes easier to visualize the actions that were recorded. It also is a way to produce material for RPA presentations.</p>
<p>This parameter can also be accessed through <strong>OpenRPA</strong> ribbon, in the <code class="docutils literal notranslate"><span class="pre">Settings</span></code> tab.</p>
<p>Default value is <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p>
</div>
<div class="section" id="use-postwait">
<h3>use_postwait<a class="headerlink" href="#use-postwait" title="Permalink to this headline">¶</a></h3>
<p>This parameter sets the default value for all Activities that have <code class="docutils literal notranslate"><span class="pre">post_wait</span></code> property.</p>
<p>It means that the robot will wait this amount of time after each of these Activity to make sure that the computer is responsive before moving on to the next.</p>
<p>It slows down the performance of the robot when running the <code class="docutils literal notranslate"><span class="pre">Workflow</span></code>, as each Activity will have an overhead. This parameter is not necessary, but for extremely specific cases, this is already implemented and may come handy.</p>
<p>Default value is “00:00:00”.</p>
</div>
<div class="section" id="minimize">
<h3>minimize<a class="headerlink" href="#minimize" title="Permalink to this headline">¶</a></h3>
<p>This parameter defines whether <strong>OpenRPA</strong> UI should minimize when running the robot or not.</p>
<p>In order to optimize performance, this parameter should be set to <code class="docutils literal notranslate"><span class="pre">true</span></code>. When running, the robot will access the Desktop and check all open windows to find the one required. So, it doesn’t need to check its own window.</p>
<p>It may be useful to have the window maximized when debugging, so that the user will be able to see what is happenning during execution.</p>
<p>Default value is <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p>
</div>
<div class="section" id="recording-add-to-designer">
<h3>recording_add_to_designer<a class="headerlink" href="#recording-add-to-designer" title="Permalink to this headline">¶</a></h3>
<p>The <code class="docutils literal notranslate"><span class="pre">Record</span> <span class="pre">directly</span> <span class="pre">into</span> <span class="pre">designer</span></code> checkbox (set inside <strong>OpenRPA</strong> ribbon in the <code class="docutils literal notranslate"><span class="pre">Settings</span></code> tab) is used when the user wants to see the activities being inserted into the designer as they are recording it.</p>
<p>Having this parameter enabled is advised during development or while debugging, but be aware that it might cause some input delay. If disabled, the <code class="docutils literal notranslate"><span class="pre">Recorder</span></code> will memorize the activities and only insert them after recording is over.</p>
<p>Default value is <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p>
</div>
<div class="section" id="reloadinterval">
<h3>reloadinterval<a class="headerlink" href="#reloadinterval" title="Permalink to this headline">¶</a></h3>
<p>Time interval that the robot will use to reload local files when <strong>OpenRPA</strong> is running connected to an <strong>OpenFlow</strong>.</p>
<p>The robot will query <strong>OpenFlow</strong> for a list of <code class="docutils literal notranslate"><span class="pre">Workflows</span></code> and <code class="docutils literal notranslate"><span class="pre">Detectors</span></code> and it will compare the last updated assign on those with the time it has on its local copy. If there are any changes, it will then reload the file or files.</p>
<p>If the <code class="docutils literal notranslate"><span class="pre">Worflow</span></code> or <code class="docutils literal notranslate"><span class="pre">Detector</span></code> is already open in the Designer, <strong>OpenRPA</strong> will then raise a warning to the user and ask if the newer version should be loaded or not. If new files are found or if files were deleted, <strong>OpenRPA</strong> will automatically proceed to create or delete files in local directory.</p>
<p>There is also the option of realoding at any time through <strong>OpenRPA</strong> UI, at the <code class="docutils literal notranslate"><span class="pre">General</span></code> tab at the upper ribbon.</p>
<p>Default value is “00:05:00”. If value is set to “00:00:00”, it will never be reaload.</p>
</div>
<div class="section" id="move-animation-run-time-move-animation-steps">
<h3>move_animation_run_time / move_animation_steps<a class="headerlink" href="#move-animation-run-time-move-animation-steps" title="Permalink to this headline">¶</a></h3>
<p>When playing a recorded Sequence, the user may choose whether the movement of a window will be shown as an animation or not. It can be set in the Properties menu of the Activity.</p>
<p><code class="docutils literal notranslate"><span class="pre">move_animation_run_time</span></code> - This parameter sets the amount of time between each of the steps of the animation. Default value is “00:00:00.5000000”.</p>
<p><code class="docutils literal notranslate"><span class="pre">move_animation_steps</span></code> - This parameter sets how many steps the animation will take. If set to 1, no movement will visible, since the window will move directly to the new position. The more steps, the smothier the movement. Default value is “20”.</p>
</div>
<div class="section" id="remote-allow-multiple-running-remote-allow-multiple-running-max">
<h3>remote_allow_multiple_running / remote_allow_multiple_running_max<a class="headerlink" href="#remote-allow-multiple-running-remote-allow-multiple-running-max" title="Permalink to this headline">¶</a></h3>
<p>When a robot is running <code class="docutils literal notranslate"><span class="pre">Workflows</span></code> that rely on application GUI, keyboard or mouse and parallel <code class="docutils literal notranslate"><span class="pre">Workflow</span></code> executions would result in conflicting actions, these parameters set limitations so <strong>OpenFlow</strong>/<strong>Node-RED</strong> will only invoke a given number of workflows at once.</p>
<p><code class="docutils literal notranslate"><span class="pre">remote_allow_multiple_running</span></code> - This parameter sets the permission for the robot to run additional <code class="docutils literal notranslate"><span class="pre">Workflows</span></code> at the same time. Default value is <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p>
<p><code class="docutils literal notranslate"><span class="pre">remote_allow_multiple_running_max</span></code> - It sets the maximum number of <code class="docutils literal notranslate"><span class="pre">Workflows</span></code> that can be run at the same time. Default value is “2”.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>These parameters only apply when the <code class="docutils literal notranslate"><span class="pre">Workflows</span></code> are invoked remotely. When running manually (i.e.: clicking the Play button), the number of allowed <code class="docutils literal notranslate"><span class="pre">Workflows</span></code> is not limited by these.</p>
</div>
</div>
<div class="section" id="cef-useragent">
<h3>cef_useragent<a class="headerlink" href="#cef-useragent" title="Permalink to this headline">¶</a></h3>
<p>This parameter allows user to define what <code class="docutils literal notranslate"><span class="pre">user-agent</span></code> value should the robot use when logging in a Google account. Some users may find issues when loggin in <strong>OpenRPA</strong> using a Google account due to different versions of Chromium browser, so this parameter makes sure the robot is using the most up-to-date version.</p>
<p>Default value is an empty string <code class="docutils literal notranslate"><span class="pre">""</span></code>.</p>
<p>Possible values are the literal <code class="docutils literal notranslate"><span class="pre">user-agent</span></code> header used in most common <code class="docutils literal notranslate"><span class="pre">http-requests</span></code>, such as “Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0) Gecko/20100101 Firefox/42.0”.</p>
</div>
<div class="section" id="show-getting-started">
<h3>show_getting_started<a class="headerlink" href="#show-getting-started" title="Permalink to this headline">¶</a></h3>
<p>This parameter lets the user decide if the “Getting Started” tab will be shown when <strong>OpenRPA</strong> is initialized. This message contains basic information about the App, such as most common shortcuts, as well as links to the Wiki page and explanatory videos.</p>
<p>Default value is <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p>
<p>Users may also disable “Getting Started” on the right botton corner of the page (“Show again” checkbox).</p>
</div>
<div class="section" id="notify-on-workflow-remote-start-notify-on-workflow-end-notify-on-workflow-remote-end">
<h3>notify_on_workflow_remote_start / notify_on_workflow_end / notify_on_workflow_remote_end<a class="headerlink" href="#notify-on-workflow-remote-start-notify-on-workflow-end-notify-on-workflow-remote-end" title="Permalink to this headline">¶</a></h3>
<p>These parameters set the notification behavior of <strong>OpenRPA</strong> during execution start and end.</p>
<p><code class="docutils literal notranslate"><span class="pre">notify_on_workflow_remote_start</span></code> - It shows a notification when the <code class="docutils literal notranslate"><span class="pre">Workflow</span></code> is started remotely. Default value is <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p>
<p><code class="docutils literal notranslate"><span class="pre">notify_on_workflow_end</span></code> - It shows a notification when <code class="docutils literal notranslate"><span class="pre">Workflow</span></code> ends running. Default value is <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p>
<p><code class="docutils literal notranslate"><span class="pre">notify_on_workflow_remote_end</span></code> - It shows a anotification when <code class="docutils literal notranslate"><span class="pre">Workflow</span></code> ends running remotely. Default value is <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p>
</div>
<div class="section" id="log-busy-warning">
<h3>log_busy_warning<a class="headerlink" href="#log-busy-warning" title="Permalink to this headline">¶</a></h3>
<p>This parameter defines if a message is logged everytime <strong>OpenFlow</strong> tries to run a <code class="docutils literal notranslate"><span class="pre">Workflow</span></code> and the robot is busy.</p>
<p>This is a performance oriented parameter. It is advised to keep it set to <code class="docutils literal notranslate"><span class="pre">false</span></code> if it is expected for the message to show up often.</p>
<p>Default value is <code class="docutils literal notranslate"><span class="pre">`true</span></code>.</p>
</div>
</div>
</div>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2020, Paulo Veras, Thiago Pestitschek, Diego Thijssen
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
<p>Powered by <a href="https://bpatechnologies.com/">BPA Technologies</a></p>
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
<h4>>Powered by BPA Technologies - bpatechnologies.com</h4>
</body>
</html>