http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/6833975e/extensions/web-tracker/javascript/package.json ---------------------------------------------------------------------- diff --git a/extensions/web-tracker/javascript/package.json b/extensions/web-tracker/javascript/package.json index 10bcf38..39698b9 100644 --- a/extensions/web-tracker/javascript/package.json +++ b/extensions/web-tracker/javascript/package.json @@ -1,6 +1,6 @@ { "name": "unomi-analytics", - "version": "1.0.4", + "version": "1.0.5", "description": "The Apache Unomi analytics.js integration.", "main": "dist/unomi-tracker.js", "keywords": [ @@ -15,7 +15,7 @@ "browserify": "browserify src/index.js -p [ browserify-header --file src/license.js ] -s unomiTracker -o dist/unomi-tracker.js", "replace": "replace-in-file 'analytics.require = require' '//analytics.require = require' dist/unomi-tracker.js", "minify": "uglifyjs -c -m --comments '/@license/' -o dist/unomi-tracker.min.js -- dist/unomi-tracker.js", - "snippet:minify": "uglifyjs -c -m -o snippet.min.js -- snippet.js", + "snippet:minify": "uglifyjs -c -m -o snippet.min.js --source-map snippet.min.js.map -- snippet.js", "clean": "rimraf *.log dist/unomi-tracker.js dist/unomi-tracker.min.js", "clean:all": "yarn clean && rimraf node_modules" },
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/6833975e/extensions/web-tracker/javascript/snippet.min.js.map ---------------------------------------------------------------------- diff --git a/extensions/web-tracker/javascript/snippet.min.js.map b/extensions/web-tracker/javascript/snippet.min.js.map new file mode 100644 index 0000000..4f72bdd --- /dev/null +++ b/extensions/web-tracker/javascript/snippet.min.js.map @@ -0,0 +1 @@ +{"version":3,"sources":["snippet.js"],"names":["window","unomiTracker","callback","e","initialize","Apache Unomi","unomiOption","unomiTracker_queue","length","item","shift","method","apply","methods","i","args","Array","prototype","slice","call","arguments","unshift","push","load","script","document","createElement","type","async","src","url","addEventListener","onreadystatechange","this","readyState","event","first","getElementsByTagName","parentNode","insertBefore","page"],"mappings":"AAgBAA,OAAOC,eAAiBD,OAAOC,iBAC/B,WAoBI,QAASC,GAASC,GAOd,IANAF,aAAaG,YACTC,eAAgBC,cAKbC,EAAmBC,OAAS,GAAG,CAClC,GAAIC,GAAOF,EAAmBG,QAC1BC,EAASF,EAAKC,OACdT,cAAaU,IACbV,aAAaU,GAAQC,MAAMX,aAAcQ,IAhBrD,IAAK,GAdDF,MAEAM,GAAW,cAAe,aAAc,YAAa,YAAa,aAAc,WAAY,WAAY,QAAS,QAAS,QAAS,QAAS,QAAS,QAAS,OAAQ,OAAQ,MAAO,KAAM,eAYtLC,EAAI,EAAGA,EAAID,EAAQL,OAAQM,IAAK,CACrC,GAAIH,GAASE,EAAQC,EACrBd,QAAOC,aAAaU,GAZV,SAAUA,GACpB,MAAO,YACH,GAAII,GAAOC,MAAMC,UAAUC,MAAMC,KAAKC,UAGtC,OAFAL,GAAKM,QAAQV,GACbJ,EAAmBe,KAAKP,GACjBf,OAAO C,eAOoBU,GAqB1CV,aAAasB,KAAO,WAEhB,GAAIC,GAASC,SAASC,cAAc,SACpCF,GAAOG,KAAO,kBACdH,EAAOI,OAAQ,EAEfJ,EAAOK,IAAMvB,YAAYwB,IAAM,gCAE3BN,EAAOO,iBACPP,EAAOO,iBAAiB,OAAQ,SAAU5B,GACd,kBAAbD,IACPA,EAASC,KAEd,GAEHqB,EAAOQ,mBAAqB,WACA,aAApBC,KAAKC,YAAiD,WAApBD,KAAKC,YACvChC,EAASF,OAAOmC,OAM5B,IAAIC,GAAQX,SAASY,qBAAqB,UAAU,EACpDD,GAAME,WAAWC,aAAaf,EAAQY,IAG1CX,SAASM,iBAAiB,mBAAoB9B,aAAasB,MAE3DtB,aAAauC","file":"snippet.min.js"} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/6833975e/manual/src/archives/1.3/asciidoc/5-min-quickstart.adoc ---------------------------------------------------------------------- diff --git a/manual/src/archives/1.3/asciidoc/5-min-quickstart.adoc b/manual/src/archives/1.3/asciidoc/5-min-quickstart.adoc new file mode 100644 index 0000000..5bb2e20 --- /dev/null +++ b/manual/src/archives/1.3/asciidoc/5-min-quickstart.adoc @@ -0,0 +1,38 @@ +// +// Licensed 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. +// +==== Five Minutes QuickStart + +1) Install JDK 8 (http://www.oracle.com/technetwork/java/javase/downloads/index.html) and make sure you set the +JAVA_HOME variable https://docs.oracle.com/cd/E19182-01/820-7851/inst_cli_jdk_javahome_t/ + +2) Download ElasticSearch here : https://www.elastic.co/downloads/past-releases/elasticsearch-5-6-3 (please <strong>make sure</strong> you use the proper version : 5.6.3) + +3) Uncompress it and change the `config/elasticsearch.yml` to include the following config : <code>cluster.name: contextElasticSearch</code> + +4) Launch ElasticSearch using : `bin/elasticsearch` + +5) Download Apache Unomi here : http://unomi.incubator.apache.org/download.html + +6) Start it using : `./bin/karaf` + +7) Start the Apache Unomi packages using `unomi:start` in the Apache Karaf Shell + +8) Wait for startup to complete + +9) Try accessing https://localhost:9443/cxs/cluster with username/password: `karaf/karaf` . You might get a certificate warning in your browser, just accept it despite the warning it is safe. + +10) Request your first context by simply accessing : http://localhost:8181/context.js?sessionId=1234 + +11) If something goes wrong, you should check the logs in `./data/log/karaf.log`. If you get errors on ElasticSearch, +make sure you are using the proper version. http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/6833975e/manual/src/archives/1.3/asciidoc/connectors/mailchimp-connector.adoc ---------------------------------------------------------------------- diff --git a/manual/src/archives/1.3/asciidoc/connectors/mailchimp-connector.adoc b/manual/src/archives/1.3/asciidoc/connectors/mailchimp-connector.adoc new file mode 100644 index 0000000..2a220ed --- /dev/null +++ b/manual/src/archives/1.3/asciidoc/connectors/mailchimp-connector.adoc @@ -0,0 +1,100 @@ +// +// Licensed 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. +// +=== MailChimp Connector + +This extension has 3 actions: + + * Add a visitor into a defined Mailchimp list. + * Remove a visitor from a defined Mailchimp list. + * Unsubscribe a visitor from a defined Mailchimp list. + +==== Getting started + +. Create a new MailChimp account: https://login.mailchimp.com/signup/ + +. Generate a new API Key, or get the default: https://usX.admin.mailchimp.com/account/api/ + +. Configure the MailChimp Connector Basic in the `etc/org.apache.unomi.mailchimpconnector.cfg` file change the following settings: ++ +[source] +---- + mailChimpConnector.apiKey=YOUR_APIKEY + mailChimpConnector.url.subDomain=YOUR_SUB_DOMAIN (exemple: https://usX.admin.mailchimp.com/account/api/, the X is the SUB_DOMAIN) +---- ++ +. Before starting configure the mapping between Apache Unomi profile properties and MailChimp member properties. + + The mapping can't be use with multitued properties. You need to setup your MailChimp properties first in the MailChimp administration. ++ +[source] +---- + Go to: lists/ + Select the triggered list + Settings +---- ++ + ++ +Then in the cfg file `mailChimpConnector.list.merge-fields.activate={Boolean} if you like to activate the mapping feature.` ++ + ++ +This is the property to configure for the mapping, the format is as shown. `mailChimpConnector.list.merge-fields.mapping={Apache Unomi property ID}<=>{MailChimp Tag name}` ++ + ++ +[NOTE] +=============================== +there is a particular format for the address `{Apache Unomi property ID}<=>{MailChimp Tag name}<=>{MailChimp tag sub entry}` +=============================== ++ + ++ +MailChimp supported type are: ++ + ++ +* Date `The format is (DD/MM/YYYY) or (MM/DD/YYYY)` + +* Birthday `The format is (DD/MM) or (MM/DD)` + +* Website or Text `They are text` + +* Number `The number will be parse into a Integer` + +* Phone `The North American format is not supported, use international` + +* Address ++ +[NOTE] +=============================== +Street, City, Country and Zip are mandatory properties, otherwise the address property will be skipped. +=============================== + ++ + +[source] +---- + address<=>ADDRESS<=>addr1, + city<=>ADDRESS<=>city, + zipCode<=>ADDRESS<=>zip, + countryName<=>ADDRESS<=>country +---- ++ + +. Deploy into Apache Unomi using the following commands from the Apache Karaf shell: + +[source] +---- + feature:repo-add mvn:org.apache.unomi/unomi-mailchimp-connector-karaf-kar/${project.version}/xml/features + feature:install unomi-mailchimp-connector-karaf-kar +---- http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/6833975e/manual/src/archives/1.3/asciidoc/installing-tracker.adoc ---------------------------------------------------------------------- diff --git a/manual/src/archives/1.3/asciidoc/installing-tracker.adoc b/manual/src/archives/1.3/asciidoc/installing-tracker.adoc new file mode 100644 index 0000000..0739c4c --- /dev/null +++ b/manual/src/archives/1.3/asciidoc/installing-tracker.adoc @@ -0,0 +1,44 @@ +// +// Licensed 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. +// +==== Web Tracker + +This extension is providing the web tracker to start collecting visitors data on your website. +The tracker is implemented as an integration of https://github.com/segmentio/analytics.js[analytics.js] for Unomi. + +===== Getting started + +Extension can be tested at : `http://localhost:8181/tracker/index.html` + +In your page include unomiOptions and include code snippet from `snippet.min.js` : + +[source] +---- +<script type="text/javascript"> + var unomiOption = { + scope: 'realEstateManager', + url: 'http://localhost:8181' + }; + window.unomiTracker||(window.unomiTracker={}),function(){function e(e){for(unomiTracker.initialize({"Apache Unomi":unomiOption});n.length>0;){var r=n.shift(),t=r.shift();unomiTracker[t]&&unomiTracker[t].apply(unomiTracker,r)}}for(var n=[],r=["trackSubmit","trackClick","trackLink","trackForm","initialize","pageview","identify","reset","group","track","ready","alias","debug","page","once","off","on","personalize"],t=0;t<r.length;t++){var i=r[t];window.unomiTracker[i]=function(e){return function(){var r=Array.prototype.slice.call(arguments);return r.unshift(e),n.push(r),window.unomiTracker}}(i)}unomiTracker.load=function(){var n=document.createElement("script");n.type="text/javascript",n.async=!0,n.src=unomiOption.url+"/tracker/unomi-tracker.min.js",n.addEventListener?n.addEventListener("load",function(n){"function"==typeof e&&e(n)},!1):n.onreadystatechange=function(){"complete"!==this.readyState&&"loaded"!==this.readyState||e(window.event)};var r=document.getElementsByTagName( "script")[0];r.parentNode.insertBefore(n,r)},document.addEventListener("DOMContentLoaded",unomiTracker.load),unomiTracker.page()}(); +</script> +---- + +`window.unomiTracker` can be used to send additional events when needed. + +Check analytics.js API https://segment.com/docs/sources/website/analytics.js/[here]. +All methods can be used on `unomiTracker` object, although not all event types are supported by Unomi intergation. + +===== How to contribute + +The source code is in the folder javascript with a package.json, the file to update is `analytics.js-integration-apache-unomi.js` apply your modification in this file then use the command `yarn build` to compile a new JS file. +Then you can use the test page to try your changes `http://localhost:8181/tracker/index.html`. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/6833975e/manual/src/archives/1.3/asciidoc/patches.adoc ---------------------------------------------------------------------- diff --git a/manual/src/archives/1.3/asciidoc/patches.adoc b/manual/src/archives/1.3/asciidoc/patches.adoc new file mode 100644 index 0000000..3baba57 --- /dev/null +++ b/manual/src/archives/1.3/asciidoc/patches.adoc @@ -0,0 +1,102 @@ +// +// Licensed 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. +// +==== Migration patches + +You may provide patches on any predefined items by simply adding a JSON file in : + +[source] +---- +src/main/resources/META-INF/cxs/patches +---- + +These patches will be applied when the module will be deployed the first time. +They allow to modify an item, that would have been previously deployed on unomi by a previous version of the extension or by something else. + +Each patch must have a unique id - unomi will use this id to remember that the patch has already been applied. It can also be used to reapply the patch when need by using the karaf command `unomi:deploy-definition` + +A patch also need to reference the item to patch by setting `patchedItemId` and `patchedItemType`, and an operation that tells what the patch should do. + + +.`patchedItemType` can take one of the following value: +- condition +- action +- goal +- campaign +- persona +- propertyType +- rule +- segment +- scoring + +.`operation` can take one of the following value: +- patch +- override +- remove + +You can apply a patch in http://jsonpatch.com/[json-patch] format in the `data` field, and by specifying operation `patch` like in this example : + +[source] +---- +{ + "itemId": "firstName-patch1", + "patchedItemId": "firstName", + "patchedItemType": "propertyType", + "operation": "patch", + "data": [ + { + "op": "replace", "path": "/defaultValue", "value": "foo" + } + ] +} +---- + +If you need to completely redeploy a definition, you can use the `override` operation and put the definition in `data` + +[source] +---- +{ + "itemId": "gender-patch1", + "patchedItemId": "gender", + "patchedItemType": "propertyType", + "operation": "override", + "data": { + "metadata": { + "id": "gender", + "name": "Gender", + "systemTags": [ + "properties", + "profileProperties" + ] + }, + "type": "string", + "defaultValue": "foo", + "automaticMappingsFrom": [ ], + "rank": "105.0" + } +} +---- + +It is also possible to simply remove an item by using the operation `remove` : + +[source] +---- +{ + "itemId": "firstName-patch2", + "patchedItemId": "firstName", + "patchedItemType": "propertyType", + "operation": "remove" +} +---- + +Patches can also be deployed at runtime by using the REST endpoint /patch/apply . http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/6833975e/manual/src/archives/1.3/asciidoc/shell-commands.adoc ---------------------------------------------------------------------- diff --git a/manual/src/archives/1.3/asciidoc/shell-commands.adoc b/manual/src/archives/1.3/asciidoc/shell-commands.adoc new file mode 100644 index 0000000..e69e2bc --- /dev/null +++ b/manual/src/archives/1.3/asciidoc/shell-commands.adoc @@ -0,0 +1,138 @@ +// +// Licensed 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. +// +=== SSH Shell Commands + +Apache Unomi provides its own Apache Karaf Shell commands to make it easy to control the application +lifecycle or perform queries or modifications on the internal state of the system. + +All Apache Unomi-specific commands are namespaced and use the `unomi:` namespace. You can use the Apache Karaf Shell's +autocompletion to list all the commands available. + +==== Using the shell + +You can connect to the Apache Karaf SSH Shell using the following command: + + ssh -p 8102 karaf@localhost + +The default username/password is karaf/karaf. You should change this as soon as possible by editing the `etc/users.properties` file. + +Once connected you can simply type in : + + unomi: + +And hit the <tab> key to see the list of all the available Apache Unomi commands. Note that some commands +are only available when the application is started. + +You can also use the `help` command on any command such as in the following example: + +``` +karaf@root()> help unomi:migrate +DESCRIPTION + unomi:migrate + + This will Migrate your date in ES to be compliant with current version + +SYNTAX + unomi:migrate [fromVersionWithoutSuffix] + +ARGUMENTS + fromVersionWithoutSuffix + Origin version without suffix/qualifier (e.g: 1.2.0) + (defaults to 1.2.0) +``` +==== Lifecycle commands + +The commands control the lifecycle of the Apache Unomi server and are used to migrate, start or stop the server. + +.Table Lifecycle commands +|=== +|Command|Arguments|Description + +|migrate +|fromVersion +|This command must be used only when the Apache Unomi application is NOT STARTED. It will perform migration of the data stored in ElasticSearch using the argument fromVersion as a starting point. + +|stop +|n/a +|Shutsdown the Apache Unomi application + +|start +|n/a +|Starts the Apache Unomi application. Note that this state will be remembered between Apache Karaf launches, so in general it is only needed after a first installation or after a `migrate` command + +|version +|n/a +|Prints out the currently deployed version of the Apache Unomi application inside the Apache Karaf runtime. +|=== + +==== Runtime commands + +These commands are available once the application is running. If an argument is between brackets [] it means it is optional. + +.Table Runtime commands +|=== +|Command|Arguments|Description +|rule-list +|[--csv] +|Lists all the rules registered in the Apache Unomi server. If you add the "--csv" option the list will be output +as a CSV formatted table +|rule-view +|rule-id +|Dumps a single rule in JSON. The rule-id argument can be retrieved from the `rule-list` command output. +|rule-reset-stats +|n/a +|Resets the rule statistics. This is notably useful when trying to understand rule performance and impact +|event-tail +|n/a +|Dumps any incoming events to the Apache Unomi server to the console. Use CTRL+C to exit tail +|event-view +|event-id +|Dumps a single event in JSON. The `event-id` can be retrieved from the event-tail command output. +|action-list +|[--csv] +|Lists all the rule actions registered in the Apache Unomi server. This command is useful when developing plugins to +check that everything is properly registered. If you add the "--csv" option the list will be output + as a CSV formatted table +|action-view +|action-id +|Dumps a single action in JSON. The action-id argument can be retrieved from the `action-list` command output. +|profile-list +|[--csv] +|List the last 10 modified profiles. If you add the "--csv" option the list will be output + as a CSV formatted table +|profile-view +|profile-id +|Dumps a single profile in JSON. The profile-id argument can be retrieved from the `profile-list` command output. +|segment-list +|[--csv] +|Lists all the segments registered in the Apache Unomi server. If you add the "--csv" option the list will be output + as a CSV formatted table +|segment-view +|segment-id +|Dumps a single segment in JSON. The segment-id argument can be retrieved from the `segment-list` command output. +|session-list +|[--csv] +|Lists the last 10 sessions by last event date. If you add the "--csv" option the list will be output + as a CSV formatted table +|session-view +|session-id +|Dumps a single session in JSON. The session-id argument can be retrieved from the `session-list`, `profile-list` or + `event-tail` command output. +|deploy-definition +|[bundleId] [type] [fileName] +|This command can be used to force redeployment of definitions from bundles. By default existing definitions will not +be overriden unless they come from SNAPSHOT bundles. Using this command you can override this mechanism. Here are some +examples of using this command: `unomi:deploy-definition 175 rule *` will redeploy all the rules provided by bundle with id 175. If you launch the command without any arguments you will get prompts for what you want to deploy from which bundle + +|=== \ No newline at end of file
