Admins: OpenField integration overview

Tabata Vossen -

Connect your identified campaigns created in Qualifio with the Openfield platform. Once integration is configured, the login/signup screen will be displayed each time the participant participates in a Qualifio campaign in which the integration was enabled.

Possible scenarios

Screenshot_2019-08-01_at_10.13.08.png

When integration is enabled for the campaign, the participant faces one of 3 scenarios below:

1. The user is not logged in, but has an account

A call to the Openfield webservice allows us to identify this person and retrieve their data to pre-fill the Qualifio form.

Depending on the settings you selected for this form, the participant will have the option to change their data before submitting the form. The entire file is then returned in such a way that existing data is overwritten and the profile is updated in your database.

2. The user does not have an account yet and needs to create a new one

The profile is created and pushed in Openfield after submitting the Qualifio campaign form (via the 'Create' method of the Openfield webservice).

3. The user has an account, but has forgotten their password

The user is redirected to your password reset page so that they can create a new one.

Screenshot_2019-08-01_at_10.17.36.png

Enabling the OpenField integration from Qualifio

Connecting Openfield to your Qualifio account

  1. Click on your Settings -> Integrations & Partners
  2. Click SSO
  3. Choose Openfield from the integrations list
  4. Click the OFF/ON button to enable the integration, then click Configure
  5. Under Global, fill out the following fields:
    - URL Redirection Forget Password:
    - idTenant Openfield
    - IdApplication Openfield
    - URL Openfield
  6. Click Save

NOTE: Qualifio requires and will use these fields to authenticate with your specific Openfield account and its particular configuration. These information would be provided by your Openfield Expert.

Enabling the Openfield integration in a form or campaign

Once configured, the integration will be available in

  • Editing the campaign: Form step > Data connections. Don't forget to select your opt-ins in the campaign (Form step, too).
  • Documents > Identification forms > Master forms > Edit > Data connections.

Screenshot_2019-08-01_at_16.05.01.png

Supported data

Background data

Openfield webservice parameter Description
Party.PartyType Fixed value "Person"
Party.Version Versionning value
Party.LanguageId Qualifio campaign's language 

Form fields

Qualifio CRM/SSO variable

Openfield webservice parameter

Description or example

CRM variable:
{email}

Party.Accounts[0].Email

johndoe@gmail.com

CRM variable:{username}

Party.Accounts[0].UserName

 johndoe12

CRM variable:{password}

Party.Accounts[0].Pwd

 johndoespassword

CRM variable:{firstname}

Party.PersonalInfo.FirstName

John

CRM variable:{lastname}

Party.PersonalInfo.LastName

Doe

CRM variable:{country}

Party.Addresses[0].Country

ISO ALPHA-3 country code
(e.g. BEL for Belgium)

CRM variable:{locality}

Party.Addresses[0].City

City/locality (e.g. Brussels)

CRM variable:{zipcode}

Party.Addresses[0].ZipCode

Postal code (e.g. 1000)

CRM variable:{address}

Party.Addresses[0].Street1

Street name + number

CRM variable:
{gender}

Party.PersonalInfo.Gender

'H' or 'F'*

CRM variable:{birthday}

Party.PersonalInfo.BirthDateDDMMYYYY

DDMMYYYY format (e.g. 01082019 for August 1, 2019)
SSO variable:
{openfield_Civility}

Party.PersonalInfo.Civility

'M' or 'MME'**

* Important: For the "Gender" field, only the values "H" and "F" (in upper case) will be passed to Openfield. To ensure that the push works properly, you must absolutely configure these values in your form field, as follows:

Screenshot_2019-08-01_at_17.08.31.png

** Important: For the "Civility" field, only the values "M" and "MME" (in upper case) will be passed to Openfield. To ensure that the push works properly, you must absolutely configure these values in your form field, as follows:

Screenshot_2019-08-01_at_17.16.24.png

Opt-ins

Opt-ins are managed from Qualifio's Opt-in Manager. 

Qualifio only pushes opt-ins that have been selected by the participant. Opt-ins are pushed under 'Services': 

"Services": [{
    	"ActivationDate": "2017-01-01T00:00:00",
    	"ServiceId": "Partners",
    	"ServiceStatus": true,
    	"ServiceTypeId": "OPTINS"
}, {
    	"ActivationDate": "2017-01-01T00:00:00",
    	"ServiceId": "Newsletter",
    	"ServiceStatus": true,
    	"ServiceTypeId": "OPTINS"
}]
Openfield webservice parameter Description
ActivationDate Participation date and time
ServiceStatus Fixed value "true"
ServiceTypeId Fixed value "OPTINS"
ServiceId Code of the SSO variable (see examples below)

Important: You must associate an SSO variable to each opt-in.

Opt-in name Opt-in text Qualifio SSO variable Openfield ServiceId
Newsletter opt-in Yes, I would like to receive the newsletter optin_newsletter Newsletter
Partners opt-in Yes, I would like to receive information and tips from partners optin_partners Partners

 

Read more:

Powered by Zendesk