Page History
...
clear | both |
---|---|
width | 244px |
align | right |
class | menu |
This page shows how to 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 store the data in IBM Watson Marketing. The example uses the Magnolia External Forms IBM module and the Magnolia Data privacy API.
Table of Contents |
---|
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.
...
...
How the example works
The External Forms IBM module adds a watsonFormSample
page in the Pages app. The page contains a form with an email field. The form was created in IBM Watson and is rendered by Magnolia.
...
When a visitor types their email address into the field and submits the form, Magnolia processes the input using . Magnolia uses an
Javadoc resource link | ||||
---|---|---|---|---|
|
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....
The example uses Magnolia's default data privacy mechanism. The mechanism from the magnolia‐privacy‐visitor‐manager
module which 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 info.magnolia.extforms.consent.WatsonReferencesSearcher
processes the personal data on the form.
Similar to the IBM Watson example, you can connect to 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 | ||||
---|---|---|---|---|
|
Configuring the IBM Watson sample
To enable the sample with your implementation of IBM Watson Campaign Automation, follow the steps in the sections below.
We assume that you are familiar with IBM Watson Campaign Automation.
Connecting 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.
- External forms Infusionsoft: not needed, you can exclude this.
- External forms Eloqua: not needed, you can exclude this.
Configuration
Connecting to IBM Watson database
- Create If you do not already have one, create a Single Opt-In database in your in Watson Campaign Automation account.
- Make sure that
Email
is one of the fields in your database. - Once created, open Open the additional details and copy the Database ID.
- In Magnolia, open the configuration of the
magnolia-privacy-visitor-manager
module: go to Configuration app >/modules/visitor-manager/config/visitorReferencesSearchers/watson/databasesIds
- Add a property
watsonid
property node underdatabaseIds
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. - In Magnolia, open the configuration of the
magnolia-external-forms-ibm
module: Go to Configuration app >/modules/external-forms-ibm/config
- Add your IBM Watson credentials for the three property nodesproperties:
clientId
clientSecret
refreshToken
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 field, connect to it directly in add the form on the watsonFormSample
page. Use the External Form component. The External Form component in the watsonFormSample
page The component extends the default externalForm
component and is preconfigured todoes the following:
- Fetch data Fetches a form from IBM Watson once the as configured in site URL is provided.
- Ask Asks 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 for the second phase of the opt-in procedure.
...
- In your IBM Watson Automation Campaign database, create a new standard web form.
- Keep the default form fields in the new form and follow the instructions in the IBM wizard.
- Publish the form.
- On the Publish Confirmation page, click Publish Site.
- In the Site Settings, copy the site URL. For example: , for example
http://www.pages03.net/trial-magnoliainternational/<sitename>/Form
- In Magnolia, go to the Pages app and open the
watsonFormSample
page: http://localhost:8080/magnoliaAuthor/.magnolia/admincentral#app:pages:detail;/watsonFormSample:edit. - Edit the External Form sample component to add . Add the URL of the site you just published.
The component can now fetch data from IBM Watson Automation Campaign
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.
|
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. |
- Preview the
watsonFormSample
page in the Pages app.
...
- Fill the form with your email address.
- Give consent to processing personal data.
...
- 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.
...
- 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. - Once
...
- a visitor confirms their consent, you can see a record of it in the Visitors app
...
- .
...
- Click Show dependencies to see the link to the external
...
- source, in this
...
- case IBM Watson Campaign Automation
...
- .
The link takes you to your Watson dashboard where you can see an entry for the visitor along with the consent recorded.
...
Note that the other You can also use other Magnolia data privacy features provided by Magnolia can be used with with an 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 Watson)
...