Responsys

Skip to end of metadata
Go to start of metadata

Overview

Gigya’s integration with Responsys combines Gigya's rich, permission-based social and other profile info with Responsys relationship-based marketing.

The integration synchronizes user data between Gigya and Responsys on a recurring basis (daily) or ad-hoc, including:

  • Creating and updating users in Responsys based on information from Gigya.
  • Updating user data in Gigya based on information from Responsys.
  • Extracting segments using filter criteria.
  • Integration is by transferring single value Gigya user account fields such as name, age, address or email. Field names are matched with corresponding fields on the target system. Gigya account fields which hold complex multi-value object data such as user photos' URLs or Facebook likes cannot be integrated using this method.

Integration with Responsys is a premium service requiring activation. For more information, please contact your Gigya Account Manager or enter a support request on our site.

Configuration Parameters

Please create a test site in the Gigya admin console for integration testing (don't use your production site) and use a test list on the target integration platform. We are able to put integrations in "sample mode" for testing, which will restrict audiences to 10 sample accounts.

Setting up the Gigya- Responsys integration requires the following configuration information:

Parameters for General Integration Configuration

RequiredNameValueDescription
[general] Section
esp.update.houre.g. 22:00The time of day that that synchronization will run. By default it is read in the format of HH:MM. Time is set in 10 min. intervals. (e.g 20:10)
gigya.api.key The unique API key associated with your site in the console

getGm

  • True
  • False (default)

Set to "true" to enable file flattening for Loyalty (Game Mechanics) data. To implement this data flattening, you need to specify the appropriate mapping (see [fieldMapping] section).

See field.array.extract for an example of the output.

getCounters
  • True
  • False (default)

Set to "true" to enable file flattening for Counters data. To implement this data flattening, you need to specify the appropriate mapping (see [fieldMapping] section).

See field.array.extract for an example of the output.

[fieldMapping] Section
 

Mapping of field names in the source platform to field names in the target platform. Each Gigya field must map to a single field in the destination partner's platform.

Format: "sourcefield=targetfield". For example:

[fieldMapping]
profile.email = email
profile.UID = GigyaUID
profile.firstName = First_Name
profile.lastName = Last_Name 

Additional configuration options:

  • Date Format: To alter the date format, use
    fn_formatDate(data.externalCustomerDate|YYYY-MM-HH)
  • Loyalty (GM) Data: If you set getGm to true in the [general] section, use the following format to set the mapping:
    [{"UID"|"UID","gmLevelTitle"|"levelTitle","gmPoints"| "pointsCurrent","requiredAchievement"|"requiredAchievement"}=gm
  • Counters Data: If you set getCounters to true in the [general] section, use the following format to set the mapping:
    {"UID"|"UID","class"|"class","path"|"path","period"| "period","value"|"value","count"|"count"}=counters

Parameters for FTP Configuration

RequiredNameTypeDescription
fileNamePrefixstringThe outbound file name prefix created is {fileNamePrefix}{fileNameDateFormat}. We recommend indicating the company name in {fileNamePrefix}.
fileNameSuffixstringThe suffix should include the extension of the created outbound file. (e.g. ".csv", ".txt").
fileNameDateFormatstring

Format for the filename timestamp. This should be in one of the simple date formats.

Default: yyyyMMdd_HHmm

For example, if we transfer a .csv file to a company called "ACME Inc." on March 22, 2015 at 11:15pm, the file may be named acme_20150322_1115.csv.

Date-only formats (such as YYMMDD - without Time) are permitted, but in that case, if the file is transferred more than once a day, it will have the same name each time, and may overwrite a previously transferred file.

fileDelimitercharCharacter used to distinguish columns in the CS file. Supported values are comma (","), semicolon (";"), pipe ("|") and tab ("\t").
outbound.compressstring

Determines whether compression is used, and if so, specifies a format. Permitted values are:

  • "gzip" - Use gzip compression.
  • "lzo" - Use lzo compression.
  • "none" - Do not use compression.
esp.storage.protocolstring"SFTP" or "FTPS".
esp.storage.serverstringIP of the destination server.
esp.storage.portstring Port on the destination server.
esp.storage.userstringFile storage account user name.
esp.storage.passstringFile storage account password.
esp.storage.keystringIf a value is entered, this field is used instead of the SFTP password, otherwise the SFTP password will be used.
The key should be in OpenSSH format. For more information see http://www.ietf.org/rfc/rfc4716.txt.
esp.storage.phrasestringIF SFTP is used, a pass phrase can be set for additional security. This is the passphrase.
outbound.completePopulationFolderNamestringName of the folder to populate the full data import on the outbound server.
outbound.deltaPopulationFolderNamestringName of the folder to populate the data updates on the outbound server.

Parameter for Data Filtering

RequiredNameTypeDescription
ae.filterClausestringAn SQL-like query specifying the data to retrieve from Gigya on outbound data transfers. Refer to the filter criteria in the Identity Query Tool.

Parameters for Inbound Data Transfers 

RequiredNameTypeDescription
inboundFilePatternstringGigya will search for files with a prefix, sorted by date: "Prefix*.extension".
esp.sync.unsubscribed.hourStringThe time of day to retrieve unsubscribe actions in the format of HH:MM. Time is set in 10 min. intervals. (e.g 20:10)

Compression Support

Gigya supports transmitting files in compressed format.

By default files are not compressed, but you can configure gzip or LZO compression.

Save