Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: DOCU-2700

...

clearboth
width244px
alignright
classmenu

This page describes shows how to enable data privacy features offered by Magnolia with your third-party marketing automation system.Magnolia provides a sample implementation showing how you can collect leads (such as email addresses) on ensure data privacy when you collect personal data on the website and store data in an external system. In this example we collect an email address from the visitor in a web form, ask the visitor for their consent, and push those leads to store the data in IBM Watson Marketing. The example on this page makes use of the Privacy moduleIBM Marketing cloud connector and External Forms IBM modules.

Note

Note that External Forms is an EE std module and is not bundled. You should only use:

  • magnolia-external-forms – provides functionality to render external forms as Magnolia forms.
  • magnolia-external-forms-ibmprovides the example implementation for the IBM Watson Campaign Automation tool.

Do not include the Infusionsoft and Eloqua submodules.

uses the Magnolia External Forms IBM module and the Magnolia Data privacy API.

Table of Contents

How the example works

The External Forms IBM module adds a watsonFormSample page In the sample implementation, the magnolia-external-forms-ibm module (sub module of External Forms) provides a page called watsonFormSample (and a followup confrmation page) in the Pages app. This The page contains a simple form with an email field form linked to . The form was created in IBM Watson . The form is processed using an out-of-the-box processor called XXXand is rendered by Magnolia.

Image Added

When a visitor types their email address into the field and submits the form, Magnolia processes the input. Magnolia uses an 

Javadoc resource link
classNameinfo.magnolia.extforms.services.ExternalFormService
renderTypeasynchronous
 named ibm to process the form data. Magnolia asks the visitor to give consent for storing personal data and how long that consent should be valid.

Image Added

The example uses Magnolia's default data privacy mechanism. The mechanism records the consent in the Visitors app Magnolia and links to IBM Watson as the external data storage. The default privacy mechanism comes from magnolia‐privacy‐visitor‐manager which is a submodule of the Privacy module. A custom visitor reference searcher called The visitor consent tracking mechanism is provided using the default implementation of the magnolia‐privacy‐visitor‐manager module (sub module of Privacy module). A dedicated visitor references searcher called info.magnolia.extforms.consent.WatsonReferencesSearcher processes GDPR-sensitive data from the forms.the personal data on the form.

Similar to the IBM Watson example, Magnolia provides a sample for IBM Watson Campaign Automation but you can connect to any external form provider by writing custom forms, custom form processors in Javascript/Nashorn and your own implementation of the a different external marketing automation tool or your own CRM system. See the examples for Eloqua and InfusionSoft. You need to render the forms created in the external system and process the submitted data in Java or JavaScript/Nashorn. For data privacy, use the Magnolia default 

Javadoc resource link
classNameinfo.magnolia.consent.visitor.VisitorManager
renderTypeasynchronous
 or implement your own.

DIAGRAMImage Added

Table of Contents

Configuring the sample 

To enable the sample with your implementation of IMB Watson follow the steps in the sections below.

Connect to the external database

Installation

Install the External Forms module which is an EE Standard module. The module is not bundled with Magnolia by default.

Required artifacts:

  • External forms: eenders external forms as Magnolia forms.

  • External forms IBM: example implementation for the IBM Watson Campaign Automation tool.

  • (warning) External forms Infusionsoft: not needed, you can exclude this.
  • (warning) External forms Eloqua: not needed, you can exclude this.

Configuration

Connecting to IBM Watson database

  1. Create If you do not already have one, create a Single Opt-In database in your in Watson Campaign Automation account.
  2. Make sure that Email is one of the fields in your database. 
  3. Once created, open Open the additional details and copy the Database ID.
  4. In Magnolia, open the configuration of the magnolia-privacy-visitor-manager module: go to Configuration app > /modules/visitor-manager/config/visitorReferencesSearchers/watson/databasesIds
  5. Add a property watsonid property node under databaseIds with  and set its value to the Database ID you copied previously as the valueearlier.
    The name of the property node is unimportantarbitrary. You can add as many database ids IDs as required. 
  6. In Magnolia, open the configuration of the magnolia-external-forms-ibm module: Go to Configuration app > /modules/external-forms-ibm/config
  7. Add your IBM Watson credentials for the three property nodesproperties:
    • clientId
    • clientSecret
    • refreshToken

