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 [21/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...
Added: incubator/unomi/website/versions/1.2/getting-started.html
URL: http://svn.apache.org/viewvc/incubator/unomi/website/versions/1.2/getting-started.html?rev=1810306&view=auto
==============================================================================
--- incubator/unomi/website/versions/1.2/getting-started.html (added)
+++ incubator/unomi/website/versions/1.2/getting-started.html Mon Oct 2 08:11:40 2017
@@ -0,0 +1,402 @@
+
+<!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>Getting started with Unomi | 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-getting-started 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="getting_started_with_unomi">Getting started with Unomi</h1>
+</div>
+<p>We will first get you up and running with an example. We will then lift the corner of the cover somewhat and explain in greater details what just happened.</p>
+<div class="section">
+ <h2 id="Prerequisites">Prerequisites</h2>
+ <p>This document assumes that you are already familiar with Unomiâs <a href="concepts.html">concepts</a>. On the technical side, we also assume working knowledge of <a class="externalLink" href="https://git-scm.com/">git</a> to be able to retrieve the code for Unomi and the example. Additionnally, you will require a working Java 7 or above install. Refer to <a class="externalLink" href="http://www.oracle.com/technetwork/java/javase/">http://www.oracle.com/technetwork/java/javase/</a> for details on how to download and install Java SE 7 or greater.</p>
+</div>
+<div class="section">
+ <h2 id="Running_Unomi">Running Unomi</h2>
+ <div class="section">
+ <h3 id="Building_Unomi">Building Unomi</h3>
+ <ol style="list-style-type: decimal">
+ <li>Get the code: <tt>git clone https://git-wip-us.apache.org/repos/asf/incubator-unomi.git</tt></li>
+ <li>Build and install according to the <a href="building-and-deploying.html">instructions</a> and install Unomi.</li>
+ </ol>
+ </div>
+ <div class="section">
+ <h3 id="Start_Unomi">Start Unomi</h3>
+ <p>Start Unomi according to the <a href="building-and-deploying.html#Deploying_the_generated_package">instructions</a>. Once you have Karaf running, you should wait until you see the following messages on the Karaf console:</p>
+ <div class="source">
+ <div class="source">
+ <pre>Initializing user list service endpoint...
+Initializing geonames service endpoint...
+Initializing segment service endpoint...
+Initializing scoring service endpoint...
+Initializing campaigns service endpoint...
+Initializing rule service endpoint...
+Initializing profile service endpoint...
+Initializing cluster service endpoint...
+</pre>
+ </div>
+ </div>
+ <p>This indicates that all the Unomi services are started and ready to react to requests. You can then open a browser and go to <tt>http://localhost:8181/cxs</tt> to see the list of available RESTful services or retrieve an initial context at <tt>http://localhost:8181/context.json</tt> (which isnât very useful at this point).</p>
+ </div>
+ <div class="section">
+ <h3 id="Request_examples">Request examples</h3>
+ <div class="section">
+ <h4 id="Retrieving_your_first_context">Retrieving your first context</h4>
+ <p>You can retrieve a context using curl like this : </p>
+ <div class="source">
+ <div class="source">
+ <pre>curl http://localhost:8181/context.js?sessionId=1234
+</pre>
+ </div>
+ </div>
+ <p>This will retrieve a JavaScript script that contains a <tt>cxs</tt> object that contains the context with the current user profile, segments, scores as well as functions that makes it easier to perform further requests (such as collecting events using the cxs.collectEvents() function).</p>
+ </div>
+ <div class="section">
+ <h4 id="Retrieving_a_context_as_a_JSON_object">Retrieving a context as a JSON object.</h4>
+ <p>If you prefer to retrieve a pure JSON object, you can simply use a request formed like this:</p>
+ <div class="source">
+ <div class="source">
+ <pre>curl http://localhost:8181/context.json?sessionId=1234
+</pre>
+ </div>
+ </div>
+ </div>
+ <div class="section">
+ <h4 id="Accessing_profile_properties_in_a_context">Accessing profile properties in a context</h4>
+ <p>By default, in order to optimize the amount of data sent over the network, Apache Unomi will not send the content of the profile or session properties. If you need this data, you must send a JSON object to configure the resulting output of the context.js(on) servlet.</p>
+ <p>Here is an example that will retrieve all the session and profile properties.</p>
+ <div class="source">
+ <div class="source">
+ <pre>curl -H "Content-Type: application/json" -X POST -d '{"source":{"itemId":"homepage","itemType":"page","scope":"example"},"requiredProfileProperties":["*"],"requiredSessionProperties":["*"],"requireSegments":true}' http://localhost:8181/context.json?sessionId=1234
+</pre>
+ </div>
+ </div>
+ <p>The <tt>requiredProfileProperties</tt> and <tt>requiredSessionProperties</tt> are properties that take an array of property names that should be retrieved. In this case we use the wildcard character â*â to say we want to retrieve all the available properties. The structure of the JSON object that you should send is a JSON-serialized version of the <a class="externalLink" href="http://unomi.incubator.apache.org/unomi-api/apidocs/org/apache/unomi/api/ContextRequest.html">ContextRequest</a> Java class. </p>
+ </div>
+ <div class="section">
+ <h4 id="Sending_events_using_the_context_servlet">Sending events using the context servlet</h4>
+ <p>At the same time as you are retrieving the context, you can also directly send events in the ContextRequest object as illustrated in the following example:</p>
+ <div class="source">
+ <div class="source">
+ <pre>curl -H "Content-Type: application/json" -X POST -d '{"source":{"itemId":"homepage","itemType":"page","scope":"example"},"events":[{"eventType":"view","scope": "example","source":{"itemType": "site","scope":"example","itemId": "mysite"},"target":{"itemType":"page","scope":"example","itemId":"homepage","properties":{"pageInfo":{"referringURL":""}}}}]}' http://localhost:8181/context.json?sessionId=1234
+</pre>
+ </div>
+ </div>
+ <p>Upon received events, Apache Unomi will execute all the rules that match the current context, and return an updated context. This way of sending events is usually used upon first loading of a page. If you want to send events after the page has finished loading you could either do a second call and get an updating context, or if you donât need the context and want to send events in a network optimal way you can use the eventcollector servlet (see below). </p>
+ </div>
+ <div class="section">
+ <h4 id="Sending_events_using_the_eventcollector_servlet">Sending events using the eventcollector servlet</h4>
+ <p>If you only need to send events without retrieving a context, you should use the eventcollector servlet that is optimized respond quickly and minimize network traffic. Here is an example of using this servlet:</p>
+ <div class="source">
+ <div class="source">
+ <pre>curl -H "Content-Type: application/json" -X POST -d '{"events":[{"eventType":"view","scope": "example","source":{"itemType": "site","scope":"example","itemId": "mysite"},"target":{"itemType":"page","scope":"example","itemId":"homepage","properties":{"pageInfo":{"referringURL":""}}}}]}' http://localhost:8181/eventcollector?sessionId=1234
+</pre>
+ </div>
+ </div>
+ <p>Note that the eventcollector executes the rules but does not return a context. If is generally used after a page is loaded to send additional events. </p>
+ </div>
+ </div>
+ <div class="section">
+ <h3 id="Where_to_go_from_here">Where to go from here</h3>
+ <ul>
+ <li>Read the <a href="twitter-sample.html">Twitter sample</a> documentation that contains a detailed example of how to integrate with Apache Unomi.</li>
+ </ul>
+ </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="#getting_started_with_unomi" title="Getting started with Unomi">Getting started with Unomi <b class="caret"></b></a>
+ <ul class="nav nav-list">
+ <li><a href="#Prerequisites" title="Prerequisites">Prerequisites</a>
+ <li class="dropdown"><a href="#Running_Unomi" title="Running Unomi">Running Unomi <b class="caret"></b></a>
+ <ul class="nav nav-list">
+ <li><a href="#Building_Unomi" title="Building Unomi">Building Unomi</a>
+ <li><a href="#Start_Unomi" title="Start Unomi">Start Unomi</a>
+ <li class="dropdown"><a href="#Request_examples" title="Request examples">Request examples <b class="caret"></b></a>
+ <ul class="nav nav-list">
+ <li><a href="#Retrieving_your_first_context" title="Retrieving your first context">Retrieving your first context</a>
+ <li><a href="#Retrieving_a_context_as_a_JSON_object" title="Retrieving a context as a JSON object.">Retrieving a context as a JSON object.</a>
+ <li><a href="#Accessing_profile_properties_in_a_context" title="Accessing profile properties in a context">Accessing profile properties in a context</a>
+ <li><a href="#Sending_events_using_the_context_servlet" title="Sending events using the context servlet">Sending events using the context servlet</a>
+ <li><a href="#Sending_events_using_the_eventcollector_servlet" title="Sending events using the eventcollector servlet">Sending events using the eventcollector servlet</a>
+ <li class="divider"></li>
+ </ul>
+ </li>
+ <li><a href="#Where_to_go_from_here" title="Where to go from here">Where to go from here</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
Added: incubator/unomi/website/versions/1.2/login-sample.html
URL: http://svn.apache.org/viewvc/incubator/unomi/website/versions/1.2/login-sample.html?rev=1810306&view=auto
==============================================================================
--- incubator/unomi/website/versions/1.2/login-sample.html (added)
+++ incubator/unomi/website/versions/1.2/login-sample.html Mon Oct 2 08:11:40 2017
@@ -0,0 +1,335 @@
+
+<!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>Login sample | 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-login-sample 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="login_sample">Login sample</h1>
+</div>
+<p>This sample is an example of what is involved in integrated a login with Apache Unomi. </p>
+<div class="section">
+ <h2 id="Warning_">Warning !</h2>
+ <p>The example code uses client-side Javascript code to send the login event. This is only done this way for the sake of sample simplicity but if should NEVER BE DONE THIS WAY in real cases.</p>
+ <p>The login event should always be sent from the server performing the actual login since it must only be sent if the user has authenticated properly, and only the authentication server can validate this.</p>
+</div>
+<div class="section">
+ <h2 id="Installing_the_sample">Installing the sample</h2>
+ <ol style="list-style-type: decimal">
+ <li> <p>Login into the Unomi Karaf SSH shell using something like this :</p>
+ <div class="source">
+ <div class="source">
+ <pre>ssh -p 8102 karaf@localhost (default password is karaf)
+</pre>
+ </div>
+ </div></li>
+ <li> <p>Install the login sample using the following command:</p>
+ <div class="source">
+ <div class="source">
+ <pre>bundle:install mvn:org.apache.unomi/login-integration-sample/1.2.0-incubating-SNAPSHOT
+</pre>
+ </div>
+ </div> <p>when the bundle is successfully install you will get an bundle ID back we will call it BUNDLE_ID. </p></li>
+ <li> <p>You can then do:</p>
+ <div class="source">
+ <div class="source">
+ <pre>bundle:start BUNDLE_ID
+</pre>
+ </div>
+ </div></li>
+ <li> <p>If all went well you can access the login sample HTML page here :</p>
+ <div class="source">
+ <div class="source">
+ <pre>http://localhost:8181/login/index.html
+</pre>
+ </div>
+ </div></li>
+ <li> <p>You can fill in the form to test it. Note that the hardcoded password is:</p>
+ <div class="source">
+ <div class="source">
+ <pre>test1234
+</pre>
+ </div>
+ </div></li>
+ </ol>
+</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="#login_sample" title="Login sample">Login sample <b class="caret"></b></a>
+ <ul class="nav nav-list">
+ <li><a href="#Warning_" title="Warning !">Warning !</a>
+ <li><a href="#Installing_the_sample" title="Installing the sample">Installing the sample</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/salesforce-connector.html
URL: http://svn.apache.org/viewvc/incubator/unomi/website/versions/1.2/salesforce-connector.html?rev=1810306&view=auto
==============================================================================
--- incubator/unomi/website/versions/1.2/salesforce-connector.html (added)
+++ incubator/unomi/website/versions/1.2/salesforce-connector.html Mon Oct 2 08:11:40 2017
@@ -0,0 +1,459 @@
+
+<!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>Apache Unomi Salesforce Connector | 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-salesforce-connector 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="apache_unomi_salesforce_connector">Apache Unomi Salesforce Connector</h1>
+</div>
+<p>This connector makes it possible to push and pull data to/from the Salesforce CRM. It can copy information between Apache Unomi profiles and Salesforce Leads.</p>
+<div class="section">
+ <h2 id="Getting_started">Getting started</h2>
+ <ol style="list-style-type: decimal">
+ <li> <p>Create a new developer account here:</p>
+ <div class="source">
+ <div class="source">
+ <pre>https://developer.salesforce.com/signup
+</pre>
+ </div>
+ </div></li>
+ <li> <p>Create a new Connected App, by going into Setup -> App Manager and click âCreate Connected Appâ</p></li>
+ <li> <p>In the settings, make sure you do the following:</p>
+ <div class="source">
+ <div class="source">
+ <pre>Enable OAuth settings -> Activated
+Enable for device flow -> Activated (no need for a callback URL)
+Add all the selected OAuth scopes you want (or put all of them)
+Make sure Require Secret for Web Server flow is activated
+</pre>
+ </div>
+ </div></li>
+ <li> <p>Make sure you retrieve the following information once you have created the app in the API (Enable OAuth Settings):</p>
+ <div class="source">
+ <div class="source">
+ <pre>Consumer key
+Consumer secret (click to see it)
+</pre>
+ </div>
+ </div></li>
+ <li> <p>You must also retrieve your userâs security token, or create it if you donât have one already. To do this simply click on your user at the top right, select âSettingsâ, the click on âReset my security tokenâ. You will receive an email with the security token.</p></li>
+ <li> <p>You are now ready to configure the Apache Unomi Salesforce Connector. In the etc/org.apache.unomi.sfdc.cfg file change the following settings:</p>
+ <div class="source">
+ <div class="source">
+ <pre>sfdc.user.username=YOUR_USER_NAME
+sfdc.user.password=YOUR_PASSWORD
+sfdc.user.securityToken=YOUR_USER_SECURITY_TOKEN
+sfdc.consumer.key=CONNECTED_APP_CONSUMER_KEY
+sfdc.consumer.secret=CONNECTED_APP_SECRET
+</pre>
+ </div>
+ </div></li>
+ <li> <p>Connected to the Apache Unomi Karaf Shell using : </p>
+ <div class="source">
+ <div class="source">
+ <pre>ssh -p 8102 karaf@localhost (default password is karaf)
+</pre>
+ </div>
+ </div></li>
+ <li> <p>Deploy into Apache Unomi using the following commands from the Apache Karaf shell:</p>
+ <div class="source">
+ <div class="source">
+ <pre>feature:repo-add mvn:org.apache.unomi/unomi-salesforce-connector-karaf-kar/1.2.0-incubating-SNAPSHOT/xml/features
+feature:install unomi-salesforce-connector-karaf-kar
+</pre>
+ </div>
+ </div></li>
+ <li> <p>You can then test the connection to Salesforce by accessing the following URLs:</p>
+ <div class="source">
+ <div class="source">
+ <pre>https://localhost:9443/cxs/sfdc/version
+https://localhost:9443/cxs/sfdc/limits
+</pre>
+ </div>
+ </div> <p>The first URL will give you information about the version of the connector, so this makes it easy to check that the plugin is properly deployed, started and the correct version. The second URL will actually make a request to the Salesforce REST API to retrieve the limits of the Salesforce API.</p> <p>Both URLs are password protected by the Apache Unomi (Karaf) password. You can find this user and password information in the etc/users.properties file.</p></li>
+ <li> <p>You can now use the connectorâs defined actions in rules to push or pull data to/from the Salesforce CRM. You can find more information about rules in the <a href="concepts.html">Concepts</a> and the <a href="getting-started.html">Getting Started</a> pages. </p></li>
+ </ol>
+</div>
+<div class="section">
+ <h2 id="Upgrading_the_Salesforce_connector">Upgrading the Salesforce connector</h2>
+ <p>If you followed all the steps in the Getting Started section, you can upgrade the Salesforce connector by using the following steps:</p>
+ <ol style="list-style-type: decimal">
+ <li> <p>Compile the connector using:</p>
+ <div class="source">
+ <div class="source">
+ <pre>cd extensions/salesforce-connector
+mvn clean install
+</pre>
+ </div>
+ </div></li>
+ <li> <p>Login to the Unomi Karaf Shell using:</p>
+ <div class="source">
+ <div class="source">
+ <pre>ssh -p 8102 karaf@localhost (password by default is karaf)
+</pre>
+ </div>
+ </div></li>
+ <li> <p>Execute the following commands in the Karaf shell</p>
+ <div class="source">
+ <div class="source">
+ <pre>feature:repo-refresh
+feature:uninstall unomi-salesforce-connector-karaf-feature
+feature:install unomi-salesforce-connector-karaf-feature
+</pre>
+ </div>
+ </div></li>
+ <li> <p>You can then check that the new version is properly deployed by accessing the following URL and checking the build date:</p>
+ <div class="source">
+ <div class="source">
+ <pre>https://localhost:9443/cxs/sfdc/version
+</pre>
+ </div>
+ </div> <p>(if asked for a password itâs the same karaf/karaf default)</p></li>
+ </ol>
+</div>
+<div class="section">
+ <h2 id="Using_the_Salesforce_Workbench_for_testing_REST_API">Using the Salesforce Workbench for testing REST API</h2>
+ <p>The Salesforce Workbench contains a REST API Explorer that is very useful to test requests. You may find it here : </p>
+ <div class="source">
+ <div class="source">
+ <pre>https://workbench.developerforce.com/restExplorer.php
+</pre>
+ </div>
+ </div>
+</div>
+<div class="section">
+ <h2 id="Setting_up_Streaming_Push_queries">Setting up Streaming Push queries</h2>
+ <p>Using the Salesforce Workbench, you can setting streaming push queries (Queries->Streaming push topics) such as the following example:</p>
+ <div class="source">
+ <div class="source">
+ <pre>Name: LeadUpdates
+Query : SELECT Id,FirstName,LastName,Email,Company FROM Lead
+</pre>
+ </div>
+ </div>
+</div>
+<div class="section">
+ <h2 id="Executing_the_unit_tests">Executing the unit tests</h2>
+ <p>Before running the tests, make sure you have completed all the steps above, including the streaming push queries setup.</p>
+ <p>By default the unit tests will not run as they need proper Salesforce credentials to run. To set this up create a properties file like the following one:</p>
+ <p>test.properties</p>
+ <div class="source">
+ <div class="source">
+ <pre>#
+# 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.
+#
+sfdc.user.username=YOUR_USER_NAME
+sfdc.user.password=YOUR_PASSWORD
+sfdc.user.securityToken=YOUR_USER_SECURITY_TOKEN
+sfdc.consumer.key=CONNECTED_APP_CONSUMER_KEY
+sfdc.consumer.secret=CONNECTED_APP_SECRET
+</pre>
+ </div>
+ </div>
+ <p>and then use the following command line to reference the file:</p>
+ <div class="source">
+ <div class="source">
+ <pre>cd extensions/salesforce-connector
+mvn clean install -DsfdcProperties=../test.properties
+</pre>
+ </div>
+ </div>
+ <p>(in case youâre wondering the ../ is because the test is located in the services sub-directory)</p>
+</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="#apache_unomi_salesforce_connector" title="Apache Unomi Salesforce Connector">Apache Unomi Salesforce Connector <b class="caret"></b></a>
+ <ul class="nav nav-list">
+ <li><a href="#Getting_started" title="Getting started">Getting started</a>
+ <li><a href="#Upgrading_the_Salesforce_connector" title="Upgrading the Salesforce connector">Upgrading the Salesforce connector</a>
+ <li><a href="#Using_the_Salesforce_Workbench_for_testing_REST_API" title="Using the Salesforce Workbench for testing REST API">Using the Salesforce Workbench for testing REST API</a>
+ <li><a href="#Setting_up_Streaming_Push_queries" title="Setting up Streaming Push queries">Setting up Streaming Push queries</a>
+ <li><a href="#Executing_the_unit_tests" title="Executing the unit tests">Executing the unit tests</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/samples.html
URL: http://svn.apache.org/viewvc/incubator/unomi/website/versions/1.2/samples.html?rev=1810306&view=auto
==============================================================================
--- incubator/unomi/website/versions/1.2/samples.html (added)
+++ incubator/unomi/website/versions/1.2/samples.html Mon Oct 2 08:11:40 2017
@@ -0,0 +1,288 @@
+
+<!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>Samples | 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-samples 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="samples">Samples</h1>
+</div>
+<p>Apache Unomi provides the following samples:</p>
+<ul>
+ <li><a href="twitter-sample.html">Twitter integration</a></li>
+ <li><a href="login-sample.html">Login integration</a></li>
+</ul>
+ </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><a href="#samples" title="Samples">Samples</a>
+ </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