forked from open-rpa/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
3.5._interface.html
2750 lines (2506 loc) · 340 KB
/
3.5._interface.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
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!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>Interface — BPA/OpenIAP Docs 1.0.5 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>Interface</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="interface">
<h1><strong>Interface</strong><a class="headerlink" href="#interface" title="Permalink to this headline">¶</a></h1>
<div class="section" id="activities-toolbox">
<h2>Activities/Toolbox<a class="headerlink" href="#activities-toolbox" title="Permalink to this headline">¶</a></h2>
<p>The toolbox is where all the possible activities in <strong>OpenRPA</strong> are contained. Imagine it as a box where all the instruments you’d normally use are, such as a screwdriver or drill. The toolbox is essentially where you’d reach out for getting these tools.</p>
<p>The activities in OpenRPA are separated by categories which clearly represent what they are used for. These categories are properly discussed in the next section.</p>
</div>
<div class="section" id="designer">
<h2>Designer<a class="headerlink" href="#designer" title="Permalink to this headline">¶</a></h2>
<p>The designer is where the main process of desigining and implementing a task happens inside OpenRPA. It is where you drag and drop activities and add or nest sequences to fulfill your implementation choices, as well as set properties and variables pertaining to your workflow business process. It contains five components: Toolbox & Snippets sidebar, Workspace, Properties box, Output bar and Connection bar.</p>
<div class="figure align-center" id="id26">
<img alt="images/openrpa_sections.png" src="images/openrpa_sections.png" />
<p class="caption"><span class="caption-text"><strong>OpenRPA Designer components.</strong></span><a class="headerlink" href="#id26" title="Permalink to this image">¶</a></p>
</div>
<div class="section" id="toolbox-snippets-sidebar">
<h3>Toolbox & Snippets sidebar<a class="headerlink" href="#toolbox-snippets-sidebar" title="Permalink to this headline">¶</a></h3>
<p>This is the place where all activities lie as well as some code snippets which teaches the user on how to use of the tool for various purposes.</p>
<p>To use an activity, simply drag it into the <code class="docutils literal notranslate"><span class="pre">Workspace</span></code> sequence you want to add it to.</p>
<p>For more information on these activities, such as a detailed explanation of each one, refer to the <strong>Toolbox Detailed</strong> section.</p>
<div class="figure align-center" id="id27">
<a class="reference internal image-reference" href="images/openrpa_designer_toolbox.png"><img alt="images/openrpa_designer_toolbox.png" src="images/openrpa_designer_toolbox.png" style="width: 154.0px; height: 269.5px;" /></a>
<p class="caption"><span class="caption-text"><strong>OpenRPA’s Toolbox.</strong></span><a class="headerlink" href="#id27" title="Permalink to this image">¶</a></p>
</div>
</div>
<div class="section" id="workspace">
<h3>Workspace<a class="headerlink" href="#workspace" title="Permalink to this headline">¶</a></h3>
<p>The workspace is where the user organizes all the activities pertaining to the task which will be fulfilled by the workflow. It is also where the user will set all variables, arguments and import namespaces for further use.</p>
<p>Once the user drags activities into the sequence, upon pressing the <strong>Play</strong> button inside the ribbon or pressing the <code class="docutils literal notranslate"><span class="pre">F5</span></code> key, they will be executed in a cascading manner - each one after the previous one. And if there are any errors - untreated by <strong>TryCatch</strong> or <strong>Throw</strong> activities - the workflow execution will stop and the error message will appear in the Output box, which will be discussed in the <strong>Output bar</strong> section.</p>
<p>Each <strong>Sequence</strong> activity has its own scope as well, which will be discussed in the <strong>Variables</strong> section, further below.</p>
<div class="figure align-center" id="id28">
<a class="reference internal image-reference" href="images/openrpa_designer_workspace.png"><img alt="images/openrpa_designer_workspace.png" src="images/openrpa_designer_workspace.png" style="width: 326.5px; height: 266.5px;" /></a>
<p class="caption"><span class="caption-text"><strong>OpenRPA’s Workspace.</strong></span><a class="headerlink" href="#id28" title="Permalink to this image">¶</a></p>
</div>
<p>The user can also organize their workflow by nesting <strong>Sequence</strong> activities, as shown in the picture below.</p>
<div class="figure align-center" id="id29">
<a class="reference internal image-reference" href="images/openrpa_designer_workspace_nesting_sequences.png"><img alt="images/openrpa_designer_workspace_nesting_sequences.png" src="images/openrpa_designer_workspace_nesting_sequences.png" style="width: 326.0px; height: 266.5px;" /></a>
<p class="caption"><span class="caption-text"><strong>Nesting sequences inside OpenRPA.</strong></span><a class="headerlink" href="#id29" title="Permalink to this image">¶</a></p>
</div>
<p>As well as nesting, the user can use the <strong>Comment Out</strong> activity to ignore everything inside it. In the picture below, all activities inside the <strong>Comment Out</strong> activity won’t be executed.</p>
<div class="figure align-center" id="id30">
<a class="reference internal image-reference" href="images/openrpa_designer_workspace_comment_out.png"><img alt="images/openrpa_designer_workspace_comment_out.png" src="images/openrpa_designer_workspace_comment_out.png" style="width: 326.5px; height: 267.0px;" /></a>
<p class="caption"><span class="caption-text"><strong>Commenting activities out outside OpenRPA.</strong></span><a class="headerlink" href="#id30" title="Permalink to this image">¶</a></p>
</div>
</div>
<div class="section" id="properties-box">
<h3>Properties Box<a class="headerlink" href="#properties-box" title="Permalink to this headline">¶</a></h3>
<p>Every activity in OpenRPA has its own property box, containing parameters passed that change the workings of the given activity. Inside the property box there are also sections which are pretty much self explanatory and refer to the given parameters they cause changes upon, such as <strong>Input</strong>, <strong>Output</strong> or <strong>Misc</strong>.</p>
<div class="figure align-center" id="id31">
<a class="reference internal image-reference" href="images/openrpa_property_box.png"><img alt="images/openrpa_property_box.png" src="images/openrpa_property_box.png" style="width: 196.5px; height: 268.5px;" /></a>
<p class="caption"><span class="caption-text"><strong>Properties box.</strong></span><a class="headerlink" href="#id31" title="Permalink to this image">¶</a></p>
</div>
<p>The only property common to all activities is <code class="docutils literal notranslate"><span class="pre">Displayname</span></code>, which changes the name of the activity inside the workspace. It is shown below.</p>
<div class="figure align-center" id="id32">
<a class="reference internal image-reference" href="images/openrpa_designer_property_box_displayname.png"><img alt="images/openrpa_designer_property_box_displayname.png" src="images/openrpa_designer_property_box_displayname.png" style="width: 529.5px; height: 266.0px;" /></a>
<p class="caption"><span class="caption-text"><strong>Displayname Property.</strong></span><a class="headerlink" href="#id32" title="Permalink to this image">¶</a></p>
</div>
</div>
<div class="section" id="output-bar">
<h3>Output bar<a class="headerlink" href="#output-bar" title="Permalink to this headline">¶</a></h3>
<p>The output bar contains three sections: <code class="docutils literal notranslate"><span class="pre">Logging</span></code>, <code class="docutils literal notranslate"><span class="pre">Output</span></code> and <code class="docutils literal notranslate"><span class="pre">Workflow</span> <span class="pre">Instances</span></code>.</p>
<p><strong>Logging</strong></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Logging</span></code> section shows the output of the <code class="docutils literal notranslate"><span class="pre">Workflows</span></code> as well as any instance of any error or exception which occurred inside <strong>OpenRPA</strong>.</p>
<div class="figure align-center">
<a class="reference internal image-reference" href="images/openrpa_logging_section.png"><img alt="images/openrpa_logging_section.png" src="images/openrpa_logging_section.png" style="width: 682.5px; height: 162.5px;" /></a>
</div>
<p><strong>Output</strong></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Output</span></code> section contains only outputs generated by any workflows that were executed.</p>
<div class="figure align-center">
<a class="reference internal image-reference" href="images/openrpa_output_section.png"><img alt="images/openrpa_output_section.png" src="images/openrpa_output_section.png" style="width: 682.5px; height: 118.5px;" /></a>
</div>
<p><strong>Workflow Instances</strong></p>
<p>The <code class="docutils literal notranslate"><span class="pre">Workflow</span> <span class="pre">Instances</span></code> section contains all workflow instances pertaining to the queues file path the currently logged user is listening. It is useful as a catalog of recent workflow results and to see which workflows are queued, idle, complete, failed or running (in progress).</p>
<div class="figure align-center">
<a class="reference internal image-reference" href="images/openrpa_workflow_instances_section.png"><img alt="images/openrpa_workflow_instances_section.png" src="images/openrpa_workflow_instances_section.png" style="width: 682.0px; height: 64.5px;" /></a>
</div>
</div>
<div class="section" id="connection-bar">
<h3>Connection bar<a class="headerlink" href="#connection-bar" title="Permalink to this headline">¶</a></h3>
<p>The connection bar contains information related to the connection status of the <strong>OpenFlow</strong> web service set in the <span class="xref std std-ref">Configuring OpenRPA</span> section as well as the status of both <code class="docutils literal notranslate"><span class="pre">NM</span></code> and <code class="docutils literal notranslate"><span class="pre">SAP</span></code> plugins.</p>
<div class="figure align-center">
<a class="reference internal image-reference" href="images/openrpa_connection_bar.png"><img alt="images/openrpa_connection_bar.png" src="images/openrpa_connection_bar.png" style="width: 682.5px; height: 13.0px;" /></a>
</div>
</div>
</div>
<div class="section" id="variables-arguments">
<h2>Variables, Arguments<a class="headerlink" href="#variables-arguments" title="Permalink to this headline">¶</a></h2>
<div class="figure align-center" id="id33">
<img alt="images/openrpa_variables_arguments_box.png" src="images/openrpa_variables_arguments_box.png" />
<p class="caption"><span class="caption-text"><strong>Variables, Arguments & Import box.</strong></span><a class="headerlink" href="#id33" title="Permalink to this image">¶</a></p>
</div>
<div class="section" id="variables">
<h3><strong>Variables</strong><a class="headerlink" href="#variables" title="Permalink to this headline">¶</a></h3>
<p>Variables, as their very name states - are changeable values assigned to aliases inside the execution of a sequence. These aliases can be used in mathematical or computational expressions. For example, if you want to save a variable named “price” to assign the price of a product along a sequence. You can use the assign activity and an expression to assign it’s value.</p>
<p>Upon inserting an activity with an input box, if you mention a non-existent variable and want to easily create it you can press <code class="docutils literal notranslate"><span class="pre">Ctrl+K</span></code> and a dropdown will appear with many types of variable to be selected.</p>
<p>Variables in OpenRPA are statically typed and their type can be selected from the <strong>variable type</strong> field inside the argument box.</p>
<div class="section" id="variable-use-case-saving-the-result-of-a-computation">
<h4>Variable use case: Saving the result of a computation<a class="headerlink" href="#variable-use-case-saving-the-result-of-a-computation" title="Permalink to this headline">¶</a></h4>
<p>A use case of a variable is demonstrated next. In this example, we will save the result of a computation into a variable.</p>
<p>First, drag an <strong>Assign</strong> activity to the main sequence.</p>
<p>Then, type a name for the variable and press <code class="docutils literal notranslate"><span class="pre">Ctrl+K</span></code> to create it automatically. In this case, the chosen name is <code class="docutils literal notranslate"><span class="pre">resultOfComputation</span></code>.</p>
<p>Afterwards, assign the result of the computation (<code class="docutils literal notranslate"><span class="pre">2*6</span></code>)[right-hand side] to the variable [left-hand side].</p>
<p>The user now may notice that a warning now appears in the right-hand side of the activity. That is because the expression is a <code class="docutils literal notranslate"><span class="pre">Int32</span></code> type, the variable <code class="docutils literal notranslate"><span class="pre">resultOfComputation</span></code> is a <code class="docutils literal notranslate"><span class="pre">string</span></code> and Microsoft Workflow Foundation is strongly typed. if the user has no experience with programming a thorough explanation is given on <strong>Appendix A</strong>. For now, just select the type of the variable as <code class="docutils literal notranslate"><span class="pre">Int32</span></code> in the <code class="docutils literal notranslate"><span class="pre">Variable</span> <span class="pre">type</span></code> parameter inside the <strong>Variables, Arguments & Imports box</strong>, as seen in the picture below.</p>
<div class="figure align-center">
<a class="reference internal image-reference" href="images/openrpa_variables_arguments_variable_use_case_change_variable_type.png"><img alt="images/openrpa_variables_arguments_variable_use_case_change_variable_type.png" src="images/openrpa_variables_arguments_variable_use_case_change_variable_type.png" style="width: 326.5px; height: 266.0px;" /></a>
</div>
</div>
</div>
<div class="section" id="scope">
<h3><strong>Scope</strong><a class="headerlink" href="#scope" title="Permalink to this headline">¶</a></h3>
<p>It refers to the reach of the objects contained within a sequence. If you have some knowledge of programming and scope, you can skip this part.
First, let’s think of it as sets. In this example, we are going to use variables since arguments function as if they were globally scoped.</p>
<p>Per the code block below, one may observe that sequence <strong>B</strong> has access to only variables x, - but since <strong>B</strong> is inside the scope of <strong>A</strong>, it makes sequence <strong>B</strong> to have access to all variables {n, p, x, y}. In simple words, sequences can be used to organize variable scopes and to group activities, just like a developer would normally do in a programming language using functions to avoid monolithic code.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Sequence</span> <span class="n">A</span> <span class="p">{</span>
<span class="n">variables</span> <span class="o">=</span> <span class="n">n</span><span class="p">,</span> <span class="n">p</span>
<span class="n">Sequence</span> <span class="n">B</span> <span class="p">{</span>
<span class="n">variables</span> <span class="o">=</span> <span class="n">x</span><span class="p">,</span> <span class="n">y</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="arguments">
<h3><strong>Arguments</strong><a class="headerlink" href="#arguments" title="Permalink to this headline">¶</a></h3>
<p>Arguments are simply variables that can be passed to other sequences, external services or workflows and have global scope. They act exactly as variables, except for that single characteristic. If you pass an argument to a sequence created within another sequence, the argument is still valid within the outer sequence. If you pass a variable, that does not happen.</p>
<p>It is important to notice that both variables and arguments can have a <strong>default value</strong>, which are assigned to both if a value isn’t necessarily assigned during the execution of the sequence. It is also required for arguments with the <strong>isRequired</strong> property checked to have an ‘In’ value, ie. already passed or having a default value.</p>
<p>Similarly to Variables, Arguments in OpenRPA are statically typed and their type can be selected from the <strong>variable type</strong> field inside the argument box.</p>
<p><strong>Output (In - In/Out - Out)</strong>
Output refers to the way a variable or argument is handled during run-time. They are classified below.</p>
<ul>
<li><p><strong>In</strong></p>
<blockquote>
<div><p>In this case the argument is received from external service and is only given an input value that can’t be returned after the execution of the workflow</p>
</div></blockquote>
</li>
<li><p><strong>In/Out</strong></p>
<blockquote>
<div><p>In this case the argument can both be given an input value or be changed and outputted after the execution of the workflow</p>
</div></blockquote>
</li>
<li><p><strong>Out</strong></p>
<blockquote>
<div><p>In this case the argument returns a value to an external service, and it can’t be changed after the execution of the workflow</p>
</div></blockquote>
</li>
<li><p><strong>Properties</strong></p>
<blockquote>
<div><p>This turns the argument into a <code class="docutils literal notranslate"><span class="pre">Property</span></code>, which means it has the same features of an <strong>In/Out</strong> argument but can also have a default value</p>
</div></blockquote>
</li>
</ul>
</div>
<div class="section" id="imports">
<h3><strong>Imports</strong><a class="headerlink" href="#imports" title="Permalink to this headline">¶</a></h3>
<p>Imports tab shows all the modules used and referenced in the selected sequence.</p>
</div>
<div class="section" id="serializable-vs-non-serializable-arguments">
<h3><strong>Serializable vs Non-Serializable Arguments</strong><a class="headerlink" href="#serializable-vs-non-serializable-arguments" title="Permalink to this headline">¶</a></h3>
<p>Microsoft Workflow Fundation (MWF), the technology which <strong>OpenRPA</strong> is based on, diversificates variables/arguments into two diferent categories: <code class="docutils literal notranslate"><span class="pre">Serializable</span></code> and <code class="docutils literal notranslate"><span class="pre">Non-Serializable</span></code>.
For the great majority of workflows there is no need to understand the differences, as they will not affect anything, but there are cases that knowing the technical limitations of non-serializable objects might explain why your workflow or process is not working exactly as you may expect.</p>
<p>In short: non-serializable objects, as the name suggests, can not be serialized. This term, in this context, can be simplified to: these objects can not be saved / can not be transmitted over a network. That consequently implies that a workflow state can not be saved if the workflow contains any variable/argument that is non-serializable, and also, invoking workflows with non-serializable arguments is not supported. The most common non-serializable variable/arguments types are: <code class="docutils literal notranslate"><span class="pre">DataTables</span></code> and <code class="docutils literal notranslate"><span class="pre">DataSets</span></code> but other types (from the infinitely many existing types from all the namespaces) also fall into this category.</p>
<p>With this brief explanation, here are some limitations that users may face when dealing with workflows containing non-serializable variables/arguments as well as some suggested workarounds:</p>
<ul>
<li><p><strong>Saving workflow states</strong></p>
<blockquote>
<div><p>When <strong>OpenRPA</strong> is connected to an <strong>OpenFlow</strong>, workflows states are saved automatically in <strong>OpenFlow</strong> whenever specific activities¹ are reached. These states exist to indicate the current situation relevant to a workflow instance, such as the designer layout (activities, sequences) being run, the variables and arguments and their current values, etc. Hence, if the workflow contains non-serializable objects such a <cite>DataTable</cite>, the state can not be saved.</p>
<p><em>¹ - All the activities that “go idle” (Detectors, Delay, Invoke Remote with wait) as well as Persist activity.</em></p>
<p><em>Workaround</em>: Split complex workflows into smaller workflows, leaving the smaller workflows to manage the non-serializable objects. That way if an unexpected interruption occurs, you will not lose all the data.</p>
</div></blockquote>
</li>
<li><p><strong>Remote Remote OpenRPA / invoking with non-serializable arguments</strong></p></li>
<li><p><strong>Invoke Openflow / Node-RED invoke and data return</strong></p>
<blockquote>
<div><p>If one desires to use <code class="docutils literal notranslate"><span class="pre">Invoke</span> <span class="pre">Remote</span> <span class="pre">OpenRPA</span></code> Activity, be aware that the workflow being invoked may not use non-serializable arguments. As the destination computer / <strong>OpenRPA</strong> is different than the source <strong>OpenRPA</strong>, the non-serializable arguments can not be passed around and thus the invoking will fail.</p>
<p>Similar limitation also happens when an user invokes a flow in <strong>Node-RED</strong> by using the <code class="docutils literal notranslate"><span class="pre">Invoke</span> <span class="pre">Openflow</span></code> activity, non-serializable objects are not supported to be used as arguments. Exception to this rule is the <code class="docutils literal notranslate"><span class="pre">DataTable</span></code> type, <strong>OpenRPA</strong> will attempt to neatly convert these to <code class="docutils literal notranslate"><span class="pre">JArray</span> <span class="pre">Objects</span></code> before contacting <strong>Node-RED</strong> as well as convert it back to <code class="docutils literal notranslate"><span class="pre">DataTable</span></code> when the data is returned / node <code class="docutils literal notranslate"><span class="pre">workflow</span> <span class="pre">out</span></code> is used.</p>
<p><em>Workaround</em>: Use the activities from <code class="docutils literal notranslate"><span class="pre">OpenRPA.OpenFlowDB</span></code> toolbox to upload files/update data/create entities and collections in <strong>OpenFlow</strong> MongoDB and then, on the destionation computer, access the data by querying <strong>OpenFlow</strong> MongoDB. This way, the entire <code class="docutils literal notranslate"><span class="pre">Data/DataSet/DataTable</span></code> (any non-serializable object) is stored within MongoDB and the parameter being passed during the invoke can be the <code class="docutils literal notranslate"><span class="pre">_id</span></code> or some other identifier.</p>
<p><em>Workaround2</em>: Convert the non-serializable object into a serializable one, for example base 64 string, then pass it as parameter and convert it back if needed.</p>
</div></blockquote>
</li>
</ul>
</div>
</div>
<div class="section" id="toolbox-detailed">
<h2>Toolbox Detailed<a class="headerlink" href="#toolbox-detailed" title="Permalink to this headline">¶</a></h2>
<div class="section" id="openrpa">
<h3>OpenRPA<a class="headerlink" href="#openrpa" title="Permalink to this headline">¶</a></h3>
<p>The reader will find below the activities located inside the OpenRPA toolbox.</p>
<dl class="py class">
<dt>
<code class="sig-name descname">Click Element</code></dt>
<dd><p>Click on an Element found with <strong>GetElement</strong>.</p>
<blockquote>
<div><p><strong>Properties Parameters</strong></p>
<p><code class="docutils literal notranslate"><span class="pre">Animate</span> <span class="pre">Mouse</span></code> - If set to <code class="docutils literal notranslate"><span class="pre">True</span></code>, the cursor will appear changing its position throughout execution. It only works on Physical Clicks!</p>
<p><code class="docutils literal notranslate"><span class="pre">Displayname</span></code> - Title of the Activity inside the Sequence.</p>
<p><code class="docutils literal notranslate"><span class="pre">Double</span> <span class="pre">Click</span></code> - If set to <code class="docutils literal notranslate"><span class="pre">True</span></code>, the cursor clicks twice inside the window.</p>
<p><code class="docutils literal notranslate"><span class="pre">Element</span></code> - The application selected with the <strong>Get Element</strong> activity.</p>
<p><code class="docutils literal notranslate"><span class="pre">Key</span> <span class="pre">Modifiers</span></code> - If set, the corresponding keys act as if pressed during execution.</p>
<p><code class="docutils literal notranslate"><span class="pre">Mouse</span> <span class="pre">Button</span></code> - Set to <code class="docutils literal notranslate"><span class="pre">1</span></code> if the Left Mouse button is to be clicked;``2`` if it is the Middle Mouse button; <code class="docutils literal notranslate"><span class="pre">3</span></code> for the Right Mouse button.</p>
<p><code class="docutils literal notranslate"><span class="pre">Post</span> <span class="pre">Wait</span></code> - Time <strong>OpenRPA</strong> should wait for this activity to finish after completing its execution.</p>
<p><code class="docutils literal notranslate"><span class="pre">Virtual</span> <span class="pre">Click</span></code> - Set by default as <code class="docutils literal notranslate"><span class="pre">True</span></code>. <strong>OpenRPA</strong> tries to do a <strong>Virtual Click</strong> instead of actually clicking with the mouse. Visit <strong>Appendix B</strong> - <span class="xref std std-ref">Virtual Clicking</span> for more information.</p>
<p><code class="docutils literal notranslate"><span class="pre">X</span> <span class="pre">Offset</span></code> - The horizontal offset inside the window to be clicked. Units are in pixels. It also allows for negative values. Only works on Physical Click!</p>
<p><code class="docutils literal notranslate"><span class="pre">Y</span> <span class="pre">Offset</span></code> - The vertical offset inside the window to be clicked. Units are in pixels. It also allows for negative values. Only works on Physical Click!</p>
</div></blockquote>
</dd></dl>
<div class="figure align-center" id="id34">
<img alt="images/openrpa_click_element.png" src="images/openrpa_click_element.png" />
<p class="caption"><span class="caption-text"><strong>OpenRPA Click Element.</strong></span><a class="headerlink" href="#id34" title="Permalink to this image">¶</a></p>
</div>
<dl class="py class">
<dt>
<code class="sig-name descname">Close Application</code></dt>
<dd><p>Closes a given application selected with the <strong>Get Element</strong> activity.</p>
<p><strong>Properties Parameters</strong></p>
<p><code class="docutils literal notranslate"><span class="pre">Displayname</span></code> - Title of the activity inside the sequence.</p>
<p><code class="docutils literal notranslate"><span class="pre">Force</span></code>- If set to <code class="docutils literal notranslate"><span class="pre">True</span></code>, it kills the application.</p>
<p><code class="docutils literal notranslate"><span class="pre">Selector</span></code> - Contains all the data belonging to the application selected.</p>
<p><code class="docutils literal notranslate"><span class="pre">Timeout</span></code> - Time interval until the Activity ceases if not successfully able to close the application. Can be a simple 00:00:00.00 {hh:min:ss.mili} or an object from the <strong>TimeSpan</strong> class.</p>
</dd></dl>
<div class="figure align-center" id="id35">
<img alt="images/openrpa_close_application.png" src="images/openrpa_close_application.png" />
<p class="caption"><span class="caption-text"><strong>OpenRPA Close Application.</strong></span><a class="headerlink" href="#id35" title="Permalink to this image">¶</a></p>
</div>
<dl class="py class">
<dt>
<code class="sig-name descname">Comment Out</code></dt>
<dd><p>Every Activity inside <strong>Comment Out</strong> is ignored by the execution of the workflow. This Activity is useful for remarking something out of the sequence.</p>
<p><strong>Properties Parameters</strong></p>
<p><code class="docutils literal notranslate"><span class="pre">Displayname</span></code> - Title of the Activity inside the sequence.</p>
</dd></dl>
<dl class="py class">
<dt>
<code class="sig-name descname">Copy Clipboard</code></dt>
<dd><p>Saves the content from Windows clipboard into a variable.</p>
<p>Repetitive sequential usage of this Activity, however, is not recommended, as it is unreliable due to buffer issues. As a suggestion/workaround, one can use the <code class="docutils literal notranslate"><span class="pre">Invoke</span> <span class="pre">Code</span></code> Activity and run the following AHK code <code class="docutils literal notranslate"><span class="pre">variable1</span> <span class="pre">:=</span> <span class="pre">Clipboard</span></code>. Notice that <code class="docutils literal notranslate"><span class="pre">variable1</span></code> is the name of the variable.</p>
<p>If the content of the Windows clipboard that will be copied is a <code class="docutils literal notranslate"><span class="pre">String</span></code> the user has to specify the variable inside the <code class="docutils literal notranslate"><span class="pre">String</span> <span class="pre">Result</span></code> field in the <strong>Properties Box</strong>. If it is an image the user has to specify the <code class="docutils literal notranslate"><span class="pre">BitmapSource</span></code> variable file path the image will be saved inside <code class="docutils literal notranslate"><span class="pre">Image</span> <span class="pre">Result</span></code>.</p>
<p><strong>Properties Parameters</strong></p>
<p><code class="docutils literal notranslate"><span class="pre">Displayname</span></code> - Title of the Activity inside the sequence.</p>
<p><code class="docutils literal notranslate"><span class="pre">Image</span> <span class="pre">Result</span></code> - Creates a bitmap from the image copied into the clipboard and returns it as a <code class="docutils literal notranslate"><span class="pre">BitmapSource</span></code> variable.</p>
<p><code class="docutils literal notranslate"><span class="pre">Send</span> <span class="pre">Ctrl+C</span></code> - Sends <code class="docutils literal notranslate"><span class="pre">Ctrl+C</span></code> before trying to copy the Clipboard Content.</p>
<p><code class="docutils literal notranslate"><span class="pre">String</span> <span class="pre">Result</span></code> - Returns the result from the clipboard as a string.</p>
</dd></dl>
<div class="figure align-center" id="id36">
<img alt="images/openrpa_copy_clipboard.png" src="images/openrpa_copy_clipboard.png" />
<p class="caption"><span class="caption-text"><strong>OpenRPA Copy Cliboard.</strong></span><a class="headerlink" href="#id36" title="Permalink to this image">¶</a></p>
</div>
<dl class="py class">
<dt>
<code class="sig-name descname">Detector Activity</code></dt>
<dd><p><strong>Detector</strong> turns workflow into idle mode, waiting on selected <strong>Detector</strong> to trigger.</p>
<p>It is worthy reminding the user that <strong>Detectors</strong> can also be used to trigger <strong>StateMachines</strong> inside <strong>OpenRPA</strong>.</p>
<p>An example of how to set a <strong>Detector</strong> is found at <a class="reference internal" href="openrpa.html#windows-automation"><span class="std std-ref">Windows Automation</span></a> section.</p>
<p><strong>Properties Parameters</strong></p>
<p><code class="docutils literal notranslate"><span class="pre">Detector</span></code> - ID of the <strong>Detector</strong> which will be used to trigger the condition.</p>
<p><code class="docutils literal notranslate"><span class="pre">Displayname</span></code> - Title of the Activity inside the sequence.</p>
</dd></dl>
<dl class="py class">
<dt>
<code class="sig-name descname">Foreach DataRow</code></dt>
<dd><p><strong>Foreach DataRow</strong> enumerates through each row inside a <code class="docutils literal notranslate"><span class="pre">DataTable</span></code>.</p>
<p>This Activity iterates through a <code class="docutils literal notranslate"><span class="pre">DataTable</span></code> or <code class="docutils literal notranslate"><span class="pre">DataView</span></code>.² All the Activities inside <strong>Foreach DataRow</strong> will be looped over each row. Examples of using <strong>Foreach DataRow</strong> Activities are shown both at <a class="reference internal" href="openrpa.html#web-automation"><span class="std std-ref">Web Automation</span></a> and <a class="reference internal" href="openrpa.html#excel-read"><span class="std std-ref">Excel Read</span></a> workflow examples.</p>
<p><strong>Properties Parameters</strong></p>
<p><code class="docutils literal notranslate"><span class="pre">DataTable</span></code> - The data table used to gather the data.</p>
<p><code class="docutils literal notranslate"><span class="pre">DataView</span></code> - The data view used to gather the data. For more information on how to use a <code class="docutils literal notranslate"><span class="pre">DataView</span></code>, please refer to Appendix B’s <a class="reference internal" href="appendix_b.html#dataview"><span class="std std-ref">DataView</span></a>.</p>
<p><code class="docutils literal notranslate"><span class="pre">Displayname</span></code> - Title of the Activity inside the sequence.</p>
</dd></dl>
<div class="figure align-center" id="id37">
<img alt="images/openrpa_foreach_datarow.png" src="images/openrpa_foreach_datarow.png" />
<p class="caption"><span class="caption-text"><strong>OpenRPA Foreach DataRow.</strong></span><a class="headerlink" href="#id37" title="Permalink to this image">¶</a></p>
</div>
<p>² - <a class="reference external" href="https://stackoverflow.com/questions/7382932/what-is-the-difference-between-dataview-and-datatable">What is the difference between DataView and DataTable?</a> (<code class="docutils literal notranslate"><span class="pre">https://stackoverflow.com/questions/7382932/what-is-the-difference-between-dataview-and-datatable</span></code>)</p>
<dl class="py class">
<dt>
<code class="sig-name descname">Highlight Element</code></dt>
<dd><p>Highlights an Element found with <strong>GetElement</strong> Activities.</p>
<p>Users can also define a specific Element to be highlighted when using this Activity outside of a <strong>GetElement</strong> Activity. Besides that, it allows users to specify the duration of the highlighting by inserting a <code class="docutils literal notranslate"><span class="pre">TimeSpan</span></code> object in the format <code class="docutils literal notranslate"><span class="pre">HH:mm:ss</span></code> inside the <code class="docutils literal notranslate"><span class="pre">Duration</span></code> parameter, such as <code class="docutils literal notranslate"><span class="pre">00:00:30</span></code> to highlight this given element for 30 seconds. It also allows for blocking the execution of the Workflow until the highlighting has finished by setting the <code class="docutils literal notranslate"><span class="pre">Blocking</span></code> parameter to <code class="docutils literal notranslate"><span class="pre">True</span></code>.</p>
<p><strong>Properties Parameters</strong></p>
<p><code class="docutils literal notranslate"><span class="pre">Blocking</span></code> - If set to <code class="docutils literal notranslate"><span class="pre">True</span></code>, it blocks the execution of the Workflow until the highlighting has finished.</p>
<p><code class="docutils literal notranslate"><span class="pre">DisplayName</span></code> - Title of the Activity inside the Sequence.</p>
<p><a href="#id1"><span class="problematic" id="id2">``</span></a>Duration`- Duration of the highlighting. Can be a simple 00:00:00.00 {hh:min:ss.mili} or an object from the <strong>TimeSpan</strong> class.</p>
<p><code class="docutils literal notranslate"><span class="pre">Element</span></code> - The Element to be highlighted by <strong>GetElement</strong>.</p>
<p><code class="docutils literal notranslate"><span class="pre">Result</span></code> - [DEPRECATED] Currently unused parameter.</p>
</dd></dl>
<div class="figure align-center" id="id38">
<img alt="images/openrpa_highlight_element.png" src="images/openrpa_highlight_element.png" />
<p class="caption"><span class="caption-text"><strong>OpenRPA Highlight Element</strong></span><a class="headerlink" href="#id38" title="Permalink to this image">¶</a></p>
</div>
<dl class="py class">
<dt>
<code class="sig-name descname">Insert Clipboard</code></dt>
<dd><p>Sets the content of parameter <code class="docutils literal notranslate"><span class="pre">Text</span></code> into the Windows clipboard buffer.
Repetitive sequential usage of this Activity, however, is not recommended, as it is unreliable due to buffer issues. As a suggestion/workaround, one can use the <code class="docutils literal notranslate"><span class="pre">Invoke</span> <span class="pre">Code</span></code> Activity and run the following AHK code:</p>
</dd></dl>
<div class="highlight-ahk notranslate"><div class="highlight"><pre><span></span><span class="nv">Clipboard</span> <span class="o">:=</span> <span class="n">variable1</span>
<span class="n">Timeout</span> <span class="o">:=</span> <span class="mi">3</span>
<span class="n">WaitForAnyData</span> <span class="o">:=</span> <span class="mi">1</span>
<span class="nb">ClipWait</span><span class="p">,</span> <span class="o">%</span> <span class="n">Timeout</span><span class="p">,</span> <span class="o">%</span> <span class="n">WaitForAnyData</span><span class="c1"></span>
<span class="c1">; "variable1" is the name of the variable, can be changed.</span>
<span class="c1">; More info about ClipWait at https://www.autohotkey.com/docs/commands/ClipWait.htm (yes .htm, not .html)</span>
</pre></div>
</div>
<p><strong>Properties Parameters</strong></p>
<p><code class="docutils literal notranslate"><span class="pre">Displayname</span></code> - Title of the Activity inside the sequence.</p>
<p><code class="docutils literal notranslate"><span class="pre">Ignore</span> <span class="pre">Errors</span></code> - If an error occurs, will ignore it and continue. Default value is <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p>
<p><code class="docutils literal notranslate"><span class="pre">Text</span></code> - Text which will be inserted into the clipboard.</p>
<div class="figure align-center" id="id39">
<img alt="images/openrpa_insert_clipboard.png" src="images/openrpa_insert_clipboard.png" />
<p class="caption"><span class="caption-text"><strong>OpenRPA Insert Clipboard.</strong></span><a class="headerlink" href="#id39" title="Permalink to this image">¶</a></p>
</div>
<dl class="py class">
<dt>
<code class="sig-name descname">Invoke OpenFlow</code></dt>
<dd><p><strong>Invoke OpenFlow</strong> allows the user to invoke <code class="docutils literal notranslate"><span class="pre">Workflows</span></code> which have been configured with <strong>OpenFlow</strong>/<strong>Node-RED</strong>, i.e., available at the <a class="reference external" href="http://localhost.openiap.io/#/Workflows">Workflows page</a> (e.g. <code class="docutils literal notranslate"><span class="pre">http://localhost.openiap.io/#/Workflows</span></code>).</p>
<p><strong>Properties Parameters</strong></p>
<p><code class="docutils literal notranslate"><span class="pre">Displayname</span></code> - Title of the Activity inside the sequence.</p>
<p><code class="docutils literal notranslate"><span class="pre">Wait</span> <span class="pre">until</span> <span class="pre">Completed</span></code> - If set to <code class="docutils literal notranslate"><span class="pre">True</span></code>, <strong>OpenRPA</strong> waits until the <code class="docutils literal notranslate"><span class="pre">Workflow</span></code> invoke call is finished - either success or error. If successful, the message containing the data (as designed in the flow at <strong>Node-RED</strong>) is returned to the <strong>OpenRPA</strong> robot.</p>
<p>If set to <code class="docutils literal notranslate"><span class="pre">False</span></code>, however, <strong>OpenRPA</strong> will no longer have access to the returned message - communication will be one-way. Therefore, all logic that would otherwise depend on it must then be redesigned. Think of it as a try/catch exception block that does not return any exception message. ³</p>
<p><code class="docutils literal notranslate"><span class="pre">Workflow</span></code> - The <code class="docutils literal notranslate"><span class="pre">Workflow</span></code> which is to be invoked.</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The <code class="docutils literal notranslate"><span class="pre">Workflow</span></code> is invoked by the user currently logged in <strong>OpenRPA</strong>/<strong>OpenFlow</strong>. It means that the user must have access to the desired <code class="docutils literal notranslate"><span class="pre">Workflow</span></code> which is to be invoked, otherwise it won’t even be displayed in the <code class="docutils literal notranslate"><span class="pre">Workflows</span></code> dropdown.</p>
</div>
<div class="figure align-center" id="id40">
<img alt="images/openrpa_invoke_openflow.png" src="images/openrpa_invoke_openflow.png" />
<p class="caption"><span class="caption-text"><strong>OpenRPA Invoke OpenFlow.</strong></span><a class="headerlink" href="#id40" title="Permalink to this image">¶</a></p>
</div>
<dl class="py class">
<dt>
<code class="sig-name descname">Invoke OpenRPA</code></dt>
<dd><p><strong>Invoke OpenRPA</strong> allows the user to invoke <strong>OpenRPA</strong> <code class="docutils literal notranslate"><span class="pre">Workflows</span></code> saved in <strong>OpenFlow</strong>’s repository - those available at the <a class="reference external" href="http://localhost.openiap.io/#/RPAWorkflows">RPA Workflows page</a> (eg. <code class="docutils literal notranslate"><span class="pre">http://localhost.openiap.io/#/RPAWorkflows</span></code>).</p>
<p>The <strong>Map Variables</strong> button allows the currently set variables and arguments to be passed to the <code class="docutils literal notranslate"><span class="pre">Workflow</span></code> invoke call. In order to do that, after choosing your <code class="docutils literal notranslate"><span class="pre">Workflow</span></code> from the dropdown, create the arguments in the <strong>Variables, Arguments & Imports box</strong> and click the <strong>Map Variables</strong> button in the activity.</p>
<p><strong>Properties Parameters</strong></p>
<p><code class="docutils literal notranslate"><span class="pre">Displayname</span></code> - Title of the Activity inside the sequence.</p>
<p><code class="docutils literal notranslate"><span class="pre">Wait</span> <span class="pre">until</span> <span class="pre">Completed</span></code> - If set to <code class="docutils literal notranslate"><span class="pre">True</span></code>, <strong>OpenRPA</strong> waits until the <strong>Workflow</strong> invoke call is finished - either success or error. If successful, the message containing the data (as designed in the flow at <strong>Node-RED</strong>) is returned to the <strong>OpenRPA</strong> robot.</p>
<p>If set to <code class="docutils literal notranslate"><span class="pre">False</span></code>, however, <strong>OpenRPA</strong> no longer has access to the returned message - communication now is one-way - and therefore all logic that would otherwise depend on it must then be redesigned. Think of it as a try/catch exception block that does not return any exception message.</p>
<p><code class="docutils literal notranslate"><span class="pre">Workflow</span></code> - The <code class="docutils literal notranslate"><span class="pre">Workflow</span></code> which is to be invoked.</p>
</dd></dl>
<div class="figure align-center" id="id41">
<img alt="images/openrpa_invoke_openrpa.png" src="images/openrpa_invoke_openrpa.png" />
<p class="caption"><span class="caption-text"><strong>OpenRPA Invoke OpenRPA.</strong></span><a class="headerlink" href="#id41" title="Permalink to this image">¶</a></p>
</div>
<dl class="py class">
<dt>
<code class="sig-name descname">Invoke Remote OpenRPA</code></dt>
<dd><p>Allows to remotely invoke RPA Workflows, saved in OpenFlow’s repository, to be executed at other OpenRPA clients.</p>
<p>The <strong>Map Variables</strong> button allows the currently set variables and arguments to be passed to the workflow invoke call. In order to do that, after choosing your workflow from the dropdown, create the arguments in the <strong>Variables, Arguments & Imports box</strong> and click the <strong>Map Variables</strong> button in the activity.</p>
<p><strong>Properties Parameters</strong></p>
<p><code class="docutils literal notranslate"><span class="pre">Displayname</span></code> - Title of the activity inside the sequence.</p>
<p><code class="docutils literal notranslate"><span class="pre">Target</span></code> - OpenFlow’s hash string identifying the target which will be activated to execute the workflow.</p>
<p><code class="docutils literal notranslate"><span class="pre">Wait</span> <span class="pre">until</span> <span class="pre">Completed</span></code></p>
<p>If set to <code class="docutils literal notranslate"><span class="pre">True</span></code>, OpenRPA waits until the Workflow invoke call is finished - either success or error. If successful, the message containing the data (as designed in the flow at Node-RED) is returned to the OpenRPA robot.</p>
<p>If set to <code class="docutils literal notranslate"><span class="pre">False</span></code>, however, OpenRPA no longer has access to the returned message - communication now is one-way - and therefore all logic that would otherwise depend on it must then be redesigned. Think of it as a try/catch exception block that does not return any exception message.</p>
<p><code class="docutils literal notranslate"><span class="pre">Workflow</span></code> - <strong>OpenFlow</strong>’s hash string identifying the workflow which will be executed.</p>
</dd></dl>
<div class="figure align-center" id="id42">
<img alt="images/openrpa_invoke_remote_openrpa.png" src="images/openrpa_invoke_remote_openrpa.png" />
<p class="caption"><span class="caption-text"><strong>OpenRPA Invoke Remote OpenRPA.</strong></span><a class="headerlink" href="#id42" title="Permalink to this image">¶</a></p>
</div>
<dl class="py class">
<dt>
<code class="sig-name descname">Move Mouse</code></dt>
<dd><p>Move mouse cursor to a location relative to an element found with <strong>GetElement</strong> (or desktop if no element is supplied).</p>
<p>This Activity has two modes of usage.</p>
<p>The first mode of usage is <strong>Selector</strong>-less. In this mode, the Activity will use the absolute values of the screen to find the <code class="docutils literal notranslate"><span class="pre">X</span></code> and <code class="docutils literal notranslate"><span class="pre">Y</span></code> offset values. As an example, if the <code class="docutils literal notranslate"><span class="pre">user</span></code> has a <code class="docutils literal notranslate"><span class="pre">1366x768</span></code> display, the activity will move the mouse according to that resolution inside the screen. To use this mode, all the <code class="docutils literal notranslate"><span class="pre">user</span></code> needs to do is to delete any value inside the <code class="docutils literal notranslate"><span class="pre">Element</span></code> property of the activity - its default value is <code class="docutils literal notranslate"><span class="pre">item</span></code> - and you can define the <code class="docutils literal notranslate"><span class="pre">X</span></code> and <code class="docutils literal notranslate"><span class="pre">Y</span></code> offset values.</p>
<p>The second mode of usage is <strong>Selector</strong>-bound. In this mode, after selecting a <strong>Windows element</strong>, the activity will use the relative values of the part of the screen which the element occupies to find the <code class="docutils literal notranslate"><span class="pre">X</span></code> and <code class="docutils literal notranslate"><span class="pre">Y</span></code> offset values. To use this mode, all the user needs to do is drag the <strong>Move Mouse</strong> activity into the element selected and define the <code class="docutils literal notranslate"><span class="pre">X</span></code> and <code class="docutils literal notranslate"><span class="pre">Y</span></code> offset values.</p>
<blockquote>
<div><p>The application must be selected by using the <strong>Get Element</strong> Activity.</p>
</div></blockquote>
<p><strong>Properties Parameters</strong></p>
<p><code class="docutils literal notranslate"><span class="pre">Animate</span> <span class="pre">Mouse</span></code> - If set to <code class="docutils literal notranslate"><span class="pre">True</span></code>, the cursor will appear changing its position throughout execution. Good for showing what is happening in a presentation.</p>
<p><code class="docutils literal notranslate"><span class="pre">Displayname</span></code> - Title of the Activity inside the sequence.</p>
<p><code class="docutils literal notranslate"><span class="pre">Element</span></code> - The application selected with the <strong>Get Element</strong> Activity.</p>
<p><code class="docutils literal notranslate"><span class="pre">Post</span> <span class="pre">Wait</span></code> - How long <strong>OpenRPA</strong> should wait for this Activity to finish after completing its execution.</p>
<p><code class="docutils literal notranslate"><span class="pre">X</span> <span class="pre">Offset</span></code> - The horizontal offset inside the window which the cursor will be moved to. Units are in pixels. It also allows for negative values.</p>
<p><code class="docutils literal notranslate"><span class="pre">Y</span> <span class="pre">Offset</span></code> - The vertical offset inside the window which the cursor will be moved to. Units are in pixels. It also allows for negative values.</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This activity requires a Mouse IO. If it fails to find one, it will return the error: <code class="docutils literal notranslate"><span class="pre">Could</span> <span class="pre">not</span> <span class="pre">send</span> <span class="pre">mouse</span> <span class="pre">input.</span> <span class="pre">Error</span> <span class="pre">Code:</span> <span class="pre">5</span></code>. This may happen if <strong>OpenRPA</strong> Client was launched from inside a Windows Remote Desktop and the session was disconnected. To avoid this, please use HDRobots extension, do not disconnect/close the RDP session or make the session persistent by using other techniques (i.e.: running a VNC server).</p>
</div>
<div class="figure align-center" id="id43">
<img alt="images/openrpa_move_mouse.png" src="images/openrpa_move_mouse.png" />
<p class="caption"><span class="caption-text"><strong>OpenRPA Move Mouse.</strong></span><a class="headerlink" href="#id43" title="Permalink to this image">¶</a></p>
</div>
<dl class="py class">
<dt>
<code class="sig-name descname">Open Application</code></dt>
<dd><p><strong>Open Application</strong> searches for <strong>Windows element</strong> based on a <code class="docutils literal notranslate"><span class="pre">Selector</span></code>, and focus on it. If the Application was not found, it will start it.</p>
<p>Clicking <strong>Highlight</strong> will red-highlight the first element that matches the criteria on the <code class="docutils literal notranslate"><span class="pre">Selector</span></code>. Useful for checking if the <code class="docutils literal notranslate"><span class="pre">Selector</span></code> is properly set up.</p>
<p>This Activity also supports working with <code class="docutils literal notranslate"><span class="pre">Selector</span></code> inside itself. All you need to do is drag a <code class="docutils literal notranslate"><span class="pre">GetElement</span></code>, or according activity, inside its sequence.</p>
<p>This activity can also be used to work with browsers and other applications such as Java, SAP etc.
<strong>Properties Parameters</strong></p>
<p><code class="docutils literal notranslate"><span class="pre">Animate</span> <span class="pre">Move</span></code> - Visibly move the window of the application which will be opened, instead of instantly moving it. Useful for presentations.</p>
<p><code class="docutils literal notranslate"><span class="pre">Check</span> <span class="pre">Running</span></code> - Check if application is already running using the <code class="docutils literal notranslate"><span class="pre">Selector</span></code>. If set to <code class="docutils literal notranslate"><span class="pre">False</span></code>, it will launch a new application no matter what.</p>
<p><code class="docutils literal notranslate"><span class="pre">Displayname</span></code> - Title of the Activity inside the sequence.</p>
<p><code class="docutils literal notranslate"><span class="pre">Height</span></code> - If set, the application is opened with this given height. Units are in pixels.</p>
<p><code class="docutils literal notranslate"><span class="pre">Result</span></code> - Save the result of the execution to a variable. By default, it saves the application Element itself.</p>
<p><code class="docutils literal notranslate"><span class="pre">Selector</span></code> - Contains all the data used to identify applications.</p>
<p><code class="docutils literal notranslate"><span class="pre">Timeout</span></code> - Time to check for whether the application was found. Essentially a timeout for the <code class="docutils literal notranslate"><span class="pre">Check</span> <span class="pre">Running</span></code> parameter. Can be a simple 00:00:00.00 {hh:min:ss.mili} or an object from the <strong>TimeSpan</strong> class.</p>
<p><code class="docutils literal notranslate"><span class="pre">Width</span></code> - If set, the application is opened with this given height. Units are in pixels.</p>
<p><code class="docutils literal notranslate"><span class="pre">X</span></code> - If set, move the application to this horizontal offset. Units are in pixels. It also allows for negative values.</p>
<p><code class="docutils literal notranslate"><span class="pre">Y</span></code> - If set, moves the application to this vertical offset. Units are in pixels. It also allows for negative values.</p>
</dd></dl>
<div class="figure align-center" id="id44">
<img alt="images/openrpa_open_application.png" src="images/openrpa_open_application.png" />
<p class="caption"><span class="caption-text"><strong>OpenRPA Open Application.</strong></span><a class="headerlink" href="#id44" title="Permalink to this image">¶</a></p>
</div>
<dl class="py class">
<dt>
<code class="sig-name descname">Show Balloon Tip</code></dt>
<dd><p><strong>Show Balloon Tip</strong> shows a message similar to the <strong>Show Notification</strong> activity near the system tray. It differs from <strong>Show Notification</strong> only in that it also contains a title and allows for other types of notifications such as Error or Warning.</p>
<p><strong>Properties Parameters</strong></p>
<p><code class="docutils literal notranslate"><span class="pre">Duration</span></code> - How long the message will appear.</p>
<p><code class="docutils literal notranslate"><span class="pre">Message</span></code> - Message which will be shown. Needs to be included inside quotes.</p>
<p><code class="docutils literal notranslate"><span class="pre">Title</span></code> - Title of the balloon tip.</p>
<p><code class="docutils literal notranslate"><span class="pre">Displayname</span></code> - Title of the Activity inside the sequence.</p>
<p><code class="docutils literal notranslate"><span class="pre">NotificationType</span></code> - Different notification types: Information, Error or Warning.</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Refrain from using too many Activities that change UI elements (such as Show Balloon Tip, WriteLine or Show Notification). These activities run single-threaded, which means that each time they are executed, they briefly stop Workflow execution.</p>
</div>
<div class="figure align-center" id="id45">
<img alt="images/openrpa_show_balloon_tip.png" src="images/openrpa_show_balloon_tip.png" />
<p class="caption"><span class="caption-text"><strong>OpenRPA Show Balloon Tip.</strong></span><a class="headerlink" href="#id45" title="Permalink to this image">¶</a></p>
</div>
<dl class="py class">
<dt>
<code class="sig-name descname">Type Text</code></dt>
<dd><p>The user is strongly discouraged from using this Activity. It is preferable to select an element with the <strong>GetElement</strong> activity and use the <strong>Assign</strong> property to assign a string value to it.</p>
<p><strong>Type Text</strong> sends keystrokes from the text contained inside <strong>Hint</strong> to the window currently focused. Instead of memorizing every keystroke, it is recommended to use the <strong>Recorder</strong> as it will map every keystroke automatically.¹</p>
<p>The key stroke syntax should be “{{Modifier1, Key1} {Modifier2, Key2} {…} {ModifierN, KeyN}}”.Keep in mind that <strong>Modifiers</strong>, which would be auxiliary keys - such as <code class="docutils literal notranslate"><span class="pre">Ctrl</span></code>, <code class="docutils literal notranslate"><span class="pre">Alt</span></code>, <code class="docutils literal notranslate"><span class="pre">Shift</span></code> - are not obligatory.</p>
<p>The user can also send <strong>variables</strong> or <strong>hardcoded text</strong>, such as sending “{{Modifier1, Key1} SOME TEXT ” + desired_variable + “{Enter}”.</p>
<p><strong>Properties Parameters</strong></p>
<p><code class="docutils literal notranslate"><span class="pre">Click</span> <span class="pre">Delay</span></code> - Delay between each keystroke.</p>
<p><code class="docutils literal notranslate"><span class="pre">Displayname</span></code> - Title of the Activity inside the sequence.</p>
<p><code class="docutils literal notranslate"><span class="pre">Text</span></code> - Displayname inside the <code class="docutils literal notranslate"><span class="pre">Workflow</span></code> designer.</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This activity requires a Keyboard IO. If it fails to find one, it will return “Could not send keyboard input. Error Code: 5”. This may happen if <strong>OpenRPA</strong> Client was launched from inside a Windows Remote Desktop Session and the session was disconnected. In order to avoid this, please use the HDRobots extension. Do not disconnect/close the RDP session or persist the session using other techniques (e.g. running VNC).</p>
</div>
<div class="figure align-center" id="id46">
<img alt="images/openrpa_type_text.png" src="images/openrpa_type_text.png" />
<p class="caption"><span class="caption-text"><strong>OpenRPA Type Text.</strong></span><a class="headerlink" href="#id46" title="Permalink to this image">¶</a></p>
</div>
<p><em>¹ - `Overview of TypeText Activity <https://openrpa.openiap.io/pages/typetext-syntax>`_ (``https://openrpa.openiap.io/pages/typetext-syntax``)</em></p>
</div>
<div class="section" id="openrpa-avirecorder">
<h3>OpenRPA.AviRecorder<a class="headerlink" href="#openrpa-avirecorder" title="Permalink to this headline">¶</a></h3>
<div class="figure align-center">
<img alt="images/openrpa_start_recording.png" src="images/openrpa_start_recording.png" />
</div>
<div class="figure align-center">
<img alt="images/openrpa_stop_recording.png" src="images/openrpa_stop_recording.png" />
</div>
</div>
<div class="section" id="openrpa-database">
<h3>OpenRPA.Database<a class="headerlink" href="#openrpa-database" title="Permalink to this headline">¶</a></h3>
<p>Here belong the activities located inside the OpenRPA.Database toolbox.</p>
<dl class="py class">
<dt>
<code class="sig-name descname">Database Scope</code></dt>
<dd><p>Selects the database that will be used to query, insert, update or delete data by opening a connection and ending it once all the activities inside its scope are concluded. A thorough example is shown in the <a class="reference internal" href="openrpa.html#openrpa-database-activities-datatable-dataview"><span class="std std-ref">OpenRPA.Database Activities, DataTable, DataView</span></a> section.</p>
<p><strong>Properties Parameters</strong></p>
<p><code class="docutils literal notranslate"><span class="pre">ConnectionString</span></code> - The <a class="reference external" href="https://docs.microsoft.com/en-us/dotnet/api/system.data.sqlclient.sqlconnection.connectionstring?view=dotnet-plat-ext-3.1">ConnectionString</a> (<code class="docutils literal notranslate"><span class="pre">https://docs.microsoft.com/en-us/dotnet/api/system.data.sqlclient.sqlconnection.connectionstring?view=dotnet-plat-ext-3.1</span></code>) which will be used to connect to the database. An example is <code class="docutils literal notranslate"><span class="pre">"Server=localhost;Port=3306;Database=using_datatables;Uid=root;Pwd='life</span> <span class="pre">is</span> <span class="pre">fine</span> <span class="pre">9#';"</span></code>.</p>
<p><code class="docutils literal notranslate"><span class="pre">DataProvider</span></code> - The provider used for the given database. Default for <strong>MySQL</strong> is <code class="docutils literal notranslate"><span class="pre">"MySql.Data.MySqlClient"</span></code>.</p>
<p><code class="docutils literal notranslate"><span class="pre">DataSource</span></code> - The name of the <code class="docutils literal notranslate"><span class="pre">database</span> <span class="pre">schema</span></code> that will be used to gather data from.</p>
<p><code class="docutils literal notranslate"><span class="pre">DisplayName</span></code> - Title of the Activity inside the sequence.</p>
<p><code class="docutils literal notranslate"><span class="pre">Timeout</span></code> - Time to wait until the connection is completed. If the connection is not completed until this time, activity will pass on through others inside the outer sequence. Can be a simple 00:00:00.00 {hh:min:ss.mili} or an object from the <strong>TimeSpan</strong> class.</p>
</dd></dl>
<div class="figure align-center" id="id47">
<img alt="images/openrpa_database_scope.png" src="images/openrpa_database_scope.png" />
<p class="caption"><span class="caption-text"><strong>OpenRPA.Database Database Scope.</strong></span><a class="headerlink" href="#id47" title="Permalink to this image">¶</a></p>
</div>
<dl class="py class">
<dt>
<code class="sig-name descname">Execute Non Query</code></dt>
<dd><p>Runs a query that returns no results, useful for <code class="docutils literal notranslate"><span class="pre">INSERT</span></code>, <code class="docutils literal notranslate"><span class="pre">UPDATE</span></code>, and <code class="docutils literal notranslate"><span class="pre">DELETE</span></code> statements. The <code class="docutils literal notranslate"><span class="pre">Result</span></code> value is the number of rows affected by the command. If no rows are affected, it returns <code class="docutils literal notranslate"><span class="pre">0</span></code>.</p>
<p><strong>Properties Parameters</strong></p>
<p><code class="docutils literal notranslate"><span class="pre">Query</span></code> - The query which will be executed.</p>
<p><code class="docutils literal notranslate"><span class="pre">activity_displayname</span></code> - Title of the Activity inside the sequence.</p>
<p><code class="docutils literal notranslate"><span class="pre">CommandType</span></code> - Default is set to <code class="docutils literal notranslate"><span class="pre">Text</span></code> - which means the command inside the <code class="docutils literal notranslate"><span class="pre">Query</span></code> field will be executed. If set to <code class="docutils literal notranslate"><span class="pre">StoredProcedure</span></code>, the text inside <code class="docutils literal notranslate"><span class="pre">Query</span></code> should be the name of a stored procedure. If set to <code class="docutils literal notranslate"><span class="pre">TableDirect</span></code> all rows and columns of the named table will be returned when you call one of the Execute methods.</p>
<p><code class="docutils literal notranslate"><span class="pre">Result</span></code> - <code class="docutils literal notranslate"><span class="pre">Int32</span></code> output of the executed query.</p>
</dd></dl>
<div class="figure align-center" id="id48">
<img alt="images/openrpa_execute_non_query.png" src="images/openrpa_execute_non_query.png" />
<p class="caption"><span class="caption-text"><strong>OpenRPA.Database Execute Non Query.</strong></span><a class="headerlink" href="#id48" title="Permalink to this image">¶</a></p>
</div>
<dl class="py class">
<dt>
<code class="sig-name descname">Execute Query</code></dt>
<dd><p>Runs a query and returns the results as a DataTable. Useful to be used with <code class="docutils literal notranslate"><span class="pre">SELECT</span></code> statements.</p>
<p><strong>Properties Parameters</strong></p>
<p><code class="docutils literal notranslate"><span class="pre">Query</span></code> - The query which will be executed.</p>
<p><code class="docutils literal notranslate"><span class="pre">activity_displayname</span></code> - Title of the Activity inside the sequence.</p>
<p><code class="docutils literal notranslate"><span class="pre">CommandType</span></code> - Default is set to <code class="docutils literal notranslate"><span class="pre">Text</span></code> - which means that the command inside the <code class="docutils literal notranslate"><span class="pre">Query</span></code> field will be executed. If set to <code class="docutils literal notranslate"><span class="pre">StoredProcedure</span></code>, the text inside <code class="docutils literal notranslate"><span class="pre">Query</span></code> should be the name of a stored procedure. If set to <code class="docutils literal notranslate"><span class="pre">TableDirect</span></code> all rows and columns of the named table will be returned when you call one of the Execute methods.</p>
<p><code class="docutils literal notranslate"><span class="pre">DataTable</span></code> - The <code class="docutils literal notranslate"><span class="pre">DataTable</span></code> object where to save the result of the query.</p>
</dd></dl>
<div class="figure align-center" id="id49">
<img alt="images/openrpa_execute_query.png" src="images/openrpa_execute_query.png" />
<p class="caption"><span class="caption-text"><strong>OpenRPA.Database Execute Query.</strong></span><a class="headerlink" href="#id49" title="Permalink to this image">¶</a></p>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>In OpenRPA, a <code class="docutils literal notranslate"><span class="pre">DataTable</span></code> corresponds to a 2-dimensional non-serializable object used to hold values. Think of it as a matrix with <code class="docutils literal notranslate"><span class="pre">i</span></code> rows and <code class="docutils literal notranslate"><span class="pre">j</span></code> columns. The <code class="docutils literal notranslate"><span class="pre">i</span></code> rows are accessible by using the <code class="docutils literal notranslate"><span class="pre">.Rows(n)</span></code> attribute, where <code class="docutils literal notranslate"><span class="pre">n</span></code> is the number of the row - starting from 0 - which you want to access. The <code class="docutils literal notranslate"><span class="pre">j</span></code> columns are accessible by using the <code class="docutils literal notranslate"><span class="pre">.Item(n)</span></code> attribute, where <code class="docutils literal notranslate"><span class="pre">n</span></code> is the number of the column - starting from 0 - which you want to access. It is useful to remind here that the user must have accessed the <code class="docutils literal notranslate"><span class="pre">Rows</span></code> attribute, therefore, if the user wanted to access the 2nd column on the 3rd row of the datatable they would use <code class="docutils literal notranslate"><span class="pre">.Rows(2).Item(1)</span></code> attribute.</p>
</div>
<dl class="py class">
<dt>
<code class="sig-name descname">Execute Scalar<></code></dt>
<dd><p>Runs a query that returns exactly one result, such as aggregate functions: <code class="docutils literal notranslate"><span class="pre">SUM</span></code>, <code class="docutils literal notranslate"><span class="pre">AVG</span></code>, <code class="docutils literal notranslate"><span class="pre">MAX</span></code>, <code class="docutils literal notranslate"><span class="pre">MIN</span></code> and <code class="docutils literal notranslate"><span class="pre">COUNT</span></code>.</p>
<p><strong>Properties Parameters</strong></p>
<p><code class="docutils literal notranslate"><span class="pre">Query</span></code> - The query which will be executed.</p>
<p><code class="docutils literal notranslate"><span class="pre">activity_displayname</span></code> - Title of the Activity inside the sequence.</p>
<p><code class="docutils literal notranslate"><span class="pre">ArgumentType</span></code> - Type of the result which will be returned.</p>
<p><code class="docutils literal notranslate"><span class="pre">CommandType</span></code> - Default is set to <code class="docutils literal notranslate"><span class="pre">Text</span></code> - which means that the command inside the <code class="docutils literal notranslate"><span class="pre">Query</span></code> field will be executed. If set to <code class="docutils literal notranslate"><span class="pre">StoredProcedure</span></code>, the text inside <code class="docutils literal notranslate"><span class="pre">Query</span></code> should be the name of a stored procedure. If set to <code class="docutils literal notranslate"><span class="pre">TableDirect</span></code> all rows and columns of the named table will be returned when you call one of the Execute methods.</p>
<p><code class="docutils literal notranslate"><span class="pre">Result</span></code> - Result output of the executed query. - has its type defined as in <code class="docutils literal notranslate"><span class="pre">ArgumentType</span></code>.</p>
</dd></dl>
<div class="figure align-center" id="id50">
<img alt="images/openrpa_execute_scalar.png" src="images/openrpa_execute_scalar.png" />
<p class="caption"><span class="caption-text"><strong>OpenRPA.Database Execute Scalar<>.</strong></span><a class="headerlink" href="#id50" title="Permalink to this image">¶</a></p>
</div>
<dl class="py class">
<dt>
<code class="sig-name descname">Update from DataTable</code></dt>
<dd><p>It adds in <code class="docutils literal notranslate"><span class="pre">SQL</span> <span class="pre">table</span></code> the data contained inside the given <code class="docutils literal notranslate"><span class="pre">DataTable</span></code>.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">DataTable</span></code> must first be selected with the <strong>Execute Query</strong> Activity by using the <code class="docutils literal notranslate"><span class="pre">"SELECT</span> <span class="pre">*</span> <span class="pre">from</span> <span class="pre">${TABLE};"</span></code> statement, where <code class="docutils literal notranslate"><span class="pre">"${TABLE}"</span></code> is the table file path the data will be added. Then, the user can change its data by adding rows with the <strong>AddDataRow</strong> activity and finally update it employing the above-mentioned method.</p>
<p>It is important to remind users that the headers and content must match those of the <code class="docutils literal notranslate"><span class="pre">SQL</span> <span class="pre">Table</span></code>.</p>
<p><strong>Properties</strong></p>
<p><code class="docutils literal notranslate"><span class="pre">DataTable</span> <span class="pre">with</span> <span class="pre">the</span> <span class="pre">data</span> <span class="pre">you</span> <span class="pre">want</span> <span class="pre">to</span> <span class="pre">update</span> <span class="pre">from</span></code> - self-explanatory.</p>
<p><code class="docutils literal notranslate"><span class="pre">TableName</span></code> - Table to insert rows into.</p>
<p><code class="docutils literal notranslate"><span class="pre">activity_displayname</span></code> - Title of the Activity inside the Sequence.</p>
<p><code class="docutils literal notranslate"><span class="pre">Result</span></code> - number of rows affected.</p>
</dd></dl>
<div class="figure align-center" id="id51">
<img alt="images/openrpa_update_from_datatable.png" src="images/openrpa_update_from_datatable.png" />
<p class="caption"><span class="caption-text"><strong>OpenRPA.Database Update from DataTable.</strong></span><a class="headerlink" href="#id51" title="Permalink to this image">¶</a></p>
</div>
</div>
<div class="section" id="openrpa-elisrossum">
<h3>OpenRPA.ElisRossum<a class="headerlink" href="#openrpa-elisrossum" title="Permalink to this headline">¶</a></h3>
<p>Here belong the activities located inside the OpenRPA.ElisRossum toolbox.</p>
<dl class="py class">
<dt>
<code class="sig-name descname">Auth Activity</code></dt>
<dd><p>Authenticates the user into the <a class="reference external" href="https://rossum.ai/">Rossum Platform</a> (<code class="docutils literal notranslate"><span class="pre">https://rossum.ai/</span></code>) by using his <cite>Rossum credentials</cite> and it also saves the <code class="docutils literal notranslate"><span class="pre">JWT</span> <span class="pre">token</span></code> returned to a variable. User must have first configured an account.</p>
<p>After typing the desired name for the variable in the <code class="docutils literal notranslate"><span class="pre">Result</span></code> parameter inside the <strong>Properties Box</strong>, the user must also create it by pressing <code class="docutils literal notranslate"><span class="pre">Ctrl+K</span></code>. This variable will hold the contents of the <code class="docutils literal notranslate"><span class="pre">JWT</span> <span class="pre">token</span></code> returned so users can make use of it in the activities discussed below to perform the invoice processing.</p>
<p>For more information on the <cite>Rossum Platform</cite>, please refer to <a class="reference external" href="https://rossum.ai/help/article/quick-start-guide/">Quick Start Guide on Rossum - FAQ | Help Center</a> (<code class="docutils literal notranslate"><span class="pre">https://rossum.ai/help/article/quick-start-guide/</span></code>).</p>
<p><strong>Properties Parameters</strong></p>
<p><code class="docutils literal notranslate"><span class="pre">DisplayName</span></code> - Title of the activity inside the sequence.</p>
<p><code class="docutils literal notranslate"><span class="pre">Password</span></code> - Password for the <cite>Rossum credentials</cite>.</p>
<p><code class="docutils literal notranslate"><span class="pre">Result</span></code> - Variable to which the <code class="docutils literal notranslate"><span class="pre">JWT</span> <span class="pre">token</span></code> will be saved.</p>
<p><code class="docutils literal notranslate"><span class="pre">Username</span></code> - Username for the <cite>Rossum credentials</cite>.</p>
<div class="figure align-center">
<img alt="images/openrpa_elis_rossum_auth.png" src="images/openrpa_elis_rossum_auth.png" />
</div>
<p><strong>OpenRPA.ElisRossum Auth.</strong></p>
<p>This platform provides invoice extraction services through cognitive data capture, which is the recommended way over common OCR for this type of data. Please visit <a class="reference external" href="https://rossum.ai/help/faq/">Rossum - FAQ | Help Center</a> (<code class="docutils literal notranslate"><span class="pre">https://rossum.ai/help/faq/</span></code>) for more information.</p>
</dd></dl>
<dl class="py class">
<dt>
<code class="sig-name descname">Export File Data</code></dt>
<dd><p>This activity exports the data acquired from the <a class="reference external" href="https://api.elis.rossum.ai/docs/#annotation">Rossum Platform annotation</a> (<code class="docutils literal notranslate"><span class="pre">https://api.elis.rossum.ai/docs/#annotation</span></code>) into a variable of type <code class="docutils literal notranslate"><span class="pre">OpenRPA.ElisRossum.ExportResult</span></code>. Furthermore, this object allows the users to iterate through it and consume the following datatypes: <code class="docutils literal notranslate"><span class="pre">invoice_id</span></code>, <code class="docutils literal notranslate"><span class="pre">date_issue</span></code>, <code class="docutils literal notranslate"><span class="pre">date_due</span></code>, <code class="docutils literal notranslate"><span class="pre">sender_ic</span></code>, <code class="docutils literal notranslate"><span class="pre">recipient_ic</span></code>, <code class="docutils literal notranslate"><span class="pre">amount_total_base</span></code>, <code class="docutils literal notranslate"><span class="pre">amount_total_tax</span></code>.</p>
<p>The users must have a <code class="docutils literal notranslate"><span class="pre">JWT</span> <span class="pre">token</span></code> returned by the <span class="xref std std-ref">Auth Activity</span> previously saved into a variable, which will be inserted in the <code class="docutils literal notranslate"><span class="pre">Key</span></code> parameter.</p>
<p>The users must also have previously initialized a <cite>Rossum Platform queue</cite> into a variable by using the <span class="xref std std-ref">Get Queue</span> activity.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">Fileurl</span></code> variable which will be used to acquire the data for the <cite>Rossum Platform annotation</cite> must have been initialized as the <code class="docutils literal notranslate"><span class="pre">Result</span></code> from an <span class="xref std std-ref">Upload File</span> activity.</p>
<p>After typing the desired name for the <code class="docutils literal notranslate"><span class="pre">ExportResult</span></code> variable in the <code class="docutils literal notranslate"><span class="pre">Result</span></code> parameter inside the <strong>Properties Box</strong> the user must also create it by pressing <code class="docutils literal notranslate"><span class="pre">Ctrl+K</span></code>. This variable will hold the current data of the <cite>Rossum Platform annotation</cite> acquired by using the <code class="docutils literal notranslate"><span class="pre">Fileurl</span></code> specified.</p>
<p><strong>Properties Box</strong></p>
<p><code class="docutils literal notranslate"><span class="pre">DisplayName</span></code> - Title of the activity inside the sequence.</p>
<p><code class="docutils literal notranslate"><span class="pre">Fileurl</span></code> - <code class="docutils literal notranslate"><span class="pre">URL</span></code> for the <cite>Rossum Platform annotation</cite> acquired with the <span class="xref std std-ref">Upload File</span> activity.</p>
<p><code class="docutils literal notranslate"><span class="pre">Key</span></code> - <code class="docutils literal notranslate"><span class="pre">JWT</span> <span class="pre">token</span></code> returned by the <span class="xref std std-ref">Auth Activity</span>.</p>
<p><code class="docutils literal notranslate"><span class="pre">Queue</span></code> - <code class="docutils literal notranslate"><span class="pre">URL</span> <span class="pre">attribute</span></code> for the indexed queue which is returned from the variable acquired through the <span class="xref std std-ref">Get Queue</span> activity - ie. <code class="docutils literal notranslate"><span class="pre">qs(0).url</span></code>.</p>
<p><code class="docutils literal notranslate"><span class="pre">Result</span></code> - Variable to which the data acquired will be saved.</p>
<div class="figure align-center">
<img alt="images/openrpa_elis_rossum_export_file_data.png" src="images/openrpa_elis_rossum_export_file_data.png" />
</div>
<p><strong>OpenRPA.ElisRossum Export File Data.</strong></p>
</dd></dl>
<dl class="py class">
<dt>
<code class="sig-name descname">Get File Status</code></dt>
<dd><p>Gathers the status for a <a class="reference external" href="https://api.elis.rossum.ai/docs/#annotation">Rossum Platform annotation</a> (<code class="docutils literal notranslate"><span class="pre">https://api.elis.rossum.ai/docs/#annotation</span></code>) and saves it into a variable.</p>
<p>The users must have a <code class="docutils literal notranslate"><span class="pre">JWT</span> <span class="pre">token</span></code> returned by the <span class="xref std std-ref">Auth Activity</span> previously saved into a variable, which will be inserted in the <code class="docutils literal notranslate"><span class="pre">Key</span></code> parameter.</p>
<p>The users must also have previously initialized a <cite>Rossum Platform queue</cite> into a variable by using the <span class="xref std std-ref">Get Queue</span> activity.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">Fileurl</span></code> variable which will be used to gather the status data for the <cite>Rossum Platform annotation</cite> must have been initialized as the <code class="docutils literal notranslate"><span class="pre">Result</span></code> from an <span class="xref std std-ref">Upload File</span> activity.</p>
<p>For more information on possible file statuses, please refer to <a class="reference external" href="https://api.elis.rossum.ai/docs/#annotation-lifecycle">Rossum Platform Annotation Lifecycle</a> (<code class="docutils literal notranslate"><span class="pre">https://api.elis.rossum.ai/docs/#annotation-lifecycle</span></code>).</p>
<p><strong>Properties Parameters</strong></p>
<p><code class="docutils literal notranslate"><span class="pre">DisplayName</span></code> - Title of the activity inside the sequence.</p>
<p><code class="docutils literal notranslate"><span class="pre">Fileurl</span></code> - <code class="docutils literal notranslate"><span class="pre">URL</span></code> for the <cite>Rossum Platform annotation</cite> acquired with the <span class="xref std std-ref">Upload File</span> activity.</p>
<p><code class="docutils literal notranslate"><span class="pre">Key</span></code> - <code class="docutils literal notranslate"><span class="pre">JWT</span> <span class="pre">token</span></code> returned by the <span class="xref std std-ref">Auth Activity</span>.</p>
<p><code class="docutils literal notranslate"><span class="pre">Result</span></code> - Status returned by the activity. Refer to <a class="reference external" href="https://api.elis.rossum.ai/docs/#annotation-lifecycle">Rossum Platform Annotation Lifecycle</a> (<code class="docutils literal notranslate"><span class="pre">https://api.elis.rossum.ai/docs/#annotation-lifecycle</span></code>) for more information.</p>
<div class="figure align-center">
<img alt="images/openrpa_elis_rossum_get_file_status.png" src="images/openrpa_elis_rossum_get_file_status.png" />
</div>
<p><strong>OpenRPA.ElisRossum Get File Status.</strong></p>
</dd></dl>
<dl class="py class">
<dt>
<code class="sig-name descname">Get Queue</code></dt>
<dd><p>Acquires all queues contained inside the given account for the <cite>Rossum credentials</cite> provided with the <span class="xref std std-ref">Auth Acivity</span> and saves them to a variable.</p>
<p>The users must have a <code class="docutils literal notranslate"><span class="pre">JWT</span> <span class="pre">token</span></code> returned by the <span class="xref std std-ref">Auth Activity</span> previously saved into a variable, which will be inserted in the <code class="docutils literal notranslate"><span class="pre">Key</span></code> parameter.</p>
<p>In <cite>Rossum Platform</cite>, a queue is a space into which users import documents they want to process. Each queue is an organizational unit that typically represents a particular document type that needs to be processed. Learn how to create a <cite>Rossum Platform queue</cite> at <a class="reference external" href="https://rossum.ai/help/article/creating-a-new-queue/">Creating a New Queue on Rossum - FAQ | Help Center</a> (<code class="docutils literal notranslate"><span class="pre">https://rossum.ai/help/article/creating-a-new-queue/</span></code>).</p>
<p>After typing the desired name for the variable in the <code class="docutils literal notranslate"><span class="pre">Results</span></code> parameter inside the <strong>Properties Box</strong> the user must also create it by pressing <code class="docutils literal notranslate"><span class="pre">Ctrl+K</span></code>. This variable will hold the contents of the <code class="docutils literal notranslate"><span class="pre">JSON</span> <span class="pre">Object</span></code> containing the <a href="#id5"><span class="problematic" id="id6">``</span></a>Queues[]``returned by the <cite>Rossum Platform</cite>.</p>
<p><strong>Properties Parameters</strong></p>
<p><code class="docutils literal notranslate"><span class="pre">DisplayName</span></code> - Title of the activity inside the sequence.</p>
<p><code class="docutils literal notranslate"><span class="pre">Key</span></code> - <code class="docutils literal notranslate"><span class="pre">JWT</span> <span class="pre">token</span></code> returned by the <span class="xref std std-ref">Auth Activity</span>.</p>
<p><code class="docutils literal notranslate"><span class="pre">Results</span></code> - Variable which will hold the contents of the <code class="docutils literal notranslate"><span class="pre">Queues[]</span></code>.</p>
</dd></dl>
<div class="figure align-center">
<img alt="images/openrpa_elis_rossum_get_queue.png" src="images/openrpa_elis_rossum_get_queue.png" />
</div>
<dl class="py class">
<dt>
<code class="sig-name descname">Upload File</code></dt>
<dd><p>Uploads a file into one of the queues returned by the <span class="xref std std-ref">Get Queue</span> activity and saves the resulting <cite>URL</cite> for the <a class="reference external" href="https://api.elis.rossum.ai/docs/#annotation">Rossum Platform annotation</a> (<code class="docutils literal notranslate"><span class="pre">https://api.elis.rossum.ai/docs/#annotation</span></code>).</p>
<p>The users must have a <code class="docutils literal notranslate"><span class="pre">JWT</span> <span class="pre">token</span></code> returned by the <span class="xref std std-ref">Auth Activity</span> previously saved into a variable, which will be inserted in the <code class="docutils literal notranslate"><span class="pre">Key</span></code> parameter.</p>
<p>The users must also have previously initialized a <cite>Rossum Platform queue</cite> into a variable by using the <span class="xref std std-ref">Get Queue</span> activity.</p>
<p>The users must also provide the <code class="docutils literal notranslate"><span class="pre">absolute</span> <span class="pre">filepath</span></code> of the file in the <code class="docutils literal notranslate"><span class="pre">Filename</span></code> parameter inside the <strong>Properties Box</strong>. This file must obligatorily have the <code class="docutils literal notranslate"><span class="pre">PDF</span></code> file format or else the activity will return an error. It must also be enclosed between quotes.</p>
<p>After typing the desired name for the variable in the <code class="docutils literal notranslate"><span class="pre">Result</span></code> parameter inside the <strong>Properties Box</strong> the user must also create it by pressing <code class="docutils literal notranslate"><span class="pre">Ctrl+K</span></code>. This variable will hold the contents of the <cite>URL`for the `Rossum Platform annotation</cite>.</p>
<p><strong>Properties Parameters</strong></p>
<p><code class="docutils literal notranslate"><span class="pre">DisplayName</span></code> - Title of the activity inside the sequence.</p>
<p><code class="docutils literal notranslate"><span class="pre">Filename</span></code> - <code class="docutils literal notranslate"><span class="pre">Absolute</span> <span class="pre">filepath</span></code> of the file which will be uploaded.</p>
<p><code class="docutils literal notranslate"><span class="pre">Key</span></code> - <code class="docutils literal notranslate"><span class="pre">JWT</span> <span class="pre">token</span></code> returned by the <span class="xref std std-ref">Auth Activity</span>.</p>
<p><code class="docutils literal notranslate"><span class="pre">Queue</span></code> - <code class="docutils literal notranslate"><span class="pre">URL</span> <span class="pre">attribute</span></code> for the indexed queue which is returned from the variable acquired through the <span class="xref std std-ref">Get Queue</span> activity - ie. <code class="docutils literal notranslate"><span class="pre">qs(0).url</span></code>.</p>
<p><code class="docutils literal notranslate"><span class="pre">Result</span></code> - Variable to which the <code class="docutils literal notranslate"><span class="pre">URL</span></code> for the document just uploaded will be saved.</p>
<div class="figure align-center">
<img alt="images/openrpa_elis_rossum_upload_file.png" src="images/openrpa_elis_rossum_upload_file.png" />
</div>
</dd></dl>
<dl class="py class">
<dt>
<code class="sig-name descname">Wait for File Status</code></dt>
<dd><p>Sets the workflow status to <code class="docutils literal notranslate"><span class="pre">idle</span></code> until the status of the <a class="reference external" href="https://api.elis.rossum.ai/docs/#annotation">Rossum Platform annotation</a> (<code class="docutils literal notranslate"><span class="pre">https://api.elis.rossum.ai/docs/#annotation</span></code>) is equal to the one provided by the users.</p>
<p>The users must have a <code class="docutils literal notranslate"><span class="pre">JWT</span> <span class="pre">token</span></code> returned by the <span class="xref std std-ref">Auth Activity</span> previously saved into a variable, which will be inserted in the <code class="docutils literal notranslate"><span class="pre">Key</span></code> parameter.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">Fileurl</span></code> variable which will be used to match the status data for the <cite>Rossum Platform annotation</cite> must have been initialized as the <code class="docutils literal notranslate"><span class="pre">Result</span></code> from an <span class="xref std std-ref">Upload File</span> activity.</p>
<p>After typing the desired name for the variable in the <code class="docutils literal notranslate"><span class="pre">Result</span></code> parameter inside the <strong>Properties Box</strong> the user must also create it by pressing <code class="docutils literal notranslate"><span class="pre">Ctrl+K</span></code>. This variable will hold the current status of the <cite>Rossum Platform annotation</cite> acquired by using the <code class="docutils literal notranslate"><span class="pre">Fileurl</span></code> specified.</p>
<p>For more information on possible file statuses, please refer to <a class="reference external" href="https://api.elis.rossum.ai/docs/#annotation-lifecycle">Rossum Platform Annotation Lifecycle</a> (<code class="docutils literal notranslate"><span class="pre">https://api.elis.rossum.ai/docs/#annotation-lifecycle</span></code>).</p>
<p><strong>Properties Box</strong></p>
<p><code class="docutils literal notranslate"><span class="pre">DisplayName</span></code> - Title of the activity inside the sequence.</p>
<p><code class="docutils literal notranslate"><span class="pre">Fileurl</span></code> - <code class="docutils literal notranslate"><span class="pre">URL</span></code> for the <cite>Rossum Platform annotation</cite> acquired with the <span class="xref std std-ref">Upload File</span> activity.</p>
<p><code class="docutils literal notranslate"><span class="pre">Key</span></code> - <code class="docutils literal notranslate"><span class="pre">JWT</span> <span class="pre">token</span></code> returned by the <span class="xref std std-ref">Auth Activity</span>.</p>
<p><code class="docutils literal notranslate"><span class="pre">Result</span></code> - Variable to which the <cite>Rossum Platform Annotation Status</cite> will be saved.</p>
<p><code class="docutils literal notranslate"><span class="pre">Status</span></code> - <code class="docutils literal notranslate"><span class="pre">Status</span></code> which the current status of the file will be matched against. For more information on possible file statuses, please refer to <a class="reference external" href="https://api.elis.rossum.ai/docs/#annotation-lifecycle">Rossum Platform Annotation Lifecycle</a> (<code class="docutils literal notranslate"><span class="pre">https://api.elis.rossum.ai/docs/#annotation-lifecycle</span></code>).</p>
<p><code class="docutils literal notranslate"><span class="pre">Timeout</span></code> - Time interval for which the workflow will wait before ceasing to check whether the status of the file in the <cite>Rossum Platform</cite> matches the status provided in the <code class="docutils literal notranslate"><span class="pre">Status</span></code> parameter. Can be a simple 00:00:00.00 {hh:min:ss.mili} or an object from the <strong>TimeSpan</strong> class.</p>
<div class="figure align-center">
<img alt="images/openrpa_elis_rossum_wait_for_file_status.png" src="images/openrpa_elis_rossum_wait_for_file_status.png" />
</div>
</dd></dl>
</div>
<div class="section" id="openrpa-forms">
<h3>OpenRPA.Forms<a class="headerlink" href="#openrpa-forms" title="Permalink to this headline">¶</a></h3>
<p>Here belong the activities located inside the OpenRPA.Forms toolbox.</p>
<dl class="py class">
<dt>
<code class="sig-name descname">Invoke Form</code></dt>
<dd><p>Allows the user to create a static form which uses <a class="reference external" href="https://wpf-forge.github.io/Forge.Forms/guides/getting-started.html">ForgeForms language</a> (<code class="docutils literal notranslate"><span class="pre">https://wpf-forge.github.io/Forge.Forms/guides/getting-started.html</span></code>). <code class="docutils literal notranslate"><span class="pre">SimpleForm</span></code> and <code class="docutils literal notranslate"><span class="pre">ImageForm</span></code> examples are shown in the <strong>Snippets toolbox</strong>, just besides the <strong>Activities toolbox</strong>. This is very useful when a Workflow needs to gather input from an user before executing its business logic. The user can set up the form and preview it by clicking the <strong>Open Designer</strong> button. After creating it, all the user needs to do to create the variables used by it is click the <strong>Create variables</strong> button. An example is shown in the <a class="reference internal" href="openrpa.html#id43"><span class="std std-ref">OpenRPA Forms</span></a> section.</p>
<p><strong>Properties Parameters</strong></p>
<p><code class="docutils literal notranslate"><span class="pre">DisplayName</span></code> - Title of the Activity inside the sequence.</p>
<p><code class="docutils literal notranslate"><span class="pre">Form</span></code> - String containing the form which will be created.</p>
<p><code class="docutils literal notranslate"><span class="pre">Result</span></code> - Creates a <code class="docutils literal notranslate"><span class="pre">FormResult</span></code> variable which will hold the DOM object created by the form. To access the values inside the DOM object created, the user can simply use the <code class="docutils literal notranslate"><span class="pre">Model.Values(i).ToString</span></code> to access the <code class="docutils literal notranslate"><span class="pre">i-th</span></code> input variable.</p>
</dd></dl>
<dl class="py class">
<dt>
<code class="sig-name descname">Show Notification</code></dt>
<dd><p>Shows a notification in the lower right corner of the screen for a limited amount of time.</p>
<p><strong>Properties Parameters</strong></p>
<p><code class="docutils literal notranslate"><span class="pre">DisplayName</span></code> - Title of the Activity inside the sequence.</p>
<p><code class="docutils literal notranslate"><span class="pre">Message</span></code> - Message which will be shown.</p>
<p><code class="docutils literal notranslate"><span class="pre">NotificationType</span></code> - Different notification types: Information, Error or Warning.</p>
</dd></dl>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Refrain from using too many Activities that change UI elements (such as Show Balloon Tip, WriteLine or Show Notification). These activities run single-threaded, which means that each time they are executed, they briefly stop Workflow execution.</p>
</div>
<div class="figure align-center" id="id52">
<img alt="images/openrpa_show_notification.png" src="images/openrpa_show_notification.png" />
<p class="caption"><span class="caption-text"><strong>OpenRPA.Forms Show Notification.</strong></span><a class="headerlink" href="#id52" title="Permalink to this image">¶</a></p>
</div>
</div>
<div class="section" id="openrpa-ie">
<h3>OpenRPA.IE<a class="headerlink" href="#openrpa-ie" title="Permalink to this headline">¶</a></h3>
<p>Here belongs the activities located inside the OpenRPA.IE toolbox.</p>
<dl class="py class">
<dt>
<code class="sig-name descname">Get Element</code></dt>
<dd><p>This Activity is similar to OpenRPA.GetElement. It selects an Element - or elements - filtered with the IE selector.</p>
<p>Clicking <strong>Highlight</strong> will red-highlight the first element that matches the criteria on the selector. Useful for checking if the selector is properly set up.</p>
</dd></dl>
<p>This activity also supports nesting <strong>GetElements</strong>. In order to know more about that, please refer to <span class="xref std std-ref">Return multiple elements</span> section.</p>
<blockquote>
<div><p><strong>Properties Parameters</strong></p>
<blockquote>
<div><p><code class="docutils literal notranslate"><span class="pre">Displayname</span></code> - Title of the Activity inside the sequence.</p>
<p><code class="docutils literal notranslate"><span class="pre">Elements</span></code> - the selected IE Elements.</p>
<p><code class="docutils literal notranslate"><span class="pre">From</span></code> - Allows search only within an Element found within any of the IEElement’s instances.</p>
<p><code class="docutils literal notranslate"><span class="pre">LoopAction</span></code> - Loop the selected <code class="docutils literal notranslate"><span class="pre">Activity</span></code> until something is found.</p>
<p><code class="docutils literal notranslate"><span class="pre">MaxResults</span></code> - Maximum number of elements to be found.</p>
<p><code class="docutils literal notranslate"><span class="pre">MinResults</span></code> - Number of minimum results. If this value is higher than 0 and this Activity fails to find an element, it throws an exception (<code class="docutils literal notranslate"><span class="pre">ElementNotFound</span></code>). If you want to check whether an element exists or not, set this value to 0 and test for ‘item.Length() == 0’ inside the sequence.</p>
<p><code class="docutils literal notranslate"><span class="pre">Selector</span></code> - Contains all the data to identify the IE application.</p>
<p><code class="docutils literal notranslate"><span class="pre">Timeout</span></code> - Time when the Activity ceases if it is not successfully able to find an element.</p>
<p><code class="docutils literal notranslate"><span class="pre">Wait</span> <span class="pre">for</span> <span class="pre">ready</span></code> - If true, wait until the page is fully loaded.</p>
</div></blockquote>
</div></blockquote>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The user can also use <strong>XPath Selector</strong> to select elements inside the page. <strong>XPath Selectors</strong> use the following syntax:</p>
<ul class="simple">
<li><ul>
<li><ul>
<li><p>Matches any element node</p></li>
</ul>
</li>
</ul>
</li>
<li><p>@* - Matches any attribute node</p></li>
<li><p>node() - Matches any node of any kind</p></li>
</ul>
<p>So, for instance, if the user wanted to select all the child element nodes of a <strong>bookstore</strong> node, they’d use <code class="docutils literal notranslate"><span class="pre">/bookstore/*</span></code>. To select all elements in a document, they’d use <code class="docutils literal notranslate"><span class="pre">//*</span></code>. Now if they’d like to select all <strong>title</strong> elements which have <strong>at least one</strong> attribute of any kind, they’d use <code class="docutils literal notranslate"><span class="pre">//title[@*]</span></code>. To concatenate XPath expressions, the user can use the <code class="docutils literal notranslate"><span class="pre">|</span> <span class="pre">operator</span></code>. So, if they’d like to select all <strong>title AND price</strong> elements of all book elements, they’d use the expression <code class="docutils literal notranslate"><span class="pre">//book/title</span> <span class="pre">|</span> <span class="pre">//book/price</span></code>.¹</p>
</div>
<p><em>¹ - `XPath Syntax <https://www.w3schools.com/xml/xpath_syntax.asp>`_ (``https://www.w3schools.com/xml/xpath_syntax.asp``).</em></p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>As well as the <strong>XPath Selector</strong>, the user can also use the <strong>CSS Selector</strong>. CSS Selectors use the following syntax:</p>
<ul class="simple">
<li><p><strong>.{CLASS}</strong> - Matches all elements with that class.</p></li>
<li><p><strong>#{CLASS}</strong> - Matches all elements with that id.</p></li>
<li><p>** * ** - Matches all elements.</p></li>
<li><p><strong>{ELEMENT}</strong> - Matches all <p> elements.</p></li>
</ul>
<p>The syntax is pretty similar to that of <strong>XPath Selectors</strong>. For more on <strong>CSS Selectors</strong>, refer to <a class="reference external" href="https://www.w3schools.com/cssref/css_Selectors.asp">CSS Selectors</a> (<code class="docutils literal notranslate"><span class="pre">https://www.w3schools.com/cssref/css_Selectors.asp</span></code>).</p>
</div>
<div class="figure align-center" id="id53">
<img alt="images/openrpa_ie_get_element.png" src="images/openrpa_ie_get_element.png" />
<p class="caption"><span class="caption-text"><strong>OpenRPA.IE Get Element.</strong></span><a class="headerlink" href="#id53" title="Permalink to this image">¶</a></p>
</div>
<dl class="py class">
<dt>
<code class="sig-name descname">Open URL</code></dt>
<dd><p>Opens an URL in the currently selected InternetExplorer.Application instance. If there is no URL set, it will automatically start a new Internet Explorer instance.</p>
<blockquote>
<div><p><strong>Properties Parameters</strong></p>
<p><code class="docutils literal notranslate"><span class="pre">DisplayName</span></code> - Title of the Activity inside the sequence.</p>
<p><code class="docutils literal notranslate"><span class="pre">FocusBrowser</span></code> - If set to <code class="docutils literal notranslate"><span class="pre">True</span></code>, will focus the window opened by the browser.</p>
<p><code class="docutils literal notranslate"><span class="pre">Url</span></code> - The URL which the browser will navigate to.</p>
</div></blockquote>
</dd></dl>
<div class="figure align-center" id="id54">
<img alt="images/openrpa_open_url.png" src="images/openrpa_open_url.png" />
<p class="caption"><span class="caption-text"><strong>OpenRPA.IE Open URL.</strong></span><a class="headerlink" href="#id54" title="Permalink to this image">¶</a></p>
</div>
</div>
<div class="section" id="openrpa-image">
<h3>OpenRPA.Image<a class="headerlink" href="#openrpa-image" title="Permalink to this headline">¶</a></h3>
<p>Here belongs the activities located inside the OpenRPA.Image toolbox.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Activities that use OCR to recognize text inside images must have first have the language which OCR will use first on the <strong>Settings tab</strong>.</p>
</div>
<dl class="py class">
<dt>
<code class="sig-name descname">Get Color</code></dt>
<dd><p>Gets RGBA color at the specified coordinates inside an element provided by <strong>Image.GetElement</strong>.</p>
<p><strong>Properties Parameters</strong></p>
<blockquote>
<div><p><code class="docutils literal notranslate"><span class="pre">Displayname</span></code> - Title of the Activity inside the sequence.</p>
<p><code class="docutils literal notranslate"><span class="pre">Element</span></code> - Element from which the colors will be acquired.</p>
<p><code class="docutils literal notranslate"><span class="pre">Result</span></code> - Variable file path to save the color.</p>
<p><code class="docutils literal notranslate"><span class="pre">X</span> <span class="pre">Offset</span></code> - The horizontal offset inside the element from which to capture the color. Units are in pixels. It also allows for negative values.</p>
<p><code class="docutils literal notranslate"><span class="pre">Y</span> <span class="pre">Offset</span></code> - The vertical offset inside the element from which to capture the color. Units are in pixels. It also allows for negative values.</p>
</div></blockquote>
</dd></dl>
<div class="figure align-center" id="id55">
<img alt="images/openrpa_get_color.png" src="images/openrpa_get_color.png" />
<p class="caption"><span class="caption-text"><strong>OpenRPA.Image Get Color.</strong></span><a class="headerlink" href="#id55" title="Permalink to this image">¶</a></p>
</div>
<dl class="py class">
<dt>
<code class="sig-name descname">Get Element</code></dt>
<dd><p>Locates an image in screen or in a specific application window and creates an <strong>ImageElement</strong> from it. Use the <strong>Select Image</strong> button to select the image you want to capture or use the <strong>Recorder</strong>.</p>
<p>The <strong>Recorder</strong> at first tries to create Elements from controls in Windows Applications, Java Apps or Web elements. As a last resource, it will then make use of <strong>Image.GetElement</strong> to create Elements by capturing the smallest unique images inside the image you drag while recording.</p>
<p>Clicking the <strong>Highlight</strong> button will red-highlight the first element that matches the criteria in the <strong>Selector</strong>. It is useful for checking if the <strong>Selector</strong> is properly set up.</p>
<p><strong>Properties Parameters</strong></p>
<p><code class="docutils literal notranslate"><span class="pre">CompareGray</span></code> - If set to <code class="docutils literal notranslate"><span class="pre">True</span></code>, compares the image in grayscale to find the desired element. This parameter also saves performance.</p>
<p><code class="docutils literal notranslate"><span class="pre">Displayname</span></code> - Title of the Activity inside the sequence.</p>
<p><code class="docutils literal notranslate"><span class="pre">Elements</span></code> - Element from which the image will be gathered.</p>
<p><code class="docutils literal notranslate"><span class="pre">From</span></code> - Allows search only within an Element found within any of the <strong>ImageElement</strong>’s instances.</p>
<p><code class="docutils literal notranslate"><span class="pre">Limit</span></code> - Limit the number of Elements.</p>
<p><code class="docutils literal notranslate"><span class="pre">LoopAction</span></code> - Loop the selected <code class="docutils literal notranslate"><span class="pre">Activity</span></code> until something is found.</p>
<p><code class="docutils literal notranslate"><span class="pre">MaxResults</span></code> - Number of maximum results.</p>
<p><code class="docutils literal notranslate"><span class="pre">MinResults</span></code> - Number of minimum results. If this value is higher than 0 and this activity fails to find an Element, it throws an exception (<code class="docutils literal notranslate"><span class="pre">ElementNotFound</span></code>). If you want to check whether an image exists or not, set this value to 0 and test for ‘item.Length() == 0’ inside the sequence.</p>
<p><code class="docutils literal notranslate"><span class="pre">Processname</span></code> - Limits the Element’s process to a specific processname.</p>
<p><code class="docutils literal notranslate"><span class="pre">Threshold</span></code> - Threshold used to find a matching image.</p>
<p><code class="docutils literal notranslate"><span class="pre">Timeout</span></code> - Time until the Activity ceases if not successfully able to find an Element.</p>
</dd></dl>
<div class="figure align-center" id="id56">
<img alt="images/openrpa_get_element.png" src="images/openrpa_get_element.png" />
<p class="caption"><span class="caption-text"><strong>OpenRPA.Image Get Element.</strong></span><a class="headerlink" href="#id56" title="Permalink to this image">¶</a></p>
</div>
<dl class="py class">
<dt>
<code class="sig-name descname">Get Image</code></dt>
<dd><p>Gets an image from the screen relative to another image or Element found with <strong>Image.GetElement</strong>.</p>
<p>First of all, user must use the Image.Get Element Activity to select the image which this Activity will act upon, then use the <strong>Select Image</strong> button to specify the relative area within the screen you want to capture. That is, the selection <strong>Get Image</strong> does it match to another image selected with the Image.Get Element Activity.</p>
<p>Clicking <strong>Highlight</strong> will green-highlight the image selected that is relative to the other one, which will appear blue-highlighted. This is useful for checking if the <strong>Selector</strong> is properly set up.</p>
<p>For more on Image Handling inside <strong>OpenRPA</strong>, please visit Appendix B - <a class="reference internal" href="appendix_b.html#image-handling"><span class="std std-ref">Image Handling</span></a>.</p>
<blockquote>
<div><p><strong>Properties Parameters</strong></p>
<p><code class="docutils literal notranslate"><span class="pre">Displayname</span></code> - Title of the Activity inside the sequence.</p>
<p><code class="docutils literal notranslate"><span class="pre">Element</span></code> - Element from which the image will be gathered.</p>
<p><code class="docutils literal notranslate"><span class="pre">Height</span></code> - Height of the image to be captured.</p>