Epsilon Connector

This module is responsible for integrating the current site to the DREAM real-time messaging service, called Epsilon. The main purpose is the code modularization. In other words, the e-mail integration will not only depend on the current site.

Get Started

To get started, you need to contact the DREAM team, requesting the Epsilon integration data for the current site.

Installing

The latest available version (latest tag) of the module should be downloaded and copied to the site's "modules/custom" folder. The last step is to enable and configure the module by CMS.

Module setup

The module has three configuration tabs. They are: Webservice Configuration, Webform Configuration and E-mails Templates.

Webservice Configuration

In this tab the user will configure the communication parameters with the DREAM webservice. The following fields must be typed:

• Web Service WSDL (Web Services Description Language): XML-based interface definition language that is used for describing the functionality offered by the DREAM web service.
• DREAM Partner: A collection of different business lines for an organization that share common properties in DREAM. This is the highest level in the DREAM hierarchy.
• DREAM Client: Delineates a line of business, product or service, or the like under the partner. Clients can represent any type of business, such as a website, a publication, or a brick and mortar business.
• DREAM Profile List Name: A collection of subscriber profiles maintained in DREAM to which e-mail messages are mailed.
• DREAM Folder: A location in DREAM that houses all of the assets related to a specific campaign.
• DREAM Username: Username provided by Epsilon for RTM HTTP requests.
• DREAM Password: Username password provided by Epsilon for RTM HTTP requests.

Webform Configuration

In this tab the user can enable or disable the Epsilon integration in each available webform of the site. When enabling a webform, the user must also specify how many e-mail templates will be used for that particular webform. If there are no webforms created on the site, the user can not configure anything.

E-mails Templates

In this tab the user will detail:

• The webform key of the e-mail field for each webform enabled for the Epsilon integration.
• The information for each template specified in the Webform Configuration tab, such as the DREAM template id, the Conditional Fields and the Tokens.

Conditional Fields

This field deserves a lot of attention because when a conditional field is included, the Epsilon integration becomes dependent on a unique value submitted by the site user.

An example: considering a site that contains a webform with a field called Type (radio button), capable of assuming two values: Patient or Caregiver.

[Webform Configuration] - The webform description:

[Webform Configuration] - Type field configuration:

When configuring the Epsilon module, if the user includes the Type field with the Patient value as a conditional field, the site user will only receive the e-mail if he answers the webform following the value specified.

[Epsilon Module Configuration] - Type field with the Patient value configured as a conditional field:

[Webform] - How the webform should be filled in for the final user to receive the e-mail:

To include a new conditional field, the pattern is: Field ID | Field Value.

Tokens

The tokens are webform data submitted by the user, which allow more customization of the e-mail templates. Common tokens are name and e-mail. This field follows the inclusion pattern of the Conditional Fields: DREAM Token ID | Webform Field ID.

Running the tests

Several tests can be performed:

• Check if the module is installed correctly:
  • Access the site as the admin.
  • On menu, click in Modules.
  • On filter list, search by Epsilon.
  • In links, choose Configure on the selectbox.
  • You will be redirected to the first (Web Service Configuration) of the module's three configuration tabs.
• Check if there are webforms available for the Epsilon integration:
  • Fill in all information in the Web Service Configuration tab as reported by the DREAM team.
  • Access the Webform Configuration tab. All webforms of the site in question will be displayed.
    • If there are no webforms, a warning message will be displayed.
    • If there are webforms, you can enable the integration in each one individually through a respective checkbox ("Enable Epsilon integration"). The number of e-mail templates for the current webform should be filled (only a positive numeric value greater than zero will be accepted).
• Configuring an integration:
  • After accessing and populating the Web Service Configuration and Webform Configuration tabs, access the E-mail Templates tab.
  • For each webform enabled in the previous tab, a fieldset will be displayed. The E-mail Key field must be filled with a valid field of the current webform. If the field you enter is not an E-mail type, an alert message will be displayed.
  • For each previously configured template, you must enter the DREAM template id.
  • The Conditional Fields and Tokens should be filled as explained previously in their respective sessions.
    • If there are invalid Conditional Fields (with Field ID or Field Value incorrect), an error message will be displayed, specifying the ID or value to be fixed.
    • If there are Tokens with invalid Webform Field ID, an error message will be displayed specifying which tokens should be filled in correctly.
• Verify if the integration has been configured correctly:
  • Access the site as the final user.
  • Answer a webform that is enabled and configured for the Epsilon integration (if there are conditional fields, remember to answer according to the configured values).
  • After submitting the form, check your e-mail box.
  • The e-mail template should be available.

Troubleshooting

• If the module has been configured and the webform has been filled, both correctly, but the e-mail was not sent as expected:
  • Access the site as an admin.
  • On menu, access the Reports option.
  • On menu, access the Recent Log Messages option.
  • Verify if the error message matches the title: "Error on Epsilon service integration":
    • If yes and if the detailed message is "the RTM request was rejected because the RTM template was not armed or the template does not exist", it means that the configured e-mail template was not created or is under construction by the DREAM team . The e-mail will not be sent successfully until the template has been finalized by DREAM. In this case, the problem should be reported to the Epsilon team.