Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The example on this page makes use of the External Forms IBM module and the API provided by 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-ibm – provides a sample implementation for the IBM Watson Campaign Automation tool.

Do not include the Infusionsoft and Eloqua submodules.

In the sample implementation, the magnolia-external-forms-ibm module (sub module of External Forms) provides a page called watsonFormSample (and a followup follow up confrmation page) in the Pages app.

This page contains a simple email field form linked to IBM Watson. The form is processed using using an out

Javadoc-
of
resource-
the-box processor called XXX
link-macro
classNameinfo.magnolia.extforms.services.ExternalFormService
renderTypeasynchronous
 called ibm

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.

...

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

...

Creating an external web form with a GDPR-aware email field

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

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

  • Fetch data from IBM Watson once the site URL is provided.
  • Ask for visitor consent before submitting the form by displaying consent checkboxes.
  • Send the visitor an opt-in email for the second phase of the opt-in procedure.

...

  1. In your IBM Watson Automation Campaign database, create a new standard web form.
  2. Keep the default 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: 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
  7. Edit the External Form sample component to add the URL of the site you just published.

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

...

To complete the double opt-in process in this sample, the visitor must follow a link contained in an email that is sent to them and click Proceed to confirm their consent. The email visitors receive is preconfigured in the Opt-in Email tab of the IBM external forms External Forms component. See GDPR and Forms for details about configuring email options and consent duration settings.

...

In the Visitors app, click Show dependencies to see the link to external sources (in this example: IBM Watson Campaign Automation). The clickable link takes you to your Watson dashboard (contacts list) where you can see an entry for the visitor along with the consent recorded.

...