You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@unomi.apache.org by dg...@apache.org on 2018/11/05 17:30:44 UTC
incubator-unomi git commit: UNOMI-208 convert mailchimp connector
documentation to adoc
Repository: incubator-unomi
Updated Branches:
refs/heads/master 67657bdb1 -> 781cab948
UNOMI-208 convert mailchimp connector documentation to adoc
Project: http://git-wip-us.apache.org/repos/asf/incubator-unomi/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-unomi/commit/781cab94
Tree: http://git-wip-us.apache.org/repos/asf/incubator-unomi/tree/781cab94
Diff: http://git-wip-us.apache.org/repos/asf/incubator-unomi/diff/781cab94
Branch: refs/heads/master
Commit: 781cab94867e7d60047914c810259630fc1c85c7
Parents: 67657bd
Author: dgaillard <dg...@jahia.com>
Authored: Mon Nov 5 18:30:22 2018 +0100
Committer: dgaillard <dg...@jahia.com>
Committed: Mon Nov 5 18:30:38 2018 +0100
----------------------------------------------------------------------
extensions/unomi-mailchimp/README.md | 103 -------------------
.../connectors/mailchimp-connector.adoc | 100 ++++++++++++++++++
2 files changed, 100 insertions(+), 103 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/781cab94/extensions/unomi-mailchimp/README.md
----------------------------------------------------------------------
diff --git a/extensions/unomi-mailchimp/README.md b/extensions/unomi-mailchimp/README.md
deleted file mode 100644
index 0d6f525..0000000
--- a/extensions/unomi-mailchimp/README.md
+++ /dev/null
@@ -1,103 +0,0 @@
-<!--
- ~ 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.
- -->
-
-
-Apache Unomi :: Extensions :: 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
-
-1. Create a new MailChimp account:
-
- https://login.mailchimp.com/signup/
-
-2. Generate a new API Key, or get the default
-
- https://usX.admin.mailchimp.com/account/api/
-
-3. Configure the MailChimp Connector Basic
- In the etc/org.apache.unomi.mailchimpconnector.cfg file change the following settings:
- ```
- mailChimpConnector.apiKey=YOUR_APIKEY
- mailChimpConnector.url.subDomain=YOUR_SUB_DOMAIN (exemple: https://usX.admin.mailchimp.com/account/api/, the X is the SUB_DOMAIN)
- ```
-
-
-4. 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.
-
- ```
- 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 type supported 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
-
- Example:
- ```
- address<=>ADDRESS<=>addr1,
- city<=>ADDRESS<=>city,
- zipCode<=>ADDRESS<=>zip,
- countryName<=>ADDRESS<=>country
- ```
-
-5. Deploy into Apache Unomi using the following commands from the Apache Karaf shell:
-
- 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/781cab94/manual/src/main/asciidoc/connectors/mailchimp-connector.adoc
----------------------------------------------------------------------
diff --git a/manual/src/main/asciidoc/connectors/mailchimp-connector.adoc b/manual/src/main/asciidoc/connectors/mailchimp-connector.adoc
new file mode 100644
index 0000000..e66b828
--- /dev/null
+++ b/manual/src/main/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.
+//
+=== Apache Unomi :: Extensions :: 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
+----