Differences

This shows you the differences between two versions of the page.

--- addons:bizwizard:how-it-works [2017-12-01 11:07]
Magnus Fagerlund [Mailing]
+++ — (current)
@@ Line 1: / Line 1: @@
-====== How it works ======
-===== What does it do =====
-The Lime CRM Newsletter add-on will make marketing activities tagged as e-mail campaigns available in Bizwizard. This means that you can select a list of recipients from those marketing activities from Lime CRM when composing and sending your newsletter.
-=== Campaign/mailing list===
-E-mail campaigns created in Lime CRM will appear in Bizwizard mail module when selecting the send to list. The user must select which campaigns that should be available for selection in Bizwizard. This is done when logged in to Bizwizard mail module (each customer has their login page available at www.bwz.se).
-=== Statistics ===
-Mailing and recipient data is available on each mailing and recipient. On the recipient you can see if it has been sent, opened, clicked or bounced. On the mailing you can view HTML tabs for statistics and the mailing layout. The statistics is a pdf file which means that you need to be able to view pdf in Internet Explorer, meaning you need a IE plugin for that, example Acrobat Reader plugin.
-=== Opt-out handling ===
-Only total opt outs are shown on the person card in Lime CRM. The key is
-All Lime CRM persons also have a field indicating their global opt out status. The flag is set on all persons present in Lime CRM that are also present in the global opt out list in Apsis, with the e-mail address used as the key. The global opt out flag cannot be set or cleared using Lime CRM and exists for viewing purposes only.
-=== Bounce data ===
-All Lime CRM persons have an "hard bounce" checkbox which indicates whether or not Bizwizard has succeeded in sending email to the person using the specified address.
-  * Hard bounce: Permanent problem sending email to the address, probably due to an incorrect address.
-----
-===== Lime CRM layout =====
-==== Marketing activity ====
-Lime CRM marketing activity records are used for storing mailing lists and therefore a table having the //Campaign// label must exist. On the marketing activity table there must be three fields:
-^ Field name  ^ Required ^ Field type ^ Description ^
-| name| Yes | Text field | text field used for finding campaigns in Bizwizard. |
-| type| Yes | Option list | Used to filter out which campaigns should be available in Bizwizard. |
-| campaignstatus| Yes  | Option list | Used to filter out which campaigns should be available in Bizwizard. |
-| participant| Yes  | Relation (n-1) participant-campaign) | The participants are thoses who will get the sendout |
-| mailing| Yes  | Relation (n-1 mailing-campaign) | The mailings sent from Bizwizard |
-==== Person ====
-Identified by the table having the //Person// table label. The Bizwizard Integration will look for the fields:
-^ Field name  ^ Required ^ Field type ^ Description ^
-| firstname | Yes | Text field | Firstname |
-| lastname | Yes | Text field | Lastname |
-| email | Yes  | Link field | The email to the person __**IMPORTANT: Used as key**__  |
-| totaloptout| Yes  | Checkbox  | Read only that is controlled from Bizwizard to mark up total opt-outs |
-| emailhardbounce | Yes  | Checkbox  | Read Only that is controlled from Bizwizard to mark up hard bounces ("error" in e-mail address) |
-| recipient| Yes  | Relation (n-1 recipient-subscriber)| Relation to recipient (middle-object between mailing and person) |
-==== Company ====
-Identified by the table having the //Company// table label. The Bizwizard Integration will look for the fields:
-^ Field name  ^ Required ^ Field type ^ Description ^
-| name | Yes | Text field | Name of the company |
-| coworker | Yes | realtion (1-n coworker-company)| The coworker responsible for the customer |
-==== Mailing====
-Identified by tablename; **mailing**. Used to save mailings to campaigns and store the statistic links. All field should be Read only
-^ Field name  ^ Required ^ Field type ^ Description ^
-| subject| Yes | Text field | The subject from the mailing (1024 characters) |
-| campaign | Yes| relation: (1:n campaign-mailing) | Relation to the campaign, a campaign can have many mailings |
-| statisticlink| Yes | Link field | Hidden field used to hold statistic link from Bizwizard (1024 long) |
-| sendoutlink| Yes  | Link field| Hidden field used to hold send out link from Bizwizard, e.i the actual layout of the mail sent (1024 long) |
-| htmlstatisticlink| No | Html-tab | SQL-expression: [mailing].[statisticlink]. Displays the content of the statistic link |
-| htmlsendoutlink| No | Html-tab  | SQL-expression: [mailing].[sendoutlink]. Displays the content of the send out link |
-| mailingid| Yes| Integer | The mailing id from Bizwizard, should be hidden|
-| senddate| Yes| Datetime (only date) | The date when the mailing was done|
-==== Recipient====
-Identified by table name; **recipient**. Used to store recipients connected to a certain mailing and store their mailing status (sent, opened, clicked and bounce). All fields should be read-only.
-^ Field name  ^ Required ^ Field type ^ Description ^
-| person | Yes | relation: (1:n person-recipient) | Relation to the person, a person can have many recipients |
-| mailing| Yes| relation: (1:n mailing-recipient) | Relation to the mailing, a mailing can have many recipients |
-| sendoutstatus| Yes  | Option list | Used to set status for the mailing. must contain correct option keys|
-=== Field: sendoutstatus ===
-Option keys:
-  * sent
-  * open
-  * clicked
-  * bounce
-----
-===== Technical =====
-The Lime CRM NEwsletter add-on is a .NET 4.0 based application implemented as a Windows service. It uses the Lime CRM Web Service (SOAP) to communicate with Lime CRM.