forked from open-rpa/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
node_red.html
2338 lines (2214 loc) · 189 KB
/
node_red.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>4. Node-RED — 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" />
<link rel="next" title="5. Appendix A" href="appendix_a.html" />
<link rel="prev" title="3. OpenRPA" href="openrpa.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 class="current">
<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 current"><a class="current reference internal" href="#">4.
<strong>Node-RED</strong></a>
<ul>
<li class="toctree-l2"><a class="reference internal" href="#what-is-node-red">4.1. <strong>What
is Node-RED?</strong></a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#id1">4.1.1. What is
Node-RED?</a>
<ul>
<li class="toctree-l4"><a class="reference internal" href="#what-is-mqtt">4.1.1.1.
What is MQTT?</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal"
href="#accessing-node-red-for-the-first-time">4.2. <strong>Accessing Node-RED for the
first time</strong></a>
<ul>
<li class="toctree-l3"><a class="reference internal"
href="#quickstart-running-node-red-demo-instance">4.2.1. Quickstart Running Node-RED
Demo Instance</a>
<ul>
<li class="toctree-l4"><a class="reference internal"
href="#creating-a-demo-node-red-instance-using-openiap-platform">4.2.1.1.
Creating a demo Node-RED instance using OpenIAP platform</a></li>
<li class="toctree-l4"><a class="reference internal"
href="#logging-in-to-node-red">4.2.1.2. Logging in to Node-RED</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal"
href="#quickstart-running-openflow-node-red-using-npm">4.2.2. Quickstart Running
OpenFlow Node-RED using NPM</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#node-red-editor">4.3.
<strong>Node-RED Editor</strong></a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#header">4.3.1. Header</a>
<ul>
<li class="toctree-l4"><a class="reference internal" href="#deploy-button">4.3.1.1.
Deploy Button</a></li>
<li class="toctree-l4"><a class="reference internal" href="#main-menu">4.3.1.2. Main
Menu</a></li>
<li class="toctree-l4"><a class="reference internal" href="#user-menu">4.3.1.3. User
Menu</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#palette">4.3.2. Palette</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#workspace">4.3.3.
Workspace</a>
<ul>
<li class="toctree-l4"><a class="reference internal" href="#view-tools">4.3.3.1.
View Tools</a></li>
<li class="toctree-l4"><a class="reference internal"
href="#customising-the-view">4.3.3.2. Customising the view</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#sidebar">4.3.4. Sidebar</a>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal"
href="#flow-subflows-nodes-and-messages">4.4. <strong>Flow, Subflows, Nodes and
Messages</strong></a></li>
<li class="toctree-l2"><a class="reference internal" href="#openflow-and-openrpa-nodes">4.5.
<strong>OpenFlow and OpenRPA Nodes</strong></a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#rpa-detector">4.5.1. RPA
Detector</a></li>
<li class="toctree-l3"><a class="reference internal" href="#rpa-workflow">4.5.2. RPA
Workflow</a></li>
<li class="toctree-l3"><a class="reference internal" href="#smtpserver-in">4.5.3.
SMTPServer In</a></li>
<li class="toctree-l3"><a class="reference internal" href="#workflow-in">4.5.4. Workflow
In</a></li>
<li class="toctree-l3"><a class="reference internal" href="#workflow-out">4.5.5. Workflow
Out</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#flow-examples">4.6. <strong>Flow
Examples</strong></a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#using-openflow-forms">4.6.1.
Using OpenFlow Forms</a>
<ul>
<li class="toctree-l4"><a class="reference internal"
href="#create-a-form-in-openflow">4.6.1.1. Create a Form in OpenFlow</a></li>
<li class="toctree-l4"><a class="reference internal"
href="#configure-form-in-node-red">4.6.1.2. Configure Form in Node-RED</a>
</li>
<li class="toctree-l4"><a class="reference internal"
href="#invoking-the-form">4.6.1.3. Invoking the Form</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal"
href="#dummy-integration-openrpa-openflow-nodered">4.6.2. Dummy Integration
OpenRPA-OpenFlow-NodeRED</a></li>
<li class="toctree-l3"><a class="reference internal" href="#ai-image-recognition">4.6.3.
AI Image Recognition</a>
<ul>
<li class="toctree-l4"><a class="reference internal"
href="#serving-the-page-through-templates-and-http-endpoint">4.6.3.1. Serving
the page through Templates and HTTP Endpoint</a></li>
<li class="toctree-l4"><a class="reference internal"
href="#google-cloud-vision-processing-logic">4.6.3.2. Google Cloud Vision
Processing logic</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#email-receive-send">4.6.4.
Email Receive, Send</a>
<ul>
<li class="toctree-l4"><a class="reference internal"
href="#receive-e-mails">4.6.4.1. Receive e-mails</a></li>
<li class="toctree-l4"><a class="reference internal"
href="#redirecting-e-mails">4.6.4.2. Redirecting e-mails</a></li>
<li class="toctree-l4"><a class="reference internal" href="#send-e-mails">4.6.4.3.
Send e-mails</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal"
href="#creating-an-http-endpoint">4.6.5. Creating an HTTP endpoint</a>
<ul>
<li class="toctree-l4"><a class="reference internal"
href="#api-s-basic-structure">4.6.5.1. API’s basic structure</a></li>
<li class="toctree-l4"><a class="reference internal"
href="#creating-a-database-and-adding-new-items-to-it">4.6.5.2. Creating a
database and adding new items to it</a></li>
<li class="toctree-l4"><a class="reference internal"
href="#get-a-full-list-of-items">4.6.5.3. Get a full list of items</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#excel-detector">4.6.6. Excel
Detector</a>
<ul>
<li class="toctree-l4"><a class="reference internal"
href="#setting-up-the-detector-inside-openrpa">4.6.6.1. Setting up the
Detector inside OpenRPA</a></li>
<li class="toctree-l4"><a class="reference internal"
href="#configuring-detector-and-invoking-workflow-inside-node-red">4.6.6.2.
Configuring Detector and Invoking Workflow inside Node-RED</a></li>
<li class="toctree-l4"><a class="reference internal"
href="#add-debug-nodes-and-test-the-flow">4.6.6.3. Add Debug nodes and test
the Flow</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#mongodb-entities">4.6.7.
MongoDB Entities</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#node-red-faq">4.7. <strong>Node-RED
- FAQ</strong></a>
<ul>
<li class="toctree-l3"><a class="reference internal"
href="#interfacing-with-openrpa">4.7.1. Interfacing with OpenRPA</a>
<ul>
<li class="toctree-l4"><a class="reference internal"
href="#how-to-trigger-an-openrpa-workflow-from-node-red">4.7.1.1. How to
trigger an OpenRPA Workflow from Node-RED?</a></li>
<li class="toctree-l4"><a class="reference internal"
href="#how-to-send-a-variable-from-openflow-forms-to-node-red">4.7.1.2. How to
send a variable from OpenFlow Forms to Node-RED</a></li>
<li class="toctree-l4"><a class="reference internal"
href="#how-to-solve-gyp-err-stack-error-gyp-failed-with-exit-code-when-installing-node-red-from-npm">4.7.1.3.
How to solve <code
class="docutils literal notranslate"><span class="pre">gyp</span> <span class="pre">ERR!</span> <span class="pre">stack</span> <span class="pre">Error:</span> <span class="pre">gyp</span> <span class="pre">failed</span> <span class="pre">with</span> <span class="pre">exit</span> <span class="pre">code:</span> <span class="pre">?</span></code>
when installing Node-RED from <code
class="docutils literal notranslate"><span class="pre">npm</span></code>?</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</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><span class="section-number">4. </span><strong>Node-RED</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="node-red">
<h1><span class="section-number">4. </span><strong>Node-RED</strong><a class="headerlink"
href="#node-red" title="Permalink to this headline">¶</a></h1>
<div class="section" id="what-is-node-red">
<h2><span class="section-number">4.1. </span><strong>What is Node-RED?</strong><a
class="headerlink" href="#what-is-node-red" title="Permalink to this headline">¶</a>
</h2>
<div class="section" id="id1">
<h3><span class="section-number">4.1.1. </span>What is Node-RED?<a class="headerlink"
href="#id1" title="Permalink to this headline">¶</a></h3>
<p><strong>Node-RED</strong> is a programming tool used for linking all our tools together
(<strong>OpenRPA</strong> and <strong>OpenFlow</strong>) as well as hardware devices,
APIs and even online services in a new and interesting way. Think of it as a “backend”
process flow designer & integrator. The communication between
<strong>Node-RED</strong> and <strong>OON stack</strong> is done through MQTT protocol
(powered by RabbitMQ).
</p>
<p>It provides an in-browser editor where you can connect flows using any nodes available.
Each node represents a step that when wired together forms a meaningful task. It also
follows a common pattern: input, processing and output. It is important to note that
<strong>Node-RED</strong> functions like a middleware to an information processing
system. It simply connects the inputs to the workflows and allows them to process it.
</p>
<div class="section" id="what-is-mqtt">
<h4><span class="section-number">4.1.1.1. </span>What is MQTT?<a class="headerlink"
href="#what-is-mqtt" title="Permalink to this headline">¶</a></h4>
<p>MQTT stands for Message Queuing Telemetry Transport. It is a publish/subscribe,
extremely simple and lightweight messaging protocol, designed for constrained
devices with low-bandwidth, high-latency or unreliable networks. The design
principle is to minimise network bandwidth and device resource requirements while
attempting to ensure reliability and assurance of delivery. These principles in turn
make the protocol ideal for the emerging “machine-to-machine” (M2M) or “Internet of
Things” world of connected devices, and for mobile applications where bandwidth and
battery power are limited.</p>
</div>
</div>
</div>
<div class="section" id="accessing-node-red-for-the-first-time">
<h2><span class="section-number">4.2. </span><strong>Accessing Node-RED for the first
time</strong><a class="headerlink" href="#accessing-node-red-for-the-first-time"
title="Permalink to this headline">¶</a></h2>
<p>To access Node-RED, simply use a browser and go to your <strong>Node-RED</strong>
environment URL. If running local, default is <a class="reference external"
href="http://localhost.openiap.io:1880">http://localhost.openiap.io:1880</a>. If you
don’t own an <strong>OpenFlow</strong>/<strong>Node-RED</strong> of your own, feel free to
create a free (and temporary) <strong>Node-RED</strong> demo using OpenIAP platform.</p>
<div class="section" id="quickstart-running-node-red-demo-instance">
<h3><span class="section-number">4.2.1. </span>Quickstart Running Node-RED Demo Instance<a
class="headerlink" href="#quickstart-running-node-red-demo-instance"
title="Permalink to this headline">¶</a></h3>
<p>Here the users will learn how to start a Node-RED Demo Instance.</p>
<div class="section" id="creating-a-demo-node-red-instance-using-openiap-platform">
<h4><span class="section-number">4.2.1.1. </span>Creating a demo Node-RED instance
using OpenIAP platform<a class="headerlink"
href="#creating-a-demo-node-red-instance-using-openiap-platform"
title="Permalink to this headline">¶</a></h4>
<p>Go to <strong>OpenIAP</strong> demo enviroment, which can be found at <a
class="reference external" href="https://app.openiap.io">Demo OpenIAP</a> (<code
class="docutils literal notranslate"><span class="pre">https://app.openiap.io</span></code>).
</p>
<p>Access it using your <strong>OpenFlow</strong> credentials. If this is your very
fist login any credentials will do, as you user will be then created with the same
credentials you have provided. Please take notes of your user an password!</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Your <strong>NodeRED</strong> free demo enviroment URL is created based off your
<strong>OpenFlow</strong> username, hence please do not create an username with
improper characters for a URL (such as _, #, @, $, etc), otherwise it will
not work.
</p>
</div>
<p>Once there, look for the NodeRED tab on the upper menu and click it. Then, proceed
by clicking the button <code
class="docutils literal notranslate"><span class="pre">Created</span> <span class="pre">NodeRED</span></code>.
</p>
<div class="figure align-center">
<img alt="images/nodered_create_nodered_instance.png"
src="images/nodered_create_nodered_instance.png" />
</div>
<p>If everything goes right, a similar output as from the next image will be shown.
Your demo enviroment is ready to use and is accessible at <code
class="docutils literal notranslate"><span class="pre">https://{YOUR-OPENFLOW-USERNAME}.app.openiap.io/</span></code>.
In the image example next, the username was <code
class="docutils literal notranslate"><span class="pre">doc-johnny</span></code>.
</p>
<div class="figure align-center">
<img alt="images/nodered_create_nodered_instance_success.png"
src="images/nodered_create_nodered_instance_success.png" />
</div>
</div>
<div class="section" id="logging-in-to-node-red">
<h4><span class="section-number">4.2.1.2. </span>Logging in to Node-RED<a
class="headerlink" href="#logging-in-to-node-red"
title="Permalink to this headline">¶</a></h4>
<p>Access the desired <strong>Node-RED</strong> URL. Once there, a button is shown with
the text <code
class="docutils literal notranslate"><span class="pre">Sign</span> <span class="pre">in</span> <span class="pre">with</span> <span class="pre">SAML</span></code>.
When you click the button, Node-RED attempts to gather your currently (or cached)
logged in <strong>OpenFlow</strong> authentication data and then logs in, to
<strong>Node-RED</strong>, with the same user.
</p>
<div class="figure align-center" id="id12">
<img alt="images/nodered_sign_in_page.png" src="images/nodered_sign_in_page.png" />
<p class="caption"><span class="caption-text">Node-RED Sign In page.</span><a
class="headerlink" href="#id12" title="Permalink to this image">¶</a></p>
</div>
</div>
</div>
<div class="section" id="quickstart-running-openflow-node-red-using-npm">
<h3><span class="section-number">4.2.2. </span>Quickstart Running OpenFlow Node-RED using
NPM<a class="headerlink" href="#quickstart-running-openflow-node-red-using-npm"
title="Permalink to this headline">¶</a></h3>
<p>Please use guide provided at <a class="reference external"
href="https://openflow.openiap.io">Install guides</a>
Using docker is the preferred and recommended way <a class="reference external"
href="https://openflow.openiap.io/dockercompose">Install using docker</a></p>
</div>
</div>
<div class="section" id="node-red-editor">
<h2><span class="section-number">4.3. </span><strong>Node-RED Editor</strong><a
class="headerlink" href="#node-red-editor" title="Permalink to this headline">¶</a>
</h2>
<p>The editor window is where all the work gets done. It contains four components: header,
palette, workspace and sidebar.</p>
<div class="figure align-center" id="id13">
<img alt="images/nodered_editor_default_components.png"
src="images/nodered_editor_default_components.png" />
<p class="caption"><span class="caption-text">Node-RED Components.</span><a
class="headerlink" href="#id13" title="Permalink to this image">¶</a></p>
</div>
<div class="section" id="header">
<h3><span class="section-number">4.3.1. </span>Header<a class="headerlink" href="#header"
title="Permalink to this headline">¶</a></h3>
<p>The header contains the deploy button, main menu, and, if user authentication is
activated, the user menu.</p>
<div class="section" id="deploy-button">
<h4><span class="section-number">4.3.1.1. </span>Deploy Button<a class="headerlink"
href="#deploy-button" title="Permalink to this headline">¶</a></h4>
<p>The deploy button is used to deploy flows once you have finished creating or editing
them. It is important to remark that you must always deploy a flow after editing it
so the changes are applied.</p>
</div>
<div class="section" id="main-menu">
<h4><span class="section-number">4.3.1.2. </span>Main Menu<a class="headerlink"
href="#main-menu" title="Permalink to this headline">¶</a></h4>
<p>The main menu contains many actions, such as hiding components, importing or
exporting flows, searching for flows, actions (like add, rename and delete) flows
and subflows, manage palettes, settings, keyboard shortcuts and a link to Node-RED’s
webpage.</p>
</div>
<div class="section" id="user-menu">
<h4><span class="section-number">4.3.1.3. </span>User Menu<a class="headerlink"
href="#user-menu" title="Permalink to this headline">¶</a></h4>
<p>The user menu, if the user is authenticated, shows your username and the option to
logout.</p>
</div>
</div>
<div class="section" id="palette">
<h3><span class="section-number">4.3.2. </span>Palette<a class="headerlink"
href="#palette" title="Permalink to this headline">¶</a></h3>
<p>The palette contains all of the nodes that are installed and available to use. These
nodes are organized into a number of categories, which can be expanded or collapsed by
clicking its header.</p>
<p>The entire palette can be hidden by clicking the toggle button that is shown when the
mouse is over it or by pressing <strong>Ctrl+p</strong>.¹</p>
<p>¹ - <a class="reference external"
href="https://nodered.org/docs/user-guide/editor/palette/">Palette</a> (<a
class="reference external"
href="https://nodered.org/docs/user-guide/editor/palette/">https://nodered.org/docs/user-guide/editor/palette/</a>)
</p>
<div class="figure align-default" id="id14">
<a class="reference internal image-reference"
href="images/nodered_editor_palette.png"><img
alt="images/nodered_editor_palette.png" src="images/nodered_editor_palette.png"
style="width: 180.0px; height: 760.0px;" /></a>
<p class="caption"><span class="caption-text">Node-RED Editor Palette.</span><a
class="headerlink" href="#id14" title="Permalink to this image">¶</a></p>
</div>
</div>
<div class="section" id="workspace">
<h3><span class="section-number">4.3.3. </span>Workspace<a class="headerlink"
href="#workspace" title="Permalink to this headline">¶</a></h3>
<p>The main workspace is where flows are developed by dragging nodes from the palette and
wiring them together.</p>
<p>The workspace has a row of tabs along the top; one for each flow and any subflows that
have been opened. ²</p>
<div class="figure align-center" id="id15">
<img alt="images/nodered_editor_workspace.png"
src="images/nodered_editor_workspace.png" />
<p class="caption"><span class="caption-text">Node-RED Editor Workspace.</span><a
class="headerlink" href="#id15" title="Permalink to this image">¶</a></p>
</div>
<div class="section" id="view-tools">
<h4><span class="section-number">4.3.3.1. </span>View Tools<a class="headerlink"
href="#view-tools" title="Permalink to this headline">¶</a></h4>
<p>The footer of the workspace contains buttons to zoom in and out as well as to reset
the default zoom level. It also contains a toggle button for the view navigator.</p>
<p>To zoom in, either click the <strong>+</strong> button inside the view navigator or
press <strong>Ctrl+=</strong>.</p>
<p>To zoom out, either click the <strong>-</strong> button inside the view navigator or
press <strong>Ctrl+-</strong>.</p>
<p>To reset the zoom, either click the <strong>O</strong> button inside the view
navigator or press <strong>Ctrl+0</strong>.</p>
<p>The view navigator provides a scaled down view of the entire workspace, highlighting
the area currently visible. That area can be dragged around the navigator to quickly
jump to other parts of the workspace. It is also useful for finding nodes that have
been <strong>lost</strong> to the further edges of the workspace.</p>
<div class="figure align-center" id="id16">
<img alt="images/node_red_workspace_navigator_active.png"
src="images/node_red_workspace_navigator_active.png" />
<p class="caption"><span class="caption-text">Node-RED Editor Workspace Navigator
Active.</span><a class="headerlink" href="#id16"
title="Permalink to this image">¶</a></p>
</div>
</div>
<div class="section" id="customising-the-view">
<h4><span class="section-number">4.3.3.2. </span>Customising the view<a
class="headerlink" href="#customising-the-view"
title="Permalink to this headline">¶</a></h4>
<p>The workspace view can be customised via the <strong>View</strong> tab of the User
Settings dialog.</p>
<p>To activate the User Settings dialog, press <strong>Ctrl+,</strong>.</p>
<div class="figure align-center" id="id17">
<img alt="images/nodered_editor_user_settings_dialog.png"
src="images/nodered_editor_user_settings_dialog.png" />
<p class="caption"><span class="caption-text">Node-RED Editor User Settings
Dialog.</span><a class="headerlink" href="#id17"
title="Permalink to this image">¶</a></p>
</div>
<p>² - <a class="reference external"
href="https://nodered.org/docs/user-guide/editor/workspace/">Workspace</a> (<a
class="reference external"
href="https://nodered.org/docs/user-guide/editor/workspace/">https://nodered.org/docs/user-guide/editor/workspace/</a>)
</p>
</div>
</div>
<div class="section" id="sidebar">
<h3><span class="section-number">4.3.4. </span>Sidebar<a class="headerlink"
href="#sidebar" title="Permalink to this headline">¶</a></h3>
<p>The sidebar contains panels that provide a number of useful tools within the editor.³
</p>
<ul>
<li>
<p><strong>Information</strong></p>
<blockquote>
<div>
<p>View information about nodes and their help info</p>
</div>
</blockquote>
</li>
<li>
<p><strong>Debug</strong></p>
<blockquote>
<div>
<p>View messages passed into debug nodes</p>
</div>
</blockquote>
</li>
<li>
<p><strong>Configuration Nodes</strong></p>
<blockquote>
<div>
<p>Manage configuration nodes</p>
</div>
</blockquote>
</li>
<li>
<p><strong>Context Data</strong></p>
<blockquote>
<div>
<p>View the contents of the context variables</p>
</div>
</blockquote>
</li>
</ul>
<div class="figure align-center" id="id18">
<img alt="images/nodered_editor_sidebar.png" src="images/nodered_editor_sidebar.png" />
<p class="caption"><span class="caption-text">Node-RED Editor Sidebar.</span><a
class="headerlink" href="#id18" title="Permalink to this image">¶</a></p>
</div>
<p>Some nodes contribute their own sidebar panels, such as <a class="reference external"
href="https://flows.nodered.org/node/node-red-dashboard/">node-red-dashboard</a> (<a
class="reference external"
href="https://flows.nodered.org/node/node-red-dashboard">https://flows.nodered.org/node/node-red-dashboard</a>).
</p>
<p>The panels are opened by clicking their icon in the header of the sidebar, or by
selecting them in the drop-down list shown.</p>
<p>The sidebar can be resized by dragging tis edge across the workspace.</p>
<p>If the edge is dragged close to the right-hand edge, the sidebar will be hidden. It can
be shown again by selecting the <strong>Show sidebar</strong> option in the View menu,
or using the <strong>Ctrl+Space</strong> shortcut.</p>
</div>
</div>
<div class="section" id="flow-subflows-nodes-and-messages">
<h2><span class="section-number">4.4. </span><strong>Flow, Subflows, Nodes and
Messages</strong><a class="headerlink" href="#flow-subflows-nodes-and-messages"
title="Permalink to this headline">¶</a></h2>
<p>This section is mostly based on <code
class="docutils literal notranslate"><span class="pre">Node-RED</span></code>’s
documentation. Please refer to <a class="reference external"
href="https://nodered.org/docs/user-guide/editor">https://nodered.org/docs/user-guide/editor</a>
for further details.</p>
<p>A <code class="docutils literal notranslate"><span class="pre">Flow</span></code> is a
working space where <code
class="docutils literal notranslate"><span class="pre">Nodes</span></code> are
organized. Each <code
class="docutils literal notranslate"><span class="pre">Flow</span></code> is
represented by a tab with its name; a description is provided in the <em>Information
Sidebar</em>. All the <code
class="docutils literal notranslate"><span class="pre">Nodes</span></code> within a
<code class="docutils literal notranslate"><span class="pre">Flow</span></code> share the
same <em>Flowscope Context</em>, that is, they all have access to the same context values.
</p>
<p>New <code class="docutils literal notranslate"><span class="pre">Flows</span></code> are
created by clicking the “plus” button in the top bar. To edit a <code
class="docutils literal notranslate"><span class="pre">Flow</span></code>’s properties,
users can double-click on its tab in the top bar. <code
class="docutils literal notranslate"><span class="pre">Flows</span></code> can be
disabled by clicking the toggle button at the bottom of the dialog box.</p>
<p><code class="docutils literal notranslate"><span class="pre">Subflows</span></code> are
collections of <code
class="docutils literal notranslate"><span class="pre">Nodes</span></code> grouped
within a single <code
class="docutils literal notranslate"><span class="pre">Node</span></code>. The purpose
is to reduce the visual complexity of the <code
class="docutils literal notranslate"><span class="pre">Flow</span></code> or to reuse
these collections. The created <code
class="docutils literal notranslate"><span class="pre">Subflows</span></code> become a
new <code class="docutils literal notranslate"><span class="pre">Node</span></code> in the
<em>Pallete</em>.
</p>
<p>To create a blank <code
class="docutils literal notranslate"><span class="pre">Subflow</span></code>, the user
has to click on ‘Subflow -> Create subflow’ option on the menu. Another option is to
create a new <code
class="docutils literal notranslate"><span class="pre">Subflow</span></code> out of
existing <code class="docutils literal notranslate"><span class="pre">Nodes</span></code>.
The user must select the <code
class="docutils literal notranslate"><span class="pre">Nodes</span></code> to be
converted and click on ‘Subflow -> Selection to Subflow’ option on the menu.</p>
<p><code class="docutils literal notranslate"><span class="pre">Nodes</span></code> are the
visual representation of actions and can be chained together via wires, thus creating a
flow. The wires connect to the <code
class="docutils literal notranslate"><span class="pre">node</span></code>’s ports, that
work as doors. Each <code
class="docutils literal notranslate"><span class="pre">node</span></code> can have at
most one input port and several output ports.</p>
<p>Some icons must be considered here. When there is a blue circle above a <code
class="docutils literal notranslate"><span class="pre">node</span></code>, it means
that it has undeployed changes. If there are any errors within a <code
class="docutils literal notranslate"><span class="pre">node</span></code>, a red
triangle will appear above it. When a <code
class="docutils literal notranslate"><span class="pre">node</span></code> has an icon
and a status message below it, that shows the runtime status of the <code
class="docutils literal notranslate"><span class="pre">node</span></code>.</p>
<p>By double-clicking on a <code
class="docutils literal notranslate"><span class="pre">node</span></code>, the user
will have access to its <em>Properties</em>, <em>Description</em> and <em>Appearance</em>
- each one will be a tab in the dialog box. Users may also disable a <code
class="docutils literal notranslate"><span class="pre">node</span></code> by clicking
the button at the bottom of the dialog box.</p>
<p><code class="docutils literal notranslate"><span class="pre">Messages</span></code> are
JavaScript objects and can have any set of properties. <code
class="docutils literal notranslate"><span class="pre">Messages</span></code> are the
units that pass between <code
class="docutils literal notranslate"><span class="pre">Nodes</span></code> when a <code
class="docutils literal notranslate"><span class="pre">Flow</span></code> is working.
</p>
<p>The most used property of a <code
class="docutils literal notranslate"><span class="pre">Message</span></code> is its
<em>payload</em> - represented by <code
class="docutils literal notranslate"><span class="pre">msg.payload</span></code> inside
the workspace. This is the default property to pass data between <code
class="docutils literal notranslate"><span class="pre">Nodes</span></code>, but the
user is free to create their properties that most fit their needs. All JavaScript value
types are accepted.
</p>
<p>When working with JSON strings, it must be first converted into a JavaScript object before
its content can be accessed.</p>
<p>For further details on <code
class="docutils literal notranslate"><span class="pre">Messages</span></code>, please
refer to <strong>Node_RED</strong>’s page on the topic: <a class="reference external"
href="https://nodered.org/docs/user-guide/messages">https://nodered.org/docs/user-guide/messages</a>.
</p>
</div>
<div class="section" id="openflow-and-openrpa-nodes">
<h2><span class="section-number">4.5. </span><strong>OpenFlow and OpenRPA Nodes</strong><a
class="headerlink" href="#openflow-and-openrpa-nodes"
title="Permalink to this headline">¶</a></h2>
<p>The following nodes are dedicated to the integration of <strong>Node-RED</strong> to
<strong>OpenFlow</strong> and <strong>OpenRPA</strong>.
</p>
<div class="section" id="rpa-detector">
<h3><span class="section-number">4.5.1. </span>RPA Detector<a class="headerlink"
href="#rpa-detector" title="Permalink to this headline">¶</a></h3>
<p>This node is responsible for invoking a <code
class="docutils literal notranslate"><span class="pre">Detector</span></code>
previously created in <strong>OpenRPA</strong>. Once deployed, the <code
class="docutils literal notranslate"><span class="pre">RPA</span> <span class="pre">Detector</span></code>
will be active even if the <strong>Node-RED</strong> editor is closed (since the server
is still running). Connect the output end of this node to an <strong>RPA
Workflow</strong> node to invoke a workflow upon triggering the detector.</p>
<p>Properties:</p>
<p><code class="docutils literal notranslate"><span class="pre">Detector</span></code> -
the <strong>OpenRPA</strong> Detector that will be deployed in this <code
class="docutils literal notranslate"><span class="pre">flow</span></code>. A list of
all available <code
class="docutils literal notranslate"><span class="pre">Detectors</span></code> will
be presented to the user.</p>
<p><code class="docutils literal notranslate"><span class="pre">Name</span></code> - <code
class="docutils literal notranslate"><span class="pre">Display</span> <span class="pre">name</span></code>
of the <code class="docutils literal notranslate"><span class="pre">node</span></code>.
</p>
</div>
<div class="section" id="rpa-workflow">
<h3><span class="section-number">4.5.2. </span>RPA Workflow<a class="headerlink"
href="#rpa-workflow" title="Permalink to this headline">¶</a></h3>
<p>This node is responsible for invoking an <strong>OpenRPA</strong> workflow remotely.
</p>
<p>There are three output ports for this <code
class="docutils literal notranslate"><span class="pre">node</span></code>. The first
one is named <em>completed</em> and outputs the message from the
<strong>OpenRPA</strong> robot if its execution succeeded. The second one is named
<em>status</em> and outputs the status of the robot while executing. Finally, the third
one is named <em>failed</em> and outputs the error message returned by the robot in
case its execution failed.
</p>
<p>Properties:</p>
<p><code class="docutils literal notranslate"><span class="pre">Robot</span></code> - The
robot to which the <code
class="docutils literal notranslate"><span class="pre">Workflow</span></code>
belongs. It corresponds to <strong>OpenRPA</strong>’s <code
class="docutils literal notranslate"><span class="pre">Projects</span></code>.</p>
<p><code class="docutils literal notranslate"><span class="pre">Workflow</span></code> -
The name of the <code
class="docutils literal notranslate"><span class="pre">Worflow</span></code> to be
invoked. A list will be presented with all the available <code
class="docutils literal notranslate"><span class="pre">workflows</span></code>.</p>
<p><code
class="docutils literal notranslate"><span class="pre">Local</span> <span class="pre">queue</span> <span class="pre">name</span></code>
- Name of the queue that will be created inside <strong>RabbitMQ</strong> for “robot
agents” to consume from.</p>
<p><code class="docutils literal notranslate"><span class="pre">Name</span></code> - <code
class="docutils literal notranslate"><span class="pre">Display</span> <span class="pre">name</span></code>
of the <code class="docutils literal notranslate"><span class="pre">node</span></code>.
</p>
</div>
<div class="section" id="smtpserver-in">
<h3><span class="section-number">4.5.3. </span>SMTPServer In<a class="headerlink"
href="#smtpserver-in" title="Permalink to this headline">¶</a></h3>
<p>Coming soon - Work in progress</p>
</div>
<div class="section" id="workflow-in">
<h3><span class="section-number">4.5.4. </span>Workflow In<a class="headerlink"
href="#workflow-in" title="Permalink to this headline">¶</a></h3>
<p>This node creates a new <code
class="docutils literal notranslate"><span class="pre">Workflow</span></code> in
<strong>OpenFlow</strong> - visible in the <a class="reference external"
href="http://demo.openiap.io/#/Workflows">Workflows page</a> (<code
class="docutils literal notranslate"><span class="pre">http://demo.openiap.io/#/Workflows</span></code>)
or in the “Workflows” page set in your <strong>OpenFlow instance</strong> (usually
<code
class="docutils literal notranslate"><span class="pre">/#/Workflows</span></code>).
</p>
<p>The <code class="docutils literal notranslate"><span class="pre">Workflow</span></code>
created can have an execution chain that starts with this node. By wiring an
<strong>RPA Workflow</strong> node to this one, it is possible to execute <code
class="docutils literal notranslate"><span class="pre">RPA</span> <span class="pre">Workflows</span></code>.
</p>
<p>The workflow can also be invoked by clicking the “Invoke” button inside the “Workflows”
page or by creating an instance of it by using the <code
class="docutils literal notranslate"><span class="pre">Assign</span></code> in
Node-RED node or the <strong>Assign OpenFlow</strong> activity inside
<strong>OpenRPA</strong>.
</p>
<p>It is important to notice that a <code
class="docutils literal notranslate"><span class="pre">Workflow</span> <span class="pre">Out</span></code>
node must also always be added to the end of the execution flow started by a <code
class="docutils literal notranslate"><span class="pre">Workflow</span> <span class="pre">In</span></code>
node.</p>
<p>By deploying a flow containing this node, a role will be created containing the <code
class="docutils literal notranslate"><span class="pre">Queue</span> <span class="pre">name</span></code>
appended by <code
class="docutils literal notranslate"><span class="pre">users</span></code>. If the
user desires anyone else to access it, the user must be added in the <span
class="xref std std-ref">Roles</span> page.</p>
<p>The user can also create a form to be used with this execution flow by using the <code
class="docutils literal notranslate"><span class="pre">Workflow</span> <span class="pre">Out</span></code>
node to define it. If the user does not know what a Form is, please refer to the <a
class="reference internal" href="openflow.html#id7"><span
class="std std-ref">forms</span></a> section.</p>
<p>It also</p>
<p>Properties:</p>
<p><code
class="docutils literal notranslate"><span class="pre">Queue</span> <span class="pre">name</span></code>
- Name of the <code
class="docutils literal notranslate"><span class="pre">workflow</span></code> when
accessed via <strong>OpenFlow</strong>.</p>
<p><code class="docutils literal notranslate"><span class="pre">RPA</span></code> - This
option allows the <code
class="docutils literal notranslate"><span class="pre">workflow</span></code> to be
invoked by an <strong>OpenRPA</strong> robot or not.</p>
<p><code class="docutils literal notranslate"><span class="pre">WEB</span></code> - This
option allows the <code
class="docutils literal notranslate"><span class="pre">workflow</span></code> to be
invoked via the web (that is, via <strong>OpenFlow</strong> server) or not.</p>
<p><code class="docutils literal notranslate"><span class="pre">Name</span></code> - <code
class="docutils literal notranslate"><span class="pre">Display</span> <span class="pre">name</span></code>
of the <code class="docutils literal notranslate"><span class="pre">node</span></code>.
</p>
</div>
<div class="section" id="workflow-out">
<h3><span class="section-number">4.5.5. </span>Workflow Out<a class="headerlink"
href="#workflow-out" title="Permalink to this headline">¶</a></h3>
<p>This <code class="docutils literal notranslate"><span class="pre">node</span></code>
represents the output of a <code
class="docutils literal notranslate"><span class="pre">Workflow</span></code>
created with the <code
class="docutils literal notranslate"><span class="pre">Workflow</span> <span class="pre">In</span></code>
node. It also allows for the user to define an <strong>OpenFlow Form</strong> - more on
that in the <a class="reference internal" href="openflow.html#id7"><span
class="std std-ref">forms</span></a> section - which allows the user to insert
input data and can be chained to other <code
class="docutils literal notranslate"><span class="pre">Workflows</span></code>.</p>
<p>By deploying a flow containing this node, a role will be created containing the <code
class="docutils literal notranslate"><span class="pre">Queue</span> <span class="pre">name</span></code>
appended by <code
class="docutils literal notranslate"><span class="pre">users</span></code>. If the
user desires anyone else to access it, the user must be added in the <span
class="xref std std-ref">Roles</span> page.</p>
<p>The user can also create a form to be used with this execution flow by using the <code
class="docutils literal notranslate"><span class="pre">Workflow</span> <span class="pre">Out</span></code>
node to define it. If the user does not know what a Form is, please refer to the <a
class="reference internal" href="openflow.html#id7"><span
class="std std-ref">forms</span></a> section.</p>
<p>Properties:</p>
<p><code class="docutils literal notranslate"><span class="pre">State</span></code> -
There are three options here: <em>idle</em>, <em>completed</em> and <em>failed</em>.
</p>
<p><code class="docutils literal notranslate"><span class="pre">Userform</span></code> -
Defines a form for gathering user input data.</p>
<p><code class="docutils literal notranslate"><span class="pre">Name</span></code> - <code
class="docutils literal notranslate"><span class="pre">Display</span> <span class="pre">name</span></code>
of the <code class="docutils literal notranslate"><span class="pre">node</span></code>.
</p>
</div>
</div>
<div class="section" id="flow-examples">
<h2><span class="section-number">4.6. </span><strong>Flow Examples</strong><a
class="headerlink" href="#flow-examples" title="Permalink to this headline">¶</a></h2>
<p>Coming soon - Work in progress</p>
<div class="section" id="using-openflow-forms">
<h3><span class="section-number">4.6.1. </span>Using OpenFlow Forms<a class="headerlink"
href="#using-openflow-forms" title="Permalink to this headline">¶</a></h3>
<div class="section" id="create-a-form-in-openflow">
<h4><span class="section-number">4.6.1.1. </span>Create a Form in OpenFlow<a
class="headerlink" href="#create-a-form-in-openflow"
title="Permalink to this headline">¶</a></h4>
<p>In this section the users will learn how to create a Form in OpenFlow. If they do
not know what a Form is, please refer to the <a class="reference internal"
href="openflow.html#id7"><span class="std std-ref">forms</span></a> section.</p>
<p>The first step is to set up a form which will be used to pass the <code
class="docutils literal notranslate"><span class="pre">"Hello</span> <span class="pre">from</span> <span class="pre">OpenFlow!"</span></code>
or any other input inserted by the user to Node-RED.</p>
<p>Go to the <a class="reference external" href="http://demo.openiap.io/#/Forms">Forms
page</a> (default is <code
class="docutils literal notranslate"><span class="pre">http://demo.openiap.io/#/Forms</span></code>)
and click the <code
class="docutils literal notranslate"><span class="pre">Add</span> <span class="pre">Form</span></code>
button.</p>
<div class="figure align-center">
<img alt="images/nodered_openflow_forms_click_add_form_button.png"
src="images/nodered_openflow_forms_click_add_form_button.png" />
</div>
<p>Now drag a <code
class="docutils literal notranslate"><span class="pre">Text</span> <span class="pre">Field</span></code>
form to the Form designer.</p>
<div class="figure align-center">
<img alt="images/nodered_openflow_forms_drag_textfield_form.png"
src="images/nodered_openflow_forms_drag_textfield_form.png" />
</div>
<p>Change the <code
class="docutils literal notranslate"><span class="pre">Label</span></code>
parameter to <code
class="docutils literal notranslate"><span class="pre">Please</span> <span class="pre">enter</span> <span class="pre">'Hello</span> <span class="pre">from</span> <span class="pre">OpenFlow!'</span> <span class="pre">below</span></code>.
</p>
<div class="figure align-center">
<img alt="images/nodered_openflow_forms_change_label_textfield_form.png"
src="images/nodered_openflow_forms_change_label_textfield_form.png" />
</div>
<p>Click on the <code
class="docutils literal notranslate"><span class="pre">API</span></code> tab and
change the <code
class="docutils literal notranslate"><span class="pre">Property</span> <span class="pre">Name</span></code>
parameter to <code
class="docutils literal notranslate"><span class="pre">hello_from_openflow</span></code>.
This is the variable which will be passed to Node-RED.</p>
<div class="figure align-center">
<img alt="images/nodered_openflow_forms_openflow_change_property_name.png"
src="images/nodered_openflow_forms_openflow_change_property_name.png" />
</div>
<p>Finally, click the <code
class="docutils literal notranslate"><span class="pre">Save</span></code> button.
</p>
<div class="figure align-center">
<img alt="images/nodered_openflow_forms_click_save_textfield_form.png"
src="images/nodered_openflow_forms_click_save_textfield_form.png" />
</div>
<p>Set the Form name as <code
class="docutils literal notranslate"><span class="pre">hellofromopenflow</span></code>
and click the <code
class="docutils literal notranslate"><span class="pre">Save</span></code> button
to save it.</p>
<div class="figure align-center">
<img alt="images/nodered_openflow_forms_set_name_and_save.png"
src="images/nodered_openflow_forms_set_name_and_save.png" />
</div>
<p>That’s it! You have successfully configured a <code
class="docutils literal notranslate"><span class="pre">Form</span></code> in
OpenFlow. Proceed to the next sections to see how to configure it in Node-RED.</p>
</div>
<div class="section" id="configure-form-in-node-red">
<h4><span class="section-number">4.6.1.2. </span>Configure Form in Node-RED<a
class="headerlink" href="#configure-form-in-node-red"
title="Permalink to this headline">¶</a></h4>
<p>Now the users will learn how to properly configure the Form in Node-RED.</p>
<p>Navigate to the Node-RED instance, create a new flow and click twice in its tab to
rename it to <code
class="docutils literal notranslate"><span class="pre">Forms</span></code>. Then,
click in the <code
class="docutils literal notranslate"><span class="pre">Done</span></code> button
to save it.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Proceed to <span class="xref std std-ref">Accessing Node-RED for the first
time</span> for more information on how to set your own <code
class="docutils literal notranslate"><span class="pre">Node-RED</span></code>
instance.</p>
</div>
<div class="figure align-center">
<img alt="images/nodered_openflow_forms_rename_flow.png"
src="images/nodered_openflow_forms_rename_flow.png" />
</div>
<p>Drag a <code
class="docutils literal notranslate"><span class="pre">workflow</span> <span class="pre">in</span></code>
node to the workspace. This node will be responsible for starting the execution flow
which will run the Form processing logic.</p>
<div class="figure align-center">
<img alt="images/nodered_openflow_forms_drag_workflow_in.png"
src="images/nodered_openflow_forms_drag_workflow_in.png" />
</div>
<p>Cick twice in the <code
class="docutils literal notranslate"><span class="pre">workflow</span> <span class="pre">in</span></code>
node to open its <strong>Properties tab</strong>. Set the <code
class="docutils literal notranslate"><span class="pre">Queue</span> <span class="pre">name</span></code>
as <code
class="docutils literal notranslate"><span class="pre">openflowformsexample</span></code>
and check both the <code
class="docutils literal notranslate"><span class="pre">RPA</span></code> and
<code class="docutils literal notranslate"><span class="pre">WEB</span></code>
checkboxes. <code
class="docutils literal notranslate"><span class="pre">RPA</span></code> is
checked to allow the Form created in the previous section to be invoked from OpenRPA