svn commit: r1846669 - /incubator/unomi/website/manual/latest/index.html

[sh...@apache.org]

Author: shuber
Date: Thu Nov 15 19:03:07 2018
New Revision: 1846669

URL: http://svn.apache.org/viewvc?rev=1846669&view=rev
Log:
Site checkin for project Apache Unomi :: Root Project

Modified:
    incubator/unomi/website/manual/latest/index.html

Modified: incubator/unomi/website/manual/latest/index.html
URL: http://svn.apache.org/viewvc/incubator/unomi/website/manual/latest/index.html?rev=1846669&r1=1846668&r2=1846669&view=diff
==============================================================================
--- incubator/unomi/website/manual/latest/index.html (original)
+++ incubator/unomi/website/manual/latest/index.html Thu Nov 15 19:03:07 2018
@@ -96,10 +96,11 @@
 <li><a href="#_salesforce_connector">5.2. Salesforce Connector</a>
 <ul class="sectlevel3">
 <li><a href="#_getting_started_2">5.2.1. Getting started</a></li>
-<li><a href="#_hot_deploying_updates_to_the_salesforce_connector_for_developers">5.2.2. Hot-deploying updates to the Salesforce connector (for developers)</a></li>
-<li><a href="#_using_the_salesforce_workbench_for_testing_rest_api">5.2.3. Using the Salesforce Workbench for testing REST API</a></li>
-<li><a href="#_setting_up_streaming_push_queries">5.2.4. Setting up Streaming Push queries</a></li>
-<li><a href="#_executing_the_unit_tests">5.2.5. Executing the unit tests</a></li>
+<li><a href="#_properties">5.2.2. Properties</a></li>
+<li><a href="#_hot_deploying_updates_to_the_salesforce_connector_for_developers">5.2.3. Hot-deploying updates to the Salesforce connector (for developers)</a></li>
+<li><a href="#_using_the_salesforce_workbench_for_testing_rest_api">5.2.4. Using the Salesforce Workbench for testing REST API</a></li>
+<li><a href="#_setting_up_streaming_push_queries">5.2.5. Setting up Streaming Push queries</a></li>
+<li><a href="#_executing_the_unit_tests">5.2.6. Executing the unit tests</a></li>
 </ul>
 </li>
 <li><a href="#_mailchimp_connector">5.3. MailChimp Connector</a>
@@ -1707,6 +1708,8 @@ Apache Unomi profiles and Salesforce Lea
 </div>
 <div class="sect3">
 <h4 id="_getting_started_2">5.2.1. Getting started</h4>
+<div class="sect4">
+<h5 id="_salesforce_account_setup">Salesforce account setup</h5>
 <div class="olist arabic">
 <ol class="arabic">
 <li>
@@ -1745,6 +1748,13 @@ Consumer secret (click to see it)</code>
 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>
+</ol>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_apache_unomi_setup">Apache Unomi setup</h5>
+<div class="olist arabic">
+<ol class="arabic">
 <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>
@@ -1758,6 +1768,17 @@ sfdc.consumer.secret=CONNECTED_APP_SECRE
 </div>
 </div>
 </li>
+</ol>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_deployment_from_maven_repository">Deployment from Maven repository</h5>
+<div class="paragraph">
+<p>In this procedure we assume you have access to a Maven repository that contains a compiled version of the Salesforce connector.
+If this is not the case or you prefer to deploy using a KAR bundle, see the KAR deployment instructions instead.</p>
+</div>
+<div class="olist arabic">
+<ol class="arabic">
 <li>
 <p>Connect to the Apache Unomi Karaf Shell using :</p>
 <div class="listingblock">
@@ -1775,6 +1796,33 @@ feature:install unomi-salesforce-connect
 </div>
 </div>
 </li>
