Oracle Help Center | Oracle Responsys Mobile App Platform Cloud Service title

Design Mobile Apps for Responsys

Your first step in developing mobile apps that work with Oracle Responsys is to gather the design requirements. You'll work with the Responsys Account Admin and the Marketers to define the following:

More details are provided below.


About the Mobile App Channel in Responsys

The Mobile App channel in Responsys comprises the following campaign types:

"Push campaign workbook in Responsys, screenshot"

"In-app campaign workbook in Responsys, screenshot"


Creating the App Channel List

Mobile apps that work with Responsys are associated with an App Channel List. The App Channel List:

About the Match Key

Responsys uses the USER_IDENTIFIER parameter as the match key to uniquely identify "known users" of your app. This helps with such Responsys tasks as enabling filtering by known users, personalization, and for retrieving Message Center messages for known users.

How the match key is chosen

Coordinate with the Responsys Account Admin regarding which field to use. Only one field may be used as the match key across your app users, and it cannot be changed later.

When the Account Admin creates the app channel list to receive the app data, the admin should set one of the following to be the match key:

"Create app channel list in Responsys, screenshot"

The following choices are also available - but not recommended - to be set as the match key:

Why are these values not recommended? MD5/SHA are one-way keys. Therefore, the system will be unable to use the incoming USER_IDENTIFIER value to populate the EMAIL_ADDRESS_ field in a new Profile List record. (Merging with existing Profile List records is unaffected.) Not having a plain-text email address in a Profile List record is a problem, because Responsys users typically search for Profile List records by plain-text email address. Being unable to locate a record may cause confusion.

For more information about the match key, and recommendations for choosing which Profile List field to use as the match key, see the "Setting up the App Channel List" topic in the Mobile App Channel Configuration Guide.

Setting the match key value through the mobile app

An App Developer is expected to set the match key value through the USER_IDENTIFIER parameter in the app code.

For example:


When this field is set, Responsys looks for a corresponding record in the App Channel List. If there is a record, the system associates that profile record to the newly created device record. If not, it creates a new Profile List record and associates the newly created contact record to the App Channel List record.

If your mobile app supports multiple platforms, ensure that the mobile app code for each platform sets the correct match key value. For example, if CUSTOMER_ID_ is the match key and you are supporting iOS and Android, then your iOS and Android apps must both set the USER_IDENTIFIER parameter to a Customer ID value, because Responsys uses the Customer ID to match the App Channel List and Profile List records. If your iOS code is setting USER_IDENTIFIER to an email address instead of a Customer ID, and the App Channel List is expecting a Customer ID, then the App Channel List records created through the iOS version of your mobile app will not be matched to a Profile List record.

Normalization recommendations: Ensure that the data is normalized before the match key values are sent to Responsys; in the case of hashed values, perform the normalization before hashing the data. This helps ensure that records are matched properly.


Determine Message Center Design

The Mobile App Message Center feature enables Marketers to persist their Push campaign messages, so that mobile app users can view them later in the mobile app. As of the 18D update, Marketers can also create Message Center Direct campaigns, which send campaign messages directly without an accompanying Push message. Mobile App Developers can fetch these messages from Responsys and display them to mobile app users.

The SDK provides an API for fetching the Message Center messages data from Responsys. You must work with the Marketing team to design and develop the user experience in your mobile app. Marketers can learn more about Message Center by accessing the Responsys online help while using the Push Message Designer.

"Screenshot illustrating an example message center"

For more details about supporting Mobile App Message Center in your app, refer to the Message Center section.


Determine Custom Sounds

Responsys supports including custom sounds in the mobile push messages, but it must also be supported by your app. Work with your Marketers to determine the sounds and provide the names of the sound files to the Marketers.

For platform-specific information about supporting custom sounds in your mobile app to be used in notifications:


Determine Custom Triggers

In-App messaging campaigns rely on triggers to display the message for the app. Responsys and the Mobile App SDK support the standard trigger, $ExplicitAppOpen, for all apps. When a user opens the mobile app, the standard trigger is activated, which causes the in-app message to display.

However, Marketers may want different actions to trigger their in-app messages, such as when an app user adds merchandise to a cart. As the app developer, you must code the app to support each custom trigger. A custom trigger raises a mobile app event using a specific name. You must coordinate with the Account Admin on the custom trigger names, because the Account Admin must add the custom trigger names to the mobile app configuration in Responsys. Once the custom trigger names are configured in Responsys, marketers will see them in the list of triggers in the In-App Campaign Workbook.