XXXWhere would a customer get these credentials?

...

Creating an external web form with a

...

privacy-aware email field

If you already have an IBM Watson Marketing Automation web form with an email Email field, connect to it directly in add the form on the watsonFormSample page. Use the External Form component. XXX

The External Form component in the watsonFormSample page is preconfigured to:

 The component extends the default externalForm component and does the following:

  • Fetches a form from IBM Watson as configured in site URL.
  • Asks
  • Fetch data from IBM Watson.
  • Ask for visitor consent before submitting the form by displaying consent checkboxes. The consent is given by checking a box.
  • Send Sends the visitor an opt-in email . The XXX Opt-in Email tab configures the parts of the email which are sent to the user in for the second phase of the opt-in procedure.

To create an external web form and connect it to Magnolia:

  1. In your IBM Watson Automation Campaign database, create a new standard web form.
  2. Keep the default form fields in the new form and follow the instructions in the IBM wizard. 
  3. Publish the form.
  4. On the Publish Confirmation page, click Publish Site.
  5. In the Site Settings, copy the site URL. For example: , for example http://www.pages03.net/trial-magnoliainternational/<sitename>/Form
  6. In Magnolia, go to the Pages app and open the watsonFormSample page: http://localhost:8080/magnoliaAuthor/.magnolia/admincentral#app:pages:detail;/watsonFormSample:edit
    Image Added
  7. Edit the External Form sample component to add . Add the URL of the site you just published.
    Image RemovedImage Removed
    The External Form component can now fetch data from IBM Watson Automation CampaignImage Added
Hide block

Moved to a hide block and publishing of this left as "pending" cause the info is not the "optimum" we'd like to teach the users.

Note

If you encounter problems, try refreshing the configuration of the  magnolia-external-forms-ibm  module. To do so,

open

navigate to a property in Configuration app > /modules/external-forms-ibm/config , enter the property's value and close it again. This restarts the module.

...

The component can now fetch data from IBM Watson Automation Campaign.

Viewing consent in Magnolia and IBM Watson Campaign Automation

Info

If you want to act as a visitor and test this process yourself, you must configure your Mail settings in Magnolia first.

  1. Preview the watsonFormSample page

...

When a visitor submits their email address in the form, consent is requested by email (same as JCR forms in Magnolia).

In this sample, the email requests the user open the confirmation subpage and click Proceed to confirm their consent. This acts as the double opt-in mechanism. 

Enter your email address and 

...

  1. in the Pages app.
  2. Fill the form with your email address.
  3. Give consent to processing personal data.
    Image Added Image Added
  4. Open the Tools > Visitors app. Your entry as a visitor is created but no consent to storing personal data is recorded yet until the double opt-in process is complete. You can see this by selecting the item in the Visitors app and clicking Update consent.
    Image Added
  5. Complete the double opt-in process. Open your email inbox and click the link in an email that was sent to you. Click the Proceed button on the web page to confirm your consent.

    The email message sent to visitors is configured in the  Opt-in Email  tab of the External Forms component. See GDPR and Forms for details about configuring email options and consent duration settings.

  6. Once a visitor confirms their consent, you can see a record of it in the Visitors app

...

  1. .

...

  1. Image Added
  2. Click

...

  1. Show dependencies to see the link to the external

...

  1. source, in this

...

  1. case IBM Watson Campaign Automation.

...


  1. Image Added 
    The link takes you to your Watson dashboard

...

  1. where you can see

...

  1. an entry for the visitor along with the consent recorded.

Screen

  1. Image Added

You can also use other Magnolia data privacy features with an Other gdpr features also interact with external source: send

  • Export all data (export from JCR but also JSON from

...

  • Watson)
  • Forget a visitor
  • Delete a visitor's data (request sent to

...

See GDPR and Forms for details about: configuring email options, consent duration

...

  • Watson)