Author: shuber
Date: Mon Sep 4 11:50:34 2023
New Revision: 1912079
URL: http://svn.apache.org/viewvc?rev=1912079&view=rev
Log:
Site checkin for project Apache Unomi :: Root Project
Removed:
unomi/website/manual/2_3_x/
Modified:
unomi/website/manual/latest/index.html
Modified: unomi/website/manual/latest/index.html
URL:
http://svn.apache.org/viewvc/unomi/website/manual/latest/index.html?rev=1912079&r1=1912078&r2=1912079&view=diff
==============================================================================
--- unomi/website/manual/latest/index.html (original)
+++ unomi/website/manual/latest/index.html Mon Sep 4 11:50:34 2023
@@ -3492,8 +3492,7 @@ This keyword is similar to <strong>addit
When setting the <strong>unevaluatedProperties</strong> value to
<strong>false</strong>, the properties which are not present in the properties
part and are not present in the sub schemas will be considered as invalid.</p>
</div>
<div class="paragraph">
-<p>The <strong>unevaluatedProperties</strong> keyword should only be set on
the root schema. Otherwise it could leads to less readable messages when
validating events.
-Example with the following schema:</p>
+<p>Example with the following schema:</p>
</div>
<div class="listingblock">
<div class="content">
@@ -4062,13 +4061,13 @@ you might need to adjust the URL to poin
<p>Since Apache Unomi is an engine, you’ve probably built multiple
applications consuming its APIs, you might also have built extensions directly
running in Unomi.</p>
</div>
<div class="paragraph">
-<p>As you begin updating applications consuming Apache Unomi, it is generally
a good practice to <a href="#Enable debug mode">[Enable debug mode]</a>.
+<p>As you begin updating applications consuming Apache Unomi, it is generally
a good practice to <a href="#_enabling_debug_mode">enable debug mode</a>.
Doing so will display any errors when processing events (such as JSON Schema
validations), and will provide useful indications towards solving issues.</p>
</div>
<div class="sect3">
<h4 id="_data_model_changes">7.3.1. Data Model changes</h4>
<div class="paragraph">
-<p>There has been changes to Unomi Data model, please make sure to review
those in the << what_s_new>> section of the user manual.</p>
+<p>There has been changes to Unomi Data model, please make sure to review
those in the <a href="#_whats_new_in_apache_unomi_2_0">What’s new in
Unomi 2</a> section of the user manual.</p>
</div>
</div>
<div class="sect3">
@@ -4078,11 +4077,36 @@ Doing so will display any errors when pr
</div>
<div class="paragraph">
<p>Any event (and more generally, any object) received through Unomi public
endpoints do require a valid JSON schema.
-Apache Unomi ships, out of the box, with all of the necessary JSON Schemas for
its own operation but you will need to create schemas for any custom event you
may be using.</p>
+Apache Unomi ships, out of the box, with all of the necessary JSON Schemas for
its own operation as well as all event types generated from the Apache Unomi
Web Tracker but you will need to create schemas for any custom event you may be
using.</p>
</div>
<div class="paragraph">
-<p>When creating your new schemas, reviewing debug messages in the logs
(using: <code>log:set DEBUG
org.apache.unomi.schema.impl.SchemaServiceImpl</code> in Karaf console),
-will point to errors in your schemas or will help you diagnose why the events
are not being accepted.</p>
+<p>When creating your new schemas, there are multiple ways of testing them:</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p>Using a the event validation API endpoint available at the URL :
<code>/cxs/jsonSchema/validateEvent</code></p>
+</li>
+<li>
+<p>Using debug logs when sending events using the usual ways (using the
<code>/context.json</code> or <code>/eventcollector</code> endpoints)</p>
+</li>
+</ul>
+</div>
+<div class="paragraph">
+<p>Note that in both cases it helps to activate the debug logs, that may be
activated either:</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p>Through the ssh Karaf console command : <code>log:set DEBUG
org.apache.unomi.schema.impl.SchemaServiceImpl</code></p>
+</li>
+<li>
+<p>Using the UNOMI_LOGS_JSONSCHEMA_LEVEL=DEBUG environment variable and then
restarting Apache Unomi. This is especially useful when using Docker
Containers.</p>
+</li>
+</ul>
+</div>
+<div class="paragraph">
+<p>Once the debug logs are active, you will see detailed error messages if
your events are not matched with any deployed JSON schema.</p>
</div>
<div class="paragraph">
<p>Note that it is currently not possible to modify or surcharge an existing
system-deployed JSON schema via the REST API. It is however possible to deploy
new schemas and manage them through the REST API on the
<code>/cxs/jsonSchema</code> endpoint.
@@ -4094,7 +4118,7 @@ you will need to either change to use a
<a
href="https://github.com/apache/unomi/tree/master/extensions/json-schema/services/src/main/resources/META-INF/cxs/schemas";>extensions/json-schema/services/src/main/resources/META-INF/cxs/schemas</a>.</p>
</div>
<div class="paragraph">
-<p>Finally, and although it is technically feasible, we recommend against
creating permissive JSON Schemas allowing any event payload. This requires
making sure that you don’t allow open properties by using JSON schema
keywords such as <a
href="https://json-schema.org/understanding-json-schema/reference/object.html#unevaluated-properties";>unevaluated
properties</a></p>
+<p>Finally, and although it is technically feasible, we recommend against
creating permissive JSON Schemas allowing any event payload. This requires
making sure that you don’t allow undeclared properties by setting JSON
schema keywords such as <a
href="https://json-schema.org/understanding-json-schema/reference/object.html#unevaluated-properties";>unevaluated
properties</a> to <code>false</code>.</p>
</div>
</div>
</div>
@@ -4108,7 +4132,7 @@ Documentation is available on <a href="h
</div>
<div class="paragraph">
<p>Your Elasticsearch cluster must have enough capacity to handle the
migration.
-At a minimum, the required capacity must be greater than the size of the
dataset in production + the size of the largest index.</p>
+At a minimum, the required capacity storage capacity must be greater than the
size of the dataset in production + the size of the largest index. Any other
settings should at least be as big as the source setup (preferably higher).</p>
</div>
</div>
<div class="sect3">
@@ -4186,13 +4210,13 @@ The script in position "10" will introdu
<p>Shutdown your Apache Unomi 1.6 cluster</p>
</li>
<li>
-<p>Start an Apache Unomi 2.0 migration node</p>
+<p>Start one Apache Unomi 2.0 node that will perform the migration (upon
startup)</p>
</li>
<li>
<p>Wait for data migration to complete</p>
</li>
<li>
-<p>Start you Apache Unomi 2.0 cluster</p>
+<p>Start your Apache Unomi 2.0 cluster</p>
</li>
<li>
<p>(optional) Import additional JSON Schemas</p>
@@ -11471,7 +11495,7 @@ They allow to modify an item, that would
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2023-05-15 10:05:32 +0200
+Last updated 2023-06-27 12:09:36 +0200
</div>
</div>
</body>
