forked from open-rpa/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
4.5._openflow_and_openrpa_nodes.html
250 lines (142 loc) · 14.3 KB
/
4.5._openflow_and_openrpa_nodes.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
<!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>OpenFlow and OpenRPA Nodes — 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>OpenFlow and OpenRPA Nodes</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="openflow-and-openrpa-nodes">
<h1><strong>OpenFlow and OpenRPA Nodes</strong><a class="headerlink" href="#openflow-and-openrpa-nodes" title="Permalink to this headline">¶</a></h1>
<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">
<h2>RPA Detector<a class="headerlink" href="#rpa-detector" title="Permalink to this headline">¶</a></h2>
<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">
<h2>RPA Workflow<a class="headerlink" href="#rpa-workflow" title="Permalink to this headline">¶</a></h2>
<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">
<h2>SMTPServer In<a class="headerlink" href="#smtpserver-in" title="Permalink to this headline">¶</a></h2>
<p>Coming soon - Work in progress</p>
</div>
<div class="section" id="workflow-in">
<h2>Workflow In<a class="headerlink" href="#workflow-in" title="Permalink to this headline">¶</a></h2>
<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://app.openiap.io/#/Workflows">Workflows page</a> (<code class="docutils literal notranslate"><span class="pre">http://app.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">
<h2>Workflow Out<a class="headerlink" href="#workflow-out" title="Permalink to this headline">¶</a></h2>
<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>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2020, Thiago Pestitschek, Diego Thijssen, Tiago Bentivoglio, Paulo Veras
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
<p>Powered by <a href="https://bpatechnologies.com/">BPA Technologies</a></p>
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
<h4>>Powered by BPA Technologies - bpatechnologies.com</h4>
</body>
</html>