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 2017/10/02 08:12:00 UTC
svn commit: r1810306 [19/22] - in /incubator/unomi/website: ./
rest-api-doc/input/ samples/ samples/login-integration-sample/
samples/tweet-button-plugin/ unomi-api/ unomi-api/apidocs/
unomi-api/apidocs/org/apache/unomi/api/ unomi-api/apidocs/org/apach...
Modified: incubator/unomi/website/unomi/issue-tracking.html
URL: http://svn.apache.org/viewvc/incubator/unomi/website/unomi/issue-tracking.html?rev=1810306&r1=1810305&r2=1810306&view=diff
==============================================================================
--- incubator/unomi/website/unomi/issue-tracking.html (original)
+++ incubator/unomi/website/unomi/issue-tracking.html Mon Oct 2 08:11:40 2017
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2017-09-19
+ Generated by Apache Maven Doxia at 2017-10-02
Rendered using Reflow Maven Skin 1.1.1 (http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
@@ -121,7 +121,7 @@
<header>
<div>
<ul class="breadcrumb">
- <li class="publishDate version-date">Last Published: 2017-09-19</li>
+ <li class="publishDate version-date">Last Published: 2017-10-02</li>
</ul>
</div>
</header>
Modified: incubator/unomi/website/unomi/license.html
URL: http://svn.apache.org/viewvc/incubator/unomi/website/unomi/license.html?rev=1810306&r1=1810305&r2=1810306&view=diff
==============================================================================
--- incubator/unomi/website/unomi/license.html (original)
+++ incubator/unomi/website/unomi/license.html Mon Oct 2 08:11:40 2017
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2017-09-19
+ Generated by Apache Maven Doxia at 2017-10-02
Rendered using Reflow Maven Skin 1.1.1 (http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
@@ -121,7 +121,7 @@
<header>
<div>
<ul class="breadcrumb">
- <li class="publishDate version-date">Last Published: 2017-09-19</li>
+ <li class="publishDate version-date">Last Published: 2017-10-02</li>
</ul>
</div>
</header>
Modified: incubator/unomi/website/unomi/mail-lists.html
URL: http://svn.apache.org/viewvc/incubator/unomi/website/unomi/mail-lists.html?rev=1810306&r1=1810305&r2=1810306&view=diff
==============================================================================
--- incubator/unomi/website/unomi/mail-lists.html (original)
+++ incubator/unomi/website/unomi/mail-lists.html Mon Oct 2 08:11:40 2017
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2017-09-19
+ Generated by Apache Maven Doxia at 2017-10-02
Rendered using Reflow Maven Skin 1.1.1 (http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
@@ -122,7 +122,7 @@
<header>
<div>
<ul class="breadcrumb">
- <li class="publishDate version-date">Last Published: 2017-09-19</li>
+ <li class="publishDate version-date">Last Published: 2017-10-02</li>
</ul>
</div>
</header>
Modified: incubator/unomi/website/unomi/plugin-management.html
URL: http://svn.apache.org/viewvc/incubator/unomi/website/unomi/plugin-management.html?rev=1810306&r1=1810305&r2=1810306&view=diff
==============================================================================
--- incubator/unomi/website/unomi/plugin-management.html (original)
+++ incubator/unomi/website/unomi/plugin-management.html Mon Oct 2 08:11:40 2017
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2017-09-19
+ Generated by Apache Maven Doxia at 2017-10-02
Rendered using Reflow Maven Skin 1.1.1 (http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
@@ -122,7 +122,7 @@
<header>
<div>
<ul class="breadcrumb">
- <li class="publishDate version-date">Last Published: 2017-09-19</li>
+ <li class="publishDate version-date">Last Published: 2017-10-02</li>
</ul>
</div>
</header>
Modified: incubator/unomi/website/unomi/plugins.html
URL: http://svn.apache.org/viewvc/incubator/unomi/website/unomi/plugins.html?rev=1810306&r1=1810305&r2=1810306&view=diff
==============================================================================
--- incubator/unomi/website/unomi/plugins.html (original)
+++ incubator/unomi/website/unomi/plugins.html Mon Oct 2 08:11:40 2017
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2017-09-19
+ Generated by Apache Maven Doxia at 2017-10-02
Rendered using Reflow Maven Skin 1.1.1 (http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
@@ -122,7 +122,7 @@
<header>
<div>
<ul class="breadcrumb">
- <li class="publishDate version-date">Last Published: 2017-09-19</li>
+ <li class="publishDate version-date">Last Published: 2017-10-02</li>
</ul>
</div>
</header>
Modified: incubator/unomi/website/unomi/project-info.html
URL: http://svn.apache.org/viewvc/incubator/unomi/website/unomi/project-info.html?rev=1810306&r1=1810305&r2=1810306&view=diff
==============================================================================
--- incubator/unomi/website/unomi/project-info.html (original)
+++ incubator/unomi/website/unomi/project-info.html Mon Oct 2 08:11:40 2017
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2017-09-19
+ Generated by Apache Maven Doxia at 2017-10-02
Rendered using Reflow Maven Skin 1.1.1 (http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
@@ -122,7 +122,7 @@
<header>
<div>
<ul class="breadcrumb">
- <li class="publishDate version-date">Last Published: 2017-09-19</li>
+ <li class="publishDate version-date">Last Published: 2017-10-02</li>
</ul>
</div>
</header>
Modified: incubator/unomi/website/unomi/project-summary.html
URL: http://svn.apache.org/viewvc/incubator/unomi/website/unomi/project-summary.html?rev=1810306&r1=1810305&r2=1810306&view=diff
==============================================================================
--- incubator/unomi/website/unomi/project-summary.html (original)
+++ incubator/unomi/website/unomi/project-summary.html Mon Oct 2 08:11:40 2017
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2017-09-19
+ Generated by Apache Maven Doxia at 2017-10-02
Rendered using Reflow Maven Skin 1.1.1 (http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
@@ -122,7 +122,7 @@
<header>
<div>
<ul class="breadcrumb">
- <li class="publishDate version-date">Last Published: 2017-09-19</li>
+ <li class="publishDate version-date">Last Published: 2017-10-02</li>
</ul>
</div>
</header>
Modified: incubator/unomi/website/unomi/source-repository.html
URL: http://svn.apache.org/viewvc/incubator/unomi/website/unomi/source-repository.html?rev=1810306&r1=1810305&r2=1810306&view=diff
==============================================================================
--- incubator/unomi/website/unomi/source-repository.html (original)
+++ incubator/unomi/website/unomi/source-repository.html Mon Oct 2 08:11:40 2017
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2017-09-19
+ Generated by Apache Maven Doxia at 2017-10-02
Rendered using Reflow Maven Skin 1.1.1 (http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
@@ -121,7 +121,7 @@
<header>
<div>
<ul class="breadcrumb">
- <li class="publishDate version-date">Last Published: 2017-09-19</li>
+ <li class="publishDate version-date">Last Published: 2017-10-02</li>
</ul>
</div>
</header>
Modified: incubator/unomi/website/unomi/team-list.html
URL: http://svn.apache.org/viewvc/incubator/unomi/website/unomi/team-list.html?rev=1810306&r1=1810305&r2=1810306&view=diff
==============================================================================
--- incubator/unomi/website/unomi/team-list.html (original)
+++ incubator/unomi/website/unomi/team-list.html Mon Oct 2 08:11:40 2017
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2017-09-19
+ Generated by Apache Maven Doxia at 2017-10-02
Rendered using Reflow Maven Skin 1.1.1 (http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
@@ -122,7 +122,7 @@
<header>
<div>
<ul class="breadcrumb">
- <li class="publishDate version-date">Last Published: 2017-09-19</li>
+ <li class="publishDate version-date">Last Published: 2017-10-02</li>
</ul>
</div>
</header>
Modified: incubator/unomi/website/usecases.html
URL: http://svn.apache.org/viewvc/incubator/unomi/website/usecases.html?rev=1810306&r1=1810305&r2=1810306&view=diff
==============================================================================
--- incubator/unomi/website/usecases.html (original)
+++ incubator/unomi/website/usecases.html Mon Oct 2 08:11:40 2017
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2017-09-19
+ Generated by Apache Maven Doxia at 2017-10-02
Rendered using Reflow Maven Skin 1.1.1 (http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
@@ -122,7 +122,7 @@
<header>
<div>
<ul class="breadcrumb">
- <li class="publishDate version-date">Last Published: 2017-09-19</li>
+ <li class="publishDate version-date">Last Published: 2017-10-02</li>
</ul>
</div>
</header>
Modified: incubator/unomi/website/versions/1.1/building-and-deploying.html
URL: http://svn.apache.org/viewvc/incubator/unomi/website/versions/1.1/building-and-deploying.html?rev=1810306&r1=1810305&r2=1810306&view=diff
==============================================================================
--- incubator/unomi/website/versions/1.1/building-and-deploying.html (original)
+++ incubator/unomi/website/versions/1.1/building-and-deploying.html Mon Oct 2 08:11:40 2017
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2017-09-19
+ Generated by Apache Maven Doxia at 2017-10-02
Rendered using Reflow Maven Skin 1.1.1 (http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
@@ -122,7 +122,7 @@
<header>
<div>
<ul class="breadcrumb">
- <li class="publishDate version-date">Last Published: 2017-09-19</li>
+ <li class="publishDate version-date">Last Published: 2017-10-02</li>
</ul>
</div>
</header>
Modified: incubator/unomi/website/versions/1.1/clustering.html
URL: http://svn.apache.org/viewvc/incubator/unomi/website/versions/1.1/clustering.html?rev=1810306&r1=1810305&r2=1810306&view=diff
==============================================================================
--- incubator/unomi/website/versions/1.1/clustering.html (original)
+++ incubator/unomi/website/versions/1.1/clustering.html Mon Oct 2 08:11:40 2017
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2017-09-19
+ Generated by Apache Maven Doxia at 2017-10-02
Rendered using Reflow Maven Skin 1.1.1 (http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
@@ -122,7 +122,7 @@
<header>
<div>
<ul class="breadcrumb">
- <li class="publishDate version-date">Last Published: 2017-09-19</li>
+ <li class="publishDate version-date">Last Published: 2017-10-02</li>
</ul>
</div>
</header>
Modified: incubator/unomi/website/versions/1.1/concepts.html
URL: http://svn.apache.org/viewvc/incubator/unomi/website/versions/1.1/concepts.html?rev=1810306&r1=1810305&r2=1810306&view=diff
==============================================================================
--- incubator/unomi/website/versions/1.1/concepts.html (original)
+++ incubator/unomi/website/versions/1.1/concepts.html Mon Oct 2 08:11:40 2017
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2017-09-19
+ Generated by Apache Maven Doxia at 2017-10-02
Rendered using Reflow Maven Skin 1.1.1 (http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
@@ -122,7 +122,7 @@
<header>
<div>
<ul class="breadcrumb">
- <li class="publishDate version-date">Last Published: 2017-09-19</li>
+ <li class="publishDate version-date">Last Published: 2017-10-02</li>
</ul>
</div>
</header>
Modified: incubator/unomi/website/versions/1.1/configuration.html
URL: http://svn.apache.org/viewvc/incubator/unomi/website/versions/1.1/configuration.html?rev=1810306&r1=1810305&r2=1810306&view=diff
==============================================================================
--- incubator/unomi/website/versions/1.1/configuration.html (original)
+++ incubator/unomi/website/versions/1.1/configuration.html Mon Oct 2 08:11:40 2017
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2017-09-19
+ Generated by Apache Maven Doxia at 2017-10-02
Rendered using Reflow Maven Skin 1.1.1 (http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
@@ -122,7 +122,7 @@
<header>
<div>
<ul class="breadcrumb">
- <li class="publishDate version-date">Last Published: 2017-09-19</li>
+ <li class="publishDate version-date">Last Published: 2017-10-02</li>
</ul>
</div>
</header>
Modified: incubator/unomi/website/versions/1.1/getting-started.html
URL: http://svn.apache.org/viewvc/incubator/unomi/website/versions/1.1/getting-started.html?rev=1810306&r1=1810305&r2=1810306&view=diff
==============================================================================
--- incubator/unomi/website/versions/1.1/getting-started.html (original)
+++ incubator/unomi/website/versions/1.1/getting-started.html Mon Oct 2 08:11:40 2017
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2017-09-19
+ Generated by Apache Maven Doxia at 2017-10-02
Rendered using Reflow Maven Skin 1.1.1 (http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
@@ -122,7 +122,7 @@
<header>
<div>
<ul class="breadcrumb">
- <li class="publishDate version-date">Last Published: 2017-09-19</li>
+ <li class="publishDate version-date">Last Published: 2017-10-02</li>
</ul>
</div>
</header>
Added: incubator/unomi/website/versions/1.2/building-and-deploying.html
URL: http://svn.apache.org/viewvc/incubator/unomi/website/versions/1.2/building-and-deploying.html?rev=1810306&view=auto
==============================================================================
--- incubator/unomi/website/versions/1.2/building-and-deploying.html (added)
+++ incubator/unomi/website/versions/1.2/building-and-deploying.html Mon Oct 2 08:11:40 2017
@@ -0,0 +1,482 @@
+
+<!DOCTYPE html>
+<!--
+ Generated by Apache Maven Doxia at 2017-10-02
+ Rendered using Reflow Maven Skin 1.1.1 (http://andriusvelykis.github.io/reflow-maven-skin)
+-->
+<html xml:lang="en" lang="en">
+
+ <head>
+ <meta charset="UTF-8" />
+ <title>Building | Apache Unomi</title>
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="description" content="" />
+ <meta http-equiv="content-language" content="en" />
+
+ <link href="http://netdna.bootstrapcdn.com/twitter-bootstrap/2.3.2/css/bootstrap.min.css" rel="stylesheet" />
+ <link href="../..//css/docs.css" rel="stylesheet" />
+ <link href="../..//css/reflow-skin.css" rel="stylesheet" />
+
+ <link href="http://yandex.st/highlightjs/7.5/styles/github.min.css" rel="stylesheet" />
+
+ <link href="../..//css/lightbox.css" rel="stylesheet" />
+
+ <link href="../..//css/site.css" rel="stylesheet" />
+ <link href="../..//css/print.css" rel="stylesheet" media="print" />
+
+ <!-- Le HTML5 shim, for IE6-8 support of HTML5 elements -->
+ <!--[if lt IE 9]>
+ <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+ <![endif]-->
+
+
+
+ <!-- Google Analytics -->
+ <script type="text/javascript">
+
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-70313240-1']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+
+ </script>
+ </head>
+
+ <body class="page-versions-12-building-and-deploying project-unomi-root" data-spy="scroll" data-offset="60" data-target="#toc-scroll-target">
+
+ <div class="navbar navbar-fixed-top">
+ <div class="navbar-inner">
+ <div class="container">
+ <a class="btn btn-navbar" data-toggle="collapse" data-target="#top-nav-collapse">
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </a>
+ <a class="brand" href="../.."><img src="http://unomi.incubator.apache.org/images/unomi-86x20.png" /></a>
+ <div class="nav-collapse collapse" id="top-nav-collapse">
+ <ul class="nav pull-right">
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Download <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li ><a href="../../download.html" title="Packages">Packages</a></li>
+ <li ><a href="../../license.html" title="License">License</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li ><a href="../../" title="Site Home">Site Home</a></li>
+ <li ><a href="../../main.html" title="Main documentation">Main documentation</a></li>
+ <li ><a href="../../usecases.html" title="More use cases">More use cases</a></li>
+ <li ><a href="../../rest-api-doc/index.html" title="REST API documentation">REST API documentation</a></li>
+ <li ><a href="../../unomi-api/apidocs/index.html" title="API Javadoc">API Javadoc</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Standard <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li ><a href="https://www.oasis-open.org/committees/cxs/" title="OASIS Context Server Technical Committee" class="externalLink">OASIS Context Server Technical Committee</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Privacy <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li ><a href="../../privacy-policy.html" title="Site policy">Site policy</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Contribute <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li ><a href="../../mail-lists.html" title="Mailing lists">Mailing lists</a></li>
+ <li ><a href="../../source-repository.html" title="Source">Source</a></li>
+ <li ><a href="../../issue-tracking.html" title="Issues">Issues</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Community <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li ><a href="../../mail-lists.html" title="Mailing lists">Mailing lists</a></li>
+ <li ><a href="../../team-list.html" title="Team">Team</a></li>
+ <li ><a href="../../maturity-model-report.html" title="Maturity model report card">Maturity model report card</a></li>
+ <li ><a href="http://www.apache.org" title="The Apache Software Foundation" class="externalLink">The Apache Software Foundation</a></li>
+ <li ><a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsorship" class="externalLink">Sponsorship</a></li>
+ <li ><a href="http://www.apache.org/foundation/thanks.html" title="Thanks" class="externalLink">Thanks</a></li>
+ </ul>
+ </li>
+ </ul>
+ </div><!--/.nav-collapse -->
+ </div>
+ </div>
+ </div>
+
+ <div class="container">
+
+ <!-- Masthead
+ ================================================== -->
+
+ <header>
+ <div>
+ <ul class="breadcrumb">
+ <li class="publishDate version-date">Last Published: 2017-10-02</li>
+ </ul>
+ </div>
+ </header>
+
+ <div class="main-body">
+ <div class="row">
+ <div class="span8">
+ <div class="body-content">
+<!-- ~ Licensed to the Apache Software Foundation (ASF) under one or more
+ ~ contributor license agreements. See the NOTICE file distributed with
+ ~ this work for additional information regarding copyright ownership.
+ ~ The ASF licenses this file to You under the Apache License, Version 2.0
+ ~ (the "License"); you may not use this file except in compliance with
+ ~ the License. You may obtain a copy of the License at
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing, software
+ ~ distributed under the License is distributed on an "AS IS" BASIS,
+ ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ~ See the License for the specific language governing permissions and
+ ~ limitations under the License. -->
+<div class="page-header">
+ <h1 id="building">Building</h1>
+</div>
+<div class="section">
+ <h2 id="Initial_Setup">Initial Setup</h2>
+ <p>1) Install J2SE 8.0 SDK (or later), which can be downloaded from <a class="externalLink" href="http://www.oracle.com/technetwork/java/javase/downloads/index.html">http://www.oracle.com/technetwork/java/javase/downloads/index.html</a></p>
+ <p>2) Make sure that your JAVA_HOME environment variable is set to the newly installed JDK location, and that your PATH includes %JAVA_HOME%\bin (windows) or $JAVA_HOME$/bin (unix).</p>
+ <p>3) Install Maven 3.0.3 (or later), which can be downloaded from <a class="externalLink" href="http://maven.apache.org/download.html">http://maven.apache.org/download.html</a>. Make sure that your PATH includes the MVN_HOME/bin directory.</p>
+</div>
+<div class="section">
+ <h2 id="Building">Building</h2>
+ <p>1) Change to the top level directory of Apache Unomi source distribution. 2) Run</p>
+ <div class="source">
+ <div class="source">
+ <pre> $> mvn clean install
+</pre>
+ </div>
+ </div>
+ <p>This will compile Apache Unomi and run all of the tests in the Apache Unomi source distribution. Alternatively, you can run</p>
+ <div class="source">
+ <div class="source">
+ <pre> $> mvn -P \!integration-tests,\!performance-tests clean install
+</pre>
+ </div>
+ </div>
+ <p>This will compile Apache Unomi without running the tests and takes less time to build.</p>
+ <p>3) The distributions will be available under âpackage/targetâ directory.</p>
+</div>
+<div class="section">
+ <h2 id="Installing_an_ElasticSearch_server">Installing an ElasticSearch server</h2>
+ <p>Starting with version 1.2, Apache Unomi no longer embeds an ElasticSearch server as this is no longer supported by the developers of ElasticSearch. Therefore you will need to install a standalone ElasticSearch using the following steps:</p>
+ <ol style="list-style-type: decimal">
+ <li> <p>Download an ElasticSearch 5.x version (5.1.1 or more recent, but not 6.x) from the following site:</p> <p><a class="externalLink" href="https://www.elastic.co/downloads/elasticsearch">https://www.elastic.co/downloads/elasticsearch</a></p></li>
+ <li> <p>Uncompress the downloaded package into a directory and launch the server using</p> <p>bin/elasticsearch (Mac, Linux) bin\elasticsearch.bat (Windows)</p></li>
+ <li> <p>Check that the ElasticSearch is up and running by accessing the following URL : </p> <p><a class="externalLink" href="http://localhost:9200">http://localhost:9200</a> </p></li>
+ </ol>
+</div>
+<div class="section">
+ <h2 id="Deploying_the_generated_binary_package">Deploying the generated binary package</h2>
+ <p>The âpackageâ sub-project generates a pre-configured Apache Karaf installation that is the simplest way to get started. Simply uncompress the package/target/unomi-VERSION.tar.gz (for Linux or Mac OS X) or package/target/unomi-VERSION.zip (for Windows) archive into the directory of your choice.</p>
+ <p>You can then start the server simply by using the command on UNIX/Linux/MacOS X : </p>
+ <div class="source">
+ <div class="source">
+ <pre>./bin/karaf start
+</pre>
+ </div>
+ </div>
+ <p>or on Windows shell : </p>
+ <div class="source">
+ <div class="source">
+ <pre>bin\karaf.bat start
+</pre>
+ </div>
+ </div>
+</div>
+<div class="section">
+ <h2 id="Deploying_into_an_existing_Karaf_server">Deploying into an existing Karaf server</h2>
+ <p>This is only needed if you didnât use the generated package. Also, this is the preferred way to install a development environment if you intend to re-deploy the context server KAR iteratively.</p>
+ <p>Additional requirements: * Apache Karaf 3.x, <a class="externalLink" href="http://karaf.apache.org">http://karaf.apache.org</a></p>
+ <ol style="list-style-type: decimal">
+ <li> <p>Before deploying, make sure that you have Apache Karaf properly installed. You will also have to increase the default maximum memory size and perm gen size by adjusting the following environment values in the bin/setenv(.bat) files (at the end of the file):</p>
+ <div class="source">
+ <div class="source">
+ <pre> MY_DIRNAME=`dirname $0`
+ MY_KARAF_HOME=`cd "$MY_DIRNAME/.."; pwd`
+ export JAVA_MAX_MEM=3G
+ export JAVA_MAX_PERM_MEM=384M
+</pre>
+ </div>
+ </div></li>
+ <li> <p>Install the WAR support, CXF and Karaf Cellar into Karaf by doing the following in the Karaf command line:</p>
+ <div class="source">
+ <div class="source">
+ <pre> feature:repo-add cxf 3.0.2
+ feature:repo-add cellar 3.0.3
+ feature:repo-add mvn:org.apache.unomi/unomi-kar/VERSION/xml/features
+ feature:install unomi-kar
+</pre>
+ </div>
+ </div></li>
+ <li> <p>Create a new $MY_KARAF_HOME/etc/org.apache.cxf.osgi.cfg file and put the following property inside :</p>
+ <div class="source">
+ <div class="source">
+ <pre> org.apache.cxf.servlet.context=/cxs
+</pre>
+ </div>
+ </div></li>
+ <li> <p>If all went smoothly, you should be able to access the context script here : <a class="externalLink" href="http://localhost:8181/cxs/cluster">http://localhost:8181/cxs/cluster</a> . You should be able to login with karaf / karaf and see basic server information. If not something went wrong during the install.</p></li>
+ </ol>
+</div>
+<div class="section">
+ <h2 id="JDK_Selection_on_Mac_OS_X">JDK Selection on Mac OS X</h2>
+ <p>You might need to select the JDK to run the tests in the itests subproject. In order to do so you can list the installed JDKs with the following command : </p>
+ <div class="source">
+ <div class="source">
+ <pre>/usr/libexec/java_home -V
+</pre>
+ </div>
+ </div>
+ <p>which will output something like this : </p>
+ <div class="source">
+ <div class="source">
+ <pre>Matching Java Virtual Machines (7):
+ 1.7.0_51, x86_64: "Java SE 7" /Library/Java/JavaVirtualMachines/jdk1.7.0_51.jdk/Contents/Home
+ 1.7.0_45, x86_64: "Java SE 7" /Library/Java/JavaVirtualMachines/jdk1.7.0_45.jdk/Contents/Home
+ 1.7.0_25, x86_64: "Java SE 7" /Library/Java/JavaVirtualMachines/jdk1.7.0_25.jdk/Contents/Home
+ 1.6.0_65-b14-462, x86_64: "Java SE 6" /Library/Java/JavaVirtualMachines/1.6.0_65-b14-462.jdk/Contents/Home
+ 1.6.0_65-b14-462, i386: "Java SE 6" /Library/Java/JavaVirtualMachines/1.6.0_65-b14-462.jdk/Contents/Home
+ 1.6.0_65-b14-462, x86_64: "Java SE 6" /System/Library/Java/JavaVirtualMachines/1.6.0.jdk/Contents/Home
+ 1.6.0_65-b14-462, i386: "Java SE 6" /System/Library/Java/JavaVirtualMachines/1.6.0.jdk/Contents/Home
+</pre>
+ </div>
+ </div>
+ <p>You can then select the one you want using : </p>
+ <div class="source">
+ <div class="source">
+ <pre>export JAVA_HOME=`/usr/libexec/java_home -v 1.7.0_51`
+</pre>
+ </div>
+ </div>
+ <p>and then check that it was correctly referenced using: </p>
+ <div class="source">
+ <div class="source">
+ <pre>java -version
+</pre>
+ </div>
+ </div>
+ <p>which should give you a result such as this: </p>
+ <div class="source">
+ <div class="source">
+ <pre>java version "1.7.0_51"
+Java(TM) SE Runtime Environment (build 1.7.0_51-b13)
+Java HotSpot(TM) 64-Bit Server VM (build 24.51-b03, mixed mode)
+</pre>
+ </div>
+ </div>
+</div>
+<div class="section">
+ <h2 id="Running_the_integration_tests">Running the integration tests</h2>
+ <p>The integration tests are not executed by default to make build time minimal, but it is recommended to run the integration tests at least once before using the server to make sure that everything is ok in the build. Another way to use these tests is to run them from a continuous integration server such as Jenkins, Apache Gump, Atlassian Bamboo or others. </p>
+ <p>Note : the integration tests require a JDK 7 or more recent !</p>
+ <p>To run the tests simply activate the following profile : </p>
+ <div class="source">
+ <div class="source">
+ <pre>mvn -P integration-tests clean install
+</pre>
+ </div>
+ </div>
+</div>
+<div class="section">
+ <h2 id="Running_the_performance_tests">Running the performance tests</h2>
+ <p>Performance tests are based on Gatling. You need to have a running context server or cluster of servers before executing the tests.</p>
+ <p>Test parameteres are editable in the performance-tests/src/test/scala/unomi/Parameters.scala file. baseUrls should contains the URLs of all your cluster nodes</p>
+ <p>Run the test by using the gatling.conf file in performance-tests/src/test/resources :</p>
+ <div class="source">
+ <div class="source">
+ <pre> export GATLING_CONF=<path>/performance-tests/src/test/resources
+ gatling.sh
+</pre>
+ </div>
+ </div>
+ <p>Reports are generated in performance-tests/target/results.</p>
+</div>
+<div class="section">
+ <h2 id="Testing_with_an_example_page">Testing with an example page</h2>
+ <p>A default test page is provided at the following URL:</p>
+ <div class="source">
+ <div class="source">
+ <pre> http://localhost:8181/index.html
+</pre>
+ </div>
+ </div>
+ <p>This test page will trigger the loading of the /context.js script, which will try to retrieving the user context 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 class="section">
+ <h2 id="Integrating_onto_a_page">Integrating onto a page</h2>
+ <p>Simply reference the context script in your HTML as in the following example:</p>
+ <div class="source">
+ <div class="source">
+ <pre><script type="text/javascript">
+ (function(){ var u=(("https:" == document.location.protocol) ? "https://localhost:8181/" : "http://localhost:8181/");
+ var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; g.type='text/javascript'; g.defer=true; g.async=true; g.src=u+'context.js';
+ s.parentNode.insertBefore(g,s); })();
+</script>
+</pre>
+ </div>
+ </div>
+</div>
+ </div>
+ </div>
+ <div class="span4">
+ <div id="toc-sidebar">
+ <div class="well">
+ <ul class="nav nav-list">
+ <li class="nav-header">Table of Contents</li>
+ <li class="dropdown"><a href="#building" title="Building">Building <b class="caret"></b></a>
+ <ul class="nav nav-list">
+ <li><a href="#Initial_Setup" title="Initial Setup">Initial Setup</a>
+ <li><a href="#Building" title="Building">Building</a>
+ <li><a href="#Installing_an_ElasticSearch_server" title="Installing an ElasticSearch server">Installing an ElasticSearch server</a>
+ <li><a href="#Deploying_the_generated_binary_package" title="Deploying the generated binary package">Deploying the generated binary package</a>
+ <li><a href="#Deploying_into_an_existing_Karaf_server" title="Deploying into an existing Karaf server">Deploying into an existing Karaf server</a>
+ <li><a href="#JDK_Selection_on_Mac_OS_X" title="JDK Selection on Mac OS X">JDK Selection on Mac OS X</a>
+ <li><a href="#Running_the_integration_tests" title="Running the integration tests">Running the integration tests</a>
+ <li><a href="#Running_the_performance_tests" title="Running the performance tests">Running the performance tests</a>
+ <li><a href="#Testing_with_an_example_page" title="Testing with an example page">Testing with an example page</a>
+ <li><a href="#Integrating_onto_a_page" title="Integrating onto a page">Integrating onto a page</a>
+ <li class="divider"></li>
+ </ul>
+ </li>
+ </ul>
+ </div>
+ </div>
+ </div>
+ </div>
+ </div>
+
+ </div><!-- /container -->
+
+ <!-- Footer
+ ================================================== -->
+ <footer class="well">
+ <div class="container">
+ <div class="row">
+ <div class="span2 bottom-nav">
+ <ul class="nav nav-list">
+ <li class="nav-header">Download</li>
+ <li >
+ <a href="../../download.html" title="Packages">Packages</a>
+ </li>
+ <li >
+ <a href="../../license.html" title="License">License</a>
+ </li>
+ <li class="nav-header">Contribute</li>
+ <li >
+ <a href="../../mail-lists.html" title="Mailing lists">Mailing lists</a>
+ </li>
+ <li >
+ <a href="../../source-repository.html" title="Source">Source</a>
+ </li>
+ <li >
+ <a href="../../issue-tracking.html" title="Issues">Issues</a>
+ </li>
+ </ul>
+ </div>
+ <div class="span2 bottom-nav">
+ <ul class="nav nav-list">
+ <li class="nav-header">Documentation</li>
+ <li >
+ <a href="../../" title="Site Home">Site Home</a>
+ </li>
+ <li >
+ <a href="../../main.html" title="Main documentation">Main documentation</a>
+ </li>
+ <li >
+ <a href="../../usecases.html" title="More use cases">More use cases</a>
+ </li>
+ <li >
+ <a href="../../rest-api-doc/index.html" title="REST API documentation">REST API documentation</a>
+ </li>
+ <li >
+ <a href="../../unomi-api/apidocs/index.html" title="API Javadoc">API Javadoc</a>
+ </li>
+ </ul>
+ </div>
+ <div class="span2 bottom-nav">
+ <ul class="nav nav-list">
+ <li class="nav-header">Standard</li>
+ <li >
+ <a href="https://www.oasis-open.org/committees/cxs/" title="OASIS Context Server Technical Committee" class="externalLink">OASIS Context Server Technical Committee</a>
+ </li>
+ <li class="nav-header">Privacy</li>
+ <li >
+ <a href="../../privacy-policy.html" title="Site policy">Site policy</a>
+ </li>
+ <li class="nav-header">Community</li>
+ <li >
+ <a href="../../mail-lists.html" title="Mailing lists">Mailing lists</a>
+ </li>
+ <li >
+ <a href="../../team-list.html" title="Team">Team</a>
+ </li>
+ <li >
+ <a href="../../maturity-model-report.html" title="Maturity model report card">Maturity model report card</a>
+ </li>
+ <li >
+ <a href="http://www.apache.org" title="The Apache Software Foundation" class="externalLink">The Apache Software Foundation</a>
+ </li>
+ <li >
+ <a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsorship" class="externalLink">Sponsorship</a>
+ </li>
+ <li >
+ <a href="http://www.apache.org/foundation/thanks.html" title="Thanks" class="externalLink">Thanks</a>
+ </li>
+ </ul>
+ </div>
+ <div class="span3 bottom-nav">
+ <ul class="nav nav-list">
+ <li class="nav-header">Project Documentation</li>
+ <li >
+ <a href="../../project-info.html" title="Project Information">Project Information <i class="icon-chevron-right"></i></a>
+ </li>
+ </ul>
+ </div>
+ <div class="span3 bottom-description">
+ <blockquote>Powered by Apache Karaf</blockquote>
+ </div>
+ </div>
+ </div>
+ </footer>
+
+ <div class="container subfooter">
+ <div class="row">
+ <div class="span12">
+ <p class="pull-right"><a href="#">Back to top</a></p>
+ <p class="copyright">Copyright ©2014-2017 <a href="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved.</p>
+ <p><a href="http://github.com/andriusvelykis/reflow-maven-skin" title="Reflow Maven skin">Reflow Maven skin</a> by <a href="http://andrius.velykis.lt" target="_blank" title="Andrius Velykis">Andrius Velykis</a>.</p>
+ </div>
+ </div>
+ </div>
+
+ <!-- Le javascript
+ ================================================== -->
+ <!-- Placed at the end of the document so the pages load faster -->
+ <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.1/jquery.min.js"></script>
+
+ <script src="http://netdna.bootstrapcdn.com/twitter-bootstrap/2.3.2/js/bootstrap.min.js"></script>
+ <script src="../..//js/lightbox.min.js"></script>
+ <script src="../..//js/reflow-scroll.js"></script>
+ <script src="http://yandex.st/highlightjs/7.5/highlight.min.js"></script>
+
+ <script src="../..//js/reflow-skin.js"></script>
+
+ </body>
+</html>
\ No newline at end of file
Added: incubator/unomi/website/versions/1.2/clustering.html
URL: http://svn.apache.org/viewvc/incubator/unomi/website/versions/1.2/clustering.html?rev=1810306&view=auto
==============================================================================
--- incubator/unomi/website/versions/1.2/clustering.html (added)
+++ incubator/unomi/website/versions/1.2/clustering.html Mon Oct 2 08:11:40 2017
@@ -0,0 +1,357 @@
+
+<!DOCTYPE html>
+<!--
+ Generated by Apache Maven Doxia at 2017-10-02
+ Rendered using Reflow Maven Skin 1.1.1 (http://andriusvelykis.github.io/reflow-maven-skin)
+-->
+<html xml:lang="en" lang="en">
+
+ <head>
+ <meta charset="UTF-8" />
+ <title>Cluster setup | Apache Unomi</title>
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="description" content="" />
+ <meta http-equiv="content-language" content="en" />
+
+ <link href="http://netdna.bootstrapcdn.com/twitter-bootstrap/2.3.2/css/bootstrap.min.css" rel="stylesheet" />
+ <link href="../..//css/docs.css" rel="stylesheet" />
+ <link href="../..//css/reflow-skin.css" rel="stylesheet" />
+
+ <link href="http://yandex.st/highlightjs/7.5/styles/github.min.css" rel="stylesheet" />
+
+ <link href="../..//css/lightbox.css" rel="stylesheet" />
+
+ <link href="../..//css/site.css" rel="stylesheet" />
+ <link href="../..//css/print.css" rel="stylesheet" media="print" />
+
+ <!-- Le HTML5 shim, for IE6-8 support of HTML5 elements -->
+ <!--[if lt IE 9]>
+ <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+ <![endif]-->
+
+
+
+ <!-- Google Analytics -->
+ <script type="text/javascript">
+
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-70313240-1']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+
+ </script>
+ </head>
+
+ <body class="page-versions-12-clustering project-unomi-root" data-spy="scroll" data-offset="60" data-target="#toc-scroll-target">
+
+ <div class="navbar navbar-fixed-top">
+ <div class="navbar-inner">
+ <div class="container">
+ <a class="btn btn-navbar" data-toggle="collapse" data-target="#top-nav-collapse">
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </a>
+ <a class="brand" href="../.."><img src="http://unomi.incubator.apache.org/images/unomi-86x20.png" /></a>
+ <div class="nav-collapse collapse" id="top-nav-collapse">
+ <ul class="nav pull-right">
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Download <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li ><a href="../../download.html" title="Packages">Packages</a></li>
+ <li ><a href="../../license.html" title="License">License</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li ><a href="../../" title="Site Home">Site Home</a></li>
+ <li ><a href="../../main.html" title="Main documentation">Main documentation</a></li>
+ <li ><a href="../../usecases.html" title="More use cases">More use cases</a></li>
+ <li ><a href="../../rest-api-doc/index.html" title="REST API documentation">REST API documentation</a></li>
+ <li ><a href="../../unomi-api/apidocs/index.html" title="API Javadoc">API Javadoc</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Standard <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li ><a href="https://www.oasis-open.org/committees/cxs/" title="OASIS Context Server Technical Committee" class="externalLink">OASIS Context Server Technical Committee</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Privacy <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li ><a href="../../privacy-policy.html" title="Site policy">Site policy</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Contribute <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li ><a href="../../mail-lists.html" title="Mailing lists">Mailing lists</a></li>
+ <li ><a href="../../source-repository.html" title="Source">Source</a></li>
+ <li ><a href="../../issue-tracking.html" title="Issues">Issues</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Community <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li ><a href="../../mail-lists.html" title="Mailing lists">Mailing lists</a></li>
+ <li ><a href="../../team-list.html" title="Team">Team</a></li>
+ <li ><a href="../../maturity-model-report.html" title="Maturity model report card">Maturity model report card</a></li>
+ <li ><a href="http://www.apache.org" title="The Apache Software Foundation" class="externalLink">The Apache Software Foundation</a></li>
+ <li ><a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsorship" class="externalLink">Sponsorship</a></li>
+ <li ><a href="http://www.apache.org/foundation/thanks.html" title="Thanks" class="externalLink">Thanks</a></li>
+ </ul>
+ </li>
+ </ul>
+ </div><!--/.nav-collapse -->
+ </div>
+ </div>
+ </div>
+
+ <div class="container">
+
+ <!-- Masthead
+ ================================================== -->
+
+ <header>
+ <div>
+ <ul class="breadcrumb">
+ <li class="publishDate version-date">Last Published: 2017-10-02</li>
+ </ul>
+ </div>
+ </header>
+
+ <div class="main-body">
+ <div class="row">
+ <div class="span8">
+ <div class="body-content">
+<!-- ~ Licensed to the Apache Software Foundation (ASF) under one or more
+ ~ contributor license agreements. See the NOTICE file distributed with
+ ~ this work for additional information regarding copyright ownership.
+ ~ The ASF licenses this file to You under the Apache License, Version 2.0
+ ~ (the "License"); you may not use this file except in compliance with
+ ~ the License. You may obtain a copy of the License at
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing, software
+ ~ distributed under the License is distributed on an "AS IS" BASIS,
+ ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ~ See the License for the specific language governing permissions and
+ ~ limitations under the License. -->
+<div class="page-header">
+ <h1 id="cluster_setup">Cluster setup</h1>
+</div>
+<p>Apache Karaf relies on Apache Karaf Cellar, which in turn uses Hazelcast to discover and configure its cluster. You just need to install multiple context servers on the same network, and then (optionally) change the Hazelcast configuration in the following file :</p>
+<div class="source">
+ <div class="source">
+ <pre>etc/hazelcast.xml
+</pre>
+ </div>
+</div>
+<p>All nodes on the same network, sharing the same cluster name will be part of the same cluster.</p>
+<p>For the actual ElasticSearch configuration however, this must be done using the following file:</p>
+<div class="source">
+ <div class="source">
+ <pre>etc/org.apache.unomi.persistence.elasticsearch.cfg
+</pre>
+ </div>
+</div>
+<p>Depending on the cluster size, you will want to adjust the following parameters to make sure your setup is optimal in terms of performance and safety.</p>
+<div class="section">
+ <div class="section">
+ <div class="section">
+ <h4 id="a2_nodes_configuration">2 nodes configuration</h4>
+ <p>One node dedicated to context server, 1 node for elasticsearch storage.</p>
+ <p>Node A :</p>
+ <div class="source">
+ <div class="source">
+ <pre>numberOfReplicas=0
+monthlyIndex.numberOfReplicas=0
+</pre>
+ </div>
+ </div>
+ <p>Node B :</p>
+ <div class="source">
+ <div class="source">
+ <pre>numberOfReplicas=0
+monthlyIndex.numberOfReplicas=0
+</pre>
+ </div>
+ </div>
+ </div>
+ <div class="section">
+ <h4 id="a3_nodes_configuration">3 nodes configuration</h4>
+ <p>One node dedicated to context server, 2 nodes for elasticsearch storage with fault-tolerance</p>
+ <p>Node A :</p>
+ <div class="source">
+ <div class="source">
+ <pre>numberOfReplicas=1
+monthlyIndex.numberOfReplicas=1
+</pre>
+ </div>
+ </div>
+ <p>Node B :</p>
+ <div class="source">
+ <div class="source">
+ <pre>numberOfReplicas=1
+monthlyIndex.numberOfReplicas=1
+</pre>
+ </div>
+ </div>
+ <p>Node C :</p>
+ <div class="source">
+ <div class="source">
+ <pre>numberOfReplicas=1
+monthlyIndex.numberOfReplicas=1
+</pre>
+ </div>
+ </div>
+ </div>
+ </div>
+</div>
+ </div>
+ </div>
+ <div class="span4">
+ <div id="toc-sidebar">
+ <div class="well">
+ <ul class="nav nav-list">
+ <li class="nav-header">Table of Contents</li>
+ <li class="dropdown"><a href="#cluster_setup" title="Cluster setup">Cluster setup <b class="caret"></b></a>
+ <ul class="nav nav-list">
+ <li><a href="#a2_nodes_configuration" title="2 nodes configuration">2 nodes configuration</a>
+ <li><a href="#a3_nodes_configuration" title="3 nodes configuration">3 nodes configuration</a>
+ <li class="divider"></li>
+ </ul>
+ </li>
+ </ul>
+ </div>
+ </div>
+ </div>
+ </div>
+ </div>
+
+ </div><!-- /container -->
+
+ <!-- Footer
+ ================================================== -->
+ <footer class="well">
+ <div class="container">
+ <div class="row">
+ <div class="span2 bottom-nav">
+ <ul class="nav nav-list">
+ <li class="nav-header">Download</li>
+ <li >
+ <a href="../../download.html" title="Packages">Packages</a>
+ </li>
+ <li >
+ <a href="../../license.html" title="License">License</a>
+ </li>
+ <li class="nav-header">Contribute</li>
+ <li >
+ <a href="../../mail-lists.html" title="Mailing lists">Mailing lists</a>
+ </li>
+ <li >
+ <a href="../../source-repository.html" title="Source">Source</a>
+ </li>
+ <li >
+ <a href="../../issue-tracking.html" title="Issues">Issues</a>
+ </li>
+ </ul>
+ </div>
+ <div class="span2 bottom-nav">
+ <ul class="nav nav-list">
+ <li class="nav-header">Documentation</li>
+ <li >
+ <a href="../../" title="Site Home">Site Home</a>
+ </li>
+ <li >
+ <a href="../../main.html" title="Main documentation">Main documentation</a>
+ </li>
+ <li >
+ <a href="../../usecases.html" title="More use cases">More use cases</a>
+ </li>
+ <li >
+ <a href="../../rest-api-doc/index.html" title="REST API documentation">REST API documentation</a>
+ </li>
+ <li >
+ <a href="../../unomi-api/apidocs/index.html" title="API Javadoc">API Javadoc</a>
+ </li>
+ </ul>
+ </div>
+ <div class="span2 bottom-nav">
+ <ul class="nav nav-list">
+ <li class="nav-header">Standard</li>
+ <li >
+ <a href="https://www.oasis-open.org/committees/cxs/" title="OASIS Context Server Technical Committee" class="externalLink">OASIS Context Server Technical Committee</a>
+ </li>
+ <li class="nav-header">Privacy</li>
+ <li >
+ <a href="../../privacy-policy.html" title="Site policy">Site policy</a>
+ </li>
+ <li class="nav-header">Community</li>
+ <li >
+ <a href="../../mail-lists.html" title="Mailing lists">Mailing lists</a>
+ </li>
+ <li >
+ <a href="../../team-list.html" title="Team">Team</a>
+ </li>
+ <li >
+ <a href="../../maturity-model-report.html" title="Maturity model report card">Maturity model report card</a>
+ </li>
+ <li >
+ <a href="http://www.apache.org" title="The Apache Software Foundation" class="externalLink">The Apache Software Foundation</a>
+ </li>
+ <li >
+ <a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsorship" class="externalLink">Sponsorship</a>
+ </li>
+ <li >
+ <a href="http://www.apache.org/foundation/thanks.html" title="Thanks" class="externalLink">Thanks</a>
+ </li>
+ </ul>
+ </div>
+ <div class="span3 bottom-nav">
+ <ul class="nav nav-list">
+ <li class="nav-header">Project Documentation</li>
+ <li >
+ <a href="../../project-info.html" title="Project Information">Project Information <i class="icon-chevron-right"></i></a>
+ </li>
+ </ul>
+ </div>
+ <div class="span3 bottom-description">
+ <blockquote>Powered by Apache Karaf</blockquote>
+ </div>
+ </div>
+ </div>
+ </footer>
+
+ <div class="container subfooter">
+ <div class="row">
+ <div class="span12">
+ <p class="pull-right"><a href="#">Back to top</a></p>
+ <p class="copyright">Copyright ©2014-2017 <a href="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved.</p>
+ <p><a href="http://github.com/andriusvelykis/reflow-maven-skin" title="Reflow Maven skin">Reflow Maven skin</a> by <a href="http://andrius.velykis.lt" target="_blank" title="Andrius Velykis">Andrius Velykis</a>.</p>
+ </div>
+ </div>
+ </div>
+
+ <!-- Le javascript
+ ================================================== -->
+ <!-- Placed at the end of the document so the pages load faster -->
+ <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.1/jquery.min.js"></script>
+
+ <script src="http://netdna.bootstrapcdn.com/twitter-bootstrap/2.3.2/js/bootstrap.min.js"></script>
+ <script src="../..//js/lightbox.min.js"></script>
+ <script src="../..//js/reflow-scroll.js"></script>
+ <script src="http://yandex.st/highlightjs/7.5/highlight.min.js"></script>
+
+ <script src="../..//js/reflow-skin.js"></script>
+
+ </body>
+</html>
\ No newline at end of file
Added: incubator/unomi/website/versions/1.2/concepts.html
URL: http://svn.apache.org/viewvc/incubator/unomi/website/versions/1.2/concepts.html?rev=1810306&view=auto
==============================================================================
--- incubator/unomi/website/versions/1.2/concepts.html (added)
+++ incubator/unomi/website/versions/1.2/concepts.html Mon Oct 2 08:11:40 2017
@@ -0,0 +1,555 @@
+
+<!DOCTYPE html>
+<!--
+ Generated by Apache Maven Doxia at 2017-10-02
+ Rendered using Reflow Maven Skin 1.1.1 (http://andriusvelykis.github.io/reflow-maven-skin)
+-->
+<html xml:lang="en" lang="en">
+
+ <head>
+ <meta charset="UTF-8" />
+ <title>Concepts | Apache Unomi</title>
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta name="description" content="" />
+ <meta http-equiv="content-language" content="en" />
+
+ <link href="http://netdna.bootstrapcdn.com/twitter-bootstrap/2.3.2/css/bootstrap.min.css" rel="stylesheet" />
+ <link href="../..//css/docs.css" rel="stylesheet" />
+ <link href="../..//css/reflow-skin.css" rel="stylesheet" />
+
+ <link href="http://yandex.st/highlightjs/7.5/styles/github.min.css" rel="stylesheet" />
+
+ <link href="../..//css/lightbox.css" rel="stylesheet" />
+
+ <link href="../..//css/site.css" rel="stylesheet" />
+ <link href="../..//css/print.css" rel="stylesheet" media="print" />
+
+ <!-- Le HTML5 shim, for IE6-8 support of HTML5 elements -->
+ <!--[if lt IE 9]>
+ <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+ <![endif]-->
+
+
+
+ <!-- Google Analytics -->
+ <script type="text/javascript">
+
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-70313240-1']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+
+ </script>
+ </head>
+
+ <body class="page-versions-12-concepts project-unomi-root" data-spy="scroll" data-offset="60" data-target="#toc-scroll-target">
+
+ <div class="navbar navbar-fixed-top">
+ <div class="navbar-inner">
+ <div class="container">
+ <a class="btn btn-navbar" data-toggle="collapse" data-target="#top-nav-collapse">
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </a>
+ <a class="brand" href="../.."><img src="http://unomi.incubator.apache.org/images/unomi-86x20.png" /></a>
+ <div class="nav-collapse collapse" id="top-nav-collapse">
+ <ul class="nav pull-right">
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Download <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li ><a href="../../download.html" title="Packages">Packages</a></li>
+ <li ><a href="../../license.html" title="License">License</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Documentation <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li ><a href="../../" title="Site Home">Site Home</a></li>
+ <li ><a href="../../main.html" title="Main documentation">Main documentation</a></li>
+ <li ><a href="../../usecases.html" title="More use cases">More use cases</a></li>
+ <li ><a href="../../rest-api-doc/index.html" title="REST API documentation">REST API documentation</a></li>
+ <li ><a href="../../unomi-api/apidocs/index.html" title="API Javadoc">API Javadoc</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Standard <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li ><a href="https://www.oasis-open.org/committees/cxs/" title="OASIS Context Server Technical Committee" class="externalLink">OASIS Context Server Technical Committee</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Privacy <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li ><a href="../../privacy-policy.html" title="Site policy">Site policy</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Contribute <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li ><a href="../../mail-lists.html" title="Mailing lists">Mailing lists</a></li>
+ <li ><a href="../../source-repository.html" title="Source">Source</a></li>
+ <li ><a href="../../issue-tracking.html" title="Issues">Issues</a></li>
+ </ul>
+ </li>
+ <li class="dropdown">
+ <a href="#" class="dropdown-toggle" data-toggle="dropdown">Community <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li ><a href="../../mail-lists.html" title="Mailing lists">Mailing lists</a></li>
+ <li ><a href="../../team-list.html" title="Team">Team</a></li>
+ <li ><a href="../../maturity-model-report.html" title="Maturity model report card">Maturity model report card</a></li>
+ <li ><a href="http://www.apache.org" title="The Apache Software Foundation" class="externalLink">The Apache Software Foundation</a></li>
+ <li ><a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsorship" class="externalLink">Sponsorship</a></li>
+ <li ><a href="http://www.apache.org/foundation/thanks.html" title="Thanks" class="externalLink">Thanks</a></li>
+ </ul>
+ </li>
+ </ul>
+ </div><!--/.nav-collapse -->
+ </div>
+ </div>
+ </div>
+
+ <div class="container">
+
+ <!-- Masthead
+ ================================================== -->
+
+ <header>
+ <div>
+ <ul class="breadcrumb">
+ <li class="publishDate version-date">Last Published: 2017-10-02</li>
+ </ul>
+ </div>
+ </header>
+
+ <div class="main-body">
+ <div class="row">
+ <div class="span8">
+ <div class="body-content">
+<!-- ~ Licensed to the Apache Software Foundation (ASF) under one or more
+ ~ contributor license agreements. See the NOTICE file distributed with
+ ~ this work for additional information regarding copyright ownership.
+ ~ The ASF licenses this file to You under the Apache License, Version 2.0
+ ~ (the "License"); you may not use this file except in compliance with
+ ~ the License. You may obtain a copy of the License at
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing, software
+ ~ distributed under the License is distributed on an "AS IS" BASIS,
+ ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ~ See the License for the specific language governing permissions and
+ ~ limitations under the License. -->
+<div class="page-header">
+ <h1 id="concepts">Concepts</h1>
+</div>
+<p>Apache Unomi gathers information about users actions, information that is processed and stored by Unomi services. The collected information can then be used to personalize content, derive insights on user behavior, categorize the user profiles into segments along user-definable dimensions or acted upon by algorithms.</p>
+<div class="section">
+ <h2 id="Items_and_types">Items and types</h2>
+ <p>Unomi structures the information it collects using the concept of <tt>Item</tt> which provides the base information (an identifier and a type) the context server needs to process and store the data. Items are persisted according to their type (structure) and identifier (identity). This base structure can be extended, if needed, using properties in the form of key-value pairs.</p>
+ <p>These properties are further defined by the <tt>Item</tt>âs type definition which explicits the <tt>Item</tt>âs structure and semantics. By defining new types, users specify which properties (including the type of values they accept) are available to items of that specific type.</p>
+ <p>Unomi defines default value types: <tt>date</tt>, <tt>email</tt>, <tt>integer</tt> and <tt>string</tt>, all pretty self-explanatory. While you can think of these value types as âprimitiveâ types, it is possible to extend Unomi by providing additional value types.</p>
+ <p>Additionally, most items are also associated to a scope, which is a concept that Unomi uses to group together related items. A given scope is represented in Unomi by a simple string identifier and usually represents an application or set of applications from which Unomi gathers data, depending on the desired analysis granularity. In the context of web sites, a scope could, for example, represent a site or family of related sites being analyzed. Scopes allow clients accessing the context server to filter data to only see relevant data.</p>
+ <p><i>Base <tt>Item</tt> structure:</i></p>
+ <div class="source">
+ <div class="source">
+ <pre>{
+ "itemType": <type of the item>,
+ "scope": <scope>,
+ "itemId": <item identifier>,
+ "properties": <optional properties>
+}
+</pre>
+ </div>
+ </div>
+ <p>Some types can be dynamically defined at runtime by calling to the REST API while other extensions are done via Unomi plugins. Part of extending Unomi, therefore, is a matter of defining new types and specifying which kind of Unomi entity (e.g. profiles) they can be affected to. For example, the following JSON document can be passed to Unomi to declare a new property type identified (and named) <tt>tweetNb</tt>, tagged with the <tt>social</tt> tag, targeting profiles and using the <tt>integer</tt> value type.</p>
+ <p><i>Example JSON type definition:</i></p>
+ <div class="source">
+ <div class="source">
+ <pre>{
+ "itemId": "tweetNb",
+ "itemType": "propertyType",
+ "metadata": {
+ "id": "tweetNb",
+ "name": "tweetNb"
+ },
+ "tags": ["social"],
+ "target": "profiles",
+ "type": "integer"
+}
+</pre>
+ </div>
+ </div>
+ <blockquote>
+ <p>Unomi defines a built-in scope (called <tt>systemscope</tt>) that clients can use to share data across scopes.</p>
+ </blockquote>
+</div>
+<div class="section">
+ <h2 id="Events">Events</h2>
+ <p>Usersâ actions are conveyed from clients to the context server using events. Of course, the required information depends on what is collected and usersâ interactions with the observed systems but events minimally provide a type, a scope and source and target items. Additionally, events are timestamped. Conceptually, an event can be seen as a sentence, the eventâs type being the verb, the source the subject and the target the object.</p>
+ <p><i>Event structure:</i></p>
+ <div class="source">
+ <div class="source">
+ <pre>{
+ "eventType": <type of the event>,
+ "scope": <scope of the event>,
+ "source": <Item>,
+ "target": <Item>,
+ "properties": <optional properties>
+}
+</pre>
+ </div>
+ </div>
+ <p>Source and target can be any Unomi item but are not limited to them. In particular, as long as they can be described using properties and Unomiâs type mechanism and can be processed either natively or via extension plugins, source and target can represent just about anything. Events can also be triggered as part of Unomiâs internal processes for example when a rule is triggered.</p>
+ <p>Events are sent to Unomi from client applications using the JSON format and a typical page view event from a web site could look something like the following:</p>
+ <p><i>Example page view event:</i></p>
+ <div class="source">
+ <div class="source">
+ <pre>{
+ "eventType": "view",
+ "scope": "ACMESPACE",
+ "source": {
+ "itemType": "site",
+ "scope": "ACMESPACE",
+ "itemId": "c4761bbf-d85d-432b-8a94-37e866410375"
+ },
+ "target": {
+ "itemType": "page",
+ "scope": "ACMESPACE",
+ "itemId": "b6acc7b3-6b9d-4a9f-af98-54800ec13a71",
+ "properties": {
+ "pageInfo": {
+ "pageID": "b6acc7b3-6b9d-4a9f-af98-54800ec13a71",
+ "pageName": "Home",
+ "pagePath": "/sites/ACMESPACE/home",
+ "destinationURL": "http://localhost:8080/sites/ACMESPACE/home.html",
+ "referringURL": "http://localhost:8080/",
+ "language": "en"
+ },
+ "category": {},
+ "attributes": {}
+ }
+ }
+}
+</pre>
+ </div>
+ </div>
+</div>
+<div class="section">
+ <h2 id="Profiles">Profiles</h2>
+ <p>By processing events, Unomi progressively builds a picture of who the user is and how they behave. This knowledge is embedded in <tt>Profile</tt> object. A profile is an <tt>Item</tt> with any number of properties and optional segments and scores. Unomi provides default properties to cover common data (name, last name, age, email, etc.) as well as default segments to categorize users. Unomi users are, however, free and even encouraged to create additional properties and segments to better suit their needs.</p>
+ <p>Contrary to other Unomi items, profiles are not part of a scope since we want to be able to track the associated user across applications. For this reason, data collected for a given profile in a specific scope is still available to any scoped item that accesses the profile information.</p>
+ <p>It is interesting to note that there is not necessarily a one to one mapping between users and profiles as users can be captured across applications and different observation contexts. As identifying information might not be available in all contexts in which data is collected, resolving profiles to a single physical user can become complex because physical users are not observed directly. Rather, their portrait is progressively patched together and made clearer as Unomi captures more and more traces of their actions. Unomi will merge related profiles as soon as collected data permits positive association between distinct profiles, usually as a result of the user performing some identifying action in a context where the user hadnât already been positively identified.</p>
+</div>
+<div class="section">
+ <h2 id="Sessions">Sessions</h2>
+ <p>A session represents a time-bounded interaction between a user (via their associated profile) and a Unomi-enabled application. A session represents the sequence of actions the user performed during its duration. For this reason, events are associated with the session during which they occurred. In the context of web applications, sessions are usually linked to HTTP sessions. </p>
+ <h1 id="extending_unomi_via_plugins">Extending Unomi via plugins</h1>
+ <p>Unomi is architected so that users can provided extensions in the form of plugins.</p>
+</div>
+<div class="section">
+ <h2 id="Types_vs_instances">Types vs. instances</h2>
+ <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 class="section">
+ <h2 id="Plugin_structure">Plugin structure</h2>
+ <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 <tt>META-INF/cxs/</tt> directory of the bundle JAR file:</p>
+ <table border="0" class="bodyTable table table-striped table-hover">
+ <thead>
+ <tr class="a">
+ <th>Entity </th>
+ <th>Location in <tt>cxs</tt> directory </th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr class="b">
+ <td>ActionType </td>
+ <td>actions </td>
+ </tr>
+ <tr class="a">
+ <td>ConditionType </td>
+ <td>conditions </td>
+ </tr>
+ <tr class="b">
+ <td>Persona </td>
+ <td>personas </td>
+ </tr>
+ <tr class="a">
+ <td>PropertyMergeStrategyType </td>
+ <td>mergers </td>
+ </tr>
+ <tr class="b">
+ <td>PropertyType </td>
+ <td>properties then profiles or sessions subdirectory then <tt><category name></tt> directory </td>
+ </tr>
+ <tr class="a">
+ <td>Rule </td>
+ <td>rules </td>
+ </tr>
+ <tr class="b">
+ <td>Scoring </td>
+ <td>scorings </td>
+ </tr>
+ <tr class="a">
+ <td>Segment </td>
+ <td>segments </td>
+ </tr>
+ <tr class="b">
+ <td>Tag </td>
+ <td>tags then <tt><category name></tt> directory </td>
+ </tr>
+ <tr class="a">
+ <td>ValueType </td>
+ <td>values </td>
+ </tr>
+ </tbody>
+ </table>
+ <p><a class="externalLink" href="http://aries.apache.org/modules/blueprint.html">Blueprint</a> is used to declare what the plugin provides and inject any required dependency. The Blueprint file is located, as usual, at <tt>OSGI-INF/blueprint/blueprint.xml</tt> in the bundle JAR file.</p>
+ <p>The plugin otherwise follows a regular maven project layout and should depend on the Unomi API maven artifact:</p>
+ <div class="source">
+ <div class="source">
+ <pre><dependency>
+ <groupId>org.apache.unomi</groupId>
+ <artifactId>unomi-api</artifactId>
+ <version>...</version>
+</dependency>
+</pre>
+ </div>
+ </div>
+ <p>Some plugins consists only of JSON definitions that are used to instantiate the appropriate structures at runtime while some more involved plugins provide code that extends Unomi in deeper ways.</p>
+ <p>In both cases, plugins can provide more that one type of extension. For example, a plugin could provide both <tt>ActionType</tt>s and <tt>ConditionType</tt>s.</p>
+</div>
+<div class="section">
+ <h2 id="Extension_points">Extension points</h2>
+ <div class="section">
+ <h3 id="ActionType">ActionType</h3>
+ <p><tt>ActionType</tt>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 <tt>ActionType</tt>. Example actions include: âSet user property x to value yâ or âSend a message to service xâ.</p>
+ </div>
+ <div class="section">
+ <h3 id="ConditionType">ConditionType</h3>
+ <p><tt>ConditionType</tt>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 class="section">
+ <h3 id="Persona">Persona</h3>
+ <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 class="section">
+ <h3 id="PropertyMergeStrategyType">PropertyMergeStrategyType</h3>
+ <p>A strategy to resolve how to merge properties when merging profile together.</p>
+ </div>
+ <div class="section">
+ <h3 id="PropertyType">PropertyType</h3>
+ <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). <tt>PropertyType</tt>s can also be categorized using tags or file system structure, using sub-directories to organize definition files.</p>
+ </div>
+ <div class="section">
+ <h3 id="Rule">Rule</h3>
+ <p><tt>Rule</tt>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 class="section">
+ <h3 id="Scoring">Scoring</h3>
+ <p><tt>Scoring</tt>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 class="section">
+ <h3 id="Segments">Segments</h3>
+ <p><tt>Segment</tt>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 class="section">
+ <h3 id="Tag">Tag</h3>
+ <p><tt>Tag</tt>s are simple labels that are used to classify all other objects inside Unomi. Tags can define sub-tags.</p>
+ </div>
+ <div class="section">
+ <h3 id="ValueType">ValueType</h3>
+ <p>Definition for values that can be assigned to properties (âprimitiveâ types).</p>
+ </div>
+</div>
+<div class="section">
+ <h2 id="Other_Unomi_entities">Other Unomi entities</h2>
+ <div class="section">
+ <h3 id="UserList">UserList</h3>
+ <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 class="section">
+ <h3 id="Goal">Goal</h3>
+ <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>
+ <p>Goals can be defined at the scope level or in the context of a particular <tt>Campaign</tt>. Either types of goals behave exactly the same way with the exception of two notable differences: - duration: scope-level goals are considered until removed while campaign-level goals are only considered for the campaign duration - audience filtering: any visitor is considered for scope-level goals while campaign-level goals only consider visitors who match the campaignâs conditions</p>
+ </div>
+ <div class="section">
+ <h3 id="Campaign">Campaign</h3>
+ <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>
+ <div class="span4">
+ <div id="toc-sidebar">
+ <div class="well">
+ <ul class="nav nav-list">
+ <li class="nav-header">Table of Contents</li>
+ <li class="dropdown"><a href="#concepts" title="Concepts">Concepts <b class="caret"></b></a>
+ <ul class="nav nav-list">
+ <li><a href="#Items_and_types" title="Items and types">Items and types</a>
+ <li><a href="#Events" title="Events">Events</a>
+ <li><a href="#Profiles" title="Profiles">Profiles</a>
+ <li><a href="#Sessions" title="Sessions">Sessions</a>
+ <li class="divider"></li>
+ </ul>
+ </li>
+ <li class="dropdown"><a href="#extending_unomi_via_plugins" title="Extending Unomi via plugins">Extending Unomi via plugins <b class="caret"></b></a>
+ <ul class="nav nav-list">
+ <li><a href="#Types_vs_instances" title="Types vs. instances">Types vs. instances</a>
+ <li><a href="#Plugin_structure" title="Plugin structure">Plugin structure</a>
+ <li class="dropdown"><a href="#Extension_points" title="Extension points">Extension points <b class="caret"></b></a>
+ <ul class="nav nav-list">
+ <li><a href="#ActionType" title="ActionType">ActionType</a>
+ <li><a href="#ConditionType" title="ConditionType">ConditionType</a>
+ <li><a href="#Persona" title="Persona">Persona</a>
+ <li><a href="#PropertyMergeStrategyType" title="PropertyMergeStrategyType">PropertyMergeStrategyType</a>
+ <li><a href="#PropertyType" title="PropertyType">PropertyType</a>
+ <li><a href="#Rule" title="Rule">Rule</a>
+ <li><a href="#Scoring" title="Scoring">Scoring</a>
+ <li><a href="#Segments" title="Segments">Segments</a>
+ <li><a href="#Tag" title="Tag">Tag</a>
+ <li><a href="#ValueType" title="ValueType">ValueType</a>
+ <li class="divider"></li>
+ </ul>
+ </li>
+ <li class="dropdown"><a href="#Other_Unomi_entities" title="Other Unomi entities">Other Unomi entities <b class="caret"></b></a>
+ <ul class="nav nav-list">
+ <li><a href="#UserList" title="UserList">UserList</a>
+ <li><a href="#Goal" title="Goal">Goal</a>
+ <li><a href="#Campaign" title="Campaign">Campaign</a>
+ <li class="divider"></li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+ </ul>
+ </div>
+ </div>
+ </div>
+ </div>
+ </div>
+
+ </div><!-- /container -->
+
+ <!-- Footer
+ ================================================== -->
+ <footer class="well">
+ <div class="container">
+ <div class="row">
+ <div class="span2 bottom-nav">
+ <ul class="nav nav-list">
+ <li class="nav-header">Download</li>
+ <li >
+ <a href="../../download.html" title="Packages">Packages</a>
+ </li>
+ <li >
+ <a href="../../license.html" title="License">License</a>
+ </li>
+ <li class="nav-header">Contribute</li>
+ <li >
+ <a href="../../mail-lists.html" title="Mailing lists">Mailing lists</a>
+ </li>
+ <li >
+ <a href="../../source-repository.html" title="Source">Source</a>
+ </li>
+ <li >
+ <a href="../../issue-tracking.html" title="Issues">Issues</a>
+ </li>
+ </ul>
+ </div>
+ <div class="span2 bottom-nav">
+ <ul class="nav nav-list">
+ <li class="nav-header">Documentation</li>
+ <li >
+ <a href="../../" title="Site Home">Site Home</a>
+ </li>
+ <li >
+ <a href="../../main.html" title="Main documentation">Main documentation</a>
+ </li>
+ <li >
+ <a href="../../usecases.html" title="More use cases">More use cases</a>
+ </li>
+ <li >
+ <a href="../../rest-api-doc/index.html" title="REST API documentation">REST API documentation</a>
+ </li>
+ <li >
+ <a href="../../unomi-api/apidocs/index.html" title="API Javadoc">API Javadoc</a>
+ </li>
+ </ul>
+ </div>
+ <div class="span2 bottom-nav">
+ <ul class="nav nav-list">
+ <li class="nav-header">Standard</li>
+ <li >
+ <a href="https://www.oasis-open.org/committees/cxs/" title="OASIS Context Server Technical Committee" class="externalLink">OASIS Context Server Technical Committee</a>
+ </li>
+ <li class="nav-header">Privacy</li>
+ <li >
+ <a href="../../privacy-policy.html" title="Site policy">Site policy</a>
+ </li>
+ <li class="nav-header">Community</li>
+ <li >
+ <a href="../../mail-lists.html" title="Mailing lists">Mailing lists</a>
+ </li>
+ <li >
+ <a href="../../team-list.html" title="Team">Team</a>
+ </li>
+ <li >
+ <a href="../../maturity-model-report.html" title="Maturity model report card">Maturity model report card</a>
+ </li>
+ <li >
+ <a href="http://www.apache.org" title="The Apache Software Foundation" class="externalLink">The Apache Software Foundation</a>
+ </li>
+ <li >
+ <a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsorship" class="externalLink">Sponsorship</a>
+ </li>
+ <li >
+ <a href="http://www.apache.org/foundation/thanks.html" title="Thanks" class="externalLink">Thanks</a>
+ </li>
+ </ul>
+ </div>
+ <div class="span3 bottom-nav">
+ <ul class="nav nav-list">
+ <li class="nav-header">Project Documentation</li>
+ <li >
+ <a href="../../project-info.html" title="Project Information">Project Information <i class="icon-chevron-right"></i></a>
+ </li>
+ </ul>
+ </div>
+ <div class="span3 bottom-description">
+ <blockquote>Powered by Apache Karaf</blockquote>
+ </div>
+ </div>
+ </div>
+ </footer>
+
+ <div class="container subfooter">
+ <div class="row">
+ <div class="span12">
+ <p class="pull-right"><a href="#">Back to top</a></p>
+ <p class="copyright">Copyright ©2014-2017 <a href="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved.</p>
+ <p><a href="http://github.com/andriusvelykis/reflow-maven-skin" title="Reflow Maven skin">Reflow Maven skin</a> by <a href="http://andrius.velykis.lt" target="_blank" title="Andrius Velykis">Andrius Velykis</a>.</p>
+ </div>
+ </div>
+ </div>
+
+ <!-- Le javascript
+ ================================================== -->
+ <!-- Placed at the end of the document so the pages load faster -->
+ <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.1/jquery.min.js"></script>
+
+ <script src="http://netdna.bootstrapcdn.com/twitter-bootstrap/2.3.2/js/bootstrap.min.js"></script>
+ <script src="../..//js/lightbox.min.js"></script>
+ <script src="../..//js/reflow-scroll.js"></script>
+ <script src="http://yandex.st/highlightjs/7.5/highlight.min.js"></script>
+
+ <script src="../..//js/reflow-skin.js"></script>
+
+ </body>
+</html>
\ No newline at end of file