You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@unomi.apache.org by sh...@apache.org on 2018/11/30 08:35:46 UTC
svn commit: r1847788 - /incubator/unomi/website/manual/latest/index.html
Author: shuber
Date: Fri Nov 30 08:35:45 2018
New Revision: 1847788
URL: http://svn.apache.org/viewvc?rev=1847788&view=rev
Log:
Site checkin for project Apache Unomi :: Root Project
Modified:
incubator/unomi/website/manual/latest/index.html
Modified: incubator/unomi/website/manual/latest/index.html
URL: http://svn.apache.org/viewvc/incubator/unomi/website/manual/latest/index.html?rev=1847788&r1=1847787&r2=1847788&view=diff
==============================================================================
--- incubator/unomi/website/manual/latest/index.html (original)
+++ incubator/unomi/website/manual/latest/index.html Fri Nov 30 08:35:45 2018
@@ -53,10 +53,9 @@
<li><a href="#_changing_the_default_tracking_location">3.2.9. Changing the default tracking location</a></li>
<li><a href="#_apache_karaf_ssh_console">3.2.10. Apache Karaf SSH Console</a></li>
<li><a href="#_elasticsearch_x_pack_support">3.2.11. ElasticSearch X-Pack Support</a></li>
+<li><a href="#_useful_apache_unomi_urls">3.2.12. Useful Apache Unomi URLs</a></li>
</ul>
</li>
-<li><a href="#_important">3.3. Important !</a></li>
-<li><a href="#_installation_steps">3.4. Installation steps</a></li>
</ul>
</li>
<li><a href="#_integration_samples">4. Integration samples</a>
@@ -1347,16 +1346,14 @@ defaultLongitude=6.1282508</code></pre>
<p>It is now possible to use X-Pack to connect to ElasticSearch. However, for licensing reasons this is not provided out
of the box. Here is the procedure to install X-Pack with Apache Unomi:</p>
</div>
-</div>
-</div>
-<div class="sect2">
-<h3 id="_important">3.3. Important !</h3>
+<div class="sect4">
+<h5 id="_important">Important !</h5>
<div class="paragraph">
<p>Do not start Unomi directly with unomi:start, perform the following steps below first !</p>
</div>
</div>
-<div class="sect2">
-<h3 id="_installation_steps">3.4. Installation steps</h3>
+<div class="sect4">
+<h5 id="_installation_steps">Installation steps</h5>
<div class="olist arabic">
<ol class="arabic">
<li>
@@ -1437,6 +1434,106 @@ as in the following example:</p>
</div>
</div>
</div>
+<div class="sect3">
+<h4 id="_useful_apache_unomi_urls">3.2.12. Useful Apache Unomi URLs</h4>
+<div class="paragraph">
+<p>In this section we will list some useful URLs that can be used to quickly access parts of Apache Unomi that can help
+you understand or diagnose what is going on in the system.</p>
+</div>
+<div class="paragraph">
+<p>You can of course find more information about the REST API in the <a href="http://unomi.apache.org/documentation.html">related section</a>
+in the Apache Unomi website.</p>
+</div>
+<div class="paragraph">
+<p>For these requests it can be nice to use a browser (such as Firefox) that understands JSON to make it easier to view the
+results as the returned JSON is not beautified (another possiblity is a tool such as Postman).</p>
+</div>
+<div class="paragraph">
+<p>Important : all URLs are relative to the private Apache Unomi URL, by default: <a href="https://localhost:9443" class="bare">https://localhost:9443</a></p>
+</div>
+<table class="tableblock frame-all grid-all stretch">
+<caption class="title">Table 2. Useful URLs</caption>
+<colgroup>
+<col style="width: 33.3333%;">
+<col style="width: 33.3333%;">
+<col style="width: 33.3334%;">
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Path</th>
+<th class="tableblock halign-left valign-top">Method</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">/cxs/profiles/properties</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">GET</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Listing deployed properties</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">/cxs/definitions/conditions</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">GET</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Listing deployed conditions</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">/cxs/definitions/actions</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">GET</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Listing deployed actions</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">/cxs/profiles/PROFILE_ID</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">GET</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Dumping a profile in JSON</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">/cxs/profiles/PROFILE_ID/sessions</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">GET</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Listing sessions for a profile</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">/cxs/profiles/sessions/SESSION_ID</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">GET</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Dumping a session in JSON</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">/cxs/profiles/sessions/SESSION_ID/events</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">GET</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Listing events for a session. This query can have additional such as eventTypes, q (query), offset, size, sort. See the <a href="https://unomi.incubator.apache.org/rest-api-doc/#1019321624">related
+section in the REST API</a> for details.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">/cxs/events/search</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">POST</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Listing events for a profile. You will need to provide a query in the body of the request that looks something like this (and <a href="https://unomi.incubator.apache.org/rest-api-doc/#1768188821">documentation is available in the REST API</a>) :
+{ "offset" : 0,
+ "limit" : 20,
+ "condition" : {
+ "type": "eventPropertyCondition",
+ "parameterValues" : {
+ "propertyName" : "profileId",
+ "comparisonOperator" : "equals",
+ "propertyValue" : "PROFILE_ID"
+ }
+ }
+}
+where PROFILE_ID is a profile identifier. This will indeed retrieve all the events for a given profile.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">/cxs/rules/statistics</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">GET</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Get all rule execution statistics</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">/cxs/rules/statistics</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">DELETE</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Reset all rule execution statistics to 0</p></td>
+</tr>
+</tbody>
+</table>
+</div>
+</div>
+</div>
</div>
<div class="sect1">
<h2 id="_integration_samples">4. Integration samples</h2>
@@ -3096,7 +3193,7 @@ ARGUMENTS
<p>The commands control the lifecycle of the Apache Unomi server and are used to migrate, start or stop the server.</p>
</div>
<table class="tableblock frame-all grid-all stretch">
-<caption class="title">Table 2. Table Lifecycle commands</caption>
+<caption class="title">Table 3. Table Lifecycle commands</caption>
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 33.3333%;">
@@ -3139,23 +3236,26 @@ ARGUMENTS
<p>These commands are available once the application is running. If an argument is between brackets [] it means it is optional.</p>
</div>
<table class="tableblock frame-all grid-all stretch">
-<caption class="title">Table 3. Table Runtime commands</caption>
+<caption class="title">Table 4. Table Runtime commands</caption>
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 33.3333%;">
<col style="width: 33.3334%;">
</colgroup>
-<tbody>
+<thead>
<tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Command</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Arguments</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Description</p></td>
+<th class="tableblock halign-left valign-top">Command</th>
+<th class="tableblock halign-left valign-top">Arguments</th>
+<th class="tableblock halign-left valign-top">Description</th>
</tr>
+</thead>
+<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">rule-list</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">[--csv]</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">Lists all the rules registered in the Apache Unomi server. If you add the "--csv" option the list will be output
-as a CSV formatted table</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[maxEntries] [--csv]</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Lists all the rules registered in the Apache Unomi server. The maxEntries (defaults to 100) will allow you to specify
+how many entries need to be retrieved. If the value is inferior to the total value, a message will display the total
+value of rules registered in the server. If you add the "--csv" option the list will be output as a CSV formatted table</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">rule-view</p></td>
@@ -3168,6 +3268,23 @@ as a CSV formatted table</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Resets the rule statistics. This is notably useful when trying to understand rule performance and impact</p></td>
</tr>
<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">rule-tail</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Dumps any rule that is executed by the server. Only executed rules are logged here. If you want to have more detailed
+information about a particular rule’s condition evaluation and if it’s already been raised use the <code>rule-watch</code> command
+instead. This tail will continue until a CTRL+C key combination is pressed.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">rule-watch</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">rule-ids</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Dumps detailed evaluation and execution information about the rules that are where specified in the <code>rule-ids</code> arguments
+(you can specify multiple rule identifiers separated by spaces). The <code>Status</code> column has the following values: EVALUATE -
+indicates that the rule’s conditions are being evaluated (but they might not be satisfied), AR PROFILE - means the rule
+has already been raised for the profile and will therefore not execute again for this profile, AR SESSION - means the
+rule has already been executed for this session and will therefore only executed when another session for the profile is
+created, EXECUTE means the rule’s actions are being executed.</p></td>
+</tr>
+<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">event-tail</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Dumps any incoming events to the Apache Unomi server to the console. Use CTRL+C to exit tail</p></td>
@@ -3181,8 +3298,7 @@ as a CSV formatted table</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">action-list</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">[--csv]</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Lists all the rule actions registered in the Apache Unomi server. This command is useful when developing plugins to
-check that everything is properly registered. If you add the "--csv" option the list will be output
- as a CSV formatted table</p></td>
+check that everything is properly registered. If you add the "--csv" option the list will be output as a CSV formatted table</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">action-view</p></td>
@@ -3190,10 +3306,19 @@ check that everything is properly regist
<td class="tableblock halign-left valign-top"><p class="tableblock">Dumps a single action in JSON. The action-id argument can be retrieved from the <code>action-list</code> command output.</p></td>
</tr>
<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">condition-list</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[csv]</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">List all the conditions registered in the server. If you add the "--csv" option the list will be output as a CSV formatted table</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">condition-view</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">condition-id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Dumps a single condition in JSON. The condition-id can be retrieved from the <code>condition-list</code> command output.</p></td>
+</tr>
+<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">profile-list</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">[--csv]</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">List the last 10 modified profiles. If you add the "--csv" option the list will be output
- as a CSV formatted table</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">List the last 10 modified profiles. If you add the "--csv" option the list will be output as a CSV formatted table</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">profile-view</p></td>
@@ -3992,7 +4117,7 @@ They allow to modify an item, that would
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2018-11-05 20:32:11 CET
+Last updated 2018-11-26 14:15:18 CET
</div>
</div>
</body>