Introduction

The integrated solution of Oracle Responsys and Optimove makes it easy to plan and execute email and mobile push campaigns, based on the advanced customer segmentation available in Optimove.

Optimove connects to the Oracle Responsys system to instruct Oracle Responsys to execute email or mobile push campaigns, i.e., to send out particular email/push templates to specified customer lists.

There are two methods of integration between Optimove and Oracle Responsys:

  1. The Oracle Responsys Advanced Campaign API – Recommended if you will only be sending basic email campaigns
  2. SFTP connection – Recommended if you will be sending email campaigns that use advanced Oracle Responsys features (e.g. subject line A/B testing, drag-and-drop components) and/or mobile push campaigns

Setting Up the Integration

In order to set up the integration between your Optimove site and your Oracle Responsys account (for either integration method, API or SFTP), the following steps are required:

  1. Ensure that the following customer attributes are available in the Oracle Responsys database:
    • CUSTOMER_ID_ or RIID_ – one of these fields is used to match customers between Optimove and Oracle Responsys (you may also choose to use any alternative unique identifier that appears in both the Optimove and Oracle Responsys databases)
    • First name
    • Last name
    • Email address
  2. Maintain a daily update of this database. For example, when new customers join, their information must be promptly updated in Oracle Responsys.
  3. Whitelist the Optimove app server IPs in Oracle Responsys, which will allow Optimove to access the Oracle Responsys API use. These IPs will be provided to you by your CSM.
  4. Provide your CSM with login credentials to the Oracle Responsys API. Notes:
    • These details must include:
      • Your Oracle Responsys API access credentials
      • The default time zone of your Oracle Responsys account
      • API login URL (e.g., https://login5.responsys.net)
    • This step is necessary even if you will be using the SFTP integration method.
    • You should create a new administrator-level API account specifically for use by Optimove, with credentials sufficient to execute Oracle Responsys Advanced Campaign API commands.
    • These credentials may not contain any of these characters: $ & =
  5. Create a common folder called OPTIMOVE in your Oracle Responsys client. This folder should be used to store all relevant campaigns to be executed via Optimove (this enables the template preview functionality in Optimove).

Your CSM will set up the integration for your Optimove site, using the details you provide.

To continue the setup process, proceed with one of the following two sections:

Setting Up Integration Method 1: API (Email Only)

Proceed with the following steps only if you chose to integrate via the Advanced Campaign API method.

Set Up Responsys

  1. In the Oracle Responsys client, create a common folder named OPTIMOVE_SENT (this folder will contain copies of campaigns prepared for sending by Optimove).
  2. Populate the OPTIMOVE folder with basic email campaigns only.

Set Up Your Email Campaigns in Optimove

  1. When scheduling a campaign in Optimove, select the Oracle Responsys execution channel.
  2. Select the desired template(s) for the campaign, from the list of templates that Optimove retrieved from Oracle Responsys. Notes:
    • All email templates available in the OPTIMOVE folder in Responsys (as well as previews for those templates) are retrieved by Optimove (via API) on a daily basis.
    • In order to use personalization fields, the templates defined in Responsys must include references (placeholders) to personalization fields.
  3. Select any promotion codes for the campaign (optional).
  4. Set the desired send time for the campaign.

https://docs.optimove.com/wp-content/uploads/2017/07/responsys.png

Optimove Executes Your Email Campaigns

On a daily basis, Optimove performs the following steps for each campaign scheduled for that day (by automatically connecting to the Oracle Responsys API):

  1. Optimove creates a copy of the selected campaign in the OPTIMOVE_SENT folder in Oracle Responsys, creates and populates the corresponding Oracle Responsys supplemental table with the selected ID of the campaign’s recipients, and specifies the date and time when Oracle Responsys should send out the campaign. Important note: Any customer email address that does not already appear in Oracle Responsys will not receive the email (see Setting Up the Integration, above).
  2. If the selected template contains personalization tags, the relevant customer attributes for each individual recipient are added to the supplemental table.

Integration Method 2: SFTP Connection (Email and Push)

Proceed with the following steps only if you chose to integrate via the SFTP connection method.

Set Up Responsys

  1. Populate the OPTIMOVE folder in Oracle Responsys with email or mobile push campaigns. Optimove will use the provided API credentials to extract these campaigns (and previews) on a daily basis.
  2. Define an Oracle Responsys job for each campaign included in the OPTIMOVE folder. The Responsys job should contain the details of each campaign’s scheduled send time and recurrence schedule.
  3. Provide your CSM with the credentials to your SFTP server.
  4. Your CSM will provide you with the SFTP certification file required for the integration.

Set Up Your Email/Push Campaigns in Optimove

  1. When scheduling a campaign in Optimove, select Oracle Responsys as the execution channel.
  2. Select the desired template(s) from the list of available templates. Notes:
    • All email and push templates available in the OPTIMOVE folder in Oracle Responsys (and previews for those templates) are retrieved by Optimove (via API) on a daily basis.
    • In order to work with personalization fields, the templates defined in Responsys must include references (placeholders) to personalization fields.
  3. Select any promotion codes for the campaign (optional).
  4. There is no need to set the scheduled time in Optimove when using the SFTP integration method, because the scheduled time will be determined by the Oracle Responsys job configured for this campaign.
  5. Make sure that a corresponding Oracle Responsys job is configured for this campaign.

https://docs.optimove.com/wp-content/uploads/2017/07/responsys.png

Optimove Executes Your Email/Push Campaigns

On a daily basis, Optimove performs the following steps for each campaign scheduled for that day:

  1. Optimove creates a CSV file for each campaign, containing the details of the campaign as defined in Optimove:
    • the selected template
    • the customer ID for each campaign recipient
    • the personalization values for each recipient, if relevant (see Using Personalization Tags, below)

    Important note: Any customer email address that does not already appear in the Oracle Responsys database will not receive the campaign (see Setting Up the Integration, above).

  2. Optimove uploads the CSV files for all of that day’s campaigns to the Oracle Responsys SFTP server.
  3. The Oracle Responsys job that you configured for each campaign will retrieve the appropriate CSV file from the SFTP server and execute the campaign based on the details in the file.

Using Personalization Tags

In order to include personalization tags in Oracle Responsys campaigns executed via Optimove (regardless of integration method), you also need to:

  • Contact your CSM to define, in advance, the specific set of personalization tags that you will be using.
  • Add the tags to the campaign template in Oracle Responsys, using only tags of type “Dynamic Variable”:
    • Open the personalization dialog from the Oracle Responsys template editor.
    • Click Add Table.
    • Select the Dynamic Variables option.
    • Fill in the dynamic variable name.
    • Drag the new tag to the right-side area of the dialog.

Note that the tag names defined in Oracle Responsys must correspond to the tags defined in Optimove in conjunction with your CSM.

https://docs.optimove.com/wp-content/uploads/2017/07/personalization.png

Note

Due to technical limitations of Oracle Responsys, campaign metrics (e.g., delivery, open and click rates) will not appear in Optimove's Campaign Analysis reports for campaigns sent via Oracle Responsys.