Responsys: Difference between revisions

From MozillaWiki
Jump to navigation Jump to search
 
(10 intermediate revisions by 3 users not shown)
Line 1: Line 1:
== Registration Forms ==
There are few different ways of getting subscription data into Responsys.  You can set up a Responsys hosted form, build your own form and POST data to Responsys, use their API, etc.


=== POSTing directly to Responsys ===
=== Deprecated ===


# Build your form HTML. Here's an [http://www.mozilla.com/en-US/newsletter/ example]
This page is deprecated. We don't use Responsys directly anymore. We have built a web service for all of our newsletter needs, and it can talk to Responsys or do whatever it needs!
# Send a POST request to Responsys with your subscription data.  The [http://svn.mozilla.org/projects/mozilla.com/trunk/includes/email/responsys.php example form uses Curl] to send this request.
## POST to this URL:  http://awesomeness.mozilla.org/pub/rf
## Include the following in your POST data...
### _ri_ = some unique form ID.  This basically tells Responsys where to put your data.
#### for production, _ri_ = X0Gzc2X%3DUQpglLjHJlTQTtQyTQ3qQ0OQQzgQvQviRVwjpnpgHlpgneHmgJoXX0Gzc2X%3DUQpglLjHJlTQTtQyTQ3qQ0NQQGQvQvH3
#### for dev/stage, _ri_ = X0Gzc2X%3DUQpglLjHJlTQTtQ1vQ2rQ0bQQzgQvQy8KVwjpnpgHlpgneHmgJoXX0Gzc2X%3DUQpglLjHJlTQTtQ1vQ2rQ0aQQGQvQwPD
### A flag to indicate which newsletter the user is signing up for.  For example, the about:mozilla newsletter uses, "ABOUT_MOZILLA_FLG = Y".  about:mobile is "ABOUT_MOBILE_FLG = Y".  This field needs to be set up in the Responsys schema before use.
### A similar flag marks when the user signed up.  For example, "ABOUT_MOZILLA_DATE = 2010-09-30 10:00:00"
### You can include any other data that maps to an existing Responsys field.  For example, about:mobile includes the subscribers name using "FIRST_NAME" and "LAST_NAME"


==== Doing all this on mozilla.com ====
The web service is called Basket and provides a REST API for working with it. See [[Mozilla.com/Newsletters]].


If you're building a registration form on mozilla.com, many of the steps above are already built for you.  There is a [http://svn.mozilla.org/projects/mozilla.com/trunk/includes/email/responsys.php library for POSTing to Responsys], and [http://svn.mozilla.org/projects/mozilla.com/trunk/includes/email/forms.php some classes] that hopefully make building forms easier. Also, the _ri_ config is handled in [http://svn.mozilla.org/projects/mozilla.com/trunk/includes/config.inc.php-dist mozilla.com's config file]. Most of the work falls into building the actual form HTML and any validation rules.  The [http://www.mozilla.com/en-US/newsletter/about_mozilla/ about:mozilla], [http://www.mozilla.com/en-US/newsletter/about_mobile/ about:mobile], and [http://www.mozilla.com/en-US/newsletter/ mainstream] newsletters are all good examples you should work from.
=== Usage ===
 
Use this [http://viewvc.svn.mozilla.org/vc/projects/mozilla.com/trunk/includes/email/basket.php?view=markup PHP library].
 
The function you'll use the most is BasketService::subscribe which takes an array of parameters to pass. The available fields are outlines in [https://github.com/mozilla/basket/blob/master/apps/news/README basket's documentation].
 
=== Viewing subscriptions in Responsys ===
 
# Log in
# Go to the "Folders" tab
# Go to the "!MasterData" folder
# Subscriptions are kept in "CONTACTS_LIST" (obviously, be extremely careful with this list)
 
=== Testing/QA ===
 
Read the sections above.
 
Follow the instructions in "Viewing subscriptions in Responsys" above.
 
What to test?
* Form validation. Email should be valid, privacy checkbox should be required, etc
* Subscription fields are saved. For every newsletter, there are at least two
** CAMPAIGN_NAME_FLG (e.g. ABOUT_HACKS_FLG) - this is "Y" for "subscribed" or "N" for "unsubscribed"
** CAMPAIGN_NAME_DATE (e.g. ABOUT_HACKS_DATE) - this records when the user signed up
** There might be others.  For example, the [http://www.mozilla.com/en-US/newsletter/about_mobile/ about:mobile form] has country, first name, last name, etc.  Check that these are saved correctly.
* Confirmation email. Every newsletter sends a confirmation email.  Check the format and content (copy, links, etc)
* Unsubscribe form. Every newsletter has an unsubscribe form. You can find an unsubscribe link at the bottom of the confirmation note you received when you subscribed.

Latest revision as of 22:36, 21 November 2011

Deprecated

This page is deprecated. We don't use Responsys directly anymore. We have built a web service for all of our newsletter needs, and it can talk to Responsys or do whatever it needs!

The web service is called Basket and provides a REST API for working with it. See Mozilla.com/Newsletters.

Usage

Use this PHP library.

The function you'll use the most is BasketService::subscribe which takes an array of parameters to pass. The available fields are outlines in basket's documentation.

Viewing subscriptions in Responsys

  1. Log in
  2. Go to the "Folders" tab
  3. Go to the "!MasterData" folder
  4. Subscriptions are kept in "CONTACTS_LIST" (obviously, be extremely careful with this list)

Testing/QA

Read the sections above.

Follow the instructions in "Viewing subscriptions in Responsys" above.

What to test?

  • Form validation. Email should be valid, privacy checkbox should be required, etc
  • Subscription fields are saved. For every newsletter, there are at least two
    • CAMPAIGN_NAME_FLG (e.g. ABOUT_HACKS_FLG) - this is "Y" for "subscribed" or "N" for "unsubscribed"
    • CAMPAIGN_NAME_DATE (e.g. ABOUT_HACKS_DATE) - this records when the user signed up
    • There might be others. For example, the about:mobile form has country, first name, last name, etc. Check that these are saved correctly.
  • Confirmation email. Every newsletter sends a confirmation email. Check the format and content (copy, links, etc)
  • Unsubscribe form. Every newsletter has an unsubscribe form. You can find an unsubscribe link at the bottom of the confirmation note you received when you subscribed.
Retrieved from "https://wiki.allizom.org/index.php?title=Responsys&oldid=371864"