Custom trigger notes:

For platform-specific information about supporting custom triggers and in-app messages in your mobile app:


Determine Supported Key/Value Pairs

As the app developer, you must ensure that your app code can extract key-value pairs from the payload, and use it as expected by the Marketers.

For platform-specific information about supporting custom key-value pairs in your mobile app:


Notification Preferences

Work with Marketers and Responsys Account Admins to define which Notification Preferences to offer in your app. Your app can support up to 30 preferences. Each preference consists of a key, value, and type. The value can be in the form of yes or no, a numeric value, or contain a string. Convenience methods help you build UI elements to allow your users to set their preferences.

If your mobile application registers notification preferences for users, then the Responsys Account Admin must define a Preferences PET for the App Channel List associated with the mobile app. This Preferences PET captures and stores the mobile app user preferences in Responsys.


For platform-specific information about supporting notification preferences in your mobile app:


Interactive Notifications

When Marketers design Push Campaigns in Responsys, they now have an option to add greater interactivity to their Push Notifications through Interactive Notifications. Interactive Notifications enable Marketers to add actionable buttons to their Push Notifications, and they allow mobile app users to interact with Push notifications.

About Interactive Notifications

Marketers can add interactive notifications to their Push Campaigns. Responsys supports a pre-defined set of 23 Standard Interactive Notifications, which only require that your mobile app be built with the supporting SDK. If you need buttons other than those provided in the Standard Interactive Notifications, Responsys supports adding Custom Interactive Notifications for mobile apps. Mobile app developers must define Custom Interactive Notifications in their mobile app code using the Mobile App SDK and must configure them for the app using the Mobile App Developer Console.

How Interactive Notifications Work

When Marketers choose and set up an interactive notification button for a Push campaign, the mobile app user will see the button(s) displayed with the Push notification they receive. When the mobile app user clicks an Interactive Notification button, the resulting action depends on how the button is defined:

"Screenshot of Push Message Designer with campaign using notification buttons"

About the Standard Interactive Notifications

Responsys supports the following Standard Interactive Notification buttons:

Enabling Interactive Notifications

To enable Standard Interactive Notifications:

  1. Request access to the Interactive Notifications feature by contacting your Customer Success Manager or logging in to My Oracle Support and creating a service request. This feature is currently released under our Controlled Availability program.

  2. Obtain and build your mobile app with the Mobile App SDK for your supported platform. You must build your mobile app with the Mobile App SDK version 6.35 or greater for the buttons available in the Responsys 18B Update, or with the 6.38 SDK (when available) for the buttons available in Responsys 18C Update. The Mobile App SDK supports several default Interactive Notification buttons and categories, and your mobile app requires no additional configuration to use the defaults.

To implement Custom Interactive Notifications:

Do the enablement steps above, and then work with your Marketing team to define requirements. For more information about how Marketers use this feature, see the Mobile App Channel Configuration Guide.

There are two parts to implementing Custom Interactive Notifications:

  1. Define the Custom Interactive Notification buttons for your mobile app by using the Mobile App Developer Console. For instructions, see the topic Manage Notification button settings.

  2. Implement the Custom Interactive Notifications in your mobile app code. For platform-specific information about how to do this, see the following topics:



Customized UX for destination URLs

When Responsys Link Tracking is used on calls-to-action in Rich Push and In-app message creatives, mobile app users are bounced off the browser and taken to the destination URL when they click the calls-to-action. This results in a poor user experience for the mobile app users.

The new feature "Customized User Experience for Links and Calls-to-action in Rich Push, In-app Messages" gives Mobile App Developers more control of how these links are handled. For example, if you want these links (including HTTP web links) to all be displayed within the mobile app, you can now do so. You can also fix the user experience of being bounced off a browser before being taken to a destination URL.

Mobile App Developers and Marketers should coordinate regarding the desired user experience. This optional feature is implemented by Mobile App Developers using the Mobile App SDK for your supported platform. You will need the Mobile App SDK version 6.35 (when available) or greater. There are no steps for the Marketers to take in Responsys for this feature.

For platform-specific information about implementing this feature in your mobile app: