| <!doctype html> |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8"> |
| <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> |
| <meta name="description" content=""> |
| <meta name="author" content=""> |
| <link rel="icon" href="images/favicon.ico"> |
| |
| <title>Apache Unomi™ Open Source Customer Data Platform | Documentation </title> |
| |
| <!-- Google Analytics --> |
| <script> |
| (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ |
| (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), |
| m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) |
| })(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); |
| |
| ga('create', 'UA-70313240-1', 'auto'); |
| ga('send', 'pageview'); |
| </script> |
| <!-- End Google Analytics --> |
| |
| <!-- Bootstrap core CSS --> |
| <link href="css/bootstrap.min.css" rel="stylesheet"> |
| <!-- Fontawesome CSS CDN --> |
| <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.0.13/css/all.css" integrity="sha384-DNOHZ68U8hZfKXOrtjWvjxusGo9WQnrNx2sqG0tfsghAvtVlRW3tvkXWZh58N9jp" crossorigin="anonymous"> |
| <!-- Custom styles for this template --> |
| <link href="css/unomi.css" rel="stylesheet"> |
| </head> |
| <body> |
| |
| <header> |
| <nav class="navbar navbar-expand-md navbar-light bg-white fixed-top border-bottom box-shadow"> |
| <div class="container"> |
| <a class="navbar-brand" href="index.html"> |
| <img src="images/unomi-86x20.png" alt="Logo Apache Unomi"/> |
| </a> |
| <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarCollapse" |
| aria-controls="navbarCollapse" aria-expanded="false" aria-label="Toggle navigation"> |
| <span class="navbar-toggler-icon"></span> |
| </button> |
| <div class="collapse navbar-collapse justify-content-end" id="navbarCollapse"> |
| <div> |
| <ul class="navbar-nav mr-auto align-items-center text-uppercase"> |
| <li class="nav-item"> |
| <a class="nav-link" href="get-started.html">Get started</a> |
| </li> |
| <li class="nav-item"> |
| <a class="nav-link" href="use-cases.html">Use cases</a> |
| </li> |
| <li class="nav-item"> |
| <a class="nav-link" href="download.html">Download</a> |
| </li> |
| <li class="nav-item active"> |
| <a class="nav-link" href="documentation.html">Documentation <span class="sr-only">(current)</span></a> |
| </li> |
| <li class="nav-item"> |
| <a class="nav-link" href="resources.html">Resources</a> |
| </li> |
| <li class="nav-item"> |
| <a class="nav-link" href="contribute.html">Contribute</a> |
| </li> |
| <li class="nav-item"> |
| <a class="nav-link" href="community.html">Community</a> |
| </li> |
| <li class="nav-item"> |
| <a class="nav-link disabled" target="_blank" href="https://www.apache.org"> |
| <img src="images/apache-feather-tm-new.png" alt="Logo Apache Feather"/> |
| </a> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| </nav> |
| </header> |
| |
| <div class="container mb-5 pt-5"> |
| <h2 class="pb-2 mb-2 border-bottom">Documentation</h2> |
| |
| <h4 class="pt-4 mt-2 text-dark">Released versions</h4> |
| |
| <div class="row mb-2"> |
| <div class="col-md-4"> |
| <div class="card flex-md-row mb-4 box-shadow h-md-250"> |
| <div class="card-body d-flex flex-column align-items-start"> |
| <strong class="d-inline-block mb-2 text-success"><i class="fas fa-circle"></i> Latest</strong> |
| <h3 class="mb-0 text-dark">Unomi <span class="text-muted">1.3.0-incubating</span></h3> |
| <div class="mb-1 text-muted">Last update: September 10, 2018</div> |
| <p class="card-text"> |
| <a href="manual/1_3_x/index.html">online</a><br> |
| <a target="_blank" href="https://dist.apache.org/repos/dist/release/incubator/unomi/1.3.0-incubating/unomi-manual-1_3_x.zip">html</a> |
| [ <a target="_blank" href="https://archive.apache.org/dist/incubator/unomi/1.3.0-incubating/unomi-manual-1_3_x.zip.asc">PGP</a> | |
| <a target="_blank" href="https://archive.apache.org/dist/incubator/unomi/1.3.0-incubating/unomi-manual-1_3_x.zip.sha512">SHA512</a> ]<br> |
| <a target="_blank" href="https://dist.apache.org/repos/dist/release/incubator/unomi/1.3.0-incubating/unomi-manual-1_3_x.pdf">pdf</a> |
| [ <a target="_blank" href="https://archive.apache.org/dist/incubator/unomi/1.3.0-incubating/unomi-manual-1_3_x.pdf.asc">PGP</a> | |
| <a target="_blank" href="https://archive.apache.org/dist/incubator/unomi/1.3.0-incubating/unomi-manual-1_3_x.pdf.sha512">SHA512</a> ] |
| </p> |
| </div> |
| </div> |
| </div> |
| <div class="col-md-4"> |
| <div class="card flex-md-row mb-4 box-shadow h-md-250"> |
| <div class="card-body d-flex flex-column align-items-start"> |
| <strong class="d-inline-block mb-2 text-info"><i class="fas fa-circle"></i> Archive</strong> |
| <h3 class="mb-0 text-dark">Unomi <span class="text-muted">1.2.0-incubating</span></h3> |
| <div class="mb-1 text-muted">Last update: September 28, 2017</div> |
| <p class="card-text"> |
| <a href="manual/1_2_x/index.html">online</a><br> |
| <a target="_blank" href="https://dist.apache.org/repos/dist/release/incubator/unomi/1.2.0-incubating/unomi-manual-1_2_x.zip">html</a> |
| [ <a target="_blank" href="https://archive.apache.org/dist/incubator/unomi/1.2.0-incubating/unomi-manual-1_2_x.zip.asc">PGP</a> | |
| <a target="_blank" href="https://archive.apache.org/dist/incubator/unomi/1.2.0-incubating/unomi-manual-1_2_x.zip.sha512">SHA512</a> ]<br> |
| <a target="_blank" href="https://dist.apache.org/repos/dist/release/incubator/unomi/1.2.0-incubating/unomi-manual-1_2_x.pdf">pdf</a> |
| [ <a target="_blank" href="https://archive.apache.org/dist/incubator/unomi/1.2.0-incubating/unomi-manual-1_2_x.pdf.asc">PGP</a> | |
| <a target="_blank" href="https://archive.apache.org/dist/incubator/unomi/1.2.0-incubating/unomi-manual-1_2_x.pdf.sha512">SHA512</a> ] |
| </p> |
| </div> |
| </div> |
| </div> |
| <div class="col-md-4"> |
| <div class="card flex-md-row mb-4 box-shadow h-md-250"> |
| <div class="card-body d-flex flex-column align-items-start"> |
| <strong class="d-inline-block mb-2 text-info"><i class="fas fa-circle"></i> Archive</strong> |
| <h3 class="mb-0 text-dark">Unomi <span class="text-muted">1.1.0-incubating</span></h3> |
| <div class="mb-1 text-muted">Last update: October 23, 2017</div> |
| <p class="card-text"> |
| <a href="manual/1_1_x/index.html">online</a><br> |
| <a target="_blank" href="https://dist.apache.org/repos/dist/release/incubator/unomi/1.1.0-incubating/unomi-manual-1_1_x.zip">html</a> |
| [ <a target="_blank" href="https://archive.apache.org/dist/incubator/unomi/1.1.0-incubating/unomi-manual-1_1_x.zip.asc">PGP</a> | |
| <a target="_blank" href="https://archive.apache.org/dist/incubator/unomi/1.1.0-incubating/unomi-manual-1_1_x.zip.sha512">SHA512</a> ]<br> |
| <a target="_blank" href="https://dist.apache.org/repos/dist/release/incubator/unomi/1.1.0-incubating/unomi-manual-1_1_x.pdf">pdf</a> |
| [ <a target="_blank" href="https://archive.apache.org/dist/incubator/unomi/1.1.0-incubating/unomi-manual-1_1_x.pdf.asc">PGP</a> | |
| <a target="_blank" href="https://archive.apache.org/dist/incubator/unomi/1.1.0-incubating/unomi-manual-1_1_x.pdf.sha512">SHA512</a> ] |
| </p> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <h4 class="pt-4 mt-2 text-dark">In development</h4> |
| |
| <div class="row mb-2"> |
| <div class="col-md-4"> |
| <div class="card flex-md-row mb-4 box-shadow h-md-250"> |
| <div class="card-body d-flex flex-column align-items-start"> |
| <strong class="d-inline-block mb-2 text-warning"><i class="fas fa-circle"></i> Current</strong> |
| <h3 class="mb-0 text-dark">Unomi <span class="text-muted">1.4.0-incubating-SNAPSHOT</span></h3> |
| <p class="card-text"> |
| <a href="manual/latest/index.html">online</a><br> |
| </p> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <main> |
| |
| <!-- Marketing messaging and featurettes |
| ================================================== --> |
| <!-- Wrap the rest of the page in another container to center all the content. --> |
| <div class="container"> |
| |
| <!-- Migrating ES --> |
| <div class="row mb-5 mt-5"> |
| <div class="col"> |
| <h2 class="pb-3 border-bottom">API Documentation</h2> |
| <h3 class="pt-3 pb-2 text-dark">Javadoc</h3> |
| <p>Click <a class="btn-link" target="_blank" |
| href="https://unomi.incubator.apache.org/unomi-api/apidocs/index.html">here</a> to view the Javadoc documentation</p> |
| |
| <h4 class="pt-4 pb-2 text-dark">REST</h4> |
| |
| <table class="table table-striped table-sm"> |
| <thead class="thead-dark"> |
| <th>Name</th> |
| <th>Description</th> |
| <th>REST API Documentation</th> |
| <th>Since version</th> |
| <th class="text-center">Status</th> |
| </thead> |
| <tbody> |
| <tr> |
| <td><strong>userList</strong></td> |
| <td>Manage user</td> |
| <td><a href="https://unomi.incubator.apache.org/rest-api-doc/index.html#568140055" target="_blank">view</a></td> |
| <td>1.3.0-incubating</td> |
| <td class="text-center"><strong class="d-inline-block mb-2 text-success"><i class="fas fa-circle"></i></strong> |
| </tr> |
| <tr> |
| <td><strong>campaigns</strong></td> |
| <td>Manage campaign</td> |
| <td><a href="https://unomi.incubator.apache.org/rest-api-doc/#-241880339" target="_blank">view</a></td> |
| <td>1.3.0-incubating</td> |
| <td class="text-center"><strong class="d-inline-block mb-2 text-success"><i class="fas fa-circle"></i></strong> |
| </tr> |
| <tr> |
| <td><strong>cluster</strong></td> |
| <td>Manage cluster</td> |
| <td><a href="https://unomi.incubator.apache.org/rest-api-doc/#1007094421" target="_blank">view</a></td> |
| <td>1.3.0-incubating</td> |
| <td class="text-center"><strong class="d-inline-block mb-2 text-success"><i class="fas fa-circle"></i></strong> |
| </tr> |
| <tr> |
| <td><strong>definitions</strong></td> |
| <td>Manage definitions</td> |
| <td><a href="https://unomi.incubator.apache.org/rest-api-doc/#1834364863" target="_blank">view</a></td> |
| <td>1.3.0-incubating</td> |
| <td class="text-center"><strong class="d-inline-block mb-2 text-success"><i class="fas fa-circle"></i></strong> |
| </tr> |
| <tr> |
| <td><strong>goals</strong></td> |
| <td>Manage goal</td> |
| <td><a href="https://unomi.incubator.apache.org/rest-api-doc/#-379780403" target="_blank">view</a></td> |
| <td>1.3.0-incubating</td> |
| <td class="text-center"><strong class="d-inline-block mb-2 text-success"><i class="fas fa-circle"></i></strong> |
| </tr> |
| <tr> |
| <td><strong>profile</strong></td> |
| <td>Manage profile</td> |
| <td><a href="https://unomi.incubator.apache.org/rest-api-doc/#-1907885015" target="_blank">view</a></td> |
| <td>1.3.0-incubating</td> |
| <td class="text-center"><strong class="d-inline-block mb-2 text-success"><i class="fas fa-circle"></i></strong> |
| </tr> |
| <tr> |
| <td><strong>query</strong></td> |
| <td>Manage query</td> |
| <td><a href="https://unomi.incubator.apache.org/rest-api-doc/#371361199" target="_blank">view</a></td> |
| <td>1.3.0-incubating</td> |
| <td class="text-center"><strong class="d-inline-block mb-2 text-success"><i class="fas fa-circle"></i></strong> |
| </tr> |
| <tr> |
| <td><strong>rules</strong></td> |
| <td>Manage rule</td> |
| <td><a href="https://unomi.incubator.apache.org/rest-api-doc/#-1505954579" target="_blank">view</a></td> |
| <td>1.3.0-incubating</td> |
| <td class="text-center"><strong class="d-inline-block mb-2 text-success"><i class="fas fa-circle"></i></strong> |
| </tr> |
| <tr> |
| <td><strong>scoring</strong></td> |
| <td>Manage scoring</td> |
| <td><a href="https://unomi.incubator.apache.org/rest-api-doc/#-1379828888" target="_blank">view</a></td> |
| <td>1.3.0-incubating</td> |
| <td class="text-center"><strong class="d-inline-block mb-2 text-success"><i class="fas fa-circle"></i></strong> |
| </tr> |
| <tr> |
| <td><strong>segments</strong></td> |
| <td>Manage segment</td> |
| <td><a href="https://unomi.incubator.apache.org/rest-api-doc/#1558745832" target="_blank">view</a></td> |
| <td>1.3.0-incubating</td> |
| <td class="text-center"><strong class="d-inline-block mb-2 text-success"><i class="fas fa-circle"></i></strong> |
| </tr> |
| <tr> |
| <td><strong>patches</strong></td> |
| <td>Manage patch</td> |
| <td><a href="https://unomi.incubator.apache.org/rest-api-doc/#943335618" target="_blank">view</a></td> |
| <td>1.4.0-incubating-SNAPSHOT</td> |
| <td class="text-center"><strong class="d-inline-block mb-2 text-warning"><i class="fas fa-circle"></i></strong> |
| </tr> |
| <tr> |
| <td><strong>events</strong></td> |
| <td>Manage event</td> |
| <td><a href="https://unomi.incubator.apache.org/rest-api-doc/#1768188821" target="_blank">view</a></td> |
| <td>1.4.0-incubating-SNAPSHOT</td> |
| <td class="text-center"><strong class="d-inline-block mb-2 text-warning"><i class="fas fa-circle"></i></strong> |
| </tr> |
| </tbody> |
| </table> |
| </div><!-- /.blog-main --> |
| </div> |
| |
| <!-- Migrating ES --> |
| <div class="row mb-5 mt-5"> |
| <div class="col"> |
| <h2 class="pb-3 mb-3 border-bottom">Migrating ElasticSearch</h2> |
| <h3 class="mb-3 text-dark">Introduction</h3> |
| <p> |
| In this section of the documentation we will explain some general notions of how to migrate between ElasticSearch versions, as well as present specific migration steps to migrate from one version of ElasticSearch used by Apache Unomi to another, if it is needed. |
| </p> |
| |
| <h3 class="pt-3 mb-3 text-dark">General steps and notions</h3> |
| <p> |
| Depending on the type of ElasticSearch install you may have, the migration steps will differ. Basically when dealing with a single node (standalone) installation, a simple procedure may be used that simply copies some directories over, while in the case of a cluster installation ElasticSearch Snapshot and Restore functionality must be used. |
| </p> |
| <h4 class="mb-2">Standalone (one node migration)</h4> |
| <p> |
| In the case of a standalone install, it is generally sufficient, provided the versions are compatible (meaning that only one major version seperates the two installs), to simply copy over the data directory over to the new version. Also you will need to make sure that you copy over any custom settings from the <code>config/elasticsearch.yml</code> file over to the new version. |
| </p> |
| <h4 class="mb-2">Cluster migration</h4> |
| <p> |
| Here we recommend you read the <a target="_blank" href="https://www.elastic.co/guide/en/elasticsearch/reference/current/setup-upgrade.html">official upgrading documentation</a>. |
| </p> |
| |
| <h3 class="pt-3 mb-3 text-dark">Migrating between versions used by Apache Unomi.</h3> |
| <h4 class="mb-2">Cluster migration</h4> |
| <p> |
| Steps: |
| </p> |
| <ol> |
| <li>Depending on your install, perform either the standalone or cluster migration</li> |
| <li>That’s it !</li> |
| </ol> |
| </div><!-- /.blog-main --> |
| </div> |
| |
| </div><!-- /.container --> |
| </main> |
| |
| <!-- FOOTER --> |
| <footer class="container-fluid bg-dark pt-5 pb-3 text-white text-center footer"> |
| |
| <div class="container pb-5"> |
| <div class="row"> |
| <div class="col-3 col-md-3"> |
| <h5>Start</h5> |
| <ul class="list-unstyled text-small"> |
| <li><a href="get-started.html" title="Get started">Get started</a></li> |
| <li><a href="get-started.html#quickstart" title="Quick start">Quick start</a></li> |
| <li><a href="download.html" title="Download">Download</a></li> |
| </ul> |
| </div> |
| |
| <div class="col-3 col-md-3"> |
| <h5>Documentation</h5> |
| <ul class="list-unstyled text-small"> |
| <li><a href="documentation.html" title="Main documentation">Main documentation</a></li> |
| <li><a href="use-cases.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="col-3 col-md-3"> |
| <h5>Community</h5> |
| <ul class="list-unstyled text-small"> |
| <li><a href="community.html" title="Mailing lists">Contact Us</a></li> |
| <li><a href="contribute.html" title="Contribute">Contribute</a></li> |
| <li><a href="community-team.html" title="Team">Team</a></li> |
| <li><a href="community-maturity-model-report.html" title="Maturity model report card">Maturity model report card</a></li> |
| </ul> |
| </div> |
| |
| <div class="col-3 col-md-3"> |
| <h5>About</h5> |
| <ul class="list-unstyled text-small"> |
| <li><a target="_blank" href="https://www.oasis-open.org/committees/cxs/" title="OASIS Context Server Technical Committee">OASIS CXS Committee</a></li> |
| <li><a href="privacy-policy.html" title="Site policy">Site policy</a></li> |
| <li><a target="_blank" href="https://www.apache.org/events/current-event.html" title="Apache Events">Apache Events</a></li> |
| <li><a target="_blank" href="https://www.apache.org/licenses/" title="License">License</a></li> |
| <li><a target="_blank" href="https://www.apache.org/security/" title="Security">Security</a></li> |
| <li><a target="_blank" href="https://www.apache.org/foundation/sponsorship.html" title="Sponsorship">Sponsorship</a></li> |
| <li><a target="_blank" href="https://www.apache.org/foundation/thanks.html" title="Thanks">Thanks</a></li> |
| </ul> |
| </div> |
| <div class="w-100 pt-md-3"></div> |
| </div> |
| </div> |
| |
| <p class="float-right"><a href="#">Back to top</a></p> |
| <p>Copyright ©2014 - 2019 <a target="_blank" href="https://www.apache.org">Apache Software Foundation</a> - All Rights Reserved - Powered by <a target="_blank" href="https://karaf.apache.org">Apache Karaf™</a><br/> |
| Apache Unomi, Unomi, Apache and the Apache feather logo are either registered trademarks or trademarks of The Apache Software Foundation in the United States and other countries.</p> |
| </footer> |
| |
| <!-- Bootstrap core JavaScript |
| ================================================== --> |
| <!-- Placed at the end of the document so the pages load faster --> |
| <script src="https://code.jquery.com/jquery-3.3.1.slim.min.js" integrity="sha384-q8i/X+965DzO0rT7abK41JStQIAqVgRVzpbzo5smXKp4YfRvH+8abtTE1Pi6jizo" crossorigin="anonymous"></script> |
| <script>window.jQuery || document.write('<script src="assets/js/vendor/jquery-slim.min.js"><\/script>')</script> |
| <script src="assets/js/vendor/popper.min.js"></script> |
| <script src="js/bootstrap.min.js"></script> |
| </body> |
| </html> |
