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/13 16:37:44 UTC
svn commit: r1846523 - in /incubator/unomi/website/manual/latest:
connectors/connectors.html connectors/mailchimp-connector.html index.html
shell-commands.html
Author: shuber
Date: Tue Nov 13 16:37:44 2018
New Revision: 1846523
URL: http://svn.apache.org/viewvc?rev=1846523&view=rev
Log:
Site checkin for project Apache Unomi :: Root Project
Added:
incubator/unomi/website/manual/latest/connectors/mailchimp-connector.html
incubator/unomi/website/manual/latest/shell-commands.html
Modified:
incubator/unomi/website/manual/latest/connectors/connectors.html
incubator/unomi/website/manual/latest/index.html
Modified: incubator/unomi/website/manual/latest/connectors/connectors.html
URL: http://svn.apache.org/viewvc/incubator/unomi/website/manual/latest/connectors/connectors.html?rev=1846523&r1=1846522&r2=1846523&view=diff
==============================================================================
--- incubator/unomi/website/manual/latest/connectors/connectors.html (original)
+++ incubator/unomi/website/manual/latest/connectors/connectors.html Tue Nov 13 16:37:44 2018
@@ -26,21 +26,24 @@
<div class="ulist">
<ul>
<li>
-<p><a href="salesforce-connectors.html">Salesforce CRM connectors</a></p>
+<p><a href="connectors/salesforce-connectors.html">Salesforce CRM connectors</a></p>
+</li>
+<li>
+<p><a href="connectors/mailchimp-connectors.html">MailChimp connectors</a></p>
</li>
</ul>
</div>
<div class="sect3">
<h4 id="_call_for_contributors">Call for contributors</h4>
<div class="paragraph">
-<p>We are looking for help with the development of additional connectors. Any contribution (large or small) is more than welcome. Feel free to discuss this in our <a href="../../mail-lists.html">mailing list</a>.</p>
+<p>We are looking for help with the development of additional connectors. Any contribution (large or small) is more than welcome. Feel free to discuss this in our <a href="http://unomi.apache.org/community.html">mailing list, window="_blank"</a>.</p>
</div>
</div>
</div>
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2018-09-10 11:30:03 CEST
+Last updated 2018-11-05 20:32:11 CET
</div>
</div>
</body>
Added: incubator/unomi/website/manual/latest/connectors/mailchimp-connector.html
URL: http://svn.apache.org/viewvc/incubator/unomi/website/manual/latest/connectors/mailchimp-connector.html?rev=1846523&view=auto
==============================================================================
--- incubator/unomi/website/manual/latest/connectors/mailchimp-connector.html (added)
+++ incubator/unomi/website/manual/latest/connectors/mailchimp-connector.html Tue Nov 13 16:37:44 2018
@@ -0,0 +1,156 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+<meta charset="UTF-8">
+<!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]-->
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<meta name="generator" content="Asciidoctor 1.5.6.1">
+<title>Apache Unomi :: Extensions :: MailChimp Connector</title>
+<link rel="stylesheet" href="./apache.css">
+</head>
+<body class="article">
+<div id="header">
+<div id="toc" class="toc">
+<div id="toctitle">Table of Contents</div>
+<ul class="sectlevel2">
+<li><a href="#_apache_unomi_extensions_mailchimp_connector">Apache Unomi :: Extensions :: MailChimp Connector</a></li>
+</ul>
+</div>
+</div>
+<div id="content">
+<div class="sect2">
+<h3 id="_apache_unomi_extensions_mailchimp_connector">Apache Unomi :: Extensions :: MailChimp Connector</h3>
+<div class="paragraph">
+<p>This extension has 3 actions:</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p>Add a visitor into a defined Mailchimp list.</p>
+</li>
+<li>
+<p>Remove a visitor from a defined Mailchimp list.</p>
+</li>
+<li>
+<p>Unsubscribe a visitor from a defined Mailchimp list.</p>
+</li>
+</ul>
+</div>
+<div class="sect3">
+<h4 id="_getting_started">Getting started</h4>
+<div class="olist arabic">
+<ol class="arabic">
+<li>
+<p>Create a new MailChimp account: <a href="https://login.mailchimp.com/signup/" class="bare">https://login.mailchimp.com/signup/</a></p>
+</li>
+<li>
+<p>Generate a new API Key, or get the default: <a href="https://usX.admin.mailchimp.com/account/api/" class="bare">https://usX.admin.mailchimp.com/account/api/</a></p>
+</li>
+<li>
+<p>Configure the MailChimp Connector Basic in the <code>etc/org.apache.unomi.mailchimpconnector.cfg</code> file change the following settings:</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code> mailChimpConnector.apiKey=YOUR_APIKEY
+ mailChimpConnector.url.subDomain=YOUR_SUB_DOMAIN (exemple: https://usX.admin.mailchimp.com/account/api/, the X is the SUB_DOMAIN)</code></pre>
+</div>
+</div>
+</li>
+<li>
+<p>Before starting configure the mapping between Apache Unomi profile properties and MailChimp member properties.<br>
+The mapping can’t be use with multitued properties. You need to setup your MailChimp properties first in the MailChimp administration.</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code> Go to: lists/
+ Select the triggered list
+ Settings</code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>Then in the cfg file <code>mailChimpConnector.list.merge-fields.activate={Boolean} if you like to activate the mapping feature.</code></p>
+</div>
+<div class="paragraph">
+<p>This is the property to configure for the mapping, the format is as shown. <code>mailChimpConnector.list.merge-fields.mapping={Apache Unomi property ID}<⇒{MailChimp Tag name}</code></p>
+</div>
+<div class="admonitionblock note">
+<table>
+<tr>
+<td class="icon">
+<div class="title">Note</div>
+</td>
+<td class="content">
+<div class="paragraph">
+<p>there is a particular format for the address <code>{Apache Unomi property ID}<⇒{MailChimp Tag name}<⇒{MailChimp tag sub entry}</code></p>
+</div>
+</td>
+</tr>
+</table>
+</div>
+<div class="paragraph">
+<p>MailChimp supported type are:</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p>Date <code>The format is (DD/MM/YYYY) or (MM/DD/YYYY)</code></p>
+</li>
+<li>
+<p>Birthday <code>The format is (DD/MM) or (MM/DD)</code></p>
+</li>
+<li>
+<p>Website or Text <code>They are text</code></p>
+</li>
+<li>
+<p>Number <code>The number will be parse into a Integer</code></p>
+</li>
+<li>
+<p>Phone <code>The North American format is not supported, use international</code></p>
+</li>
+<li>
+<p>Address</p>
+<div class="admonitionblock note">
+<table>
+<tr>
+<td class="icon">
+<div class="title">Note</div>
+</td>
+<td class="content">
+<div class="paragraph">
+<p>Street, City, Country and Zip are mandatory properties, otherwise the address property will be skipped.</p>
+</div>
+</td>
+</tr>
+</table>
+</div>
+</li>
+</ul>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code> address<=>ADDRESS<=>addr1,
+ city<=>ADDRESS<=>city,
+ zipCode<=>ADDRESS<=>zip,
+ countryName<=>ADDRESS<=>country</code></pre>
+</div>
+</div>
+</li>
+<li>
+<p>Deploy into Apache Unomi using the following commands from the Apache Karaf shell:<br></p>
+</li>
+</ol>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre> feature:repo-add mvn:org.apache.unomi/unomi-mailchimp-connector-karaf-kar/${project.version}/xml/features
+ feature:install unomi-mailchimp-connector-karaf-kar</pre>
+</div>
+</div>
+</div>
+</div>
+</div>
+<div id="footer">
+<div id="footer-text">
+Last updated 2018-11-05 20:32:11 CET
+</div>
+</div>
+</body>
+</html>
\ No newline at end of file
Modified: incubator/unomi/website/manual/latest/index.html
URL: http://svn.apache.org/viewvc/incubator/unomi/website/manual/latest/index.html?rev=1846523&r1=1846522&r2=1846523&view=diff
==============================================================================
--- incubator/unomi/website/manual/latest/index.html (original)
+++ incubator/unomi/website/manual/latest/index.html Tue Nov 13 16:37:44 2018
@@ -102,6 +102,11 @@
<li><a href="#_executing_the_unit_tests">5.2.5. Executing the unit tests</a></li>
</ul>
</li>
+<li><a href="#_apache_unomi_extensions_mailchimp_connector">5.3. Apache Unomi :: Extensions :: MailChimp Connector</a>
+<ul class="sectlevel3">
+<li><a href="#_getting_started_3">5.3.1. Getting started</a></li>
+</ul>
+</li>
</ul>
</li>
<li><a href="#_cluster_setup">6. Cluster setup</a>
@@ -141,41 +146,48 @@
<li><a href="#_testing_with_an_example_page">8.1.9. Testing with an example page</a></li>
</ul>
</li>
-<li><a href="#_types_vs_instances">8.2. Types vs. instances</a></li>
-<li><a href="#_plugin_structure">8.3. Plugin structure</a></li>
-<li><a href="#_extension_points">8.4. Extension points</a>
+<li><a href="#_ssh_shell_commands">8.2. SSH Shell Commands</a>
+<ul class="sectlevel3">
+<li><a href="#_using_the_shell">8.2.1. Using the shell</a></li>
+<li><a href="#_lifecycle_commands">8.2.2. Lifecycle commands</a></li>
+<li><a href="#_runtime_commands">8.2.3. Runtime commands</a></li>
+</ul>
+</li>
+<li><a href="#_types_vs_instances">8.3. Types vs. instances</a></li>
+<li><a href="#_plugin_structure">8.4. Plugin structure</a></li>
+<li><a href="#_extension_points">8.5. Extension points</a>
<ul class="sectlevel3">
-<li><a href="#_actiontype">8.4.1. ActionType</a></li>
-<li><a href="#_conditiontype">8.4.2. ConditionType</a></li>
-<li><a href="#_persona">8.4.3. Persona</a></li>
-<li><a href="#_propertymergestrategytype">8.4.4. PropertyMergeStrategyType</a></li>
-<li><a href="#_propertytype">8.4.5. PropertyType</a></li>
-<li><a href="#_rule">8.4.6. Rule</a></li>
-<li><a href="#_scoring">8.4.7. Scoring</a></li>
-<li><a href="#_segments">8.4.8. Segments</a></li>
-<li><a href="#_tag">8.4.9. Tag</a></li>
-<li><a href="#_valuetype">8.4.10. ValueType</a></li>
+<li><a href="#_actiontype">8.5.1. ActionType</a></li>
+<li><a href="#_conditiontype">8.5.2. ConditionType</a></li>
+<li><a href="#_persona">8.5.3. Persona</a></li>
+<li><a href="#_propertymergestrategytype">8.5.4. PropertyMergeStrategyType</a></li>
+<li><a href="#_propertytype">8.5.5. PropertyType</a></li>
+<li><a href="#_rule">8.5.6. Rule</a></li>
+<li><a href="#_scoring">8.5.7. Scoring</a></li>
+<li><a href="#_segments">8.5.8. Segments</a></li>
+<li><a href="#_tag">8.5.9. Tag</a></li>
+<li><a href="#_valuetype">8.5.10. ValueType</a></li>
</ul>
</li>
-<li><a href="#_other_unomi_entities">8.5. Other Unomi entities</a>
+<li><a href="#_other_unomi_entities">8.6. Other Unomi entities</a>
<ul class="sectlevel3">
-<li><a href="#_userlist">8.5.1. UserList</a></li>
-<li><a href="#_goal">8.5.2. Goal</a></li>
-<li><a href="#_campaign">8.5.3. Campaign</a></li>
+<li><a href="#_userlist">8.6.1. UserList</a></li>
+<li><a href="#_goal">8.6.2. Goal</a></li>
+<li><a href="#_campaign">8.6.3. Campaign</a></li>
</ul>
</li>
-<li><a href="#_custom_extensions">8.6. Custom extensions</a>
+<li><a href="#_custom_extensions">8.7. Custom extensions</a>
<ul class="sectlevel3">
-<li><a href="#_creating_an_extension">8.6.1. Creating an extension</a></li>
-<li><a href="#_deployment_and_custom_definition">8.6.2. Deployment and custom definition</a></li>
-<li><a href="#_predefined_segments">8.6.3. Predefined segments</a></li>
-<li><a href="#_predefined_rules">8.6.4. Predefined rules</a></li>
-<li><a href="#_predefined_properties">8.6.5. Predefined properties</a></li>
-<li><a href="#_predefined_child_conditions">8.6.6. Predefined child conditions</a></li>
-<li><a href="#_predefined_personas">8.6.7. Predefined personas</a></li>
-<li><a href="#_custom_actions">8.6.8. Custom actions</a></li>
-<li><a href="#_custom_conditions">8.6.9. Custom conditions</a></li>
-<li><a href="#_migration_patches">8.6.10. Migration patches</a></li>
+<li><a href="#_creating_an_extension">8.7.1. Creating an extension</a></li>
+<li><a href="#_deployment_and_custom_definition">8.7.2. Deployment and custom definition</a></li>
+<li><a href="#_predefined_segments">8.7.3. Predefined segments</a></li>
+<li><a href="#_predefined_rules">8.7.4. Predefined rules</a></li>
+<li><a href="#_predefined_properties">8.7.5. Predefined properties</a></li>
+<li><a href="#_predefined_child_conditions">8.7.6. Predefined child conditions</a></li>
+<li><a href="#_predefined_personas">8.7.7. Predefined personas</a></li>
+<li><a href="#_custom_actions">8.7.8. Custom actions</a></li>
+<li><a href="#_custom_conditions">8.7.9. Custom conditions</a></li>
+<li><a href="#_migration_patches">8.7.10. Migration patches</a></li>
</ul>
</li>
</ul>
@@ -1660,14 +1672,17 @@ image: images/unomi-request.png[Unomi re
<div class="ulist">
<ul>
<li>
-<p><a href="salesforce-connectors.html">Salesforce CRM connectors</a></p>
+<p><a href="connectors/salesforce-connectors.html">Salesforce CRM connectors</a></p>
+</li>
+<li>
+<p><a href="connectors/mailchimp-connectors.html">MailChimp connectors</a></p>
</li>
</ul>
</div>
<div class="sect3">
<h4 id="_call_for_contributors">5.1.1. Call for contributors</h4>
<div class="paragraph">
-<p>We are looking for help with the development of additional connectors. Any contribution (large or small) is more than welcome. Feel free to discuss this in our <a href="../../mail-lists.html">mailing list</a>.</p>
+<p>We are looking for help with the development of additional connectors. Any contribution (large or small) is more than welcome. Feel free to discuss this in our <a href="http://unomi.apache.org/community.html">mailing list, window="_blank"</a>.</p>
</div>
</div>
</div>
@@ -1929,6 +1944,134 @@ mvn clean install -DsfdcProperties=../te
</div>
</div>
</div>
+<div class="sect2">
+<h3 id="_apache_unomi_extensions_mailchimp_connector">5.3. Apache Unomi :: Extensions :: MailChimp Connector</h3>
+<div class="paragraph">
+<p>This extension has 3 actions:</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p>Add a visitor into a defined Mailchimp list.</p>
+</li>
+<li>
+<p>Remove a visitor from a defined Mailchimp list.</p>
+</li>
+<li>
+<p>Unsubscribe a visitor from a defined Mailchimp list.</p>
+</li>
+</ul>
+</div>
+<div class="sect3">
+<h4 id="_getting_started_3">5.3.1. Getting started</h4>
+<div class="olist arabic">
+<ol class="arabic">
+<li>
+<p>Create a new MailChimp account: <a href="https://login.mailchimp.com/signup/" class="bare">https://login.mailchimp.com/signup/</a></p>
+</li>
+<li>
+<p>Generate a new API Key, or get the default: <a href="https://usX.admin.mailchimp.com/account/api/" class="bare">https://usX.admin.mailchimp.com/account/api/</a></p>
+</li>
+<li>
+<p>Configure the MailChimp Connector Basic in the <code>etc/org.apache.unomi.mailchimpconnector.cfg</code> file change the following settings:</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code> mailChimpConnector.apiKey=YOUR_APIKEY
+ mailChimpConnector.url.subDomain=YOUR_SUB_DOMAIN (exemple: https://usX.admin.mailchimp.com/account/api/, the X is the SUB_DOMAIN)</code></pre>
+</div>
+</div>
+</li>
+<li>
+<p>Before starting configure the mapping between Apache Unomi profile properties and MailChimp member properties.<br>
+The mapping can’t be use with multitued properties. You need to setup your MailChimp properties first in the MailChimp administration.</p>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code> Go to: lists/
+ Select the triggered list
+ Settings</code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>Then in the cfg file <code>mailChimpConnector.list.merge-fields.activate={Boolean} if you like to activate the mapping feature.</code></p>
+</div>
+<div class="paragraph">
+<p>This is the property to configure for the mapping, the format is as shown. <code>mailChimpConnector.list.merge-fields.mapping={Apache Unomi property ID}<⇒{MailChimp Tag name}</code></p>
+</div>
+<div class="admonitionblock note">
+<table>
+<tr>
+<td class="icon">
+<div class="title">Note</div>
+</td>
+<td class="content">
+<div class="paragraph">
+<p>there is a particular format for the address <code>{Apache Unomi property ID}<⇒{MailChimp Tag name}<⇒{MailChimp tag sub entry}</code></p>
+</div>
+</td>
+</tr>
+</table>
+</div>
+<div class="paragraph">
+<p>MailChimp supported type are:</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p>Date <code>The format is (DD/MM/YYYY) or (MM/DD/YYYY)</code></p>
+</li>
+<li>
+<p>Birthday <code>The format is (DD/MM) or (MM/DD)</code></p>
+</li>
+<li>
+<p>Website or Text <code>They are text</code></p>
+</li>
+<li>
+<p>Number <code>The number will be parse into a Integer</code></p>
+</li>
+<li>
+<p>Phone <code>The North American format is not supported, use international</code></p>
+</li>
+<li>
+<p>Address</p>
+<div class="admonitionblock note">
+<table>
+<tr>
+<td class="icon">
+<div class="title">Note</div>
+</td>
+<td class="content">
+<div class="paragraph">
+<p>Street, City, Country and Zip are mandatory properties, otherwise the address property will be skipped.</p>
+</div>
+</td>
+</tr>
+</table>
+</div>
+</li>
+</ul>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code> address<=>ADDRESS<=>addr1,
+ city<=>ADDRESS<=>city,
+ zipCode<=>ADDRESS<=>zip,
+ countryName<=>ADDRESS<=>country</code></pre>
+</div>
+</div>
+</li>
+<li>
+<p>Deploy into Apache Unomi using the following commands from the Apache Karaf shell:<br></p>
+</li>
+</ol>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre> feature:repo-add mvn:org.apache.unomi/unomi-mailchimp-connector-karaf-kar/${project.version}/xml/features
+ feature:install unomi-mailchimp-connector-karaf-kar</pre>
+</div>
+</div>
+</div>
+</div>
</div>
</div>
<div class="sect1">
@@ -2466,19 +2609,219 @@ contains the URLs of all your cluster no
or create a new one if it doesn’t exist yet. It also contains an experimental integration with Facebook Login, but it
doesn’t yet save the context back to the context server.</p>
</div>
+</div>
+</div>
+<div class="sect2">
+<h3 id="_ssh_shell_commands">8.2. SSH Shell Commands</h3>
+<div class="paragraph">
+<p>Apache Unomi provides its own Apache Karaf Shell commands to make it easy to control the application
+lifecycle or perform queries or modifications on the internal state of the system.</p>
+</div>
+<div class="paragraph">
+<p>All Apache Unomi-specific commands are namespaced and use the <code>unomi:</code> namespace. You can use the Apache Karaf Shell’s
+autocompletion to list all the commands available.</p>
+</div>
+<div class="sect3">
+<h4 id="_using_the_shell">8.2.1. Using the shell</h4>
+<div class="paragraph">
+<p>You can connect to the Apache Karaf SSH Shell using the following command:</p>
+</div>
+<div class="literalblock">
+<div class="content">
+<pre>ssh -p 8102 karaf@localhost</pre>
+</div>
+</div>
+<div class="paragraph">
+<p>The default username/password is karaf/karaf. You should change this as soon as possible by editing the <code>etc/users.properties</code> file.</p>
+</div>
+<div class="paragraph">
+<p>Once connected you can simply type in :</p>
+</div>
+<div class="literalblock">
+<div class="content">
+<pre>unomi:</pre>
+</div>
+</div>
+<div class="paragraph">
+<p>And hit the <tab> key to see the list of all the available Apache Unomi commands. Note that some commands
+are only available when the application is started.</p>
+</div>
+<div class="paragraph">
+<p>You can also use the <code>help</code> command on any command such as in the following example:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code>karaf@root()> help unomi:migrate
+DESCRIPTION
+ unomi:migrate
+
+ This will Migrate your date in ES to be compliant with current version
+
+SYNTAX
+ unomi:migrate [fromVersionWithoutSuffix]
+
+ARGUMENTS
+ fromVersionWithoutSuffix
+ Origin version without suffix/qualifier (e.g: 1.2.0)
+ (defaults to 1.2.0)</code></pre>
+</div>
+</div>
+</div>
+<div class="sect3">
+<h4 id="_lifecycle_commands">8.2.2. Lifecycle commands</h4>
+<div class="paragraph">
+<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 spread">
+<caption class="title">Table 1. Table Lifecycle commands</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">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">migrate</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">fromVersion</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">This command must be used only when the Apache Unomi application is NOT STARTED. It will perform migration of the data stored in ElasticSearch using the argument fromVersion as a starting point.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">stop</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">Shutsdown the Apache Unomi application</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">start</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">Starts the Apache Unomi application. Note that this state will be remembered between Apache Karaf launches, so in general it is only needed after a first installation or after a <code>migrate</code> command</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">version</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">Prints out the currently deployed version of the Apache Unomi application inside the Apache Karaf runtime.</p></td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="sect3">
+<h4 id="_runtime_commands">8.2.3. Runtime commands</h4>
+<div class="paragraph">
+<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 spread">
+<caption class="title">Table 2. Table Runtime commands</caption>
+<colgroup>
+<col style="width: 33.3333%;">
+<col style="width: 33.3333%;">
+<col style="width: 33.3334%;">
+</colgroup>
+<tbody>
+<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>
+</tr>
+<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>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">rule-view</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">rule-id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Dumps a single rule in JSON. The rule-id argument can be retrieved from the <code>rule-list</code> command output.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">rule-reset-stats</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">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">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>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">event-view</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">event-id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Dumps a single event in JSON. The <code>event-id</code> can be retrieved from the event-tail command output.</p></td>
+</tr>
+<tr>
+<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>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">action-view</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">action-id</p></td>
+<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">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>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">profile-view</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">profile-id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Dumps a single profile in JSON. The profile-id argument can be retrieved from the <code>profile-list</code> command output.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">segment-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 segments registered in the Apache Unomi 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">segment-view</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">segment-id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Dumps a single segment in JSON. The segment-id argument can be retrieved from the <code>segment-list</code> command output.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">session-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 the last 10 sessions by last event date. 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">session-view</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">session-id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Dumps a single session in JSON. The session-id argument can be retrieved from the <code>session-list</code>, <code>profile-list</code> or
+ <code>event-tail</code> command output.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">deploy-definition</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[bundleId] [type] [fileName]</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">This command can be used to force redeployment of definitions from bundles. By default existing definitions will not
+be overriden unless they come from SNAPSHOT bundles. Using this command you can override this mechanism. Here are some
+examples of using this command: <code>unomi:deploy-definition 175 rule *</code> will redeploy all the rules provided by bundle with id 175. If you launch the command without any arguments you will get prompts for what you want to deploy from which bundle</p></td>
+</tr>
+</tbody>
+</table>
<div class="paragraph">
<p>Unomi is architected so that users can provided extensions in the form of plugins.</p>
</div>
</div>
</div>
<div class="sect2">
-<h3 id="_types_vs_instances">8.2. Types vs. instances</h3>
+<h3 id="_types_vs_instances">8.3. Types vs. instances</h3>
<div class="paragraph">
<p>Several extension points in Unomi rely on the concept of type: the extension defines a prototype for what the actual items will be once parameterized with values known only at runtime. This is similar to the concept of classes in object-oriented programming: types define classes, providing the expected structure and which fields are expected to be provided at runtime, that are then instantiated when needed with actual values.</p>
</div>
</div>
<div class="sect2">
-<h3 id="_plugin_structure">8.3. Plugin structure</h3>
+<h3 id="_plugin_structure">8.4. Plugin structure</h3>
<div class="paragraph">
<p>Being built on top of Apache Karaf, Unomi leverages OSGi to support plugins. A Unomi plugin is, thus, an OSGi bundle specifying some specific metadata to tell Unomi the kind of entities it provides. A plugin can provide the following entities to extend Unomi, each with its associated definition (as a JSON file), located in a specific spot within the <code>META-INF/cxs/</code> directory of the bundle JAR file:</p>
</div>
@@ -2555,78 +2898,78 @@ doesn’t yet save the context back
</div>
</div>
<div class="sect2">
-<h3 id="_extension_points">8.4. Extension points</h3>
+<h3 id="_extension_points">8.5. Extension points</h3>
<div class="sect3">
-<h4 id="_actiontype">8.4.1. ActionType</h4>
+<h4 id="_actiontype">8.5.1. ActionType</h4>
<div class="paragraph">
<p><code>ActionType`s define new actions that can be used as consequences of Rules being triggered. When a rule triggers, it creates new actions based on the event data and the rule internal processes, providing values for parameters defined in the associated `ActionType</code>. Example actions include: âSet user property x to value yâ or âSend a message to service xâ.</p>
</div>
</div>
<div class="sect3">
-<h4 id="_conditiontype">8.4.2. ConditionType</h4>
+<h4 id="_conditiontype">8.5.2. ConditionType</h4>
<div class="paragraph">
<p>`ConditionType`s define new conditions that can be applied to items (for example to decide whether a rule needs to be triggered or if a profile is considered as taking part in a campaign) or to perform queries against the stored Unomi data. They may be implemented in Java when attempting to define a particularly complex test or one that can better be optimized by coding it. They may also be defined as combination of other conditions. A simple condition could be: âUser is maleâ, while a more generic condition with parameters may test whether a given property has a specific value: âUser property x has value yâ.</p>
</div>
</div>
<div class="sect3">
-<h4 id="_persona">8.4.3. Persona</h4>
+<h4 id="_persona">8.5.3. Persona</h4>
<div class="paragraph">
<p>A persona is a "virtual" profile used to represent categories of profiles, and may also be used to test how a personalized experience would look like using this virtual profile. A persona can define predefined properties and sessions. Persona definition make it possible to âemulateâ a certain type of profile, e.g : US visitor, non-US visitor, etc.</p>
</div>
</div>
<div class="sect3">
-<h4 id="_propertymergestrategytype">8.4.4. PropertyMergeStrategyType</h4>
+<h4 id="_propertymergestrategytype">8.5.4. PropertyMergeStrategyType</h4>
<div class="paragraph">
<p>A strategy to resolve how to merge properties when merging profile together.</p>
</div>
</div>
<div class="sect3">
-<h4 id="_propertytype">8.4.5. PropertyType</h4>
+<h4 id="_propertytype">8.5.5. PropertyType</h4>
<div class="paragraph">
<p>Definition for a profile or session property, specifying how possible values are constrained, if the value is multi-valued (a vector of values as opposed to a scalar value). `PropertyType`s can also be categorized using systemTags or file system structure, using sub-directories to organize definition files.</p>
</div>
</div>
<div class="sect3">
-<h4 id="_rule">8.4.6. Rule</h4>
+<h4 id="_rule">8.5.6. Rule</h4>
<div class="paragraph">
<p>`Rule`s are conditional sets of actions to be executed in response to incoming events. Triggering of rules is guarded by a condition: the rule is only triggered if the associated condition is satisfied. That condition can test the event itself, but also the profile or the session. Once a rule triggers, a list of actions can be performed as consequences. Also, when rules trigger, a specific event is raised so that other parts of Unomi can react accordingly.</p>
</div>
</div>
<div class="sect3">
-<h4 id="_scoring">8.4.7. Scoring</h4>
+<h4 id="_scoring">8.5.7. Scoring</h4>
<div class="paragraph">
<p>`Scoring`s are set of conditions associated with a value to assign to profiles when matching so that the associated users can be scored along that dimension. Each scoring element is evaluated and matching profiles' scores are incremented with the associated value.</p>
</div>
</div>
<div class="sect3">
-<h4 id="_segments">8.4.8. Segments</h4>
+<h4 id="_segments">8.5.8. Segments</h4>
<div class="paragraph">
<p>`Segment`s represent dynamically evaluated groups of similar profiles in order to categorize the associated users. To be considered part of a given segment, users must satisfies the segmentâs condition. If they match, users are automatically added to the segment. Similarly, if at any given point during, they cease to satisfy the segmentâs condition, they are automatically removed from it.</p>
</div>
</div>
<div class="sect3">
-<h4 id="_tag">8.4.9. Tag</h4>
+<h4 id="_tag">8.5.9. Tag</h4>
<div class="paragraph">
<p>`Tag`s are simple labels that are used to classify all other objects inside Unomi.</p>
</div>
</div>
<div class="sect3">
-<h4 id="_valuetype">8.4.10. ValueType</h4>
+<h4 id="_valuetype">8.5.10. ValueType</h4>
<div class="paragraph">
<p>Definition for values that can be assigned to properties ("primitive" types).</p>
</div>
</div>
</div>
<div class="sect2">
-<h3 id="_other_unomi_entities">8.5. Other Unomi entities</h3>
+<h3 id="_other_unomi_entities">8.6. Other Unomi entities</h3>
<div class="sect3">
-<h4 id="_userlist">8.5.1. UserList</h4>
+<h4 id="_userlist">8.6.1. UserList</h4>
<div class="paragraph">
<p>User list are simple static lists of users. The associated profile stores the lists it belongs to in a specific property.</p>
</div>
</div>
<div class="sect3">
-<h4 id="_goal">8.5.2. Goal</h4>
+<h4 id="_goal">8.6.2. Goal</h4>
<div class="paragraph">
<p>Goals represent tracked activities / actions that can be accomplished by site (or more precisely scope) visitors. These are tracked in general because they relate to specific business objectives or are relevant to measure site/scope performance.</p>
</div>
@@ -2637,21 +2980,21 @@ doesn’t yet save the context back
</div>
</div>
<div class="sect3">
-<h4 id="_campaign">8.5.3. Campaign</h4>
+<h4 id="_campaign">8.6.3. Campaign</h4>
<div class="paragraph">
<p>A goal-oriented, time-limited marketing operation that needs to be evaluated for return on investment performance by tracking the ratio of visits to conversions.</p>
</div>
</div>
</div>
<div class="sect2">
-<h3 id="_custom_extensions">8.6. Custom extensions</h3>
+<h3 id="_custom_extensions">8.7. Custom extensions</h3>
<div class="paragraph">
<p>Apache Unomi is a pluggeable server that may be extended in many ways. This document assumes you are familiar with the
<a href="concepts.html">Apache Unomi concepts</a> . This document is mostly a reference document on the different things that may
be used inside an extension. If you are looking for complete samples, please see the <a href="samples.html">samples page</a>.</p>
</div>
<div class="sect3">
-<h4 id="_creating_an_extension">8.6.1. Creating an extension</h4>
+<h4 id="_creating_an_extension">8.7.1. Creating an extension</h4>
<div class="paragraph">
<p>An extension is simply a Maven project, with a Maven pom that looks like this:</p>
</div>
@@ -2709,7 +3052,7 @@ is needed to build your application.</p>
</div>
</div>
<div class="sect3">
-<h4 id="_deployment_and_custom_definition">8.6.2. Deployment and custom definition</h4>
+<h4 id="_deployment_and_custom_definition">8.7.2. Deployment and custom definition</h4>
<div class="paragraph">
<p>When you deploy a custom bundle with a custom definition (see "Predefined xxx" chapters under) for the first time, the definition will automatically be deployed at your bundle start event <strong>if it does not exist</strong>.
After that if you redeploy the same bundle, the definition will not be redeployed, but you can redeploy it manually using the command <code>unomi:deploy-definition <bundleId> <fileName></code> If you need to modify an existing
@@ -2717,7 +3060,7 @@ definition when deploying the module, se
</div>
</div>
<div class="sect3">
-<h4 id="_predefined_segments">8.6.3. Predefined segments</h4>
+<h4 id="_predefined_segments">8.7.3. Predefined segments</h4>
<div class="paragraph">
<p>You may provide pre-defined segments by simply adding a JSON file in the src/main/resources/META-INF/cxs/segments directory of
your Maven project. Here is an example of a pre-defined segment:</p>
@@ -2756,7 +3099,7 @@ that match this condition will be part o
</div>
</div>
<div class="sect3">
-<h4 id="_predefined_rules">8.6.4. Predefined rules</h4>
+<h4 id="_predefined_rules">8.7.4. Predefined rules</h4>
<div class="paragraph">
<p>You may provide pre-defined rules by simply adding a JSON file in the src/main/resources/META-INF/cxs/rules directory of
your Maven project. Here is an example of a pre-defined rule:</p>
@@ -2797,7 +3140,7 @@ You can also see below how custom action
</div>
</div>
<div class="sect3">
-<h4 id="_predefined_properties">8.6.5. Predefined properties</h4>
+<h4 id="_predefined_properties">8.7.5. Predefined properties</h4>
<div class="paragraph">
<p>By default Apache Unomi comes with a set of pre-defined properties, but in many cases it is useful to add additional
predefined property definitions. You can create property definitions for session or profile properties by creating them
@@ -2839,7 +3182,7 @@ in different directories.</p>
</div>
</div>
<div class="sect3">
-<h4 id="_predefined_child_conditions">8.6.6. Predefined child conditions</h4>
+<h4 id="_predefined_child_conditions">8.7.6. Predefined child conditions</h4>
<div class="paragraph">
<p>You can define new predefined conditions that are actually conditions inheriting from a parent condition and setting
pre-defined parameter values. You can do this by creating a JSON file in:</p>
@@ -2880,7 +3223,7 @@ type eventTypeCondition.</p>
</div>
</div>
<div class="sect3">
-<h4 id="_predefined_personas">8.6.7. Predefined personas</h4>
+<h4 id="_predefined_personas">8.7.7. Predefined personas</h4>
<div class="paragraph">
<p>Personas may also be pre-defined by creating JSON files in the following directory:</p>
</div>
@@ -2935,7 +3278,7 @@ type eventTypeCondition.</p>
</div>
</div>
<div class="sect3">
-<h4 id="_custom_actions">8.6.8. Custom actions</h4>
+<h4 id="_custom_actions">8.7.8. Custom actions</h4>
<div class="paragraph">
<p>Custom actions are a powerful way to integrate with external systems by being able to define custom logic that will
be executed by an Apache Unomi rule. An action is defined by a JSON file created in the following directory:</p>
@@ -3010,7 +3353,7 @@ content:</p>
</div>
</div>
<div class="sect3">
-<h4 id="_custom_conditions">8.6.9. Custom conditions</h4>
+<h4 id="_custom_conditions">8.7.9. Custom conditions</h4>
<div class="paragraph">
<p>Custom conditions are different from predefined child conditions because they implement their logic using Java classes.
They are also declared by adding a JSON file into the conditions directory:</p>
@@ -3093,7 +3436,7 @@ definition file.</p>
</div>
</div>
<div class="sect3">
-<h4 id="_migration_patches">8.6.10. Migration patches</h4>
+<h4 id="_migration_patches">8.7.10. Migration patches</h4>
<div class="paragraph">
<p>You may provide patches on any predefined items by simply adding a JSON file in :</p>
</div>
@@ -3226,7 +3569,7 @@ They allow to modify an item, that would
</div>
<div id="footer">
<div id="footer-text">
-Last updated 2018-11-02 16:30:07 CET
+Last updated 2018-11-05 20:32:11 CET
</div>
</div>
</body>
Added: incubator/unomi/website/manual/latest/shell-commands.html
URL: http://svn.apache.org/viewvc/incubator/unomi/website/manual/latest/shell-commands.html?rev=1846523&view=auto
==============================================================================
--- incubator/unomi/website/manual/latest/shell-commands.html (added)
+++ incubator/unomi/website/manual/latest/shell-commands.html Tue Nov 13 16:37:44 2018
@@ -0,0 +1,228 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+<meta charset="UTF-8">
+<!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]-->
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<meta name="generator" content="Asciidoctor 1.5.6.1">
+<title>SSH Shell Commands</title>
+<link rel="stylesheet" href="./apache.css">
+</head>
+<body class="article">
+<div id="header">
+<div id="toc" class="toc">
+<div id="toctitle">Table of Contents</div>
+<ul class="sectlevel2">
+<li><a href="#_ssh_shell_commands">SSH Shell Commands</a></li>
+</ul>
+</div>
+</div>
+<div id="content">
+<div class="sect2">
+<h3 id="_ssh_shell_commands">SSH Shell Commands</h3>
+<div class="paragraph">
+<p>Apache Unomi provides its own Apache Karaf Shell commands to make it easy to control the application
+lifecycle or perform queries or modifications on the internal state of the system.</p>
+</div>
+<div class="paragraph">
+<p>All Apache Unomi-specific commands are namespaced and use the <code>unomi:</code> namespace. You can use the Apache Karaf Shell’s
+autocompletion to list all the commands available.</p>
+</div>
+<div class="sect3">
+<h4 id="_using_the_shell">Using the shell</h4>
+<div class="paragraph">
+<p>You can connect to the Apache Karaf SSH Shell using the following command:</p>
+</div>
+<div class="literalblock">
+<div class="content">
+<pre>ssh -p 8102 karaf@localhost</pre>
+</div>
+</div>
+<div class="paragraph">
+<p>The default username/password is karaf/karaf. You should change this as soon as possible by editing the <code>etc/users.properties</code> file.</p>
+</div>
+<div class="paragraph">
+<p>Once connected you can simply type in :</p>
+</div>
+<div class="literalblock">
+<div class="content">
+<pre>unomi:</pre>
+</div>
+</div>
+<div class="paragraph">
+<p>And hit the <tab> key to see the list of all the available Apache Unomi commands. Note that some commands
+are only available when the application is started.</p>
+</div>
+<div class="paragraph">
+<p>You can also use the <code>help</code> command on any command such as in the following example:</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code>karaf@root()> help unomi:migrate
+DESCRIPTION
+ unomi:migrate
+
+ This will Migrate your date in ES to be compliant with current version
+
+SYNTAX
+ unomi:migrate [fromVersionWithoutSuffix]
+
+ARGUMENTS
+ fromVersionWithoutSuffix
+ Origin version without suffix/qualifier (e.g: 1.2.0)
+ (defaults to 1.2.0)</code></pre>
+</div>
+</div>
+</div>
+<div class="sect3">
+<h4 id="_lifecycle_commands">Lifecycle commands</h4>
+<div class="paragraph">
+<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 spread">
+<caption class="title">Table 1. Table Lifecycle commands</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">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">migrate</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">fromVersion</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">This command must be used only when the Apache Unomi application is NOT STARTED. It will perform migration of the data stored in ElasticSearch using the argument fromVersion as a starting point.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">stop</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">Shutsdown the Apache Unomi application</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">start</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">Starts the Apache Unomi application. Note that this state will be remembered between Apache Karaf launches, so in general it is only needed after a first installation or after a <code>migrate</code> command</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">version</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">Prints out the currently deployed version of the Apache Unomi application inside the Apache Karaf runtime.</p></td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="sect3">
+<h4 id="_runtime_commands">Runtime commands</h4>
+<div class="paragraph">
+<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 spread">
+<caption class="title">Table 2. Table Runtime commands</caption>
+<colgroup>
+<col style="width: 33.3333%;">
+<col style="width: 33.3333%;">
+<col style="width: 33.3334%;">
+</colgroup>
+<tbody>
+<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>
+</tr>
+<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>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">rule-view</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">rule-id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Dumps a single rule in JSON. The rule-id argument can be retrieved from the <code>rule-list</code> command output.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">rule-reset-stats</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">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">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>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">event-view</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">event-id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Dumps a single event in JSON. The <code>event-id</code> can be retrieved from the event-tail command output.</p></td>
+</tr>
+<tr>
+<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>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">action-view</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">action-id</p></td>
+<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">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>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">profile-view</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">profile-id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Dumps a single profile in JSON. The profile-id argument can be retrieved from the <code>profile-list</code> command output.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">segment-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 segments registered in the Apache Unomi 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">segment-view</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">segment-id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Dumps a single segment in JSON. The segment-id argument can be retrieved from the <code>segment-list</code> command output.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">session-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 the last 10 sessions by last event date. 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">session-view</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">session-id</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Dumps a single session in JSON. The session-id argument can be retrieved from the <code>session-list</code>, <code>profile-list</code> or
+ <code>event-tail</code> command output.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">deploy-definition</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">[bundleId] [type] [fileName]</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">This command can be used to force redeployment of definitions from bundles. By default existing definitions will not
+be overriden unless they come from SNAPSHOT bundles. Using this command you can override this mechanism. Here are some
+examples of using this command: <code>unomi:deploy-definition 175 rule *</code> will redeploy all the rules provided by bundle with id 175. If you launch the command without any arguments you will get prompts for what you want to deploy from which bundle</p></td>
+</tr>
+</tbody>
+</table>
+</div>
+</div>
+</div>
+<div id="footer">
+<div id="footer-text">
+Last updated 2018-11-05 18:20:52 CET
+</div>
+</div>
+</body>
+</html>
\ No newline at end of file