[ofbiz-framework] branch trunk updated (8160a57 -> 19f10cc)
Locked
 
|
This is an automated email from the ASF dual-hosted git repository.
holivier pushed a change to branch trunk in repository https://gitbox.apache.org/repos/asf/ofbiz-framework.git. from 8160a57 Added Changelog.adoc file (#206) new 2f7aa04 Documented: Marketing migration to asciidoc and new documentation organization (OFBIZ-11577) new 19f10cc Documented: migrate help link to asciidoc user manual for marketing (OFBIZ-11577) The 2 revisions listed above as "new" are entirely new to this repository and will be described in separate emails. The revisions listed as "add" were already present in the repository and have only been added to this reference. Summary of changes: .../data/HELP_MARKETING.xml} | 19 +++--- applications/marketing/data/MarketingHelpData.xml | 33 +---------- .../marketing/data/helpdata/HELP_MARKETING.xml | 67 ---------------------- .../data/helpdata/HELP_MARKETING_ContactLists.xml | 35 ----------- .../helpdata/HELP_MARKETING_EditContactList.xml | 46 --------------- .../helpdata/HELP_MARKETING_FindContactLists.xml | 38 ------------ .../HELP_MARKETING_ImportContactListParties.xml | 41 ------------- .../data/helpdata/HELP_MARKETING_main.xml | 32 ----------- .../asciidoc/_include/HELP_EditContactList.adoc | 20 ++++++- .../asciidoc/_include/HELP_FindContactLists.adoc} | 14 +++-- .../_include/HELP_ImportContactListParties.adoc} | 17 ++++-- .../asciidoc/_include/marketing_ContactLists.adoc} | 16 +++--- .../marketing/src/docs/asciidoc/marketing.adoc | 51 ++++++++++++++++ applications/marketing/widget/CommonScreens.xml | 1 + .../marketing/widget/ContactListScreens.xml | 5 +- docs/asciidoc/user-manual.adoc | 2 + 16 files changed, 117 insertions(+), 320 deletions(-) copy applications/{manufacturing/data/Help_MFG.xml => marketing/data/HELP_MARKETING.xml} (62%) delete mode 100644 applications/marketing/data/helpdata/HELP_MARKETING.xml delete mode 100644 applications/marketing/data/helpdata/HELP_MARKETING_ContactLists.xml delete mode 100644 applications/marketing/data/helpdata/HELP_MARKETING_EditContactList.xml delete mode 100644 applications/marketing/data/helpdata/HELP_MARKETING_FindContactLists.xml delete mode 100644 applications/marketing/data/helpdata/HELP_MARKETING_ImportContactListParties.xml delete mode 100644 applications/marketing/data/helpdata/HELP_MARKETING_main.xml copy CONTRIBUTING.adoc => applications/marketing/src/docs/asciidoc/_include/HELP_EditContactList.adoc (52%) copy applications/{accounting/src/docs/asciidoc/_include/HELP_ViewGatewayResponse.adoc => marketing/src/docs/asciidoc/_include/HELP_FindContactLists.adoc} (65%) copy applications/{accounting/src/docs/asciidoc/_include/HELP_EditTaxAuthorityPartyInfo.adoc => marketing/src/docs/asciidoc/_include/HELP_ImportContactListParties.adoc} (57%) copy applications/{humanres/src/docs/asciidoc/_include/HELP-hr-NewEmployee.adoc => marketing/src/docs/asciidoc/_include/marketing_ContactLists.adoc} (62%) create mode 100644 applications/marketing/src/docs/asciidoc/marketing.adoc |
|
|
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 <[hidden email]> 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] |
|
|
In reply to this post by holivier
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 19f10cc24bb88896fbcb9112529d5910d78d9d54 Author: holivier <[hidden email]> AuthorDate: Thu Jul 2 11:07:16 2020 +0200 Documented: migrate help link to asciidoc user manual for marketing (OFBIZ-11577) All files have been migrated to asciidoc format and help link now point to the html file generated from the asciidoc files In the global Help Docbook index tree, remove all points about marketing and add a short page with a link to the new help Remove docbook help files for marketing --- .../HELP_MARKETING_main.xml => HELP_MARKETING.xml} | 22 ++++--- applications/marketing/data/MarketingHelpData.xml | 33 +---------- .../marketing/data/helpdata/HELP_MARKETING.xml | 67 ---------------------- .../data/helpdata/HELP_MARKETING_ContactLists.xml | 35 ----------- .../helpdata/HELP_MARKETING_EditContactList.xml | 46 --------------- .../helpdata/HELP_MARKETING_FindContactLists.xml | 38 ------------ .../HELP_MARKETING_ImportContactListParties.xml | 41 ------------- applications/marketing/widget/CommonScreens.xml | 1 + .../marketing/widget/ContactListScreens.xml | 5 +- 9 files changed, 22 insertions(+), 266 deletions(-) diff --git a/applications/marketing/data/helpdata/HELP_MARKETING_main.xml b/applications/marketing/data/HELP_MARKETING.xml similarity index 60% rename from applications/marketing/data/helpdata/HELP_MARKETING_main.xml rename to applications/marketing/data/HELP_MARKETING.xml index a31d7d5..55005ca 100644 --- a/applications/marketing/data/helpdata/HELP_MARKETING_main.xml +++ b/applications/marketing/data/HELP_MARKETING.xml @@ -7,9 +7,9 @@ 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 @@ -17,16 +17,22 @@ specific language governing permissions and limitations under the License. --> -<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5.0" - xmlns:xl="http://www.w3.org/1999/xlink" +<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5.0" + xmlns:xl="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd" xmlns="http://docbook.org/ns/docbook"> - <title>Marketing main help screen.</title> - <section> + <title>Marketing Help redirection</title> <para> - This page acts as an placeholder of the overview of the marketing activity in the company. + 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) </para> - </section> + <para>Marketing Help has been migrated to a new system, you can access it by using + <link xl:href="https://ci.apache.org/projects/ofbiz/site/trunk/ofbizdoc/html5/user-manual.html#_marketing">OFBiz user documentation site / Marketing</link> + </para> + </section> diff --git a/applications/marketing/data/MarketingHelpData.xml b/applications/marketing/data/MarketingHelpData.xml index 0749f5f..e42f87a 100644 --- a/applications/marketing/data/MarketingHelpData.xml +++ b/applications/marketing/data/MarketingHelpData.xml @@ -19,40 +19,13 @@ under the License. --> <entity-engine-xml> <!-- chapter Marketing--> - <DataResource dataResourceId="HELP_MARKETING" localeString="en" dataResourceTypeId="OFBIZ_FILE" - objectInfo="applications/marketing/data/helpdata/HELP_MARKETING.xml" dataTemplateTypeId="NONE" statusId="CTNT_IN_PROGRESS" + <DataResource dataResourceId="HELP_MARKETING" localeString="en" dataResourceTypeId="OFBIZ_FILE" + objectInfo="applications/marketing/data/HELP_MARKETING.xml" dataTemplateTypeId="NONE" statusId="CTNT_IN_PROGRESS" dataResourceName="Marketing Overview" mimeTypeId="text/xml" isPublic="Y" /> - <Content contentId="HELP_MARKETING" contentTypeId="DOCUMENT" contentName="Marketing" templateDataResourceId="HELP_TEMPL" + <Content contentId="HELP_MARKETING" contentTypeId="DOCUMENT" contentName="Marketing" templateDataResourceId="HELP_TEMPL" dataResourceId="HELP_MARKETING" statusId="CTNT_IN_PROGRESS" mimeTypeId="text/html"/> <ContentAssoc contentId="HELP_ROOT" contentIdTo="HELP_MARKETING" contentAssocTypeId="TREE_CHILD" fromDate="2006-01-12 01:01:01" sequenceNum="000"/> - <!-- marketing help --> - <DataResource dataResourceId="MARKETING_main" localeString="en" dataResourceTypeId="OFBIZ_FILE" - objectInfo="applications/marketing/data/helpdata/HELP_MARKETING_main.xml" dataTemplateTypeId="NONE" statusId="CTNT_IN_PROGRESS" dataResourceName="Marketing Main Help" mimeTypeId="text/xml" isPublic="Y" /> - <Content contentId="MARKETING_main" contentTypeId="DOCUMENT" contentName="MARKETING Main Help" templateDataResourceId="HELP_TEMPL" dataResourceId="MARKETING_main" statusId="CTNT_IN_PROGRESS" mimeTypeId="text/html"/> - <ContentAssoc contentId="HELP_MARKETING" contentIdTo="MARKETING_main" contentAssocTypeId="TREE_CHILD" fromDate="2006-01-12 01:01:01" sequenceNum="000" mapKey="MARKETING_main"/> - - <!-- Contact list help --> - <DataResource dataResourceId="MARKETING_ContLsts" localeString="en" dataResourceTypeId="OFBIZ_FILE" - objectInfo="applications/marketing/data/helpdata/HELP_MARKETING_ContactLists.xml" dataTemplateTypeId="NONE" statusId="CTNT_IN_PROGRESS" dataResourceName="Marketing Contact Lists" mimeTypeId="text/xml" isPublic="Y" /> - <Content contentId="MARKETING_ContLsts" contentTypeId="DOCUMENT" contentName="MARKETING Contact lists" templateDataResourceId="HELP_TEMPL" dataResourceId="MARKETING_ContLsts" statusId="CTNT_IN_PROGRESS" mimeTypeId="text/html"/> - <ContentAssoc contentId="HELP_MARKETING" contentIdTo="MARKETING_ContLsts" contentAssocTypeId="TREE_CHILD" fromDate="2006-01-12 01:01:01" sequenceNum="000"/> - - <DataResource dataResourceId="MARKETING_FindContL" localeString="en" dataResourceTypeId="OFBIZ_FILE" - objectInfo="applications/marketing/data/helpdata/HELP_MARKETING_FindContactLists.xml" dataTemplateTypeId="NONE" statusId="CTNT_IN_PROGRESS" dataResourceName="Marketing Main Help" mimeTypeId="text/xml" isPublic="Y" /> - <Content contentId="MARKETING_FindContL" contentTypeId="DOCUMENT" contentName="MARKETING Find contactlist" templateDataResourceId="HELP_TEMPL" dataResourceId="MARKETING_FindContL" statusId="CTNT_IN_PROGRESS" mimeTypeId="text/html"/> - <ContentAssoc contentId="MARKETING_ContLsts" contentIdTo="MARKETING_FindContL" contentAssocTypeId="TREE_CHILD" fromDate="2006-01-12 01:01:01" sequenceNum="000" mapKey="MARKETING_FindContactLists"/> - - <DataResource dataResourceId="MARKETING_EditContL" localeString="en" dataResourceTypeId="OFBIZ_FILE" - objectInfo="applications/marketing/data/helpdata/HELP_MARKETING_EditContactList.xml" dataTemplateTypeId="NONE" statusId="CTNT_IN_PROGRESS" dataResourceName="Marketing Main Help" mimeTypeId="text/xml" isPublic="Y" /> - <Content contentId="MARKETING_EditContL" contentTypeId="DOCUMENT" contentName="MARKETING Edit contactlist" templateDataResourceId="HELP_TEMPL" dataResourceId="MARKETING_EditContL" statusId="CTNT_IN_PROGRESS" mimeTypeId="text/html"/> - <ContentAssoc contentId="MARKETING_ContLsts" contentIdTo="MARKETING_EditContL" contentAssocTypeId="TREE_CHILD" fromDate="2006-01-12 01:01:01" sequenceNum="000" mapKey="MARKETING_EditContactList"/> - - <DataResource dataResourceId="MARKETING_ImpoContLP" localeString="en" dataResourceTypeId="OFBIZ_FILE" - objectInfo="applications/marketing/data/helpdata/HELP_MARKETING_ImportContactListParties.xml" dataTemplateTypeId="NONE" statusId="CTNT_IN_PROGRESS" dataResourceName="Marketing Main Help" mimeTypeId="text/xml" isPublic="Y" /> - <Content contentId="MARKETING_ImpoContLP" contentTypeId="DOCUMENT" contentName="MARKETING Import contactlist Parties" templateDataResourceId="HELP_TEMPL" dataResourceId="MARKETING_ImpoContLP" statusId="CTNT_IN_PROGRESS" mimeTypeId="text/html"/> - <ContentAssoc contentId="MARKETING_ContLsts" contentIdTo="MARKETING_ImpoContLP" contentAssocTypeId="TREE_CHILD" fromDate="2006-01-12 01:01:01" sequenceNum="000" mapKey="MARKETING_FindImportContactListParties"/> - <!-- Chapter SFA --> <DataResource dataResourceId="HELP_SFA" localeString="en" dataResourceTypeId="OFBIZ_FILE" objectInfo="applications/marketing/data/helpdata/HELP_SFA.xml" dataTemplateTypeId="NONE" statusId="CTNT_IN_PROGRESS" diff --git a/applications/marketing/data/helpdata/HELP_MARKETING.xml b/applications/marketing/data/helpdata/HELP_MARKETING.xml deleted file mode 100644 index 6e4b974..0000000 --- a/applications/marketing/data/helpdata/HELP_MARKETING.xml +++ /dev/null @@ -1,67 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!-- - 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. ---> -<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5.0" - xmlns:xl="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd" - xmlns="http://docbook.org/ns/docbook"> - <title>Marketing overview</title> - <para> - 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) - </para> - <para> - 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. - </para> - <para> - A second input to the marketing application is the Segment group and - classification which again can be allocated to parties in the party - component. - </para> - <para> - 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 - </para> - <para> - 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 - </para> - <para> - Opportunities resulting from these actions can be entered in the SFA - web application referring back to the marketing campaign. - </para> - - <xi:include href="HELP_MARKETING_main.xml" /> - <xi:include href="HELP_MARKETING_ContactLists.xml" /> - -</section> - diff --git a/applications/marketing/data/helpdata/HELP_MARKETING_ContactLists.xml b/applications/marketing/data/helpdata/HELP_MARKETING_ContactLists.xml deleted file mode 100644 index 6930c5b..0000000 --- a/applications/marketing/data/helpdata/HELP_MARKETING_ContactLists.xml +++ /dev/null @@ -1,35 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!-- - 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. ---> -<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5.0" - xmlns:xl="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd" - xmlns="http://docbook.org/ns/docbook"> - <title>Marketing Contact Lists.</title> - <para> - 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. - </para> - <xi:include href="HELP_MARKETING_FindContactLists.xml" /> - <xi:include href="HELP_MARKETING_EditContactList.xml" /> - <xi:include href="HELP_MARKETING_ImportContactListParties.xml" /> -</section> - diff --git a/applications/marketing/data/helpdata/HELP_MARKETING_EditContactList.xml b/applications/marketing/data/helpdata/HELP_MARKETING_EditContactList.xml deleted file mode 100644 index 9579577..0000000 --- a/applications/marketing/data/helpdata/HELP_MARKETING_EditContactList.xml +++ /dev/null @@ -1,46 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!-- - 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. ---> -<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5.0" - xmlns:xl="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd" - xmlns="http://docbook.org/ns/docbook"> - <title>Edit a contact list.</title> - <para> - This screen enables you to edit an existing contactlist or create a new one. Below an explanation of the fields - </para> - <section> - <title>Contact list fields.</title> - <para>ContactList Id : The unique id of the contact list</para> - <para>ContactList Name : The name of the contactlist</para> - <para>ContactList Type : The type of the contactlist</para> - <para>Is Public ? : </para> - <para>Is Single Use ? : If set to 'Y' all parties of this contactlist will be deleted after sending the email.</para> - <para>Contact Mech type: the contact type like email, postal address etc.</para> - <para>Marketing Campaign Name : The marketing campaign name</para> - <para>Owner Party Id:</para> - <para>Verify Email From:</para> - <para>Verify Email Screen:</para> - <para>Verify Email Subject:</para> - <para>Verify Email WebSite Id:</para> - <para>Opt Out Screen:</para> - </section> -</section> - diff --git a/applications/marketing/data/helpdata/HELP_MARKETING_FindContactLists.xml b/applications/marketing/data/helpdata/HELP_MARKETING_FindContactLists.xml deleted file mode 100644 index cdd9b37..0000000 --- a/applications/marketing/data/helpdata/HELP_MARKETING_FindContactLists.xml +++ /dev/null @@ -1,38 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!-- - 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. ---> -<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5.0" - xmlns:xl="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd" - xmlns="http://docbook.org/ns/docbook"> - <title>The Find contact list screen</title> - <para> - This is the initial screen to find an existing contactlist or create a new one. - </para> - <section> - <title>Find selection fields.</title> - <para>ContactList Id : The unique id of the contact list</para> - <para>ContactList Name : The name of the contactlist</para> - <para>ContactList Type : The type of the contactlist</para> - <para>Contact Mech type : the contact type like email, postal address etc.</para> - <para>Campaign Name : The marketing campaign name</para> - </section> -</section> - diff --git a/applications/marketing/data/helpdata/HELP_MARKETING_ImportContactListParties.xml b/applications/marketing/data/helpdata/HELP_MARKETING_ImportContactListParties.xml deleted file mode 100644 index 502f2c1..0000000 --- a/applications/marketing/data/helpdata/HELP_MARKETING_ImportContactListParties.xml +++ /dev/null @@ -1,41 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!-- - 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. ---> -<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5.0" - xmlns:xl="http://www.w3.org/1999/xlink" - xmlns:xi="http://www.w3.org/2001/XInclude" - xsi:schemaLocation="http://docbook.org/ns/docbook ../../../content/dtd/docbook.xsd" - xmlns="http://docbook.org/ns/docbook"> - <title>The import contact list parties screen</title> - <para> - This is the initial screen to find an existing parties and select them for import to the contact list. - </para> - <section> - <title>Find selection fields.</title> - <para>Party Id : The unique id of the party</para> - <para>Party Type Id : The type of the party</para> - <para>Role Type : The role of the party</para> - <para>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.</para> - </section> - <section> - <title>Import the parties</title> - <para>Select the parties in the search result list.</para> - <para>Press the "Submit Query" button</para> - </section> -</section> diff --git a/applications/marketing/widget/CommonScreens.xml b/applications/marketing/widget/CommonScreens.xml index 1efaa7e..4574241 100644 --- a/applications/marketing/widget/CommonScreens.xml +++ b/applications/marketing/widget/CommonScreens.xml @@ -40,6 +40,7 @@ under the License. <set field="applicationTitle" from-field="uiLabelMap.MarketingManagerApplication" global="true"/> <set field="applicationMenuName" value="MarketingAppBar" global="true"/> <set field="applicationMenuLocation" value="component://marketing/widget/MarketingMenus.xml" global="true"/> + <set field="helpAnchor" from-field="helpAnchor" default-value="_marketing"/> </actions> <widgets> <include-screen name="ApplicationDecorator" location="component://commonext/widget/CommonScreens.xml"/> diff --git a/applications/marketing/widget/ContactListScreens.xml b/applications/marketing/widget/ContactListScreens.xml index 5945412..0090dae 100644 --- a/applications/marketing/widget/ContactListScreens.xml +++ b/applications/marketing/widget/ContactListScreens.xml @@ -26,7 +26,8 @@ under the License. <actions> <set field="titleProperty" value="MarketingContactListFindContactLists"/> <set field="headerItem" value="ContactList"/> - <set field="tabButtonItem" value="ContactList"/> + <set field="tabButtonItem" value="ContactList"/> + <set field="helpAnchor" value="_help_for_find_contact_list_screen"/> <set field="contactListTabButtonItem" value="ContactList"/> <set field="labelTitleProperty" value="PageTitleFindContactLists"/> <set field="donePage" from-field="parameters.DONE_PAGE" default-value="/marketing/control/FindContactList"/> @@ -60,6 +61,7 @@ under the License. <actions> <set field="titleProperty" value="PageTitleEditContactList"/> <set field="contactListTabButtonItem" value="ContactList"/> + <set field="helpAnchor" value="_edit_a_contact_list"/> <set field="labelTitleProperty" value="PageTitleEditContactList"/> <set field="donePage" from-field="parameters.DONE_PAGE" default-value="/marketing/control/ListContactLists"/> @@ -342,6 +344,7 @@ under the License. <actions> <set field="titleProperty" value="PageTitleFindImportContactListParties"/> <set field="contactListTabButtonItem" value="ContactListImportParty"/> + <set field="helpAnchor" value="_help_for_import_contact_list_parties"/> <set field="labelTitleProperty" value="PageTitleFindImportContactListParties"/> <set field="donePage" from-field="parameters.DONE_PAGE" default-value="FindImportContactListParties?contactListId=${parameters.contactListId}"/> |
«
Return to OFBiz - Commits
|
1 view|%1 views
| Free forum by Nabble | Edit this page |