+</ol>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_deployment_using_kar_bundle">Deployment using KAR bundle</h5>
+<div class="paragraph">
+<p>If you have a KAR bundle (for example after building from source in the <code>extensions/salesforce-connector/karaf-kar/target</code> directory),
+you can follow these steps to install :</p>
+</div>
+<div class="olist arabic">
+<ol class="arabic">
+<li>
+<p>Ensure that Apache Karaf and Apache Unomi are started</p>
+</li>
+<li>
+<p>Execute the following command in karaf: <code>feature:install unomi-salesforce-connector-karaf-kar</code></p>
+</li>
+<li>
+<p>The installation is done !</p>
+</li>
+</ol>
+</div>
+</div>
+<div class="sect4">
+<h5 id="_testing_the_connector">Testing the connector</h5>
+<div class="olist arabic">
+<ol class="arabic">
 <li>
 <p>You can then test the connection to Salesforce by accessing the following URLs:</p>
 <div class="listingblock">
@@ -1793,15 +1841,36 @@ Salesforce REST API to retrieve the limi
 in the etc/users.properties file.</p>
 </div>
 </li>
-<li>
-<p>You can now use the connectors&#8217;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.adoc">Concepts</a> and the <a href="getting-started.html">Getting Started</a> pages.</p>
-</li>
 </ol>
 </div>
+<div class="paragraph">
+<p>You can now use the connectors&#8217;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">Concepts</a> and the <a href="#_getting_started_with_unomi">Getting Started</a> pages.</p>
+</div>
+</div>
+</div>
+<div class="sect3">
+<h4 id="_properties">5.2.2. Properties</h4>
+<div class="paragraph">
+<p>To define how Salesforce attributes will be mapped to Marketing Factory profile properties, edit the following entry using the pattern below :</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code>sfdc.fields.mappings=myMarketingFactoryProperty1&lt;=&gt;mySFDCAttribute1,myMarketingFactoryProperty2&lt;=&gt;mySFDCAttribute2</code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>Please note that Salesforce needs the company and the last name to be set, otherwise the lead won&#8217;t be created.
+An identifier needs to be set as well. The identifier will be used to map the Marketing Factory profile to the Salesforce lead. By default, the email is set as the identifier, meaning that if a lead in Salesforce and a profile in Marketing Factory have the same email, they&#8217;ll be considered as the same person.</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre class="highlight"><code>sfdc.fields.mappings.identifier=email&lt;=&gt;Email</code></pre>
+</div>
+</div>
 </div>
 <div class="sect3">
-<h4 id="_hot_deploying_updates_to_the_salesforce_connector_for_developers">5.2.2. Hot-deploying updates to the Salesforce connector (for developers)</h4>
+<h4 id="_hot_deploying_updates_to_the_salesforce_connector_for_developers">5.2.3. Hot-deploying updates to the Salesforce connector (for developers)</h4>
 <div class="paragraph">
 <p>If you followed all the steps in the Getting Started section, you can upgrade the Salesforce connectors by using the following steps:</p>
 </div>
@@ -1849,7 +1918,7 @@ feature:install unomi-salesforce-connect
 </div>
 </div>
 <div class="sect3">
-<h4 id="_using_the_salesforce_workbench_for_testing_rest_api">5.2.3. Using the Salesforce Workbench for testing REST API</h4>
+<h4 id="_using_the_salesforce_workbench_for_testing_rest_api">5.2.4. Using the Salesforce Workbench for testing REST API</h4>
 <div class="paragraph">
 <p>The Salesforce Workbench contains a REST API Explorer that is very useful to test requests. You may find it here :</p>
 </div>
@@ -1860,7 +1929,7 @@ feature:install unomi-salesforce-connect
 </div>
 </div>
 <div class="sect3">
-<h4 id="_setting_up_streaming_push_queries">5.2.4. Setting up Streaming Push queries</h4>
+<h4 id="_setting_up_streaming_push_queries">5.2.5. Setting up Streaming Push queries</h4>
 <div class="paragraph">
 <p>Using the Salesforce Workbench, you can setting streaming push queries (Queries-&gt;Streaming push topics) such as the
 following example:</p>
@@ -1873,7 +1942,7 @@ Query : SELECT Id,FirstName,LastName,Ema
 </div>
 </div>
 <div class="sect3">
-<h4 id="_executing_the_unit_tests">5.2.5. Executing the unit tests</h4>
+<h4 id="_executing_the_unit_tests">5.2.6. Executing the unit tests</h4>
 <div class="paragraph">
 <p>Before running the tests, make sure you have completed all the steps above, including the streaming push queries setup.</p>
 </div>