forked from open-rpa/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
4.4._flow_subflows_nodes_and_messages.html
227 lines (119 loc) · 10.9 KB
/
4.4._flow_subflows_nodes_and_messages.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
<!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>Flow, Subflows, Nodes and Messages — 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>Flow, Subflows, Nodes and Messages</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="flow-subflows-nodes-and-messages">
<h1><strong>Flow, Subflows, Nodes and Messages</strong><a class="headerlink" href="#flow-subflows-nodes-and-messages" title="Permalink to this headline">¶</a></h1>
<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>
<div class="section" id="flows">
<h2>Flows<a class="headerlink" href="#flows" title="Permalink to this headline">¶</a></h2>
<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>
</div>
<div class="section" id="subflows">
<h2>Subflows<a class="headerlink" href="#subflows" title="Permalink to this headline">¶</a></h2>
<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>
</div>
<div class="section" id="nodes">
<h2>Nodes<a class="headerlink" href="#nodes" title="Permalink to this headline">¶</a></h2>
<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>
</div>
<div class="section" id="messages">
<h2>Messages<a class="headerlink" href="#messages" title="Permalink to this headline">¶</a></h2>
<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>
</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>