You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ofbiz.apache.org by ho...@apache.org on 2020/07/02 09:15:08 UTC
[ofbiz-framework] 01/02: Documented: Marketing migration to
asciidoc and new documentation organization (OFBIZ-11577)
This is an automated email from the ASF dual-hosted git repository.
holivier pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/ofbiz-framework.git
commit 2f7aa0423651995da8db5903386ee3971e25f494
Author: holivier <ho...@apache.org>
AuthorDate: Tue Mar 31 14:53:22 2020 +0200
Documented: Marketing migration to asciidoc and new documentation
organization
(OFBIZ-11577)
Main files and ContactList
---
.../asciidoc/_include/HELP_EditContactList.adoc | 36 +++++++++++++++
.../asciidoc/_include/HELP_FindContactLists.adoc | 28 ++++++++++++
.../_include/HELP_ImportContactListParties.adoc | 32 ++++++++++++++
.../asciidoc/_include/marketing_ContactLists.adoc | 31 +++++++++++++
.../marketing/src/docs/asciidoc/marketing.adoc | 51 ++++++++++++++++++++++
docs/asciidoc/user-manual.adoc | 2 +
6 files changed, 180 insertions(+)
diff --git a/applications/marketing/src/docs/asciidoc/_include/HELP_EditContactList.adoc b/applications/marketing/src/docs/asciidoc/_include/HELP_EditContactList.adoc
new file mode 100644
index 0000000..8b38cf2
--- /dev/null
+++ b/applications/marketing/src/docs/asciidoc/_include/HELP_EditContactList.adoc
@@ -0,0 +1,36 @@
+////
+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.
+////
+= Edit a contact list.
+This screen enables you to edit an existing contactlist or create a new one.
+Below an explanation of the fields
+
+== Contact list fields.
+* ContactList Id : The unique id of the contact list
+* ContactList Name : The name of the contactlist
+* ContactList Type : The type of the contactlist
+* Is Public ? :
+* Is Single Use ? : If set to 'Y' all parties of this contactlist will be deleted after sending the email.
+* Contact Mech type: the contact type like email, postal address etc.
+* Marketing Campaign Name : The marketing campaign name
+* Owner Party Id:
+* Verify Email From:
+* Verify Email Screen:
+* Verify Email Subject:
+* Verify Email WebSite Id:
+* Opt Out Screen:
\ No newline at end of file
diff --git a/applications/marketing/src/docs/asciidoc/_include/HELP_FindContactLists.adoc b/applications/marketing/src/docs/asciidoc/_include/HELP_FindContactLists.adoc
new file mode 100644
index 0000000..4dd96fc
--- /dev/null
+++ b/applications/marketing/src/docs/asciidoc/_include/HELP_FindContactLists.adoc
@@ -0,0 +1,28 @@
+////
+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.
+////
+
+= Help for Find contact list screen
+This is the initial screen to find an existing contactlist or create a new one.
+
+== Find selection fields.
+* ContactList Id : The unique id of the contact list
+* ContactList Name : The name of the contactlist
+* ContactList Type : The type of the contactlist
+* Contact Mech type : the contact type like email, postal address etc.
+* Campaign Name : The marketing campaign name
\ No newline at end of file
diff --git a/applications/marketing/src/docs/asciidoc/_include/HELP_ImportContactListParties.adoc b/applications/marketing/src/docs/asciidoc/_include/HELP_ImportContactListParties.adoc
new file mode 100644
index 0000000..60e2674
--- /dev/null
+++ b/applications/marketing/src/docs/asciidoc/_include/HELP_ImportContactListParties.adoc
@@ -0,0 +1,32 @@
+////
+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.
+////
+
+= Help for import contact list parties
+This is the initial screen to find an existing parties and select them for import to the contact list.
+
+== Find selection fields.
+* Party Id : The unique id of the party
+* Party Type Id : The type of the party
+* Role Type : The role of the party
+* Contact Mech Type Id : the contact type according to the contact meth type's ID of the contact list. +
+ There is a sub form for this field according to the contact mech type's ID.
+
+== Import the parties
+1. Select the parties in the search result list.
+2. Press the "Submit Query" button
\ No newline at end of file
diff --git a/applications/marketing/src/docs/asciidoc/_include/marketing_ContactLists.adoc b/applications/marketing/src/docs/asciidoc/_include/marketing_ContactLists.adoc
new file mode 100644
index 0000000..0dfda18
--- /dev/null
+++ b/applications/marketing/src/docs/asciidoc/_include/marketing_ContactLists.adoc
@@ -0,0 +1,31 @@
+////
+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.
+////
+= Marketing Contact Lists.
+
+A contactlist is currently an email mailing list to inform a certain number of parties via email. +
+The system however already has a provision to use this facility for calling list or to create mail and merge list
+for paper documents.
+
+== Contact Lists management in UI
+include::HELP_FindContactLists.adoc[leveloffset=+2]
+
+include::HELP_EditContactList.adoc[leveloffset=+2]
+
+include::HELP_ImportContactListParties.adoc[leveloffset=+2]
+
diff --git a/applications/marketing/src/docs/asciidoc/marketing.adoc b/applications/marketing/src/docs/asciidoc/marketing.adoc
new file mode 100644
index 0000000..458927a
--- /dev/null
+++ b/applications/marketing/src/docs/asciidoc/marketing.adoc
@@ -0,0 +1,51 @@
+////
+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.
+////
+= Marketing
+
+The overall purpose of the Marketing application is the support to select leads from parties obtained from a certain source
+or marketing segment to convert to opportunities by contacting these parties via a contact-list related to a marketing campaign. +
+(contact-list generation support not yet implemented)
+
+The first option of the marketing application is the definition of a datasource [DataSource], and connecting or
+loading party information to it [PartyDataSource]. In the party application a data source Id can be added to the party.
+
+A second input to the marketing application is the Segment group and classification which again can be allocated to parties
+in the party component.
+
+Now a marketing campaign can be created.
+A contact list can be created using the parties related to a dataSource or marketing segment classification and referring back
+to the marketing campaign
+
+Contact lists are currently email mailinglists, the OFBiz system could be extended to include the support of calling by telephone
+and entering the results. +
+On the email sent via this lists tracking codes can be used to measure the response when the readers of the email mailing
+click on a link where a trackingcode is specified. +
+For more info look at the program: `applications/marketing/src/org/apache/ofbiz/marketing/tracking/TrackingCodeEvents.java`
+
+Opportunities resulting from these actions can be entered in the SFA web application referring back to the marketing campaign.
+
+== Marketing in User Interface
+=== Help for main screen
+This page acts as an placeholder of the overview of the marketing activity in the company.
+
+It can be customized to describe internal process.
+
+
+include::_include/marketing_ContactLists.adoc[leveloffset=+1]
+
diff --git a/docs/asciidoc/user-manual.adoc b/docs/asciidoc/user-manual.adoc
index 17cb319..74b46d0 100644
--- a/docs/asciidoc/user-manual.adoc
+++ b/docs/asciidoc/user-manual.adoc
@@ -160,3 +160,5 @@ include::../../applications/content/src/docs/asciidoc/content.adoc[leveloffset=+
include::../../applications/humanres/src/docs/asciidoc/humanres.adoc[leveloffset=+2]
include::../../applications/manufacturing/src/docs/asciidoc/manufacturing.adoc[leveloffset=+2]
+
+include::../../applications/marketing/src/docs/asciidoc/marketing.adoc[leveloffset=+2]