forked from open-rpa/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
2.9._entities_-_mongodb.html
259 lines (151 loc) · 10.9 KB
/
2.9._entities_-_mongodb.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
<!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>Entities - MongoDB — 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>Entities - MongoDB</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="entities-mongodb">
<h1><strong>Entities - MongoDB</strong><a class="headerlink" href="#entities-mongodb" title="Permalink to this headline">¶</a></h1>
<div class="section" id="what-are-entities">
<h2>What are Entities?<a class="headerlink" href="#what-are-entities" title="Permalink to this headline">¶</a></h2>
<p>Entities are groups of data that compose a meaningful object inside OpenFlow - ie. a workflow, a workflow instance, a user, etc. These groups of data are stored as <a class="reference external" href="https://docs.mongodb.com/manual/core/document/">Documents</a> inside <a class="reference external" href="https://docs.mongodb.com/manual/core/databases-and-collections/#collections">Collections</a> in MongoDB. <code class="docutils literal notranslate"><span class="pre">Collections</span></code> are analogous to tables in relational databases. Think of an <code class="docutils literal notranslate"><span class="pre">Entity</span></code> as a row inside a relational table. In layman terms, a <code class="docutils literal notranslate"><span class="pre">Collection</span></code> would correspond to a category inside your phonebook and an <code class="docutils literal notranslate"><span class="pre">Entity</span></code> would correspond to a single entry. Please check below for more on <code class="docutils literal notranslate"><span class="pre">Collections</span></code>, <a class="reference internal" href="openflow.html#id8"><span class="std std-ref">Collections</span></a>.</p>
<blockquote>
<div><p>In OpenFlow, these <code class="docutils literal notranslate"><span class="pre">Collections</span></code> are grouped by their name inside the <a class="reference external" href="http://app.openiap.io/#/Entities">Entities page</a> (<code class="docutils literal notranslate"><span class="pre">http://app.openiap.io/#/Entities</span></code>). Currently, there exist 10 groups, listed below.</p>
</div></blockquote>
<div class="section" id="workflow-instances">
<h3>workflow_instances<a class="headerlink" href="#workflow-instances" title="Permalink to this headline">¶</a></h3>
<p>Here lie all instances of workflows invoked through 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>).</p>
</div>
<div class="section" id="openrpa">
<h3>openrpa<a class="headerlink" href="#openrpa" title="Permalink to this headline">¶</a></h3>
<p>All objects pertaining to workflows created inside <strong>OpenRPA</strong> are found in this section. By clicking the <strong>Edit button</strong> in one of these objects, the user can see the <code class="docutils literal notranslate"><span class="pre">XAML</span> <span class="pre">code</span></code> which was generated by the OpenRPA workflow.</p>
</div>
<div class="section" id="entities">
<h3>entities<a class="headerlink" href="#entities" title="Permalink to this headline">¶</a></h3>
<p>This section contains all objects serialized into OpenFlow by using the <strong>OpenRPA.OpenFlowDB</strong> activities.</p>
</div>
<div class="section" id="config">
<h3>config<a class="headerlink" href="#config" title="Permalink to this headline">¶</a></h3>
<p>Lists config data for Providers. For more on providers, please refer to <a class="reference external" href="https://github.com/open-rpa/openflow/blob/master/docs/providers.md">Providers</a> (<code class="docutils literal notranslate"><span class="pre">https://github.com/open-rpa/openflow/blob/master/docs/providers.md</span></code>).</p>
</div>
<div class="section" id="openrpa-instances">
<h3>openrpa_instances<a class="headerlink" href="#openrpa-instances" title="Permalink to this headline">¶</a></h3>
<p>Here lie all instances of workflows invoked either through the <a class="reference external" href="http://app.openiap.io/#/Workflows">RPA Workflows page</a> (<code class="docutils literal notranslate"><span class="pre">http://app.openiap.io/#/Workflows</span></code>) or through <strong>OpenRPA</strong> itself.</p>
</div>
<div class="section" id="users">
<h3>users<a class="headerlink" href="#users" title="Permalink to this headline">¶</a></h3>
<p>This section contains all users and roles automatically created by Node-RED or through OpenFlow itself.</p>
</div>
<div class="section" id="workflow">
<h3>workflow<a class="headerlink" href="#workflow" title="Permalink to this headline">¶</a></h3>
<p>This section contains all queues created from Node-RED’s <code class="docutils literal notranslate"><span class="pre">workflow</span> <span class="pre">in</span></code> nodes</p>
</div>
<div class="section" id="forms">
<h3>forms<a class="headerlink" href="#forms" title="Permalink to this headline">¶</a></h3>
<p>This section holds all Forms created inside OpenFlow.</p>
</div>
<div class="section" id="nodered">
<h3>nodered<a class="headerlink" href="#nodered" title="Permalink to this headline">¶</a></h3>
<p>Lists config variables for Node-RED.</p>
</div>
<div class="section" id="audit">
<h3>audit<a class="headerlink" href="#audit" title="Permalink to this headline">¶</a></h3>
<p>This section contains data on all authentication and reauthentication attempts inside OpenFlow.</p>
</div>
</div>
<div class="section" id="usages">
<h2>Usages<a class="headerlink" href="#usages" title="Permalink to this headline">¶</a></h2>
<p>The user can make use of the <a class="reference internal" href="openrpa.html#openrpa-openflowdb"><span class="std std-ref">OpenRPA.OpenFlowDB</span></a> activities to query these entities and manipulate them accordingly.</p>
</div>
<div class="section" id="id1">
<h2>Collections<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
<p>Collections are groups of documents in MongoDB, analogous to tables in relational databases. Collections do not require documents to have the same schema. However, it is possible to enforce that the collection only accepts a certain type of document (document’s properties). This process is called Schema Validation.</p>
<p>For a comprehensive account on MongDB Collections, please refer to the official <a class="reference external" href="https://docs.mongodb.com/manual/core/databases-and-collections/">MongoDB webpage</a> (<code class="docutils literal notranslate"><span class="pre">https://docs.mongodb.com/manual/core/databases-and-collections/</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>